openapi: 3.0.0
info:
version: '2016-11-15'
x-release: v4
title: Amazon Elastic Compute Cloud
description: '
Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the Amazon Web Services Cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster. Amazon Virtual Private Cloud (Amazon VPC) enables you to provision a logically isolated section of the Amazon Web Services Cloud where you can launch Amazon Web Services resources in a virtual network that you''ve defined. Amazon Elastic Block Store (Amazon EBS) provides block level storage volumes for use with EC2 instances. EBS volumes are highly available and reliable storage volumes that can be attached to any running instance and used like a hard drive.
To learn more, see the following resources:
Amazon EC2: Amazon EC2 product page, Amazon EC2 documentation
Amazon EBS: Amazon EBS product page, Amazon EBS documentation
Amazon VPC: Amazon VPC product page, Amazon VPC 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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptAddressTransfer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AcceptAddressTransfer
operationId: POST_AcceptAddressTransfer
description: 'Accepts an Elastic IP address transfer. For more information, see Accept a transferred Elastic IP address in the Amazon Virtual Private Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptAddressTransferResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptAddressTransferRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptAddressTransfer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AcceptReservedInstancesExchangeQuote:
get:
x-aws-operation-name: AcceptReservedInstancesExchangeQuote
operationId: GET_AcceptReservedInstancesExchangeQuote
description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ReservedInstanceId
in: query
required: true
description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservationId'
- xml:
name: ReservedInstanceId
- name: TargetConfiguration
in: query
required: false
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TargetConfigurationRequest'
- xml:
name: TargetConfigurationRequest
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptReservedInstancesExchangeQuote
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AcceptReservedInstancesExchangeQuote
operationId: POST_AcceptReservedInstancesExchangeQuote
description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptReservedInstancesExchangeQuote
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AcceptTransitGatewayMulticastDomainAssociations:
get:
x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations
operationId: GET_AcceptTransitGatewayMulticastDomainAssociations
description: Accepts a request to associate subnets with a transit gateway multicast domain.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult'
parameters:
- name: TransitGatewayMulticastDomainId
in: query
required: false
description: The ID of the transit gateway multicast domain.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: false
description: The ID of the transit gateway attachment.
schema:
type: string
- name: SubnetIds
in: query
required: false
description: The IDs of the subnets to associate with the transit gateway multicast domain.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptTransitGatewayMulticastDomainAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AcceptTransitGatewayMulticastDomainAssociations
operationId: POST_AcceptTransitGatewayMulticastDomainAssociations
description: Accepts a request to associate subnets with a transit gateway multicast domain.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptTransitGatewayMulticastDomainAssociationsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptTransitGatewayMulticastDomainAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AcceptTransitGatewayPeeringAttachment:
get:
x-aws-operation-name: AcceptTransitGatewayPeeringAttachment
operationId: GET_AcceptTransitGatewayPeeringAttachment
description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult'
parameters:
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the transit gateway attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptTransitGatewayPeeringAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AcceptTransitGatewayPeeringAttachment
operationId: POST_AcceptTransitGatewayPeeringAttachment
description: Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptTransitGatewayPeeringAttachmentRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptTransitGatewayPeeringAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AcceptTransitGatewayVpcAttachment:
get:
x-aws-operation-name: AcceptTransitGatewayVpcAttachment
operationId: GET_AcceptTransitGatewayVpcAttachment
description: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptTransitGatewayVpcAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AcceptTransitGatewayVpcAttachment
operationId: POST_AcceptTransitGatewayVpcAttachment
description: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The ID of the VPC endpoint service.
schema:
type: string
- name: VpcEndpointId
in: query
required: true
description: The IDs of the interface VPC endpoints.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptVpcEndpointConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AcceptVpcEndpointConnections
operationId: POST_AcceptVpcEndpointConnections
description: Accepts connection requests to your VPC endpoint service.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptVpcEndpointConnectionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AcceptVpcEndpointConnectionsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptVpcEndpointConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AcceptVpcPeeringConnection:
get:
x-aws-operation-name: AcceptVpcPeeringConnection
operationId: GET_AcceptVpcPeeringConnection
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
required: true
description: The ID of the VPC peering connection. You must specify this parameter in the request.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AcceptVpcPeeringConnection
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AcceptVpcPeeringConnection
operationId: POST_AcceptVpcPeeringConnection
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AcceptVpcPeeringConnectionResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AcceptVpcPeeringConnectionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AcceptVpcPeeringConnection - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AdvertiseByoipCidr: get: x-aws-operation-name: AdvertiseByoipCidr operationId: GET_AdvertiseByoipCidr description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AdvertiseByoipCidrResult' parameters: - name: Cidr in: query required: true description: '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.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AdvertiseByoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AdvertiseByoipCidr
operationId: POST_AdvertiseByoipCidr
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AdvertiseByoipCidrResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AdvertiseByoipCidrRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AdvertiseByoipCidr - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AllocateAddress: get: x-aws-operation-name: AllocateAddress operationId: GET_AllocateAddress description: 'Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AllocateAddressResult' parameters: - name: Domain in: query required: false description: The network (vpc).
schema:
type: string
enum:
- vpc
- standard
- name: Address
in: query
required: false
description: The Elastic IP address to recover or an IPv4 address from an address pool.
schema:
type: string
- name: PublicIpv4Pool
in: query
required: false
description: '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.'
schema:
type: string
- name: NetworkBorderGroup
in: query
required: false
description: 'A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: The tags to assign to the Elastic IP address.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- AllocateAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AllocateAddress
operationId: POST_AllocateAddress
description: 'Allocates an Elastic IP address to your Amazon Web Services account. After you allocate the Elastic IP address you can associate it with an instance or network interface. After you release an Elastic IP address, it is released to the IP address pool and can be allocated to a different Amazon Web Services account.
You can allocate an Elastic IP address from an address pool owned by Amazon Web Services or from an address pool created from a public IPv4 address range that you have brought to Amazon Web Services for use with your Amazon Web Services resources using bring your own IP addresses (BYOIP). For more information, see Bring Your Own IP Addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another Amazon Web Services account. To attempt to recover an Elastic IP address that you released, specify it in this operation.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance).
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AllocateAddressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AllocateAddressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AllocateAddress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AllocateHosts: get: x-aws-operation-name: AllocateHosts operationId: GET_AllocateHosts description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AllocateHostsResult' parameters: - name: AutoPlacement in: query required: false description: 'Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
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.
' schema: type: string - name: InstanceFamily in: query required: false description: '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.
' schema: type: string - name: Quantity in: query required: false description: '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.' schema: type: integer - name: TagSpecification in: query required: false description: The tags to apply to the Dedicated Host during creation. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: HostRecovery in: query required: false description: '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.
' schema: type: string - name: HostMaintenance in: query required: false description: 'Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.' schema: type: string enum: - 'on' - 'off' - name: AssetId in: query required: false description: '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.
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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the IPAM pool from which you would like to allocate a CIDR.
schema:
type: string
- name: Cidr
in: query
required: false
description: '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.
' schema: type: string - name: NetmaskLength in: query required: false description: '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.
' schema: type: integer - name: ClientToken in: query required: false description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' schema: type: string - name: Description in: query required: false description: A description for the allocation. schema: type: string - name: PreviewNextCidr in: query required: false description: A preview of the next available CIDR in a pool. schema: type: boolean - name: DisallowedCidr in: query required: false description: Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: Action in: query required: true schema: type: string enum: - AllocateIpamPoolCidr - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: AllocateIpamPoolCidr operationId: POST_AllocateIpamPoolCidr description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ApplySecurityGroupsToClientVpnTargetNetwork
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ApplySecurityGroupsToClientVpnTargetNetwork
operationId: POST_ApplySecurityGroupsToClientVpnTargetNetwork
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ApplySecurityGroupsToClientVpnTargetNetwork
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AssignIpv6Addresses:
get:
x-aws-operation-name: AssignIpv6Addresses
operationId: GET_AssignIpv6Addresses
description: 'Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssignIpv6AddressesResult' parameters: - name: Ipv6AddressCount in: query required: false description: 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. schema: type: integer - name: Ipv6Addresses in: query required: false description: 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. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: Ipv6PrefixCount in: query required: false description: The number of IPv6 prefixes that Amazon Web Services automatically assigns to the network interface. You cannot use this option if you use theIpv6Prefixes option.
schema:
type: integer
- name: Ipv6Prefix
in: query
required: false
description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: NetworkInterfaceId
in: query
required: true
description: The ID of the network interface.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssignIpv6Addresses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssignIpv6Addresses
operationId: POST_AssignIpv6Addresses
description: 'Assigns one or more IPv6 addresses to the specified network interface. You can specify one or more specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from within the subnet''s IPv6 CIDR block range. You can assign as many IPv6 addresses to a network interface as you can assign private IPv4 addresses, and the limit varies per instance type. For information, see IP Addresses Per Network Interface Per Instance Type in the Amazon Elastic Compute Cloud User Guide.
You must specify either the IPv6 addresses or the IPv6 address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssignIpv6AddressesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssignIpv6AddressesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssignIpv6Addresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssignPrivateIpAddresses: get: x-aws-operation-name: AssignPrivateIpAddresses operationId: GET_AssignPrivateIpAddresses description: 'Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssignPrivateIpAddressesResult' parameters: - name: AllowReassignment in: query required: false description: 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. schema: type: boolean - name: NetworkInterfaceId in: query required: true description: The ID of the network interface. schema: type: string - name: PrivateIpAddress in: query required: false description: '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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: PrivateIpAddress - name: SecondaryPrivateIpAddressCount in: query required: false description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. schema: type: integer - name: Ipv4Prefix in: query required: false description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use theIpv4PrefixCount option.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Ipv4PrefixCount
in: query
required: false
description: 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.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssignPrivateIpAddresses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssignPrivateIpAddresses
operationId: POST_AssignPrivateIpAddresses
description: 'Assigns one or more secondary private IP addresses to the specified network interface.
You can specify one or more specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned within the subnet''s CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For information about instance types, see Instance Types in the Amazon Elastic Compute Cloud User Guide. For more information about Elastic IP addresses, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved.
Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check network/interfaces/macs/mac/local-ipv4s in the instance metadata to confirm that the remapping is complete.
You must specify either the IP addresses or the IP address count in the request.
You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssignPrivateIpAddressesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssignPrivateIpAddressesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssignPrivateIpAddresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssignPrivateNatGatewayAddress: get: x-aws-operation-name: AssignPrivateNatGatewayAddress operationId: GET_AssignPrivateNatGatewayAddress description: 'Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssignPrivateNatGatewayAddressResult' parameters: - name: NatGatewayId in: query required: true description: The ID of the NAT gateway. schema: type: string - name: PrivateIpAddress in: query required: false description: The private IPv4 addresses you want to assign to the private NAT gateway. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: PrivateIpAddressCount in: query required: false description: The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses. schema: type: integer minimum: 1 maximum: 31 - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssignPrivateNatGatewayAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssignPrivateNatGatewayAddress
operationId: POST_AssignPrivateNatGatewayAddress
description: 'Assigns one or more private IPv4 addresses to a private NAT gateway. For more information, see Work with NAT gateways in the Amazon VPC User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AssignPrivateNatGatewayAddressResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AssignPrivateNatGatewayAddressRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssignPrivateNatGatewayAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AssociateAddress:
get:
x-aws-operation-name: AssociateAddress
operationId: GET_AssociateAddress
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInterfaceId
in: query
required: false
description: '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.
' schema: type: string - name: PrivateIpAddress in: query required: false description: '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.' schema: type: string - name: Action in: query required: true schema: type: string enum: - AssociateAddress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: AssociateAddress operationId: POST_AssociateAddress description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint. schema: type: string - name: SubnetId in: query required: true description: The ID of the subnet to associate with the Client VPN endpoint. schema: type: string - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateClientVpnTargetNetwork
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateClientVpnTargetNetwork
operationId: POST_AssociateClientVpnTargetNetwork
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateClientVpnTargetNetworkRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateClientVpnTargetNetwork - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssociateDhcpOptions: get: x-aws-operation-name: AssociateDhcpOptions operationId: GET_AssociateDhcpOptions description: 'Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP options sets in the Amazon VPC User Guide.
' responses: '200': description: Success parameters: - name: DhcpOptionsId in: query required: true description: 'The ID of the DHCP options set, ordefault to associate no DHCP options with the VPC.'
schema:
type: string
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateDhcpOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateDhcpOptions
operationId: POST_AssociateDhcpOptions
description: 'Associates a set of DHCP options (that you''ve previously created) with the specified VPC, or associates no DHCP options with the VPC.
After you associate the options with the VPC, any existing instances and all new instances that you launch in that VPC use the options. You don''t need to restart or relaunch the instances. They automatically pick up the changes within a few hours, depending on how frequently the instance renews its DHCP lease. You can explicitly renew the lease using the operating system on the instance.
For more information, see DHCP options sets in the Amazon VPC User Guide.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateDhcpOptionsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateDhcpOptions - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssociateEnclaveCertificateIamRole: get: x-aws-operation-name: AssociateEnclaveCertificateIamRole operationId: GET_AssociateEnclaveCertificateIamRole description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateEnclaveCertificateIamRole
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateEnclaveCertificateIamRole
operationId: POST_AssociateEnclaveCertificateIamRole
description: '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 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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateInstanceEventWindowResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceEventWindowId
in: query
required: true
description: The ID of the event window.
schema:
type: string
- name: AssociationTarget
in: query
required: true
description: One or more targets associated with the specified event window.
schema:
type: object
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdList'
- xml:
name: InstanceId
description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.'
InstanceTags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: InstanceTag
description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.
DedicatedHostIds:
allOf:
- $ref: '#/components/schemas/DedicatedHostIdList'
- xml:
name: DedicatedHostId
description: The IDs of the Dedicated Hosts to associate with the event window.
description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.'
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateInstanceEventWindow
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateInstanceEventWindow
operationId: POST_AssociateInstanceEventWindow
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateInstanceEventWindowResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateInstanceEventWindowRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateInstanceEventWindow - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssociateIpamResourceDiscovery: get: x-aws-operation-name: AssociateIpamResourceDiscovery operationId: GET_AssociateIpamResourceDiscovery description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateIpamResourceDiscoveryResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamId
in: query
required: true
description: An IPAM ID.
schema:
type: string
- name: IpamResourceDiscoveryId
in: query
required: true
description: A resource discovery ID.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: Tag specifications.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: A client token.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateIpamResourceDiscovery
operationId: POST_AssociateIpamResourceDiscovery
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateIpamResourceDiscoveryResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateIpamResourceDiscoveryRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AssociateNatGatewayAddress:
get:
x-aws-operation-name: AssociateNatGatewayAddress
operationId: GET_AssociateNatGatewayAddress
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateNatGatewayAddressResult' parameters: - name: NatGatewayId in: query required: true description: The ID of the NAT gateway. schema: type: string - name: AllocationId in: query required: true description: The allocation IDs of EIPs that you want to associate with your NAT gateway. schema: type: array items: allOf: - $ref: '#/components/schemas/AllocationId' - xml: name: AllocationId - name: PrivateIpAddress in: query required: false description: The private IPv4 addresses that you want to assign to the NAT gateway. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateNatGatewayAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateNatGatewayAddress
operationId: POST_AssociateNatGatewayAddress
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateNatGatewayAddressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateNatGatewayAddressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateNatGatewayAddress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssociateRouteTable: get: x-aws-operation-name: AssociateRouteTable operationId: GET_AssociateRouteTable description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateRouteTableResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: RouteTableId
in: query
required: true
description: The ID of the route table.
schema:
type: string
- name: SubnetId
in: query
required: false
description: The ID of the subnet.
schema:
type: string
- name: GatewayId
in: query
required: false
description: The ID of the internet gateway or virtual private gateway.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateRouteTable
operationId: POST_AssociateRouteTable
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateRouteTableResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateRouteTableRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateRouteTable - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssociateSubnetCidrBlock: get: x-aws-operation-name: AssociateSubnetCidrBlock operationId: GET_AssociateSubnetCidrBlock description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' parameters: - name: Ipv6CidrBlock in: query required: true description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. schema: type: string - name: SubnetId in: query required: true description: The ID of your subnet. schema: type: string - name: Action in: query required: true schema: type: string enum: - AssociateSubnetCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: AssociateSubnetCidrBlock operationId: POST_AssociateSubnetCidrBlock description: Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. An IPv6 CIDR block must have a prefix length of /64. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateSubnetCidrBlockResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateSubnetCidrBlockRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateSubnetCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssociateTransitGatewayMulticastDomain: get: x-aws-operation-name: AssociateTransitGatewayMulticastDomain operationId: GET_AssociateTransitGatewayMulticastDomain description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' parameters: - name: TransitGatewayMulticastDomainId in: query required: true description: The ID of the transit gateway multicast domain. schema: type: string - name: TransitGatewayAttachmentId in: query required: true description: The ID of the transit gateway attachment to associate with the transit gateway multicast domain. schema: type: string - name: SubnetIds in: query required: true description: The IDs of the subnets to associate with the transit gateway multicast domain. schema: type: array items: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateTransitGatewayMulticastDomain
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateTransitGatewayMulticastDomain
operationId: POST_AssociateTransitGatewayMulticastDomain
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateTransitGatewayMulticastDomainRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateTransitGatewayMulticastDomain - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AssociateTransitGatewayPolicyTable: get: x-aws-operation-name: AssociateTransitGatewayPolicyTable operationId: GET_AssociateTransitGatewayPolicyTable description: Associates the specified transit gateway attachment with a transit gateway policy table. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateTransitGatewayPolicyTableResult' parameters: - name: TransitGatewayPolicyTableId in: query required: true description: The ID of the transit gateway policy table to associate with the transit gateway attachment. schema: type: string - name: TransitGatewayAttachmentId in: query required: true description: The ID of the transit gateway attachment to associate with the policy table. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateTransitGatewayPolicyTable
operationId: POST_AssociateTransitGatewayPolicyTable
description: Associates the specified transit gateway attachment with a transit gateway policy table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateTransitGatewayPolicyTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateTransitGatewayPolicyTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AssociateTransitGatewayRouteTable:
get:
x-aws-operation-name: AssociateTransitGatewayRouteTable
operationId: GET_AssociateTransitGatewayRouteTable
description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateTransitGatewayRouteTable
operationId: POST_AssociateTransitGatewayRouteTable
description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AssociateTransitGatewayRouteTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AssociateTrunkInterface:
get:
x-aws-operation-name: AssociateTrunkInterface
operationId: GET_AssociateTrunkInterface
description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Associates a branch network interface with a trunk network interface.
Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AssociateTrunkInterface
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AssociateTrunkInterface
operationId: POST_AssociateTrunkInterface
description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Associates a branch network interface with a trunk network interface.
Before you create the association, run the create-network-interface command and set --interface-type to trunk. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface.
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateVpcCidrBlockResult' parameters: - name: AmazonProvidedIpv6CidrBlock in: query required: false description: '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.' schema: type: boolean - name: CidrBlock in: query required: false description: An IPv4 CIDR block to associate with the VPC. schema: type: string - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: Ipv6CidrBlockNetworkBorderGroup in: query required: false description: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.
schema: type: string - name: Ipv6Pool in: query required: false description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. schema: type: string - name: Ipv6CidrBlock in: query required: false description: '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.
' schema: type: string - name: Ipv4IpamPoolId in: query required: false description: '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.' schema: type: string - name: Ipv4NetmaskLength in: query required: false description: '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. ' schema: type: integer - name: Ipv6IpamPoolId in: query required: false description: '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.' schema: type: string - name: Ipv6NetmaskLength in: query required: false description: '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. ' schema: type: integer - name: Action in: query required: true schema: type: string enum: - AssociateVpcCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: AssociateVpcCidrBlock operationId: POST_AssociateVpcCidrBlock description: '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). The IPv6 CIDR block size is fixed at /56.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AssociateVpcCidrBlockResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AssociateVpcCidrBlockRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AssociateVpcCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AttachClassicLinkVpc: get: x-aws-operation-name: AttachClassicLinkVpc operationId: GET_AttachClassicLinkVpc description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachClassicLinkVpcResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SecurityGroupId
in: query
required: true
description: The IDs of the security groups. You cannot specify security groups from a different VPC.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: groupId
- name: InstanceId
in: query
required: true
description: The ID of the EC2-Classic instance.
schema:
type: string
- name: VpcId
in: query
required: true
description: The ID of the ClassicLink-enabled VPC.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AttachClassicLinkVpc
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AttachClassicLinkVpc
operationId: POST_AttachClassicLinkVpc
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachClassicLinkVpcResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AttachClassicLinkVpcRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AttachClassicLinkVpc - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AttachInternetGateway: get: x-aws-operation-name: AttachInternetGateway operationId: GET_AttachInternetGateway description: '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.' responses: '200': description: Success parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InternetGatewayId
in: query
required: true
description: The ID of the internet gateway.
schema:
type: string
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AttachInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AttachInternetGateway
operationId: POST_AttachInternetGateway
description: '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.'
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AttachInternetGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AttachInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AttachNetworkInterface:
get:
x-aws-operation-name: AttachNetworkInterface
operationId: GET_AttachNetworkInterface
description: Attaches a network interface to an instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AttachNetworkInterfaceResult'
parameters:
- name: DeviceIndex
in: query
required: true
description: The index of the device for the network interface attachment.
schema:
type: integer
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: NetworkInterfaceId
in: query
required: true
description: The ID of the network interface.
schema:
type: string
- name: NetworkCardIndex
in: query
required: false
description: 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.
schema:
type: integer
- name: EnaSrdSpecification
in: query
required: false
description: Configures ENA Express for the network interface that this action attaches to the instance.
schema:
type: object
properties:
EnaSrdEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether ENA Express is enabled for the network interface.
EnaSrdUdpSpecification:
allOf:
- $ref: '#/components/schemas/EnaSrdUdpSpecification'
- description: Configures ENA Express for UDP network traffic.
description: '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.
' - name: Action in: query required: true schema: type: string enum: - AttachNetworkInterface - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: AttachNetworkInterface operationId: POST_AttachNetworkInterface description: Attaches a network interface to an instance. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachNetworkInterfaceResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AttachNetworkInterfaceRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AttachNetworkInterface - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AttachVerifiedAccessTrustProvider: get: x-aws-operation-name: AttachVerifiedAccessTrustProvider operationId: GET_AttachVerifiedAccessTrustProvider description: Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachVerifiedAccessTrustProviderResult' parameters: - name: VerifiedAccessInstanceId in: query required: true description: The ID of the Verified Access instance. schema: type: string - name: VerifiedAccessTrustProviderId in: query required: true description: The ID of the Verified Access trust provider. schema: type: string - name: ClientToken in: query required: false description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AttachVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AttachVerifiedAccessTrustProvider
operationId: POST_AttachVerifiedAccessTrustProvider
description: Attaches the specified Amazon Web Services Verified Access trust provider to the specified Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AttachVerifiedAccessTrustProviderResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AttachVerifiedAccessTrustProviderRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AttachVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AttachVolume:
get:
x-aws-operation-name: AttachVolume
operationId: GET_AttachVolume
description: '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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/VolumeAttachment' parameters: - name: Device in: query required: true description: 'The device name (for example,/dev/sdh or xvdh).'
schema:
type: string
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: VolumeId
in: query
required: true
description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AttachVolume
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AttachVolume
operationId: POST_AttachVolume
description: '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 Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/VolumeAttachment' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AttachVolumeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AttachVolume - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AttachVpnGateway: get: x-aws-operation-name: AttachVpnGateway operationId: GET_AttachVpnGateway description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachVpnGatewayResult' parameters: - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: VpnGatewayId in: query required: true description: The ID of the virtual private gateway. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AttachVpnGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AttachVpnGateway
operationId: POST_AttachVpnGateway
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AttachVpnGatewayResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AttachVpnGatewayRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AttachVpnGateway - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AuthorizeClientVpnIngress: get: x-aws-operation-name: AuthorizeClientVpnIngress operationId: GET_AuthorizeClientVpnIngress description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AuthorizeClientVpnIngressResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint. schema: type: string - name: TargetNetworkCidr in: query required: true description: 'The IPv4 address range, in CIDR notation, of the network for which access is being authorized.' schema: type: string - name: AccessGroupId in: query required: false description: 'The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required ifAuthorizeAllGroups is false or not specified.'
schema:
type: string
- name: AuthorizeAllGroups
in: query
required: false
description: 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.
schema:
type: boolean
- name: Description
in: query
required: false
description: A brief description of the authorization rule.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- AuthorizeClientVpnIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AuthorizeClientVpnIngress
operationId: POST_AuthorizeClientVpnIngress
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/AuthorizeClientVpnIngressResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/AuthorizeClientVpnIngressRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- AuthorizeClientVpnIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=AuthorizeSecurityGroupEgress:
get:
x-aws-operation-name: AuthorizeSecurityGroupEgress
operationId: GET_AuthorizeSecurityGroupEgress
description: 'Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups. When specifying an outbound rule for your security group in a VPC, the IpPermissions must include a destination for the traffic.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupId
in: query
required: true
description: The ID of the security group.
schema:
type: string
- name: IpPermissions
in: query
required: false
description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpPermission'
- xml:
name: item
- name: TagSpecification
in: query
required: false
description: The tags applied to the security group rule.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: CidrIp
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the CIDR.
schema:
type: string
- name: FromPort
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the port.
schema:
type: integer
- name: IpProtocol
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
schema:
type: string
- name: ToPort
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the port.
schema:
type: integer
- name: SourceSecurityGroupName
in: query
required: false
description: Not supported. Use a set of IP permissions to specify a destination security group.
schema:
type: string
- name: SourceSecurityGroupOwnerId
in: query
required: false
description: Not supported. Use a set of IP permissions to specify a destination security group.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- AuthorizeSecurityGroupEgress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AuthorizeSecurityGroupEgress
operationId: POST_AuthorizeSecurityGroupEgress
description: 'Adds the specified outbound (egress) rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 CIDR address ranges, or to the instances that are associated with the specified source security groups. When specifying an outbound rule for your security group in a VPC, the IpPermissions must include a destination for the traffic.
You specify a protocol for each rule (for example, TCP). For the TCP and UDP protocols, you must also specify the destination port or port range. For the ICMP protocol, you must also specify the ICMP type and code. You can use -1 for the type or code to mean all types or all codes.
Rule changes are propagated to affected instances as quickly as possible. However, a small delay might occur.
For information about VPC security group quotas, see Amazon VPC quotas.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AuthorizeSecurityGroupEgressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AuthorizeSecurityGroupEgressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AuthorizeSecurityGroupEgress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=AuthorizeSecurityGroupIngress: get: x-aws-operation-name: AuthorizeSecurityGroupIngress operationId: GET_AuthorizeSecurityGroupIngress description: 'Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups. When specifying an inbound rule for your security group in a VPC, the IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' parameters: - name: CidrIp in: query required: false description: 'The IPv4 address range, in CIDR format. You can''t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' schema: type: string - name: FromPort in: query required: false description: 'If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types. If you specify all ICMP types, you must specify all ICMP codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' schema: type: integer - name: GroupId in: query required: false description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' schema: type: string - name: GroupName in: query required: false description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' schema: type: string - name: IpPermissions in: query required: false description: The sets of IP permissions. schema: type: array items: allOf: - $ref: '#/components/schemas/IpPermission' - xml: name: item - name: IpProtocol in: query required: false description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' schema: type: string - name: SourceSecurityGroupName in: query required: false description: '[Default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. The source security group must be in the same VPC.' schema: type: string - name: SourceSecurityGroupOwnerId in: query required: false description: '[Nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.' schema: type: string - name: ToPort in: query required: false description: 'If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes. If you specify all ICMP types, you must specify all ICMP codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' schema: type: integer - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: '[VPC Only] The tags applied to the security group rule.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- AuthorizeSecurityGroupIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: AuthorizeSecurityGroupIngress
operationId: POST_AuthorizeSecurityGroupIngress
description: 'Adds the specified inbound (ingress) rules to a security group.
An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 CIDR address range, or from the instances that are associated with the specified destination security groups. When specifying an inbound rule for your security group in a VPC, the IpPermissions must include a source for the traffic.
You specify a protocol for each rule (for example, TCP). For TCP and UDP, you must also specify the destination port or port range. For ICMP/ICMPv6, you must also specify the ICMP/ICMPv6 type and code. You can use -1 to mean all types or all codes.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
For more information about VPC security group quotas, see Amazon VPC quotas.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/AuthorizeSecurityGroupIngressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/AuthorizeSecurityGroupIngressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - AuthorizeSecurityGroupIngress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=BundleInstance: get: x-aws-operation-name: BundleInstance operationId: GET_BundleInstance description: '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.
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
' schema: type: string - name: Storage in: query required: true description: '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.' schema: type: object properties: S3: allOf: - $ref: '#/components/schemas/S3Storage' - description: An Amazon S3 storage location. description: Describes the storage location for an instance store-backed AMI. - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- BundleInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: BundleInstance
operationId: POST_BundleInstance
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelBundleTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelBundleTask
operationId: POST_CancelBundleTask
description: Cancels a bundling operation for an instance store-backed Windows instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelBundleTaskResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelBundleTaskRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelBundleTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CancelCapacityReservation:
get:
x-aws-operation-name: CancelCapacityReservation
operationId: GET_CancelCapacityReservation
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CancelCapacityReservationResult' parameters: - name: CapacityReservationId in: query required: true description: The ID of the Capacity Reservation to be cancelled. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelCapacityReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelCapacityReservation
operationId: POST_CancelCapacityReservation
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CancelCapacityReservationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CancelCapacityReservationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CancelCapacityReservation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CancelCapacityReservationFleets: get: x-aws-operation-name: CancelCapacityReservationFleets operationId: GET_CancelCapacityReservationFleets description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: CapacityReservationFleetId
in: query
required: true
description: The IDs of the Capacity Reservation Fleets to cancel.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelCapacityReservationFleets
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelCapacityReservationFleets
operationId: POST_CancelCapacityReservationFleets
description: '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.
' responses: '200': description: Success parameters: - name: ConversionTaskId in: query required: true description: The ID of the conversion task. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ReasonMessage
in: query
required: false
description: The reason for canceling the conversion task.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelConversionTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelConversionTask
operationId: POST_CancelConversionTask
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/CancelConversionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CancelConversionTask - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CancelExportTask: get: x-aws-operation-name: CancelExportTask operationId: GET_CancelExportTask description: '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.' responses: '200': description: Success parameters: - name: ExportTaskId in: query required: true description: The ID of the export task. This is the ID returned byCreateInstanceExportTask.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelExportTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelExportTask
operationId: POST_CancelExportTask
description: '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.'
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelExportTaskRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelExportTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CancelImageLaunchPermission:
get:
x-aws-operation-name: CancelImageLaunchPermission
operationId: GET_CancelImageLaunchPermission
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelImageLaunchPermissionResult'
parameters:
- name: ImageId
in: query
required: true
description: The ID of the AMI that was shared with your Amazon Web Services account.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelImageLaunchPermission
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelImageLaunchPermission
operationId: POST_CancelImageLaunchPermission
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelImageLaunchPermissionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelImageLaunchPermissionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelImageLaunchPermission
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CancelImportTask:
get:
x-aws-operation-name: CancelImportTask
operationId: GET_CancelImportTask
description: Cancels an in-process import virtual machine or import snapshot task.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelImportTaskResult'
parameters:
- name: CancelReason
in: query
required: false
description: The reason for canceling the task.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ImportTaskId
in: query
required: false
description: The ID of the import image or import snapshot task to be canceled.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelImportTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelImportTask
operationId: POST_CancelImportTask
description: Cancels an in-process import virtual machine or import snapshot task.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelImportTaskResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CancelImportTaskRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelImportTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CancelReservedInstancesListing:
get:
x-aws-operation-name: CancelReservedInstancesListing
operationId: GET_CancelReservedInstancesListing
description: 'Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CancelReservedInstancesListingResult' parameters: - name: ReservedInstancesListingId in: query required: true description: The ID of the Reserved Instance listing. schema: type: string - name: Action in: query required: true schema: type: string enum: - CancelReservedInstancesListing - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CancelReservedInstancesListing operationId: POST_CancelReservedInstancesListing description: 'Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CancelReservedInstancesListingResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CancelReservedInstancesListingRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CancelReservedInstancesListing - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CancelSpotFleetRequests: get: x-aws-operation-name: CancelSpotFleetRequests operationId: GET_CancelSpotFleetRequests description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SpotFleetRequestId
in: query
required: true
description: The IDs of the Spot Fleet requests.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestId'
- xml:
name: item
- name: TerminateInstances
in: query
required: true
description: '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.
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.
Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SpotInstanceRequestId
in: query
required: true
description: The IDs of the Spot Instance requests.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotInstanceRequestId'
- xml:
name: SpotInstanceRequestId
- name: Action
in: query
required: true
schema:
type: string
enum:
- CancelSpotInstanceRequests
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CancelSpotInstanceRequests
operationId: POST_CancelSpotInstanceRequests
description: Cancels one or more Spot Instance requests.
Canceling a Spot Instance request does not terminate running Spot Instances associated with the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ConfirmProductInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ConfirmProductInstance
operationId: POST_ConfirmProductInstance
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ConfirmProductInstanceResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ConfirmProductInstanceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ConfirmProductInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CopyFpgaImage:
get:
x-aws-operation-name: CopyFpgaImage
operationId: GET_CopyFpgaImage
description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CopyFpgaImageResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SourceFpgaImageId
in: query
required: true
description: The ID of the source AFI.
schema:
type: string
- name: Description
in: query
required: false
description: The description for the new AFI.
schema:
type: string
- name: Name
in: query
required: false
description: The name for the new AFI. The default is the name of the source AFI.
schema:
type: string
- name: SourceRegion
in: query
required: true
description: The Region that contains the source AFI.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CopyFpgaImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CopyFpgaImage
operationId: POST_CopyFpgaImage
description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CopyFpgaImageResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CopyFpgaImageRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CopyFpgaImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CopyImage:
get:
x-aws-operation-name: CopyImage
operationId: GET_CopyImage
description: 'Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CopyImageResult' parameters: - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.' schema: type: string - name: Description in: query required: false description: A description for the new AMI in the destination Region. schema: type: string - name: Encrypted in: query required: false description: '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 usingKmsKeyId. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.'
schema:
type: boolean
- name: KmsKeyId
in: query
required: false
description: '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.
' schema: type: string - name: Name in: query required: true description: The name of the new AMI in the destination Region. schema: type: string - name: SourceImageId in: query required: true description: The ID of the AMI to copy. schema: type: string - name: SourceRegion in: query required: true description: The name of the Region that contains the AMI to copy. schema: type: string - name: DestinationOutpostArn in: query required: false description: '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 EC2 User Guide.
' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: CopyImageTags
in: query
required: false
description: '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.
' schema: type: boolean - name: Action in: query required: true schema: type: string enum: - CopyImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CopyImage operationId: POST_CopyImage description: 'Initiates the copy of an AMI. You can copy an AMI from one Region to another, or from a Region to an Outpost. You can''t copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. To copy an AMI to another partition, see CreateStoreImageTask.
To copy an AMI from one Region to another, specify the source Region using the SourceRegion parameter, and specify the destination Region using its endpoint. Copies of encrypted backing snapshots for the AMI are encrypted. Copies of unencrypted backing snapshots remain unencrypted, unless you set Encrypted during the copy operation. You cannot create an unencrypted copy of an encrypted backing snapshot.
To copy an AMI from a Region to an Outpost, specify the source Region using the SourceRegion parameter, and specify the ARN of the destination Outpost using DestinationOutpostArn. Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
For more information about the prerequisites and limits when copying an AMI, see Copy an AMI in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CopyImageResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CopyImageRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CopyImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CopySnapshot: get: x-aws-operation-name: CopySnapshot operationId: GET_CopySnapshot description: 'Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CopySnapshotResult' parameters: - name: Description in: query required: false description: A description for the EBS snapshot. schema: type: string - name: DestinationOutpostArn in: query required: false description: '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 Elastic Compute Cloud User Guide.
' schema: type: string - name: DestinationRegion in: query required: false description: '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.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' schema: type: string - name: PresignedUrl in: query required: false description: 'When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CopySnapshot
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CopySnapshot
operationId: POST_CopySnapshot
description: 'Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy a snapshot within the same Region, from one Region to another, or from a Region to an Outpost. You can''t copy a snapshot from an Outpost to a Region, from one Outpost to another, or within the same Outpost.
You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs).
When copying snapshots to a Region, copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless you enable encryption for the snapshot copy operation. By default, encrypted snapshot copies use the default Key Management Service (KMS) KMS key; however, you can specify a different KMS key. To copy an encrypted snapshot that has been shared from another account, you must have permissions for the KMS key used to encrypt the snapshot.
Snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region, or a different key that you specify in the request using KmsKeyId. Outposts do not support unencrypted snapshots. For more information, Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CopySnapshotResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CopySnapshotRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CopySnapshot - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateCapacityReservation: get: x-aws-operation-name: CreateCapacityReservation operationId: GET_CreateCapacityReservation description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateCapacityReservationResult' parameters: - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' schema: type: string - name: InstanceType in: query required: true description: 'The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.' schema: type: string - name: InstancePlatform in: query required: true description: The type of operating system for which to reserve capacity. schema: 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 - name: AvailabilityZone in: query required: false description: The Availability Zone in which to create the Capacity Reservation. schema: type: string - name: AvailabilityZoneId in: query required: false description: The ID of the Availability Zone in which to create the Capacity Reservation. schema: type: string - name: Tenancy in: query required: false description: '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
' schema: type: integer - name: EbsOptimized in: query required: false description: 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. schema: type: boolean - name: EphemeralStorage in: query required: false description: ' Deprecated. ' schema: type: boolean - name: EndDate in: query required: false description: '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
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: OutpostArn
in: query
required: false
description: The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
schema:
type: string
pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$'
- name: PlacementGroupArn
in: query
required: false
description: '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.'
schema:
type: string
pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/^.{1,255}$'
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCapacityReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateCapacityReservation
operationId: POST_CreateCapacityReservation
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateCapacityReservationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateCapacityReservationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateCapacityReservation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateCapacityReservationFleet: get: x-aws-operation-name: CreateCapacityReservationFleet operationId: GET_CreateCapacityReservationFleet description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateCapacityReservationFleetResult' parameters: - name: AllocationStrategy in: query required: false description: '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
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 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCapacityReservationFleet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateCapacityReservationFleet
operationId: POST_CreateCapacityReservationFleet
description: 'Creates a Capacity Reservation Fleet. For more information, see Create a Capacity Reservation Fleet in the Amazon EC2 User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCapacityReservationFleetResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCapacityReservationFleetRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCapacityReservationFleet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateCarrierGateway:
get:
x-aws-operation-name: CreateCarrierGateway
operationId: GET_CreateCarrierGateway
description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCarrierGatewayResult'
parameters:
- name: VpcId
in: query
required: true
description: The ID of the VPC to associate with the carrier gateway.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to associate with the carrier gateway.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCarrierGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateCarrierGateway
operationId: POST_CreateCarrierGateway
description: 'Creates a carrier gateway. For more information about carrier gateways, see Carrier gateways in the Amazon Web Services Wavelength Developer Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCarrierGatewayResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCarrierGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCarrierGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateClientVpnEndpoint:
get:
x-aws-operation-name: CreateClientVpnEndpoint
operationId: GET_CreateClientVpnEndpoint
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateClientVpnEndpointResult'
parameters:
- name: ClientCidrBlock
in: query
required: true
description: '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.'
schema:
type: string
- name: ServerCertificateArn
in: query
required: true
description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.'
schema:
type: string
- name: Authentication
in: query
required: true
description: Information about the authentication method to be used to authenticate clients.
schema:
type: array
items:
$ref: '#/components/schemas/ClientVpnAuthenticationRequest'
- name: ConnectionLogOptions
in: query
required: true
description: '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
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
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.
' schema: type: boolean - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to apply to the Client VPN endpoint during creation.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: SecurityGroupId
in: query
required: false
description: 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.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
- name: VpcId
in: query
required: false
description: '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.'
schema:
type: string
- name: SelfServicePortal
in: query
required: false
description: 'Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
false (not enabled).
LambdaFunctionArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
description: The options for managing connection authorization for new client connections.
- name: SessionTimeoutHours
in: query
required: false
description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
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
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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateClientVpnRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateClientVpnRoute
operationId: POST_CreateClientVpnRoute
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateClientVpnRouteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateClientVpnRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateClientVpnRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateCoipCidr:
get:
x-aws-operation-name: CreateCoipCidr
operationId: GET_CreateCoipCidr
description: ' Creates a range of customer-owned IP addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCoipCidrResult'
parameters:
- name: Cidr
in: query
required: true
description: ' A customer-owned IP address range to create. '
schema:
type: string
- name: CoipPoolId
in: query
required: true
description: ' The ID of the address pool. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateCoipCidr
operationId: POST_CreateCoipCidr
description: ' Creates a range of customer-owned IP addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCoipCidrResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCoipCidrRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateCoipPool:
get:
x-aws-operation-name: CreateCoipPool
operationId: GET_CreateCoipPool
description: ' Creates a pool of customer-owned IP (CoIP) addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCoipPoolResult'
parameters:
- name: LocalGatewayRouteTableId
in: query
required: true
description: ' The ID of the local gateway route table. '
schema:
type: string
- name: TagSpecification
in: query
required: false
description: ' The tags to assign to the CoIP address pool. '
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCoipPool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateCoipPool
operationId: POST_CreateCoipPool
description: ' Creates a pool of customer-owned IP (CoIP) addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCoipPoolResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateCoipPoolRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCoipPool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateCustomerGateway:
get:
x-aws-operation-name: CreateCustomerGateway
operationId: GET_CreateCustomerGateway
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateCustomerGatewayResult' parameters: - name: BgpAsn in: query required: false description: 'For devices that support BGP, the customer gateway''s BGP ASN.
Default: 65000
' schema: type: integer - name: PublicIp in: query required: false description: ' This member has been deprecated. The Internet-routable IP address for the customer gateway''s outside interface. The address must be static.' schema: type: string - name: CertificateArn in: query required: false description: The Amazon Resource Name (ARN) for the customer gateway certificate. schema: type: string - name: Type in: query required: true description: The type of VPN connection that this customer gateway supports (ipsec.1).
schema:
type: string
enum:
- ipsec.1
- name: TagSpecification
in: query
required: false
description: The tags to apply to the customer gateway.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DeviceName
in: query
required: false
description: 'A name for the customer gateway device.
Length Constraints: Up to 255 characters.
' schema: type: string - name: IpAddress in: query required: false description: ' IPv4 address for the customer gateway device''s outside interface. The address must be static. ' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateCustomerGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateCustomerGateway
operationId: POST_CreateCustomerGateway
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateCustomerGatewayResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateCustomerGatewayRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateCustomerGateway - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateDefaultSubnet: get: x-aws-operation-name: CreateDefaultSubnet operationId: GET_CreateDefaultSubnet description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateDefaultSubnetResult'
parameters:
- name: AvailabilityZone
in: query
required: true
description: The Availability Zone in which to create the default subnet.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Ipv6Native
in: query
required: false
description: '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.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDefaultSubnet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateDefaultSubnet
operationId: POST_CreateDefaultSubnet
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateDefaultSubnetResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateDefaultSubnetRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDefaultSubnet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateDefaultVpc:
get:
x-aws-operation-name: CreateDefaultVpc
operationId: GET_CreateDefaultVpc
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateDefaultVpcResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDefaultVpc
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateDefaultVpc
operationId: POST_CreateDefaultVpc
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateDefaultVpcResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateDefaultVpcRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateDefaultVpc - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateDhcpOptions: get: x-aws-operation-name: CreateDhcpOptions operationId: GET_CreateDhcpOptions description: 'Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: 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 options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
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 currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon VPC User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateDhcpOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateDhcpOptions
operationId: POST_CreateDhcpOptions
description: 'Creates a set of DHCP options for your VPC. After creating the set, you must associate it with the VPC, causing all existing and new instances that you launch in the VPC to use this set of DHCP options. The following are the individual DHCP options you can specify. For more information about the options, see RFC 2132.
domain-name-servers - The IP addresses of up to four domain name servers, or AmazonProvidedDNS. The default DHCP option set specifies AmazonProvidedDNS. If specifying more than one domain name server, specify the IP addresses in a single parameter, separated by commas. To have your instance receive a custom DNS hostname as specified in domain-name, you must set domain-name-servers to a custom DNS server.
domain-name - If you''re using AmazonProvidedDNS in us-east-1, specify ec2.internal. If you''re using AmazonProvidedDNS in another Region, specify region.compute.internal (for example, ap-northeast-1.compute.internal). Otherwise, specify a domain name (for example, ExampleCompany.com). This value is used to complete unqualified DNS hostnames. Important: 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 options set is associated with a VPC that has instances with multiple operating systems, specify only one domain name.
ntp-servers - The IP addresses of up to four Network Time Protocol (NTP) servers.
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 currently supported). For more information about these node types, see RFC 2132.
Your VPC automatically starts out with a set of DHCP options that includes only a DNS server that we provide (AmazonProvidedDNS). If you create a set of options, and if your VPC has an internet gateway, make sure to set the domain-name-servers option either to AmazonProvidedDNS or to a domain name server of your choice. For more information, see DHCP options sets in the Amazon VPC User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcId
in: query
required: true
description: The ID of the VPC for which to create the egress-only internet gateway.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the egress-only internet gateway.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateEgressOnlyInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateEgressOnlyInternetGateway
operationId: POST_CreateEgressOnlyInternetGateway
description: '[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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateEgressOnlyInternetGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateEgressOnlyInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateFleet:
get:
x-aws-operation-name: CreateFleet
operationId: GET_CreateFleet
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateFleetResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
schema:
type: string
- name: SpotOptions
in: query
required: false
description: Describes the configuration of Spot Instances in an EC2 Fleet.
schema:
type: object
properties:
AllocationStrategy:
allOf:
- $ref: '#/components/schemas/SpotAllocationStrategy'
- description: 'The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn''t have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowest-price
The behavior when a Spot Instance is interrupted.
Default: terminate
The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' SingleInstanceType: allOf: - $ref: '#/components/schemas/Boolean' - description:Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
The maximum amount per hour for Spot Instances that you''re willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
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.
DefaultTargetCapacityType.'
OnDemandTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of On-Demand units to request.
SpotTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of Spot units to request.
DefaultTargetCapacityType:
allOf:
- $ref: '#/components/schemas/DefaultTargetCapacityType'
- description: 'The default TotalTargetCapacity, which is either Spot or On-Demand.'
TargetCapacityUnitType:
allOf:
- $ref: '#/components/schemas/TargetCapacityUnitType'
- description: 'The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
The 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.
' schema: type: string enum: - request - maintain - instant - name: ValidFrom in: query required: false description: '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.' schema: type: string format: date-time - name: ValidUntil in: query required: false description: '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.' schema: type: string format: date-time - name: ReplaceUnhealthyInstances in: query required: false description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of typemaintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: 'The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging 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.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateFleetResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateFleetRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateFleet - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateFlowLogs: get: x-aws-operation-name: CreateFlowLogs operationId: GET_CreateFlowLogs description: 'Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateFlowLogsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: DeliverLogsPermissionArn
in: query
required: false
description: The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.
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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/FlowLogResourceId' - xml: name: item - name: ResourceType in: query required: true description: The type of resource to monitor. schema: type: string enum: - VPC - Subnet - NetworkInterface - TransitGateway - TransitGatewayAttachment - name: TrafficType in: query required: false description: '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.' schema: type: string enum: - ACCEPT - REJECT - ALL - name: LogDestinationType in: query required: false description: '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. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
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
' schema: type: integer - name: DestinationOptions in: query required: false description: The destination options. schema: type: object properties: FileFormat: allOf: - $ref: '#/components/schemas/DestinationFileFormat' - description: The format for the flow log. The default isplain-text.
HiveCompatiblePartitions:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is false.
PerHourPartition:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false.
description: Describes the destination options for a flow log.
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateFlowLogs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateFlowLogs
operationId: POST_CreateFlowLogs
description: 'Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC.
Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see Flow log records in the Amazon Virtual Private Cloud User Guide.
When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket.
For more information, see VPC Flow Logs in the Amazon Virtual Private Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateFlowLogsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateFlowLogsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateFlowLogs - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateFpgaImage: get: x-aws-operation-name: CreateFpgaImage operationId: GET_CreateFpgaImage description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateFpgaImageResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InputStorageLocation
in: query
required: true
description: The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
schema:
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the S3 bucket.
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: The key.
description: Describes a storage location in Amazon S3.
- name: LogsStorageLocation
in: query
required: false
description: The location in Amazon S3 for the output logs.
schema:
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the S3 bucket.
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: The key.
description: Describes a storage location in Amazon S3.
- name: Description
in: query
required: false
description: A description for the AFI.
schema:
type: string
- name: Name
in: query
required: false
description: A name for the AFI.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to apply to the FPGA image during creation.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateFpgaImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateFpgaImage
operationId: POST_CreateFpgaImage
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateFpgaImageResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateFpgaImageRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateFpgaImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateImage: get: x-aws-operation-name: CreateImage operationId: GET_CreateImage description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateImageResult' parameters: - name: BlockDeviceMapping in: query required: false description: 'The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.' schema: type: array items: allOf: - $ref: '#/components/schemas/BlockDeviceMapping' - xml: name: BlockDeviceMapping - name: Description in: query required: false description: A description for the new image. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: Name
in: query
required: true
description: 'A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' schema: type: string - name: NoReboot in: query required: false description: '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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: Action in: query required: true schema: type: string enum: - CreateImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateImage operationId: POST_CreateImage description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateImageResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateImageRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateInstanceConnectEndpoint: get: x-aws-operation-name: CreateInstanceConnectEndpoint operationId: GET_CreateInstanceConnectEndpoint description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceConnectEndpointResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SubnetId
in: query
required: true
description: The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
schema:
type: string
- name: SecurityGroupId
in: query
required: false
description: '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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: SecurityGroupId
minItems: 0
maxItems: 16
- name: PreserveClientIp
in: query
required: false
description: 'Indicates whether your client''s IP address is preserved as the source. The value is true or false.
If true, your client''s IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceConnectEndpointResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceConnectEndpointRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateInstanceConnectEndpoint - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateInstanceEventWindow: get: x-aws-operation-name: CreateInstanceEventWindow operationId: GET_CreateInstanceEventWindow description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceEventWindowResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Name
in: query
required: false
description: The name of the event window.
schema:
type: string
- name: TimeRange
in: query
required: false
description: 'The time range for the event window. If you specify a time range, you can''t specify a cron expression.'
schema:
type: array
items:
$ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
- name: CronExpression
in: query
required: false
description: '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.
' schema: type: string - name: TagSpecification in: query required: false description: The tags to apply to the event window. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: Action in: query required: true schema: type: string enum: - CreateInstanceEventWindow - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateInstanceEventWindow operationId: POST_CreateInstanceEventWindow description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceEventWindowResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceEventWindowRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateInstanceEventWindow - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateInstanceExportTask: get: x-aws-operation-name: CreateInstanceExportTask operationId: GET_CreateInstanceExportTask description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceExportTaskResult' parameters: - name: Description in: query required: false description: A description for the conversion task or the resource being exported. The maximum length is 255 characters. schema: type: string - name: ExportToS3 in: query required: true description: The format and location for an export instance task. schema: type: object properties: ContainerFormat: allOf: - $ref: '#/components/schemas/ContainerFormat' - xml: name: containerFormat description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' DiskImageFormat: allOf: - $ref: '#/components/schemas/DiskImageFormat' - xml: name: diskImageFormat description: The format for the exported image. S3Bucket: allOf: - $ref: '#/components/schemas/String' - xml: name: s3Bucket description: 'The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for theGrantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.'
S3Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: s3Prefix
description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
description: Describes an export instance task.
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: TargetEnvironment
in: query
required: true
description: The target virtualization environment.
schema:
type: string
enum:
- citrix
- vmware
- microsoft
- name: TagSpecification
in: query
required: false
description: The tags to apply to the export instance task during creation.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateInstanceExportTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateInstanceExportTask
operationId: POST_CreateInstanceExportTask
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceExportTaskResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateInstanceExportTaskRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateInstanceExportTask - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateInternetGateway: get: x-aws-operation-name: CreateInternetGateway operationId: GET_CreateInternetGateway description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInternetGatewayResult' parameters: - name: TagSpecification in: query required: false description: The tags to assign to the internet gateway. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateInternetGateway
operationId: POST_CreateInternetGateway
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateInternetGatewayResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateInternetGatewayRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateInternetGateway - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateIpam: get: x-aws-operation-name: CreateIpam operationId: GET_CreateIpam description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateIpamResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Description
in: query
required: false
description: A description for the IPAM.
schema:
type: string
- name: OperatingRegion
in: query
required: false
description: '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.
' schema: type: array items: $ref: '#/components/schemas/AddIpamOperatingRegion' minItems: 0 maxItems: 50 - name: TagSpecification in: query required: false description: '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 keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateIpam
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateIpam
operationId: POST_CreateIpam
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateIpamResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateIpamRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateIpam - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateIpamPool: get: x-aws-operation-name: CreateIpamPool operationId: GET_CreateIpamPool description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateIpamPoolResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamScopeId
in: query
required: true
description: The ID of the scope in which you would like to create the IPAM pool.
schema:
type: string
- name: Locale
in: query
required: false
description: 'In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM''s home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
' schema: type: string - name: SourceIpamPoolId in: query required: false description: 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. schema: type: string - name: Description in: query required: false description: A description for the IPAM pool. schema: type: string - name: AddressFamily in: query required: true description: The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool. schema: type: string enum: - ipv4 - ipv6 - name: AutoImport in: query required: false description: '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.
' schema: type: boolean - name: PubliclyAdvertisable in: query required: false description: Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set toipv4.
schema:
type: boolean
- name: AllocationMinNetmaskLength
in: query
required: false
description: 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.
schema:
type: integer
minimum: 0
maximum: 128
- name: AllocationMaxNetmaskLength
in: query
required: false
description: 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.
schema:
type: integer
minimum: 0
maximum: 128
- name: AllocationDefaultNetmaskLength
in: query
required: false
description: '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.'
schema:
type: integer
minimum: 0
maximum: 128
- name: AllocationResourceTag
in: query
required: false
description: '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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/RequestIpamResourceTag'
- xml:
name: item
- name: TagSpecification
in: query
required: false
description: '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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: AwsService
in: query
required: false
description: '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.'
schema:
type: string
enum:
- ec2
- name: PublicIpSource
in: query
required: false
description: '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.'
schema:
type: string
enum:
- amazon
- byoip
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateIpamPool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateIpamPool
operationId: POST_CreateIpamPool
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateIpamPoolResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateIpamPoolRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateIpamPool - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateIpamResourceDiscovery: get: x-aws-operation-name: CreateIpamResourceDiscovery operationId: GET_CreateIpamResourceDiscovery description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateIpamResourceDiscoveryResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Description
in: query
required: false
description: A description for the IPAM resource discovery.
schema:
type: string
- name: OperatingRegion
in: query
required: false
description: 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.
schema:
type: array
items:
$ref: '#/components/schemas/AddIpamOperatingRegion'
minItems: 0
maxItems: 50
- name: TagSpecification
in: query
required: false
description: Tag specifications for the IPAM resource discovery.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: A client token for the IPAM resource discovery.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateIpamResourceDiscovery
operationId: POST_CreateIpamResourceDiscovery
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateIpamResourceDiscoveryResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateIpamResourceDiscoveryRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateIpamScope:
get:
x-aws-operation-name: CreateIpamScope
operationId: GET_CreateIpamScope
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateIpamScopeResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamId
in: query
required: true
description: The ID of the IPAM for which you're creating this scope.
schema:
type: string
- name: Description
in: query
required: false
description: A description for the scope you're creating.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: '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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateIpamScope
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateIpamScope
operationId: POST_CreateIpamScope
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateIpamScopeResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateIpamScopeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateIpamScope - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateKeyPair: get: x-aws-operation-name: CreateKeyPair operationId: GET_CreateKeyPair description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/KeyPair' parameters: - name: KeyName in: query required: true description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: KeyType
in: query
required: false
description: 'The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The format of the key pair.
Default: pem
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/KeyPair' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateKeyPairRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateKeyPair - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateLaunchTemplate: get: x-aws-operation-name: CreateLaunchTemplate operationId: GET_CreateLaunchTemplate description: 'Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateLaunchTemplateResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
' schema: type: string - name: LaunchTemplateName in: query required: true description: A name for the launch template. schema: type: string pattern: '[a-zA-Z0-9\(\)\.\-/_]+' minLength: 3 maxLength: 128 - name: VersionDescription in: query required: false description: A description for the first version of the launch template. schema: type: string minLength: 0 maxLength: 255 - name: LaunchTemplateData in: query required: true description: The information for the launch template. schema: type: object properties: KernelId: allOf: - $ref: '#/components/schemas/KernelId' - description: 'The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameter
Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
' InstanceType: allOf: - $ref: '#/components/schemas/InstanceType' - description: 'The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
If you specify InstanceType, you can''t specify InstanceRequirements.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.'
InstanceInitiatedShutdownBehavior:
allOf:
- $ref: '#/components/schemas/ShutdownBehavior'
- description: 'Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' TagSpecifications: allOf: - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - xml: name: TagSpecification description: 'The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
To tag the launch template itself, you must use the TagSpecification parameter.
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
LicenseSpecifications:
allOf:
- $ref: '#/components/schemas/LaunchTemplateLicenseSpecificationListRequest'
- xml:
name: LicenseSpecification
description: The license configurations.
HibernationOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateHibernationOptionsRequest'
- description: 'Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.'
MetadataOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptionsRequest'
- description: 'The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.'
EnclaveOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateEnclaveOptionsRequest'
- description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
' InstanceRequirements: allOf: - $ref: '#/components/schemas/InstanceRequirementsRequest' - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can''t specify InstanceRequirements.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' PrivateDnsNameOptions: allOf: - $ref: '#/components/schemas/LaunchTemplatePrivateDnsNameOptionsRequest' - description: The options for the instance hostname. The default values are inherited from the subnet. MaintenanceOptions: allOf: - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest' - description: The maintenance options for the instance. DisableApiStop: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.' description:The information to include in the launch template.
You must specify at least one parameter for the launch template data.
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.
Creates a launch template.
A launch template contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify a launch template instead of providing the launch parameters in the request. For more information, see Launch an instance from a launch template in the Amazon Elastic Compute Cloud User Guide.
If you want to clone an existing launch template as the basis for creating a new launch template, you can use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see Create a launch template from an existing launch template in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateLaunchTemplateResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateLaunchTemplateRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateLaunchTemplate - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateLaunchTemplateVersion: get: x-aws-operation-name: CreateLaunchTemplateVersion operationId: GET_CreateLaunchTemplateVersion description: 'Creates a new version of a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot 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 any changes you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
' schema: type: string - name: LaunchTemplateId in: query required: false description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.'
schema:
type: string
- name: VersionDescription
in: query
required: false
description: A description for the version of the launch template.
schema:
type: string
minLength: 0
maxLength: 255
- name: LaunchTemplateData
in: query
required: true
description: The information for the launch template.
schema:
type: object
properties:
KernelId:
allOf:
- $ref: '#/components/schemas/KernelId'
- description: 'The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameter
Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
' InstanceType: allOf: - $ref: '#/components/schemas/InstanceType' - description: 'The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
If you specify InstanceType, you can''t specify InstanceRequirements.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.'
InstanceInitiatedShutdownBehavior:
allOf:
- $ref: '#/components/schemas/ShutdownBehavior'
- description: 'Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' TagSpecifications: allOf: - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - xml: name: TagSpecification description: 'The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
To tag the launch template itself, you must use the TagSpecification parameter.
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
LicenseSpecifications:
allOf:
- $ref: '#/components/schemas/LaunchTemplateLicenseSpecificationListRequest'
- xml:
name: LicenseSpecification
description: The license configurations.
HibernationOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateHibernationOptionsRequest'
- description: 'Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.'
MetadataOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptionsRequest'
- description: 'The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.'
EnclaveOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateEnclaveOptionsRequest'
- description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
' InstanceRequirements: allOf: - $ref: '#/components/schemas/InstanceRequirementsRequest' - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can''t specify InstanceRequirements.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' PrivateDnsNameOptions: allOf: - $ref: '#/components/schemas/LaunchTemplatePrivateDnsNameOptionsRequest' - description: The options for the instance hostname. The default values are inherited from the subnet. MaintenanceOptions: allOf: - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest' - description: The maintenance options for the instance. DisableApiStop: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.' description:The information to include in the launch template.
You must specify at least one parameter for the launch template data.
If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID is displayed in the response for imageID. For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default: false
Creates a new version of a launch template. You can specify an existing version of launch template from which to base the new version.
Launch template versions are numbered in the order in which they are created. You cannot 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 any changes you require.
For more information, see Modify a launch template (manage launch template versions) in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateLaunchTemplateVersionResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateLaunchTemplateVersionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateLaunchTemplateVersion - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateLocalGatewayRoute: get: x-aws-operation-name: CreateLocalGatewayRoute operationId: GET_CreateLocalGatewayRoute description: 'Creates a static route for the specified local gateway route table. You must specify one of the following targets:
LocalGatewayVirtualInterfaceGroupId
NetworkInterfaceId
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInterfaceId
in: query
required: false
description: The ID of the network interface.
schema:
type: string
- name: DestinationPrefixListId
in: query
required: false
description: ' The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request. '
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLocalGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateLocalGatewayRoute
operationId: POST_CreateLocalGatewayRoute
description: 'Creates a static route for the specified local gateway route table. You must specify one of the following targets:
LocalGatewayVirtualInterfaceGroupId
NetworkInterfaceId
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLocalGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateLocalGatewayRouteTable
operationId: POST_CreateLocalGatewayRouteTable
description: ' Creates a local gateway route table. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLocalGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation:
get:
x-aws-operation-name: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
operationId: GET_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
description: ' Creates a local gateway route table virtual interface group association. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult'
parameters:
- name: LocalGatewayRouteTableId
in: query
required: true
description: ' The ID of the local gateway route table. '
schema:
type: string
- name: LocalGatewayVirtualInterfaceGroupId
in: query
required: true
description: ' The ID of the local gateway route table virtual interface group association. '
schema:
type: string
- name: TagSpecification
in: query
required: false
description: ' The tags assigned to the local gateway route table virtual interface group association. '
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
operationId: POST_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
description: ' Creates a local gateway route table virtual interface group association. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateLocalGatewayRouteTableVpcAssociation:
get:
x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation
operationId: GET_CreateLocalGatewayRouteTableVpcAssociation
description: Associates the specified VPC with the specified local gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult'
parameters:
- name: LocalGatewayRouteTableId
in: query
required: true
description: The ID of the local gateway route table.
schema:
type: string
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the local gateway route table VPC association.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLocalGatewayRouteTableVpcAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateLocalGatewayRouteTableVpcAssociation
operationId: POST_CreateLocalGatewayRouteTableVpcAssociation
description: Associates the specified VPC with the specified local gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateLocalGatewayRouteTableVpcAssociationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateLocalGatewayRouteTableVpcAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateManagedPrefixList:
get:
x-aws-operation-name: CreateManagedPrefixList
operationId: GET_CreateManagedPrefixList
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateManagedPrefixListResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PrefixListName
in: query
required: true
description: 'A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
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.
' schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateManagedPrefixList - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateManagedPrefixList operationId: POST_CreateManagedPrefixList description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateManagedPrefixListResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateManagedPrefixListRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateManagedPrefixList - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateNatGateway: get: x-aws-operation-name: CreateNatGateway operationId: GET_CreateNatGateway description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNatGatewayResult' parameters: - name: AllocationId in: query required: false description: '[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.' schema: type: string - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Constraint: Maximum 64 ASCII characters.
' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SubnetId
in: query
required: true
description: The ID of the subnet in which to create the NAT gateway.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the NAT gateway.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ConnectivityType
in: query
required: false
description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
schema:
type: string
enum:
- private
- public
- name: PrivateIpAddress
in: query
required: false
description: '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.'
schema:
type: string
- name: SecondaryAllocationId
in: query
required: false
description: 'Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/AllocationId'
- xml:
name: AllocationId
- name: SecondaryPrivateIpAddress
in: query
required: false
description: 'Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: SecondaryPrivateIpAddressCount
in: query
required: false
description: '[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.'
schema:
type: integer
minimum: 1
maximum: 31
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateNatGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateNatGateway
operationId: POST_CreateNatGateway
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNatGatewayResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateNatGatewayRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateNatGateway - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateNetworkAcl: get: x-aws-operation-name: CreateNetworkAcl operationId: GET_CreateNetworkAcl description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkAclResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the network ACL.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateNetworkAcl
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateNetworkAcl
operationId: POST_CreateNetworkAcl
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkAclResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkAclRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateNetworkAcl - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateNetworkAclEntry: get: x-aws-operation-name: CreateNetworkAclEntry operationId: GET_CreateNetworkAclEntry description: '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.
' responses: '200': description: Success parameters: - name: CidrBlock in: query required: false description: 'The IPv4 network range to allow or deny, in CIDR notation (for example172.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.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Egress
in: query
required: true
description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
schema:
type: boolean
- name: Icmp
in: query
required: false
description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.'
schema:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: code
description: The ICMP code. A value of -1 means all codes for the specified ICMP type.
Type:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: type
description: The ICMP type. A value of -1 means all types.
description: Describes the ICMP type and code.
- name: Ipv6CidrBlock
in: query
required: false
description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).'
schema:
type: string
- name: NetworkAclId
in: query
required: true
description: The ID of the network ACL.
schema:
type: string
- name: PortRange
in: query
required: false
description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
schema:
type: object
properties:
From:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: from
description: The first port in the range.
To:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: to
description: The last port in the range.
description: Describes a range of ports.
- name: Protocol
in: query
required: true
description: '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.'
schema:
type: string
- name: RuleAction
in: query
required: true
description: Indicates whether to allow or deny the traffic that matches the rule.
schema:
type: string
enum:
- allow
- deny
- name: RuleNumber
in: query
required: true
description: '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.
' schema: type: integer - name: Action in: query required: true schema: type: string enum: - CreateNetworkAclEntry - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateNetworkAclEntry operationId: POST_CreateNetworkAclEntry description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkAclEntryRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateNetworkAclEntry - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateNetworkInsightsAccessScope: get: x-aws-operation-name: CreateNetworkInsightsAccessScope operationId: GET_CreateNetworkInsightsAccessScope description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' parameters: - name: MatchPath in: query required: false description: The paths to match. schema: type: array items: allOf: - $ref: '#/components/schemas/AccessScopePathRequest' - xml: name: item - name: ExcludePath in: query required: false description: The paths to exclude. schema: type: array items: allOf: - $ref: '#/components/schemas/AccessScopePathRequest' - xml: name: item - name: ClientToken in: query required: true description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' schema: type: string - name: TagSpecification in: query required: false description: The tags to apply. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateNetworkInsightsAccessScope
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateNetworkInsightsAccessScope
operationId: POST_CreateNetworkInsightsAccessScope
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInsightsAccessScopeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateNetworkInsightsAccessScope - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateNetworkInsightsPath: get: x-aws-operation-name: CreateNetworkInsightsPath operationId: GET_CreateNetworkInsightsPath description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInsightsPathResult' parameters: - name: SourceIp in: query required: false description: The IP address of the source. schema: type: string pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' minLength: 0 maxLength: 15 - name: DestinationIp in: query required: false description: The IP address of the destination. schema: type: string pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' minLength: 0 maxLength: 15 - name: Source in: query required: true description: 'The ID or ARN of the source. If the resource is in another account, you must specify an ARN.' schema: type: string - name: Destination in: query required: false description: 'The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.' schema: type: string - name: Protocol in: query required: true description: The protocol. schema: type: string enum: - tcp - udp - name: DestinationPort in: query required: false description: The destination port. schema: type: integer minimum: 0 maximum: 65535 - name: TagSpecification in: query required: false description: The tags to add to the path. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: true
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: FilterAtSource
in: query
required: false
description: '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.'
schema:
type: object
properties:
SourceAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The source IPv4 address.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/RequestFilterPortRange'
- description: The source port range.
DestinationAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The destination IPv4 address.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/RequestFilterPortRange'
- description: The destination port range.
description: Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.
- name: FilterAtDestination
in: query
required: false
description: '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.'
schema:
type: object
properties:
SourceAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The source IPv4 address.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/RequestFilterPortRange'
- description: The source port range.
DestinationAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The destination IPv4 address.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/RequestFilterPortRange'
- description: The destination port range.
description: Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateNetworkInsightsPath
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateNetworkInsightsPath
operationId: POST_CreateNetworkInsightsPath
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInsightsPathResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInsightsPathRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateNetworkInsightsPath - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateNetworkInterface: get: x-aws-operation-name: CreateNetworkInterface operationId: GET_CreateNetworkInterface description: 'Creates a network interface in the specified subnet.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
For more information about network interfaces, see Elastic network interfaces in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInterfaceResult' parameters: - name: Description in: query required: false description: A description for the network interface. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SecurityGroupId
in: query
required: false
description: The IDs of one or more security groups.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: SecurityGroupId
- name: Ipv6AddressCount
in: query
required: false
description: '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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceIpv6Address' - xml: name: item - name: PrivateIpAddress in: query required: false description: '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 inprivateIpAddresses as primary (only one IP address can be designated as primary).'
schema:
type: string
- name: PrivateIpAddresses
in: query
required: false
description: '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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/PrivateIpAddressSpecification' - xml: name: item - name: SecondaryPrivateIpAddressCount in: query required: false description: '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.
' schema: type: integer - name: Ipv4Prefix in: query required: false description: '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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest' - xml: name: item - name: Ipv4PrefixCount in: query required: false description: '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.
' schema: type: integer - name: Ipv6Prefix in: query required: false description: '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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest' - xml: name: item - name: Ipv6PrefixCount in: query required: false description: '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.
' schema: type: integer - name: InterfaceType in: query required: false description: 'The type of network interface. The default is interface.
The only supported values are interface, efa, and trunk.
Creates a network interface in the specified subnet.
The number of IP addresses you can assign to a network interface varies by instance type. For more information, see IP Addresses Per ENI Per Instance Type in the Amazon Virtual Private Cloud User Guide.
For more information about network interfaces, see Elastic network interfaces in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInterfaceResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInterfaceRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateNetworkInterface - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateNetworkInterfacePermission: get: x-aws-operation-name: CreateNetworkInterfacePermission operationId: GET_CreateNetworkInterfacePermission description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' parameters: - name: NetworkInterfaceId in: query required: true description: The ID of the network interface. schema: type: string - name: AwsAccountId in: query required: false description: The Amazon Web Services account ID. schema: type: string - name: AwsService in: query required: false description: The Amazon Web Service. Currently not supported. schema: type: string - name: Permission in: query required: true description: The type of permission to grant. schema: type: string enum: - INSTANCE-ATTACH - EIP-ASSOCIATE - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateNetworkInterfacePermission
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateNetworkInterfacePermission
operationId: POST_CreateNetworkInterfacePermission
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateNetworkInterfacePermissionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateNetworkInterfacePermission - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreatePlacementGroup: get: x-aws-operation-name: CreatePlacementGroup operationId: GET_CreatePlacementGroup description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreatePlacementGroupResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupName
in: query
required: false
description: 'A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
' schema: type: string - name: Strategy in: query required: false description: The placement strategy. schema: type: string enum: - cluster - spread - partition - name: PartitionCount in: query required: false description: The number of partitions. Valid only when Strategy is set topartition.
schema:
type: integer
- name: TagSpecification
in: query
required: false
description: The tags to apply to the new placement group.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: SpreadLevel
in: query
required: false
description: Determines how placement groups spread instances.
Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreatePlacementGroupResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreatePlacementGroupRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreatePlacementGroup - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreatePublicIpv4Pool: get: x-aws-operation-name: CreatePublicIpv4Pool operationId: GET_CreatePublicIpv4Pool description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreatePublicIpv4PoolResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: '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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreatePublicIpv4Pool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreatePublicIpv4Pool
operationId: POST_CreatePublicIpv4Pool
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreatePublicIpv4PoolResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreatePublicIpv4PoolRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreatePublicIpv4Pool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateReplaceRootVolumeTask:
get:
x-aws-operation-name: CreateReplaceRootVolumeTask
operationId: GET_CreateReplaceRootVolumeTask
description: 'Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume''s launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' parameters: - name: InstanceId in: query required: true description: The ID of the instance for which to replace the root volume. schema: type: string - name: SnapshotId in: query required: false description: '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.
' schema: type: string - name: ClientToken in: query required: false description: '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.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: The tags to apply to the root volume replacement task.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ImageId
in: query
required: false
description: '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.
' schema: type: string - name: DeleteReplacedRootVolume in: query required: false description: 'Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specifytrue. 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.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateReplaceRootVolumeTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateReplaceRootVolumeTask
operationId: POST_CreateReplaceRootVolumeTask
description: 'Replaces the EBS-backed root volume for a running instance with a new volume that is restored to the original root volume''s launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance.
For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateReplaceRootVolumeTaskResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateReplaceRootVolumeTaskRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateReplaceRootVolumeTask - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateReservedInstancesListing: get: x-aws-operation-name: CreateReservedInstancesListing operationId: GET_CreateReservedInstancesListing description: 'Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateReservedInstancesListingResult' parameters: - name: ClientToken in: query required: true description: 'Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency.' schema: type: string - name: InstanceCount in: query required: true description: 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. schema: type: integer - name: PriceSchedules in: query required: true description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. schema: type: array items: allOf: - $ref: '#/components/schemas/PriceScheduleSpecification' - xml: name: item - name: ReservedInstancesId in: query required: true description: The ID of the active Standard Reserved Instance. schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateReservedInstancesListing - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateReservedInstancesListing operationId: POST_CreateReservedInstancesListing description: 'Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the DescribeReservedInstances operation.
Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold.
The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the DescribeReservedInstancesListings operation.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateReservedInstancesListingResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateReservedInstancesListingRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateReservedInstancesListing - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateRestoreImageTask: get: x-aws-operation-name: CreateRestoreImageTask operationId: GET_CreateRestoreImageTask description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateRestoreImageTaskResult' parameters: - name: Bucket in: query required: true description: The name of the Amazon S3 bucket that contains the stored AMI object. schema: type: string - name: ObjectKey in: query required: true description: The name of the stored AMI object in the bucket. schema: type: string - name: Name in: query required: false description: '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.' schema: type: string - name: TagSpecification in: query required: false description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateRestoreImageTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateRestoreImageTask
operationId: POST_CreateRestoreImageTask
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateRestoreImageTaskResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateRestoreImageTaskRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateRestoreImageTask - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateRoute: get: x-aws-operation-name: CreateRoute operationId: GET_CreateRoute description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateRouteResult' parameters: - name: DestinationCidrBlock in: query required: false description: '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 specify100.68.0.18/18, we modify it to 100.68.0.0/18.'
schema:
type: string
- name: DestinationIpv6CidrBlock
in: query
required: false
description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
schema:
type: string
- name: DestinationPrefixListId
in: query
required: false
description: The ID of a prefix list used for the destination match.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcEndpointId
in: query
required: false
description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
schema:
type: string
- name: EgressOnlyInternetGatewayId
in: query
required: false
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
schema:
type: string
- name: GatewayId
in: query
required: false
description: The ID of an internet gateway or virtual private gateway attached to your VPC.
schema:
type: string
- name: InstanceId
in: query
required: false
description: 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.
schema:
type: string
- name: NatGatewayId
in: query
required: false
description: '[IPv4 traffic only] The ID of a NAT gateway.'
schema:
type: string
- name: TransitGatewayId
in: query
required: false
description: The ID of a transit gateway.
schema:
type: string
- name: LocalGatewayId
in: query
required: false
description: The ID of the local gateway.
schema:
type: string
- name: CarrierGatewayId
in: query
required: false
description: 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.
schema: type: string - name: NetworkInterfaceId in: query required: false description: The ID of a network interface. schema: type: string - name: RouteTableId in: query required: true description: The ID of the route table for the route. schema: type: string - name: VpcPeeringConnectionId in: query required: false description: The ID of a VPC peering connection. schema: type: string - name: CoreNetworkArn in: query required: false description: The Amazon Resource Name (ARN) of the core network. schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateRoute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateRoute operationId: POST_CreateRoute description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateRouteResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateRouteRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateRoute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateRouteTable: get: x-aws-operation-name: CreateRouteTable operationId: GET_CreateRouteTable description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateRouteTableResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the route table.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateRouteTable
operationId: POST_CreateRouteTable
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateRouteTableResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateRouteTableRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateRouteTable - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateSecurityGroup: get: x-aws-operation-name: CreateSecurityGroup operationId: GET_CreateSecurityGroup description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSecurityGroupResult' parameters: - name: GroupDescription in: query required: true description: 'A description for the security group.
Constraints: Up to 255 characters in length
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' schema: type: string - name: GroupName in: query required: true description: '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 ._-:/()#,@[]+=&;{}!$*
' schema: type: string - name: VpcId in: query required: false description: The ID of the VPC. Required for a nondefault VPC. schema: type: string - name: TagSpecification in: query required: false description: The tags to assign to the security group. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSecurityGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateSecurityGroup
operationId: POST_CreateSecurityGroup
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSecurityGroupResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateSecurityGroupRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateSecurityGroup - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateSnapshot: get: x-aws-operation-name: CreateSnapshot operationId: GET_CreateSnapshot description: 'Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/Snapshot' parameters: - name: Description in: query required: false description: A description for the snapshot. schema: type: string - name: OutpostArn in: query required: false description: '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 Elastic Compute Cloud User Guide.
' schema: type: string - name: VolumeId in: query required: true description: The ID of the Amazon EBS volume. schema: type: string - name: TagSpecification in: query required: false description: The tags to apply to the snapshot during creation. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSnapshot
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateSnapshot
operationId: POST_CreateSnapshot
description: 'Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance.
You can create snapshots of volumes in a Region and volumes on an Outpost. If you create a snapshot of a volume in a Region, the snapshot must be stored in the same Region as the volume. If you create a snapshot of a volume on an Outpost, the snapshot can be stored on the same Outpost as the volume, or in the Region for that Outpost.
When a snapshot is created, any Amazon Web Services Marketplace product codes that are associated with the source volume are propagated to the snapshot.
You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is pending.
When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot.
Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected.
You can tag your snapshots during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Amazon Elastic Block Store and Amazon EBS encryption in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/Snapshot' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateSnapshotRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateSnapshot - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateSnapshots: get: x-aws-operation-name: CreateSnapshots operationId: GET_CreateSnapshots description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSnapshotsResult' parameters: - name: Description in: query required: false description: ' A description propagated to every snapshot specified by the instance.' schema: type: string - name: InstanceSpecification in: query required: true description: The instance to specify which volumes should be included in the snapshots. schema: type: object required: - InstanceId properties: InstanceId: allOf: - $ref: '#/components/schemas/InstanceIdWithVolumeResolver' - description: The instance to specify which volumes should be snapshotted. ExcludeBootVolume: allOf: - $ref: '#/components/schemas/Boolean' - description: Excludes the root volume from being snapshotted. ExcludeDataVolumeIds: allOf: - $ref: '#/components/schemas/VolumeIdStringList' - xml: name: ExcludeDataVolumeId description: 'The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. If you specify the ID of the root volume, the request fails. To exclude the root volume, use ExcludeBootVolume.
You can specify up to 40 volume IDs per request.
' description: The instance details to specify which volumes should be snapshotted. - name: OutpostArn in: query required: false description: '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 Elastic Compute Cloud User Guide.
' schema: type: string - name: TagSpecification in: query required: false description: Tags to apply to every snapshot specified by the instance. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: CopyTagsFromSource
in: query
required: false
description: Copies the tags from the specified volume to corresponding snapshot.
schema:
type: string
enum:
- volume
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSnapshots
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateSnapshots
operationId: POST_CreateSnapshots
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSnapshotsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateSnapshotsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateSnapshots - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateSpotDatafeedSubscription: get: x-aws-operation-name: CreateSpotDatafeedSubscription operationId: GET_CreateSpotDatafeedSubscription description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult' parameters: - name: Bucket in: query required: true description: '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.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Prefix
in: query
required: false
description: The prefix for the data feed file names.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSpotDatafeedSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateSpotDatafeedSubscription
operationId: POST_CreateSpotDatafeedSubscription
description: 'Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per Amazon Web Services account. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateSpotDatafeedSubscriptionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSpotDatafeedSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateStoreImageTask:
get:
x-aws-operation-name: CreateStoreImageTask
operationId: GET_CreateStoreImageTask
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateStoreImageTaskResult' parameters: - name: ImageId in: query required: true description: The ID of the AMI. schema: type: string - name: Bucket in: query required: true description: '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. ' schema: type: string - name: S3ObjectTag in: query required: false description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. ' schema: type: array items: allOf: - $ref: '#/components/schemas/S3ObjectTag' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateStoreImageTask
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateStoreImageTask
operationId: POST_CreateStoreImageTask
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateStoreImageTaskResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateStoreImageTaskRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateStoreImageTask - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateSubnet: get: x-aws-operation-name: CreateSubnet operationId: GET_CreateSubnet description: '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. The allowed block size for an IPv6 subnet is a /64 netmask.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSubnetResult' parameters: - name: TagSpecification in: query required: false description: The tags to assign to the subnet. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: AvailabilityZone in: query required: false description: 'The Availability Zone or Local Zone for the subnet.
Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Local Zones locations.
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
' schema: type: string - name: AvailabilityZoneId in: query required: false description: The AZ ID or the Local Zone ID of the subnet. schema: type: string - name: CidrBlock in: query required: false description: '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.
' schema: type: string - name: Ipv6CidrBlock in: query required: false description: 'The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
This parameter is required for an IPv6 only subnet.
' schema: type: string - name: OutpostArn in: query required: false description: '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.' schema: type: string - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Ipv6Native
in: query
required: false
description: Indicates whether to create an IPv6 only subnet.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSubnet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateSubnet
operationId: POST_CreateSubnet
description: '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. The allowed block size for an IPv6 subnet is a /64 netmask.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSubnetResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateSubnetRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateSubnet - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateSubnetCidrReservation: get: x-aws-operation-name: CreateSubnetCidrReservation operationId: GET_CreateSubnetCidrReservation description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateSubnetCidrReservationResult' parameters: - name: SubnetId in: query required: true description: The ID of the subnet. schema: type: string - name: Cidr in: query required: true description: The IPv4 or IPV6 CIDR range to reserve. schema: type: string - name: ReservationType in: query required: true description: 'The type of reservation.
The following are valid values:
prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses to network interfaces that are associated with an instance. For information about Prefix Delegation, see Prefix Delegation for Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
explicit: You manually assign the IP addresses to resources that reside in your subnet.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: The tags to assign to the subnet CIDR reservation.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSubnetCidrReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateSubnetCidrReservation
operationId: POST_CreateSubnetCidrReservation
description: 'Creates a subnet CIDR reservation. For information about subnet CIDR reservations, see Subnet CIDR reservations in the Amazon Virtual Private Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateSubnetCidrReservationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateSubnetCidrReservationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateSubnetCidrReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateTags:
get:
x-aws-operation-name: CreateTags
operationId: GET_CreateTags
description: '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.
' responses: '200': description: Success parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ResourceId
in: query
required: true
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' schema: type: array items: $ref: '#/components/schemas/TaggableResourceId' - name: Tag in: query required: true description: 'The tags. Thevalue 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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Tag'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTags
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTags
operationId: POST_CreateTags
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTagsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTags - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTrafficMirrorFilter: get: x-aws-operation-name: CreateTrafficMirrorFilter operationId: GET_CreateTrafficMirrorFilter description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' parameters: - name: Description in: query required: false description: The description of the Traffic Mirror filter. schema: type: string - name: TagSpecification in: query required: false description: The tags to assign to a Traffic Mirror filter. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTrafficMirrorFilter
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTrafficMirrorFilter
operationId: POST_CreateTrafficMirrorFilter
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorFilterResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorFilterRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTrafficMirrorFilter - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTrafficMirrorFilterRule: get: x-aws-operation-name: CreateTrafficMirrorFilterRule operationId: GET_CreateTrafficMirrorFilterRule description: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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' parameters: - name: TrafficMirrorFilterId in: query required: true description: The ID of the filter that this rule is associated with. schema: type: string - name: TrafficDirection in: query required: true description: The type of traffic. schema: type: string enum: - ingress - egress - name: RuleNumber in: query required: true description: 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. schema: type: integer - name: RuleAction in: query required: true description: The action to take on the filtered traffic. schema: type: string enum: - accept - reject - name: DestinationPortRange in: query required: false description: The destination port range. schema: type: object properties: FromPort: allOf: - $ref: '#/components/schemas/Integer' - description: The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. ToPort: allOf: - $ref: '#/components/schemas/Integer' - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. description: Information about the Traffic Mirror filter rule port range. - name: SourcePortRange in: query required: false description: The source port range. schema: type: object properties: FromPort: allOf: - $ref: '#/components/schemas/Integer' - description: The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. ToPort: allOf: - $ref: '#/components/schemas/Integer' - description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols. description: Information about the Traffic Mirror filter rule port range. - name: Protocol in: query required: false description: '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.
' schema: type: integer - name: DestinationCidrBlock in: query required: true description: The destination CIDR block to assign to the Traffic Mirror rule. schema: type: string - name: SourceCidrBlock in: query required: true description: The source CIDR block to assign to the Traffic Mirror rule. schema: type: string - name: Description in: query required: false description: The description of the Traffic Mirror rule. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTrafficMirrorFilterRule
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTrafficMirrorFilterRule
operationId: POST_CreateTrafficMirrorFilterRule
description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorFilterRuleRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTrafficMirrorFilterRule - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTrafficMirrorSession: get: x-aws-operation-name: CreateTrafficMirrorSession operationId: GET_CreateTrafficMirrorSession description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' parameters: - name: NetworkInterfaceId in: query required: true description: The ID of the source network interface. schema: type: string - name: TrafficMirrorTargetId in: query required: true description: The ID of the Traffic Mirror target. schema: type: string - name: TrafficMirrorFilterId in: query required: true description: The ID of the Traffic Mirror filter. schema: type: string - name: PacketLength in: query required: false description: '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.
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.
schema: type: integer - name: VirtualNetworkId in: query required: false description: 'The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify aVirtualNetworkId, an account-wide unique id is chosen at random.'
schema:
type: integer
- name: Description
in: query
required: false
description: The description of the Traffic Mirror session.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to a Traffic Mirror session.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTrafficMirrorSession
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTrafficMirrorSession
operationId: POST_CreateTrafficMirrorSession
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorSessionResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorSessionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTrafficMirrorSession - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTrafficMirrorTarget: get: x-aws-operation-name: CreateTrafficMirrorTarget operationId: GET_CreateTrafficMirrorTarget description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' parameters: - name: NetworkInterfaceId in: query required: false description: The network interface ID that is associated with the target. schema: type: string - name: NetworkLoadBalancerArn in: query required: false description: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. schema: type: string - name: Description in: query required: false description: The description of the Traffic Mirror target. schema: type: string - name: TagSpecification in: query required: false description: The tags to assign to the Traffic Mirror target. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: GatewayLoadBalancerEndpointId
in: query
required: false
description: The ID of the Gateway Load Balancer endpoint.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTrafficMirrorTarget
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTrafficMirrorTarget
operationId: POST_CreateTrafficMirrorTarget
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorTargetResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTrafficMirrorTargetRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTrafficMirrorTarget - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTransitGateway: get: x-aws-operation-name: CreateTransitGateway operationId: GET_CreateTransitGateway description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayResult' parameters: - name: Description in: query required: false description: A description of the transit gateway. schema: type: string - name: Options in: query required: false description: The transit gateway options. schema: type: object properties: AmazonSideAsn: allOf: - $ref: '#/components/schemas/Long' - description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is64512.
AutoAcceptSharedAttachments:
allOf:
- $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue'
- description: Enable or disable automatic acceptance of attachment requests. Disabled by default.
DefaultRouteTableAssociation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTableAssociationValue'
- description: Enable or disable automatic association with the default association route table. Enabled by default.
DefaultRouteTablePropagation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTablePropagationValue'
- description: Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
VpnEcmpSupport:
allOf:
- $ref: '#/components/schemas/VpnEcmpSupportValue'
- description: Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- description: Enable or disable DNS support. Enabled by default.
MulticastSupport:
allOf:
- $ref: '#/components/schemas/MulticastSupportValue'
- description: Indicates whether multicast is enabled on the transit gateway
TransitGatewayCidrBlocks:
allOf:
- $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
- description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.'
description: Describes the options for a transit gateway.
- name: TagSpecification
in: query
required: false
description: The tags to apply to the transit gateway.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGateway
operationId: POST_CreateTransitGateway
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTransitGateway - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTransitGatewayConnect: get: x-aws-operation-name: CreateTransitGatewayConnect operationId: GET_CreateTransitGatewayConnect description: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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayConnectResult' parameters: - name: TransportTransitGatewayAttachmentId in: query required: true description: The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment. schema: type: string - name: Options in: query required: true description: The Connect attachment options. schema: type: object required: - Protocol properties: Protocol: allOf: - $ref: '#/components/schemas/ProtocolValue' - description: The tunnel protocol. description: The options for a Connect attachment. - name: TagSpecification in: query required: false description: The tags to apply to the Connect attachment. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayConnect
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayConnect
operationId: POST_CreateTransitGatewayConnect
description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayConnectResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayConnectRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTransitGatewayConnect - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTransitGatewayConnectPeer: get: x-aws-operation-name: CreateTransitGatewayConnectPeer operationId: GET_CreateTransitGatewayConnectPeer description: 'Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' parameters: - name: TransitGatewayAttachmentId in: query required: true description: The ID of the Connect attachment. schema: type: string - name: TransitGatewayAddress in: query required: false description: '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.' schema: type: string - name: PeerAddress in: query required: true description: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer. schema: type: string - name: BgpOptions in: query required: false description: The BGP options for the Connect peer. schema: type: object properties: PeerAsn: allOf: - $ref: '#/components/schemas/Long' - description: The peer Autonomous System Number (ASN). description: The BGP options for the Connect attachment. - name: InsideCidrBlocks in: query required: true description: 'The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the169.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.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: TagSpecification
in: query
required: false
description: The tags to apply to the Connect peer.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayConnectPeer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayConnectPeer
operationId: POST_CreateTransitGatewayConnectPeer
description: 'Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance.
The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).
For more information, see Connect peers in the Transit Gateways Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayConnectPeerResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayConnectPeerRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTransitGatewayConnectPeer - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTransitGatewayMulticastDomain: get: x-aws-operation-name: CreateTransitGatewayMulticastDomain operationId: GET_CreateTransitGatewayMulticastDomain description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' parameters: - name: TransitGatewayId in: query required: true description: The ID of the transit gateway. schema: type: string - name: Options in: query required: false description: The options for the transit gateway multicast domain. schema: type: object properties: Igmpv2Support: allOf: - $ref: '#/components/schemas/Igmpv2SupportValue' - description: Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain. StaticSourcesSupport: allOf: - $ref: '#/components/schemas/StaticSourcesSupportValue' - description: Specify whether to enable support for statically configuring multicast group sources for a domain. AutoAcceptSharedAssociations: allOf: - $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue' - description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain. description: The options for the transit gateway multicast domain. - name: TagSpecification in: query required: false description: The tags for the transit gateway multicast domain. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayMulticastDomain
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayMulticastDomain
operationId: POST_CreateTransitGatewayMulticastDomain
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTransitGatewayMulticastDomain - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTransitGatewayPeeringAttachment: get: x-aws-operation-name: CreateTransitGatewayPeeringAttachment operationId: GET_CreateTransitGatewayPeeringAttachment description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' parameters: - name: TransitGatewayId in: query required: true description: The ID of the transit gateway. schema: type: string - name: PeerTransitGatewayId in: query required: true description: The ID of the peer transit gateway with which to create the peering attachment. schema: type: string - name: PeerAccountId in: query required: true description: The ID of the Amazon Web Services account that owns the peer transit gateway. schema: type: string - name: PeerRegion in: query required: true description: The Region where the peer transit gateway is located. schema: type: string - name: Options in: query required: false description: Requests a transit gateway peering attachment. schema: type: object properties: DynamicRouting: allOf: - $ref: '#/components/schemas/DynamicRoutingValue' - description: Indicates whether dynamic routing is enabled or disabled. description: Describes whether dynamic routing is enabled or disabled for the transit gateway peering request. - name: TagSpecification in: query required: false description: The tags to apply to the transit gateway peering attachment. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayPeeringAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayPeeringAttachment
operationId: POST_CreateTransitGatewayPeeringAttachment
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTransitGatewayPeeringAttachment - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateTransitGatewayPolicyTable: get: x-aws-operation-name: CreateTransitGatewayPolicyTable operationId: GET_CreateTransitGatewayPolicyTable description: Creates a transit gateway policy table. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayPolicyTableResult' parameters: - name: TransitGatewayId in: query required: true description: The ID of the transit gateway used for the policy table. schema: type: string - name: TagSpecifications in: query required: false description: The tags specification for the transit gateway policy table created during the request. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayPolicyTable
operationId: POST_CreateTransitGatewayPolicyTable
description: Creates a transit gateway policy table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayPolicyTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayPolicyTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateTransitGatewayPrefixListReference:
get:
x-aws-operation-name: CreateTransitGatewayPrefixListReference
operationId: GET_CreateTransitGatewayPrefixListReference
description: Creates a reference (route) to a prefix list in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list that is used for destination matches.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: false
description: The ID of the attachment to which traffic is routed.
schema:
type: string
- name: Blackhole
in: query
required: false
description: Indicates whether to drop traffic that matches this route.
schema:
type: boolean
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayPrefixListReference
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayPrefixListReference
operationId: POST_CreateTransitGatewayPrefixListReference
description: Creates a reference (route) to a prefix list in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayPrefixListReferenceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayPrefixListReference
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateTransitGatewayRoute:
get:
x-aws-operation-name: CreateTransitGatewayRoute
operationId: GET_CreateTransitGatewayRoute
description: Creates a static route for the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteResult'
parameters:
- name: DestinationCidrBlock
in: query
required: true
description: The CIDR range used for destination matches. Routing decisions are based on the most specific match.
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: false
description: The ID of the attachment.
schema:
type: string
- name: Blackhole
in: query
required: false
description: Indicates whether to drop traffic that matches this route.
schema:
type: boolean
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayRoute
operationId: POST_CreateTransitGatewayRoute
description: Creates a static route for the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateTransitGatewayRouteTable:
get:
x-aws-operation-name: CreateTransitGatewayRouteTable
operationId: GET_CreateTransitGatewayRouteTable
description: Creates a route table for the specified transit gateway.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
parameters:
- name: TransitGatewayId
in: query
required: true
description: The ID of the transit gateway.
schema:
type: string
- name: TagSpecifications
in: query
required: false
description: The tags to apply to the transit gateway route table.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayRouteTable
operationId: POST_CreateTransitGatewayRouteTable
description: Creates a route table for the specified transit gateway.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateTransitGatewayRouteTableAnnouncement:
get:
x-aws-operation-name: CreateTransitGatewayRouteTableAnnouncement
operationId: GET_CreateTransitGatewayRouteTableAnnouncement
description: Advertises a new transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableAnnouncementResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: PeeringAttachmentId
in: query
required: true
description: The ID of the peering attachment.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags specifications applied to the transit gateway route table announcement.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayRouteTableAnnouncement
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayRouteTableAnnouncement
operationId: POST_CreateTransitGatewayRouteTableAnnouncement
description: Advertises a new transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableAnnouncementResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableAnnouncementRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayRouteTableAnnouncement
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateTransitGatewayVpcAttachment:
get:
x-aws-operation-name: CreateTransitGatewayVpcAttachment
operationId: GET_CreateTransitGatewayVpcAttachment
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' parameters: - name: TransitGatewayId in: query required: true description: The ID of the transit gateway. schema: type: string - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: SubnetIds in: query required: true description: '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.' schema: type: array items: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: item - name: Options in: query required: false description: The VPC attachment options. schema: type: object properties: DnsSupport: allOf: - $ref: '#/components/schemas/DnsSupportValue' - description: Enable or disable DNS support. The default isenable.
Ipv6Support:
allOf:
- $ref: '#/components/schemas/Ipv6SupportValue'
- description: Enable or disable IPv6 support. The default is disable.
ApplianceModeSupport:
allOf:
- $ref: '#/components/schemas/ApplianceModeSupportValue'
- description: '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.'
description: Describes the options for a VPC attachment.
- name: TagSpecifications
in: query
required: false
description: The tags to apply to the VPC attachment.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateTransitGatewayVpcAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateTransitGatewayVpcAttachment
operationId: POST_CreateTransitGatewayVpcAttachment
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateTransitGatewayVpcAttachment - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateVerifiedAccessEndpoint: get: x-aws-operation-name: CreateVerifiedAccessEndpoint operationId: GET_CreateVerifiedAccessEndpoint description: An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVerifiedAccessEndpointResult' parameters: - name: VerifiedAccessGroupId in: query required: true description: The ID of the Verified Access group to associate the endpoint with. schema: type: string - name: EndpointType in: query required: true description: The type of Verified Access endpoint to create. schema: type: string enum: - load-balancer - network-interface - name: AttachmentType in: query required: true description: The type of attachment. schema: type: string enum: - vpc - name: DomainCertificateArn in: query required: true description: 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. schema: type: string - name: ApplicationDomain in: query required: true description: The DNS name for users to reach your application. schema: type: string - name: EndpointDomainPrefix in: query required: true description: A custom identifier that is prepended to the DNS name that is generated for the endpoint. schema: type: string - name: SecurityGroupId in: query required: false description: The IDs of the security groups to associate with the Verified Access endpoint. schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupId' - xml: name: item - name: LoadBalancerOptions in: query required: false description: The load balancer details. This parameter is required if the endpoint type isload-balancer.
schema:
type: object
properties:
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
LoadBalancerArn:
allOf:
- $ref: '#/components/schemas/LoadBalancerArn'
- description: The ARN of the load balancer.
SubnetIds:
allOf:
- $ref: '#/components/schemas/CreateVerifiedAccessEndpointSubnetIdList'
- xml:
name: SubnetId
description: The IDs of the subnets.
description: Describes the load balancer options when creating an Amazon Web Services Verified Access endpoint using the load-balancer type.
- name: NetworkInterfaceOptions
in: query
required: false
description: The network interface details. This parameter is required if the endpoint type is network-interface.
schema:
type: object
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the network interface.
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
description: Describes the network interface options when creating an Amazon Web Services Verified Access endpoint using the network-interface type.
- name: Description
in: query
required: false
description: A description for the Verified Access endpoint.
schema:
type: string
- name: PolicyDocument
in: query
required: false
description: The Verified Access policy document.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the Verified Access endpoint.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateVerifiedAccessEndpoint
operationId: POST_CreateVerifiedAccessEndpoint
description: An Amazon Web Services Verified Access endpoint is where you define your application along with an optional endpoint-level access policy.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessEndpointResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessEndpointRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateVerifiedAccessGroup:
get:
x-aws-operation-name: CreateVerifiedAccessGroup
operationId: GET_CreateVerifiedAccessGroup
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessGroupResult'
parameters:
- name: VerifiedAccessInstanceId
in: query
required: true
description: The ID of the Verified Access instance.
schema:
type: string
- name: Description
in: query
required: false
description: A description for the Verified Access group.
schema:
type: string
- name: PolicyDocument
in: query
required: false
description: The Verified Access policy document.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the Verified Access group.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateVerifiedAccessGroup
operationId: POST_CreateVerifiedAccessGroup
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessGroupResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessGroupRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateVerifiedAccessInstance:
get:
x-aws-operation-name: CreateVerifiedAccessInstance
operationId: GET_CreateVerifiedAccessInstance
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessInstanceResult'
parameters:
- name: Description
in: query
required: false
description: A description for the Verified Access instance.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the Verified Access instance.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateVerifiedAccessInstance
operationId: POST_CreateVerifiedAccessInstance
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessInstanceResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessInstanceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateVerifiedAccessTrustProvider:
get:
x-aws-operation-name: CreateVerifiedAccessTrustProvider
operationId: GET_CreateVerifiedAccessTrustProvider
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessTrustProviderResult'
parameters:
- name: TrustProviderType
in: query
required: true
description: The type of trust provider.
schema:
type: string
enum:
- user
- device
- name: UserTrustProviderType
in: query
required: false
description: The type of user-based trust provider. This parameter is required when the provider type is user.
schema:
type: string
enum:
- iam-identity-center
- oidc
- name: DeviceTrustProviderType
in: query
required: false
description: The type of device-based trust provider. This parameter is required when the provider type is device.
schema:
type: string
enum:
- jamf
- crowdstrike
- name: OidcOptions
in: query
required: false
description: The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is user.
schema:
type: object
properties:
Issuer:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC issuer.
AuthorizationEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC authorization endpoint.
TokenEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC token endpoint.
UserInfoEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC user info endpoint.
ClientId:
allOf:
- $ref: '#/components/schemas/String'
- description: The client identifier.
ClientSecret:
allOf:
- $ref: '#/components/schemas/ClientSecretType'
- description: The client secret.
Scope:
allOf:
- $ref: '#/components/schemas/String'
- description: 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.
description: Describes the options when creating an Amazon Web Services Verified Access trust provider using the user type.
- name: DeviceOptions
in: query
required: false
description: The options for a device-based trust provider. This parameter is required when the provider type is device.
schema:
type: object
properties:
TenantId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the tenant application with the device-identity provider.
description: Describes the options when creating an Amazon Web Services Verified Access trust provider using the device type.
- name: PolicyReferenceName
in: query
required: true
description: The identifier to be used when working with policy rules.
schema:
type: string
- name: Description
in: query
required: false
description: A description for the Verified Access trust provider.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to assign to the Verified Access trust provider.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateVerifiedAccessTrustProvider
operationId: POST_CreateVerifiedAccessTrustProvider
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessTrustProviderResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/CreateVerifiedAccessTrustProviderRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=CreateVolume:
get:
x-aws-operation-name: CreateVolume
operationId: GET_CreateVolume
description: '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 Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/Volume' parameters: - name: AvailabilityZone in: query required: true description: 'The ID of the Availability Zone in which to create the volume. For example,us-east-1a.'
schema:
type: string
- name: Encrypted
in: query
required: false
description: 'Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
' schema: type: boolean - name: Iops in: query required: false description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' schema: type: string - name: OutpostArn in: query required: false description: The Amazon Resource Name (ARN) of the Outpost. schema: type: string - name: Size in: query required: false description: 'The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
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 Elastic Compute Cloud User Guide.
Default: gp2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: The tags to apply to the volume during creation.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: MultiAttachEnabled
in: query
required: false
description: 'Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
schema:
type: boolean
- name: Throughput
in: query
required: false
description: '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.
' schema: type: integer - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateVolume - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateVolume operationId: POST_CreateVolume description: '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 Elastic Compute Cloud User Guide.
You can tag your volumes during creation. For more information, see Tag your Amazon EC2 resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Create an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/Volume' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateVolumeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateVolume - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateVpc: get: x-aws-operation-name: CreateVpc operationId: GET_CreateVpc description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpcResult' parameters: - name: CidrBlock in: query required: false description: '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.'
schema:
type: string
- name: AmazonProvidedIpv6CidrBlock
in: query
required: false
description: '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.'
schema:
type: boolean
- name: Ipv6Pool
in: query
required: false
description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
schema:
type: string
- name: Ipv6CidrBlock
in: query
required: false
description: '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.
' schema: type: string - name: Ipv4IpamPoolId in: query required: false description: '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. ' schema: type: string - name: Ipv4NetmaskLength in: query required: false description: '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.' schema: type: integer - name: Ipv6IpamPoolId in: query required: false description: '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.' schema: type: string - name: Ipv6NetmaskLength in: query required: false description: '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.' schema: type: integer - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceTenancy
in: query
required: false
description: '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.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpcResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateVpcRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateVpc - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateVpcEndpoint: get: x-aws-operation-name: CreateVpcEndpoint operationId: GET_CreateVpcEndpoint description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpcEndpointResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcEndpointType
in: query
required: false
description: 'The type of endpoint.
Default: Gateway
' schema: type: string enum: - Interface - Gateway - GatewayLoadBalancer - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: ServiceName in: query required: true description: The name of the endpoint service. schema: type: string - name: PolicyDocument in: query required: false description: '(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.' schema: type: string - name: RouteTableId in: query required: false description: (Gateway endpoint) The route table IDs. schema: type: array items: allOf: - $ref: '#/components/schemas/RouteTableId' - xml: name: item - name: SubnetId in: query required: false description: '(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify only one subnet.' schema: type: array items: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: item - name: SecurityGroupId in: query required: false description: '(Interface endpoint) The IDs of the security groups to associate with the endpoint network interface. If this parameter is not specified, we use the default security group for the VPC.' schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupId' - xml: name: item - name: IpAddressType in: query required: false description: The IP address type for the endpoint. schema: type: string enum: - ipv4 - dualstack - ipv6 - name: DnsOptions in: query required: false description: The DNS options for the endpoint. schema: type: object properties: DnsRecordIpType: allOf: - $ref: '#/components/schemas/DnsRecordIpType' - description: The DNS records created for the endpoint. PrivateDnsOnlyForInboundResolverEndpoint: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint. description: Describes the DNS options for an endpoint. - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' schema: type: string - name: PrivateDnsEnabled in: query required: false description: '(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
Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: false
description: The ID of the endpoint service.
schema:
type: string
- name: VpcEndpointId
in: query
required: false
description: The ID of the endpoint.
schema:
type: string
- name: ConnectionNotificationArn
in: query
required: true
description: The ARN of the SNS topic for the notifications.
schema:
type: string
- name: ConnectionEvents
in: query
required: true
description: 'The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVpcEndpointConnectionNotification
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateVpcEndpointConnectionNotification
operationId: POST_CreateVpcEndpointConnectionNotification
description: 'Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see Create a Topic in the Amazon Simple Notification Service Developer Guide.
You can create a connection notification for interface endpoints only.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateVpcEndpointConnectionNotification - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateVpcEndpointServiceConfiguration: get: x-aws-operation-name: CreateVpcEndpointServiceConfiguration operationId: GET_CreateVpcEndpointServiceConfiguration description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: AcceptanceRequired
in: query
required: false
description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
schema:
type: boolean
- name: PrivateDnsName
in: query
required: false
description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
schema:
type: string
- name: NetworkLoadBalancerArn
in: query
required: false
description: The Amazon Resource Names (ARNs) of the Network Load Balancers.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: GatewayLoadBalancerArn
in: query
required: false
description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: SupportedIpAddressType
in: query
required: false
description: The supported IP address types. The possible values are ipv4 and ipv6.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to associate with the service.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVpcEndpointServiceConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateVpcEndpointServiceConfiguration
operationId: POST_CreateVpcEndpointServiceConfiguration
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateVpcEndpointServiceConfiguration - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateVpcPeeringConnection: get: x-aws-operation-name: CreateVpcPeeringConnection operationId: GET_CreateVpcPeeringConnection description: 'Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PeerOwnerId
in: query
required: false
description: 'The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
' schema: type: string - name: PeerVpcId in: query required: false description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. schema: type: string - name: VpcId in: query required: true description: The ID of the requester VPC. You must specify this parameter in the request. schema: type: string - name: PeerRegion in: query required: false description: '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.
' schema: type: string - name: TagSpecification in: query required: false description: The tags to assign to the peering connection. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: Action in: query required: true schema: type: string enum: - CreateVpcPeeringConnection - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateVpcPeeringConnection operationId: POST_CreateVpcPeeringConnection description: 'Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another Amazon Web Services account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks.
Limitations and rules apply to a VPC peering connection. For more information, see the limitations section in the VPC Peering Guide.
The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected.
If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of failed.
Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is ipsec.1.
The response includes information that you need to give to your network administrator to configure your customer gateway.
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device.
If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn''t return an error.
For more information, see Amazon Web Services Site-to-Site VPN in the Amazon Web Services Site-to-Site VPN User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpnConnectionResult' parameters: - name: CustomerGatewayId in: query required: true description: The ID of the customer gateway. schema: type: string - name: Type in: query required: true description: The type of VPN connection (ipsec.1).
schema:
type: string
- name: VpnGatewayId
in: query
required: false
description: 'The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.'
schema:
type: string
- name: TransitGatewayId
in: query
required: false
description: 'The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Options
in: query
required: false
description: The options for the VPN connection.
schema:
type: object
properties:
EnableAcceleration:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicate whether to enable acceleration for the VPN connection.
Default: false
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.
Default: false
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
The type of IPv4 address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
The transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpnConnectionResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateVpnConnectionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateVpnConnection - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateVpnConnectionRoute: get: x-aws-operation-name: CreateVpnConnectionRoute operationId: GET_CreateVpnConnectionRoute description: '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.
' responses: '200': description: Success parameters: - name: DestinationCidrBlock in: query required: true description: The CIDR block associated with the local subnet of the customer network. schema: type: string - name: VpnConnectionId in: query required: true description: The ID of the VPN connection. schema: type: string - name: Action in: query required: true schema: type: string enum: - CreateVpnConnectionRoute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: CreateVpnConnectionRoute operationId: POST_CreateVpnConnectionRoute description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateVpnConnectionRouteRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateVpnConnectionRoute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=CreateVpnGateway: get: x-aws-operation-name: CreateVpnGateway operationId: GET_CreateVpnGateway description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpnGatewayResult' parameters: - name: AvailabilityZone in: query required: false description: The Availability Zone for the virtual private gateway. schema: type: string - name: Type in: query required: true description: The type of VPN connection this virtual private gateway supports. schema: type: string enum: - ipsec.1 - name: TagSpecification in: query required: false description: The tags to apply to the virtual private gateway. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: AmazonSideAsn in: query required: false description: '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
' schema: type: integer - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- CreateVpnGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: CreateVpnGateway
operationId: POST_CreateVpnGateway
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/CreateVpnGatewayResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/CreateVpnGatewayRequest' parameters: - name: Action in: query required: true schema: type: string enum: - CreateVpnGateway - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteCarrierGateway: get: x-aws-operation-name: DeleteCarrierGateway operationId: GET_DeleteCarrierGateway description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCarrierGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteCarrierGateway
operationId: POST_DeleteCarrierGateway
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteClientVpnEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteClientVpnEndpoint
operationId: POST_DeleteClientVpnEndpoint
description: Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClientVpnEndpointResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClientVpnEndpointRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteClientVpnEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteClientVpnRoute:
get:
x-aws-operation-name: DeleteClientVpnRoute
operationId: GET_DeleteClientVpnRoute
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClientVpnRouteResult'
parameters:
- name: ClientVpnEndpointId
in: query
required: true
description: The ID of the Client VPN endpoint from which the route is to be deleted.
schema:
type: string
- name: TargetVpcSubnetId
in: query
required: false
description: The ID of the target subnet used by the route.
schema:
type: string
- name: DestinationCidrBlock
in: query
required: true
description: 'The IPv4 address range, in CIDR notation, of the route to be deleted.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteClientVpnRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteClientVpnRoute
operationId: POST_DeleteClientVpnRoute
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClientVpnRouteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteClientVpnRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteClientVpnRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteCoipCidr:
get:
x-aws-operation-name: DeleteCoipCidr
operationId: GET_DeleteCoipCidr
description: ' Deletes a range of customer-owned IP addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteCoipCidrResult'
parameters:
- name: Cidr
in: query
required: true
description: ' A customer-owned IP address range that you want to delete. '
schema:
type: string
- name: CoipPoolId
in: query
required: true
description: ' The ID of the customer-owned address pool. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteCoipCidr
operationId: POST_DeleteCoipCidr
description: ' Deletes a range of customer-owned IP addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteCoipCidrResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteCoipCidrRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteCoipPool:
get:
x-aws-operation-name: DeleteCoipPool
operationId: GET_DeleteCoipPool
description: 'Deletes a pool of customer-owned IP (CoIP) addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteCoipPoolResult'
parameters:
- name: CoipPoolId
in: query
required: true
description: 'The ID of the CoIP pool that you want to delete. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCoipPool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteCoipPool
operationId: POST_DeleteCoipPool
description: 'Deletes a pool of customer-owned IP (CoIP) addresses. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteCoipPoolResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteCoipPoolRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCoipPool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteCustomerGateway:
get:
x-aws-operation-name: DeleteCustomerGateway
operationId: GET_DeleteCustomerGateway
description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
responses:
'200':
description: Success
parameters:
- name: CustomerGatewayId
in: query
required: true
description: The ID of the customer gateway.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCustomerGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteCustomerGateway
operationId: POST_DeleteCustomerGateway
description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteCustomerGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteCustomerGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteDhcpOptions:
get:
x-aws-operation-name: DeleteDhcpOptions
operationId: GET_DeleteDhcpOptions
description: 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.
responses:
'200':
description: Success
parameters:
- name: DhcpOptionsId
in: query
required: true
description: The ID of the DHCP options set.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteDhcpOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteDhcpOptions
operationId: POST_DeleteDhcpOptions
description: 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.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteDhcpOptionsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteDhcpOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteEgressOnlyInternetGateway:
get:
x-aws-operation-name: DeleteEgressOnlyInternetGateway
operationId: GET_DeleteEgressOnlyInternetGateway
description: Deletes an egress-only internet gateway.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EgressOnlyInternetGatewayId
in: query
required: true
description: The ID of the egress-only internet gateway.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteEgressOnlyInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteEgressOnlyInternetGateway
operationId: POST_DeleteEgressOnlyInternetGateway
description: Deletes an egress-only internet gateway.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteEgressOnlyInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteFleets:
get:
x-aws-operation-name: DeleteFleets
operationId: GET_DeleteFleets
description: '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. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteFleetsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FleetId
in: query
required: true
description: The IDs of the EC2 Fleets.
schema:
type: array
items:
$ref: '#/components/schemas/FleetId'
- name: TerminateInstances
in: query
required: true
description: '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.
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. A deleted instant fleet with running instances is not supported.
Restrictions
You can delete up to 25 instant fleets in a single request. If you exceed this number, no instant fleets are deleted and an error is returned. There is no restriction on the number of fleets of type maintain or request that can be deleted in a single request.
Up to 1000 instances can be terminated in a single request to delete instant fleets.
For more information, see Delete an EC2 Fleet in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteFleetsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteFleetsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteFleets - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteFlowLogs: get: x-aws-operation-name: DeleteFlowLogs operationId: GET_DeleteFlowLogs description: Deletes one or more flow logs. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteFlowLogsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FlowLogId
in: query
required: true
description: 'One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' schema: type: array items: allOf: - $ref: '#/components/schemas/VpcFlowLogId' - xml: name: item - name: Action in: query required: true schema: type: string enum: - DeleteFlowLogs - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DeleteFlowLogs operationId: POST_DeleteFlowLogs description: Deletes one or more flow logs. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteFlowLogsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteFlowLogsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteFlowLogs - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteFpgaImage: get: x-aws-operation-name: DeleteFpgaImage operationId: GET_DeleteFpgaImage description: Deletes the specified Amazon FPGA Image (AFI). responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteFpgaImageResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FpgaImageId
in: query
required: true
description: The ID of the AFI.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteFpgaImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteFpgaImage
operationId: POST_DeleteFpgaImage
description: Deletes the specified Amazon FPGA Image (AFI).
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteFpgaImageResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteFpgaImageRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteFpgaImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteInstanceConnectEndpoint:
get:
x-aws-operation-name: DeleteInstanceConnectEndpoint
operationId: GET_DeleteInstanceConnectEndpoint
description: Deletes the specified EC2 Instance Connect Endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteInstanceConnectEndpointResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceConnectEndpointId
in: query
required: true
description: The ID of the EC2 Instance Connect Endpoint to delete.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteInstanceConnectEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteInstanceConnectEndpoint
operationId: POST_DeleteInstanceConnectEndpoint
description: Deletes the specified EC2 Instance Connect Endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteInstanceConnectEndpointResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteInstanceConnectEndpointRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteInstanceConnectEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteInstanceEventWindow:
get:
x-aws-operation-name: DeleteInstanceEventWindow
operationId: GET_DeleteInstanceEventWindow
description: 'Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteInstanceEventWindowResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ForceDelete
in: query
required: false
description: Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.
schema:
type: boolean
- name: InstanceEventWindowId
in: query
required: true
description: The ID of the event window.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteInstanceEventWindow
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteInstanceEventWindow
operationId: POST_DeleteInstanceEventWindow
description: 'Deletes the specified event window.
For more information, see Define event windows for scheduled events in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteInstanceEventWindowResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteInstanceEventWindowRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteInstanceEventWindow - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteInternetGateway: get: x-aws-operation-name: DeleteInternetGateway operationId: GET_DeleteInternetGateway description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. responses: '200': description: Success parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InternetGatewayId
in: query
required: true
description: The ID of the internet gateway.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteInternetGateway
operationId: POST_DeleteInternetGateway
description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteInternetGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteIpam:
get:
x-aws-operation-name: DeleteIpam
operationId: GET_DeleteIpam
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamId
in: query
required: true
description: The ID of the IPAM to delete.
schema:
type: string
- name: Cascade
in: query
required: false
description: '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.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteIpam - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteIpamPool: get: x-aws-operation-name: DeleteIpamPool operationId: GET_DeleteIpamPool description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamPoolResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the pool to delete.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteIpamPool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteIpamPool
operationId: POST_DeleteIpamPool
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamPoolResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamPoolRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteIpamPool - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteIpamResourceDiscovery: get: x-aws-operation-name: DeleteIpamResourceDiscovery operationId: GET_DeleteIpamResourceDiscovery description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamResourceDiscoveryResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamResourceDiscoveryId
in: query
required: true
description: The IPAM resource discovery ID.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteIpamResourceDiscovery
operationId: POST_DeleteIpamResourceDiscovery
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteIpamResourceDiscoveryResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteIpamResourceDiscoveryRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteIpamScope:
get:
x-aws-operation-name: DeleteIpamScope
operationId: GET_DeleteIpamScope
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamScopeResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamScopeId
in: query
required: true
description: The ID of the scope to delete.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteIpamScope
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteIpamScope
operationId: POST_DeleteIpamScope
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamScopeResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteIpamScopeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteIpamScope - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteKeyPair: get: x-aws-operation-name: DeleteKeyPair operationId: GET_DeleteKeyPair description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.' responses: '200': description: Success parameters: - name: KeyName in: query required: false description: The name of the key pair. schema: type: string - name: KeyPairId in: query required: false description: The ID of the key pair. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteKeyPair
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteKeyPair
operationId: POST_DeleteKeyPair
description: 'Deletes the specified key pair, by removing the public key from Amazon EC2.'
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteKeyPairRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteKeyPair
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteLaunchTemplate:
get:
x-aws-operation-name: DeleteLaunchTemplate
operationId: GET_DeleteLaunchTemplate
description: Deletes a launch template. Deleting a launch template deletes all of its versions.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLaunchTemplateResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: LaunchTemplateId
in: query
required: false
description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: LaunchTemplateId
in: query
required: false
description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: DestinationPrefixListId
in: query
required: false
description: ' Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request. '
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteLocalGatewayRoute
operationId: POST_DeleteLocalGatewayRoute
description: Deletes the specified route from the specified local gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteLocalGatewayRouteTable:
get:
x-aws-operation-name: DeleteLocalGatewayRouteTable
operationId: GET_DeleteLocalGatewayRouteTable
description: ' Deletes a local gateway route table. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableResult'
parameters:
- name: LocalGatewayRouteTableId
in: query
required: true
description: ' The ID of the local gateway route table. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteLocalGatewayRouteTable
operationId: POST_DeleteLocalGatewayRouteTable
description: ' Deletes a local gateway route table. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation:
get:
x-aws-operation-name: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
operationId: GET_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
description: ' Deletes a local gateway route table virtual interface group association. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult'
parameters:
- name: LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
in: query
required: true
description: ' The ID of the local gateway route table virtual interface group association. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
operationId: POST_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
description: ' Deletes a local gateway route table virtual interface group association. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteLocalGatewayRouteTableVpcAssociation:
get:
x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation
operationId: GET_DeleteLocalGatewayRouteTableVpcAssociation
description: Deletes the specified association between a VPC and local gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult'
parameters:
- name: LocalGatewayRouteTableVpcAssociationId
in: query
required: true
description: The ID of the association.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRouteTableVpcAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteLocalGatewayRouteTableVpcAssociation
operationId: POST_DeleteLocalGatewayRouteTableVpcAssociation
description: Deletes the specified association between a VPC and local gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteLocalGatewayRouteTableVpcAssociationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteLocalGatewayRouteTableVpcAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteManagedPrefixList:
get:
x-aws-operation-name: DeleteManagedPrefixList
operationId: GET_DeleteManagedPrefixList
description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteManagedPrefixListResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteManagedPrefixList
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteManagedPrefixList
operationId: POST_DeleteManagedPrefixList
description: Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteManagedPrefixListResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteManagedPrefixListRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteManagedPrefixList
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNatGateway:
get:
x-aws-operation-name: DeleteNatGateway
operationId: GET_DeleteNatGateway
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNatGatewayResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NatGatewayId
in: query
required: true
description: The ID of the NAT gateway.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNatGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNatGateway
operationId: POST_DeleteNatGateway
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNatGatewayResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNatGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNatGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkAcl:
get:
x-aws-operation-name: DeleteNetworkAcl
operationId: GET_DeleteNetworkAcl
description: 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.
responses:
'200':
description: Success
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkAclId
in: query
required: true
description: The ID of the network ACL.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkAcl
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkAcl
operationId: POST_DeleteNetworkAcl
description: 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.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkAclRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkAcl
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkAclEntry:
get:
x-aws-operation-name: DeleteNetworkAclEntry
operationId: GET_DeleteNetworkAclEntry
description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
responses:
'200':
description: Success
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Egress
in: query
required: true
description: Indicates whether the rule is an egress rule.
schema:
type: boolean
- name: NetworkAclId
in: query
required: true
description: The ID of the network ACL.
schema:
type: string
- name: RuleNumber
in: query
required: true
description: The rule number of the entry to delete.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkAclEntry
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkAclEntry
operationId: POST_DeleteNetworkAclEntry
description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkAclEntryRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkAclEntry
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkInsightsAccessScope:
get:
x-aws-operation-name: DeleteNetworkInsightsAccessScope
operationId: GET_DeleteNetworkInsightsAccessScope
description: Deletes the specified Network Access Scope.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInsightsAccessScopeId
in: query
required: true
description: The ID of the Network Access Scope.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsAccessScope
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkInsightsAccessScope
operationId: POST_DeleteNetworkInsightsAccessScope
description: Deletes the specified Network Access Scope.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsAccessScope
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkInsightsAccessScopeAnalysis:
get:
x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis
operationId: GET_DeleteNetworkInsightsAccessScopeAnalysis
description: Deletes the specified Network Access Scope analysis.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult'
parameters:
- name: NetworkInsightsAccessScopeAnalysisId
in: query
required: true
description: The ID of the Network Access Scope analysis.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsAccessScopeAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkInsightsAccessScopeAnalysis
operationId: POST_DeleteNetworkInsightsAccessScopeAnalysis
description: Deletes the specified Network Access Scope analysis.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAccessScopeAnalysisRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsAccessScopeAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkInsightsAnalysis:
get:
x-aws-operation-name: DeleteNetworkInsightsAnalysis
operationId: GET_DeleteNetworkInsightsAnalysis
description: Deletes the specified network insights analysis.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInsightsAnalysisId
in: query
required: true
description: The ID of the network insights analysis.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkInsightsAnalysis
operationId: POST_DeleteNetworkInsightsAnalysis
description: Deletes the specified network insights analysis.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAnalysisResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsAnalysisRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkInsightsPath:
get:
x-aws-operation-name: DeleteNetworkInsightsPath
operationId: GET_DeleteNetworkInsightsPath
description: Deletes the specified path.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsPathResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInsightsPathId
in: query
required: true
description: The ID of the path.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsPath
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkInsightsPath
operationId: POST_DeleteNetworkInsightsPath
description: Deletes the specified path.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsPathResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInsightsPathRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInsightsPath
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkInterface:
get:
x-aws-operation-name: DeleteNetworkInterface
operationId: GET_DeleteNetworkInterface
description: Deletes the specified network interface. You must detach the network interface before you can delete it.
responses:
'200':
description: Success
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInterfaceId
in: query
required: true
description: The ID of the network interface.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInterface
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkInterface
operationId: POST_DeleteNetworkInterface
description: Deletes the specified network interface. You must detach the network interface before you can delete it.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInterfaceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInterface
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteNetworkInterfacePermission:
get:
x-aws-operation-name: DeleteNetworkInterfacePermission
operationId: GET_DeleteNetworkInterfacePermission
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
parameters:
- name: NetworkInterfacePermissionId
in: query
required: true
description: The ID of the network interface permission.
schema:
type: string
- name: Force
in: query
required: false
description: Specify true to remove the permission even if the network interface is attached to an instance.
schema:
type: boolean
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInterfacePermission
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteNetworkInterfacePermission
operationId: POST_DeleteNetworkInterfacePermission
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteNetworkInterfacePermissionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteNetworkInterfacePermission
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeletePlacementGroup:
get:
x-aws-operation-name: DeletePlacementGroup
operationId: GET_DeletePlacementGroup
description: '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.'
responses:
'200':
description: Success
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupName
in: query
required: true
description: The name of the placement group.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeletePlacementGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeletePlacementGroup
operationId: POST_DeletePlacementGroup
description: '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.'
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeletePlacementGroupRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeletePlacementGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeletePublicIpv4Pool:
get:
x-aws-operation-name: DeletePublicIpv4Pool
operationId: GET_DeletePublicIpv4Pool
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeletePublicIpv4PoolResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: PoolId
in: query
required: true
description: The ID of the public IPv4 pool you want to delete.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeletePublicIpv4Pool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeletePublicIpv4Pool
operationId: POST_DeletePublicIpv4Pool
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeletePublicIpv4PoolResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeletePublicIpv4PoolRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeletePublicIpv4Pool
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteQueuedReservedInstances:
get:
x-aws-operation-name: DeleteQueuedReservedInstances
operationId: GET_DeleteQueuedReservedInstances
description: Deletes the queued purchases for the specified Reserved Instances.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteQueuedReservedInstancesResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ReservedInstancesId
in: query
required: true
description: The IDs of the Reserved Instances.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservationId'
- xml:
name: item
minItems: 1
maxItems: 100
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteQueuedReservedInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteQueuedReservedInstances
operationId: POST_DeleteQueuedReservedInstances
description: Deletes the queued purchases for the specified Reserved Instances.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteQueuedReservedInstancesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteQueuedReservedInstancesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteQueuedReservedInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteRoute:
get:
x-aws-operation-name: DeleteRoute
operationId: GET_DeleteRoute
description: Deletes the specified route from the specified route table.
responses:
'200':
description: Success
parameters:
- name: DestinationCidrBlock
in: query
required: false
description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
schema:
type: string
- name: DestinationIpv6CidrBlock
in: query
required: false
description: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
schema:
type: string
- name: DestinationPrefixListId
in: query
required: false
description: The ID of the prefix list for the route.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: RouteTableId
in: query
required: true
description: The ID of the route table.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteRoute
operationId: POST_DeleteRoute
description: Deletes the specified route from the specified route table.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteRouteTable:
get:
x-aws-operation-name: DeleteRouteTable
operationId: GET_DeleteRouteTable
description: 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.
responses:
'200':
description: Success
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: RouteTableId
in: query
required: true
description: The ID of the route table.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteRouteTable
operationId: POST_DeleteRouteTable
description: 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.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteRouteTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteSecurityGroup:
get:
x-aws-operation-name: DeleteSecurityGroup
operationId: GET_DeleteSecurityGroup
description: 'Deletes a security group.
If you attempt to delete a security group that is associated with an instance or network interface or is referenced by another security group, the operation fails with DependencyViolation.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSecurityGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteSecurityGroup
operationId: POST_DeleteSecurityGroup
description: 'Deletes a security group.
If you attempt to delete a security group that is associated with an instance or network interface or is referenced by another security group, the operation fails with DependencyViolation.
Deletes the specified snapshot.
When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume.
You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first de-register the AMI before you can delete the snapshot.
For more information, see Delete an Amazon EBS snapshot in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success parameters: - name: SnapshotId in: query required: true description: The ID of the EBS snapshot. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSnapshot
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteSnapshot
operationId: POST_DeleteSnapshot
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteSnapshotRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteSnapshot - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteSpotDatafeedSubscription: get: x-aws-operation-name: DeleteSpotDatafeedSubscription operationId: GET_DeleteSpotDatafeedSubscription description: Deletes the data feed for Spot Instances. responses: '200': description: Success parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSpotDatafeedSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteSpotDatafeedSubscription
operationId: POST_DeleteSpotDatafeedSubscription
description: Deletes the data feed for Spot Instances.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteSpotDatafeedSubscriptionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSpotDatafeedSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteSubnet:
get:
x-aws-operation-name: DeleteSubnet
operationId: GET_DeleteSubnet
description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
responses:
'200':
description: Success
parameters:
- name: SubnetId
in: query
required: true
description: The ID of the subnet.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSubnet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteSubnet
operationId: POST_DeleteSubnet
description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteSubnetRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSubnet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteSubnetCidrReservation:
get:
x-aws-operation-name: DeleteSubnetCidrReservation
operationId: GET_DeleteSubnetCidrReservation
description: Deletes a subnet CIDR reservation.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteSubnetCidrReservationResult'
parameters:
- name: SubnetCidrReservationId
in: query
required: true
description: The ID of the subnet CIDR reservation.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSubnetCidrReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteSubnetCidrReservation
operationId: POST_DeleteSubnetCidrReservation
description: Deletes a subnet CIDR reservation.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteSubnetCidrReservationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteSubnetCidrReservationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteSubnetCidrReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTags:
get:
x-aws-operation-name: DeleteTags
operationId: GET_DeleteTags
description: '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.
' responses: '200': description: Success parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ResourceId
in: query
required: true
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' schema: type: array items: $ref: '#/components/schemas/TaggableResourceId' - name: Tag in: query required: false description: '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.
' schema: type: array items: allOf: - $ref: '#/components/schemas/Tag' - xml: name: item - name: Action in: query required: true schema: type: string enum: - DeleteTags - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DeleteTags operationId: POST_DeleteTags description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteTagsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteTags - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteTrafficMirrorFilter: get: x-aws-operation-name: DeleteTrafficMirrorFilter operationId: GET_DeleteTrafficMirrorFilter description:Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' parameters: - name: TrafficMirrorFilterId in: query required: true description: The ID of the Traffic Mirror filter. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTrafficMirrorFilter
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTrafficMirrorFilter
operationId: POST_DeleteTrafficMirrorFilter
description: Deletes the specified Traffic Mirror filter.
You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteTrafficMirrorFilterResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteTrafficMirrorFilterRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteTrafficMirrorFilter - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteTrafficMirrorFilterRule: get: x-aws-operation-name: DeleteTrafficMirrorFilterRule operationId: GET_DeleteTrafficMirrorFilterRule description: Deletes the specified Traffic Mirror rule. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult' parameters: - name: TrafficMirrorFilterRuleId in: query required: true description: The ID of the Traffic Mirror rule. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTrafficMirrorFilterRule
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTrafficMirrorFilterRule
operationId: POST_DeleteTrafficMirrorFilterRule
description: Deletes the specified Traffic Mirror rule.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTrafficMirrorFilterRuleRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTrafficMirrorFilterRule
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTrafficMirrorSession:
get:
x-aws-operation-name: DeleteTrafficMirrorSession
operationId: GET_DeleteTrafficMirrorSession
description: Deletes the specified Traffic Mirror session.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTrafficMirrorSessionResult'
parameters:
- name: TrafficMirrorSessionId
in: query
required: true
description: The ID of the Traffic Mirror session.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTrafficMirrorSession
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTrafficMirrorSession
operationId: POST_DeleteTrafficMirrorSession
description: Deletes the specified Traffic Mirror session.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTrafficMirrorSessionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTrafficMirrorSessionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTrafficMirrorSession
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTrafficMirrorTarget:
get:
x-aws-operation-name: DeleteTrafficMirrorTarget
operationId: GET_DeleteTrafficMirrorTarget
description: Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' parameters: - name: TrafficMirrorTargetId in: query required: true description: The ID of the Traffic Mirror target. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTrafficMirrorTarget
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTrafficMirrorTarget
operationId: POST_DeleteTrafficMirrorTarget
description: Deletes the specified Traffic Mirror target.
You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteTrafficMirrorTargetResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteTrafficMirrorTargetRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteTrafficMirrorTarget - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteTransitGateway: get: x-aws-operation-name: DeleteTransitGateway operationId: GET_DeleteTransitGateway description: Deletes the specified transit gateway. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteTransitGatewayResult' parameters: - name: TransitGatewayId in: query required: true description: The ID of the transit gateway. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGateway
operationId: POST_DeleteTransitGateway
description: Deletes the specified transit gateway.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayConnect:
get:
x-aws-operation-name: DeleteTransitGatewayConnect
operationId: GET_DeleteTransitGatewayConnect
description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayConnectResult'
parameters:
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the Connect attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayConnect
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayConnect
operationId: POST_DeleteTransitGatewayConnect
description: Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayConnectResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayConnectRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayConnect
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayConnectPeer:
get:
x-aws-operation-name: DeleteTransitGatewayConnectPeer
operationId: GET_DeleteTransitGatewayConnectPeer
description: Deletes the specified Connect peer.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult'
parameters:
- name: TransitGatewayConnectPeerId
in: query
required: true
description: The ID of the Connect peer.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayConnectPeer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayConnectPeer
operationId: POST_DeleteTransitGatewayConnectPeer
description: Deletes the specified Connect peer.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayConnectPeerResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayConnectPeerRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayConnectPeer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayMulticastDomain:
get:
x-aws-operation-name: DeleteTransitGatewayMulticastDomain
operationId: GET_DeleteTransitGatewayMulticastDomain
description: Deletes the specified transit gateway multicast domain.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult'
parameters:
- name: TransitGatewayMulticastDomainId
in: query
required: true
description: The ID of the transit gateway multicast domain.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayMulticastDomain
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayMulticastDomain
operationId: POST_DeleteTransitGatewayMulticastDomain
description: Deletes the specified transit gateway multicast domain.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayMulticastDomainRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayMulticastDomain
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayPeeringAttachment:
get:
x-aws-operation-name: DeleteTransitGatewayPeeringAttachment
operationId: GET_DeleteTransitGatewayPeeringAttachment
description: Deletes a transit gateway peering attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult'
parameters:
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the transit gateway peering attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayPeeringAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayPeeringAttachment
operationId: POST_DeleteTransitGatewayPeeringAttachment
description: Deletes a transit gateway peering attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPeeringAttachmentRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayPeeringAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayPolicyTable:
get:
x-aws-operation-name: DeleteTransitGatewayPolicyTable
operationId: GET_DeleteTransitGatewayPolicyTable
description: Deletes the specified transit gateway policy table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPolicyTableResult'
parameters:
- name: TransitGatewayPolicyTableId
in: query
required: true
description: The transit gateway policy table to delete.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayPolicyTable
operationId: POST_DeleteTransitGatewayPolicyTable
description: Deletes the specified transit gateway policy table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPolicyTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPolicyTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayPrefixListReference:
get:
x-aws-operation-name: DeleteTransitGatewayPrefixListReference
operationId: GET_DeleteTransitGatewayPrefixListReference
description: Deletes a reference (route) to a prefix list in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the route table.
schema:
type: string
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayPrefixListReference
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayPrefixListReference
operationId: POST_DeleteTransitGatewayPrefixListReference
description: Deletes a reference (route) to a prefix list in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayPrefixListReferenceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayPrefixListReference
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayRoute:
get:
x-aws-operation-name: DeleteTransitGatewayRoute
operationId: GET_DeleteTransitGatewayRoute
description: Deletes the specified route from the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: DestinationCidrBlock
in: query
required: true
description: The CIDR range for the route. This must match the CIDR for the route exactly.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayRoute
operationId: POST_DeleteTransitGatewayRoute
description: Deletes the specified route from the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayRouteTable:
get:
x-aws-operation-name: DeleteTransitGatewayRouteTable
operationId: GET_DeleteTransitGatewayRouteTable
description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayRouteTable
operationId: POST_DeleteTransitGatewayRouteTable
description: Deletes the specified transit gateway route table. You must disassociate the route table from any transit gateway route tables before you can delete it.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayRouteTableAnnouncement:
get:
x-aws-operation-name: DeleteTransitGatewayRouteTableAnnouncement
operationId: GET_DeleteTransitGatewayRouteTableAnnouncement
description: Advertises to the transit gateway that a transit gateway route table is deleted.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableAnnouncementResult'
parameters:
- name: TransitGatewayRouteTableAnnouncementId
in: query
required: true
description: 'The transit gateway route table ID that''s being deleted. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayRouteTableAnnouncement
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayRouteTableAnnouncement
operationId: POST_DeleteTransitGatewayRouteTableAnnouncement
description: Advertises to the transit gateway that a transit gateway route table is deleted.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableAnnouncementResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableAnnouncementRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayRouteTableAnnouncement
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteTransitGatewayVpcAttachment:
get:
x-aws-operation-name: DeleteTransitGatewayVpcAttachment
operationId: GET_DeleteTransitGatewayVpcAttachment
description: Deletes the specified VPC attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
parameters:
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayVpcAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteTransitGatewayVpcAttachment
operationId: POST_DeleteTransitGatewayVpcAttachment
description: Deletes the specified VPC attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteTransitGatewayVpcAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVerifiedAccessEndpoint:
get:
x-aws-operation-name: DeleteVerifiedAccessEndpoint
operationId: GET_DeleteVerifiedAccessEndpoint
description: Delete an Amazon Web Services Verified Access endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessEndpointResult'
parameters:
- name: VerifiedAccessEndpointId
in: query
required: true
description: The ID of the Verified Access endpoint.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVerifiedAccessEndpoint
operationId: POST_DeleteVerifiedAccessEndpoint
description: Delete an Amazon Web Services Verified Access endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessEndpointResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessEndpointRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVerifiedAccessGroup:
get:
x-aws-operation-name: DeleteVerifiedAccessGroup
operationId: GET_DeleteVerifiedAccessGroup
description: Delete an Amazon Web Services Verified Access group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessGroupResult'
parameters:
- name: VerifiedAccessGroupId
in: query
required: true
description: The ID of the Verified Access group.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVerifiedAccessGroup
operationId: POST_DeleteVerifiedAccessGroup
description: Delete an Amazon Web Services Verified Access group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessGroupResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessGroupRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVerifiedAccessInstance:
get:
x-aws-operation-name: DeleteVerifiedAccessInstance
operationId: GET_DeleteVerifiedAccessInstance
description: Delete an Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessInstanceResult'
parameters:
- name: VerifiedAccessInstanceId
in: query
required: true
description: The ID of the Verified Access instance.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVerifiedAccessInstance
operationId: POST_DeleteVerifiedAccessInstance
description: Delete an Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessInstanceResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessInstanceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVerifiedAccessTrustProvider:
get:
x-aws-operation-name: DeleteVerifiedAccessTrustProvider
operationId: GET_DeleteVerifiedAccessTrustProvider
description: Delete an Amazon Web Services Verified Access trust provider.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessTrustProviderResult'
parameters:
- name: VerifiedAccessTrustProviderId
in: query
required: true
description: The ID of the Verified Access trust provider.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVerifiedAccessTrustProvider
operationId: POST_DeleteVerifiedAccessTrustProvider
description: Delete an Amazon Web Services Verified Access trust provider.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessTrustProviderResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVerifiedAccessTrustProviderRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVolume:
get:
x-aws-operation-name: DeleteVolume
operationId: GET_DeleteVolume
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success parameters: - name: VolumeId in: query required: true description: The ID of the volume. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVolume
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVolume
operationId: POST_DeleteVolume
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteVolumeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteVolume - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteVpc: get: x-aws-operation-name: DeleteVpc operationId: GET_DeleteVpc description: '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.' responses: '200': description: Success parameters: - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpc
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVpc
operationId: POST_DeleteVpc
description: '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.'
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpc
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVpcEndpointConnectionNotifications:
get:
x-aws-operation-name: DeleteVpcEndpointConnectionNotifications
operationId: GET_DeleteVpcEndpointConnectionNotifications
description: Deletes the specified VPC endpoint connection notifications.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ConnectionNotificationId
in: query
required: true
description: The IDs of the notifications.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpcEndpointConnectionNotifications
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVpcEndpointConnectionNotifications
operationId: POST_DeleteVpcEndpointConnectionNotifications
description: Deletes the specified VPC endpoint connection notifications.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpcEndpointConnectionNotifications
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVpcEndpointServiceConfigurations:
get:
x-aws-operation-name: DeleteVpcEndpointServiceConfigurations
operationId: GET_DeleteVpcEndpointServiceConfigurations
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The IDs of the services.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpcEndpointServiceConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVpcEndpointServiceConfigurations
operationId: POST_DeleteVpcEndpointServiceConfigurations
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpcEndpointServiceConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVpcEndpoints:
get:
x-aws-operation-name: DeleteVpcEndpoints
operationId: GET_DeleteVpcEndpoints
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteVpcEndpointsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcEndpointId
in: query
required: true
description: The IDs of the VPC endpoints.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpcEndpoints
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVpcEndpoints
operationId: POST_DeleteVpcEndpoints
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeleteVpcEndpointsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteVpcEndpointsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteVpcEndpoints - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteVpcPeeringConnection: get: x-aws-operation-name: DeleteVpcPeeringConnection operationId: GET_DeleteVpcPeeringConnection description: 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 theactive 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 state.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
required: true
description: The ID of the VPC peering connection.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpcPeeringConnection
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVpcPeeringConnection
operationId: POST_DeleteVpcPeeringConnection
description: 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 state.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpcPeeringConnectionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpcPeeringConnection
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeleteVpnConnection:
get:
x-aws-operation-name: DeleteVpnConnection
operationId: GET_DeleteVpnConnection
description: '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.
' responses: '200': description: Success parameters: - name: VpnConnectionId in: query required: true description: The ID of the VPN connection. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpnConnection
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVpnConnection
operationId: POST_DeleteVpnConnection
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteVpnConnectionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteVpnConnection - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteVpnConnectionRoute: get: x-aws-operation-name: DeleteVpnConnectionRoute operationId: GET_DeleteVpnConnectionRoute description: 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. responses: '200': description: Success parameters: - name: DestinationCidrBlock in: query required: true description: The CIDR block associated with the local subnet of the customer network. schema: type: string - name: VpnConnectionId in: query required: true description: The ID of the VPN connection. schema: type: string - name: Action in: query required: true schema: type: string enum: - DeleteVpnConnectionRoute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DeleteVpnConnectionRoute operationId: POST_DeleteVpnConnectionRoute description: 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. responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeleteVpnConnectionRouteRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeleteVpnConnectionRoute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeleteVpnGateway: get: x-aws-operation-name: DeleteVpnGateway operationId: GET_DeleteVpnGateway description: 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. responses: '200': description: Success parameters: - name: VpnGatewayId in: query required: true description: The ID of the virtual private gateway. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpnGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeleteVpnGateway
operationId: POST_DeleteVpnGateway
description: 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.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeleteVpnGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeleteVpnGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeprovisionByoipCidr:
get:
x-aws-operation-name: DeprovisionByoipCidr
operationId: GET_DeprovisionByoipCidr
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeprovisionByoipCidrResult' parameters: - name: Cidr in: query required: true description: 'The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeprovisionByoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeprovisionByoipCidr
operationId: POST_DeprovisionByoipCidr
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeprovisionByoipCidrResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeprovisionByoipCidrRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeprovisionByoipCidr - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeprovisionIpamPoolCidr: get: x-aws-operation-name: DeprovisionIpamPoolCidr operationId: GET_DeprovisionIpamPoolCidr description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeprovisionIpamPoolCidrResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the pool that has the CIDR you want to deprovision.
schema:
type: string
- name: Cidr
in: query
required: false
description: The CIDR which you want to deprovision from the pool.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeprovisionIpamPoolCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeprovisionIpamPoolCidr
operationId: POST_DeprovisionIpamPoolCidr
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeprovisionIpamPoolCidrResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeprovisionIpamPoolCidrRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeprovisionIpamPoolCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeprovisionPublicIpv4PoolCidr:
get:
x-aws-operation-name: DeprovisionPublicIpv4PoolCidr
operationId: GET_DeprovisionPublicIpv4PoolCidr
description: Deprovision a CIDR from a public IPv4 pool.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: PoolId
in: query
required: true
description: The ID of the pool that you want to deprovision the CIDR from.
schema:
type: string
- name: Cidr
in: query
required: true
description: 'The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeprovisionPublicIpv4PoolCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeprovisionPublicIpv4PoolCidr
operationId: POST_DeprovisionPublicIpv4PoolCidr
description: Deprovision a CIDR from a public IPv4 pool.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeprovisionPublicIpv4PoolCidrRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeprovisionPublicIpv4PoolCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeregisterImage:
get:
x-aws-operation-name: DeregisterImage
operationId: GET_DeregisterImage
description: '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.
' responses: '200': description: Success parameters: - name: ImageId in: query required: true description: The ID of the AMI. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeregisterImage
operationId: POST_DeregisterImage
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DeregisterImageRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DeregisterImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DeregisterInstanceEventNotificationAttributes: get: x-aws-operation-name: DeregisterInstanceEventNotificationAttributes operationId: GET_DeregisterInstanceEventNotificationAttributes description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceTagAttribute
in: query
required: true
description: Information about the tag keys to deregister.
schema:
type: object
properties:
IncludeAllTagsOfInstance:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
InstanceTagKeys:
allOf:
- $ref: '#/components/schemas/InstanceTagKeySet'
- xml:
name: InstanceTagKey
description: Information about the tag keys to deregister.
description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterInstanceEventNotificationAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeregisterInstanceEventNotificationAttributes
operationId: POST_DeregisterInstanceEventNotificationAttributes
description: Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterInstanceEventNotificationAttributesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterInstanceEventNotificationAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeregisterTransitGatewayMulticastGroupMembers:
get:
x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers
operationId: GET_DeregisterTransitGatewayMulticastGroupMembers
description: Deregisters the specified members (network interfaces) from the transit gateway multicast group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult'
parameters:
- name: TransitGatewayMulticastDomainId
in: query
required: false
description: The ID of the transit gateway multicast domain.
schema:
type: string
- name: GroupIpAddress
in: query
required: false
description: The IP address assigned to the transit gateway multicast group.
schema:
type: string
- name: NetworkInterfaceIds
in: query
required: false
description: The IDs of the group members' network interfaces.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterTransitGatewayMulticastGroupMembers
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeregisterTransitGatewayMulticastGroupMembers
operationId: POST_DeregisterTransitGatewayMulticastGroupMembers
description: Deregisters the specified members (network interfaces) from the transit gateway multicast group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupMembersRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterTransitGatewayMulticastGroupMembers
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DeregisterTransitGatewayMulticastGroupSources:
get:
x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources
operationId: GET_DeregisterTransitGatewayMulticastGroupSources
description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult'
parameters:
- name: TransitGatewayMulticastDomainId
in: query
required: false
description: The ID of the transit gateway multicast domain.
schema:
type: string
- name: GroupIpAddress
in: query
required: false
description: The IP address assigned to the transit gateway multicast group.
schema:
type: string
- name: NetworkInterfaceIds
in: query
required: false
description: The IDs of the group sources' network interfaces.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterTransitGatewayMulticastGroupSources
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DeregisterTransitGatewayMulticastGroupSources
operationId: POST_DeregisterTransitGatewayMulticastGroupSources
description: Deregisters the specified sources (network interfaces) from the transit gateway multicast group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DeregisterTransitGatewayMulticastGroupSourcesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DeregisterTransitGatewayMulticastGroupSources
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeAccountAttributes:
get:
x-aws-operation-name: DescribeAccountAttributes
operationId: GET_DescribeAccountAttributes
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAccountAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeAccountAttributes
operationId: POST_DescribeAccountAttributes
description: '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.
Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for three days after the transfers have been accepted.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeAddressTransfersResult' parameters: - name: AllocationId in: query required: false description: The allocation IDs of Elastic IP addresses. schema: type: array items: allOf: - $ref: '#/components/schemas/AllocationId' - xml: name: AllocationId - name: NextToken in: query required: false description: Specify the pagination token from a previous request to retrieve the next page of results. schema: type: string - name: MaxResults in: query required: false description: The maximum number of address transfers to return in one page of results. schema: type: integer minimum: 5 maximum: 1000 - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAddressTransfers
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeAddressTransfers
operationId: POST_DescribeAddressTransfers
description: 'Describes an Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.
When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer Amazon Web Services accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for three days after the transfers have been accepted.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeAddressTransfersResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeAddressTransfersRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeAddressTransfers - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeAddresses: get: x-aws-operation-name: DescribeAddresses operationId: GET_DescribeAddresses description: Describes the specified Elastic IP addresses or all of your Elastic IP addresses. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeAddressesResult' parameters: - name: Filter in: query required: false description: 'One or more filters. Filter names and values are case-sensitive.
allocation-id - The allocation ID for the address.
association-id - The association ID for the address.
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
' schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: PublicIp - name: AllocationId in: query required: false description: Information about the allocation IDs. schema: type: array items: allOf: - $ref: '#/components/schemas/AllocationId' - xml: name: AllocationId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAddresses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeAddresses
operationId: POST_DescribeAddresses
description: Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeAddressesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeAddressesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAddresses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeAddressesAttribute:
get:
x-aws-operation-name: DescribeAddressesAttribute
operationId: GET_DescribeAddressesAttribute
description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeAddressesAttributeResult'
parameters:
- name: AllocationId
in: query
required: false
description: '[EC2-VPC] The allocation IDs.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/AllocationId'
- xml:
name: item
- name: Attribute
in: query
required: false
description: The attribute of the IP address.
schema:
type: string
enum:
- domain-name
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 1
maximum: 1000
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAddressesAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeAddressesAttribute
operationId: POST_DescribeAddressesAttribute
description: 'Describes the attributes of the specified Elastic IP addresses. For requirements, see Using reverse DNS for email applications.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeAddressesAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeAddressesAttributeRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAddressesAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeAggregateIdFormat:
get:
x-aws-operation-name: DescribeAggregateIdFormat
operationId: GET_DescribeAggregateIdFormat
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAggregateIdFormat
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeAggregateIdFormat
operationId: POST_DescribeAggregateIdFormat
description: 'Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs).
This request only returns information about resource types that support longer IDs.
The following resource types support longer IDs: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeAvailabilityZonesResult' parameters: - name: Filter in: query required: false description: 'The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
' schema: type: boolean - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAvailabilityZones
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeAvailabilityZones
operationId: POST_DescribeAvailabilityZones
description: 'Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. If there is an event impacting a zone, you can use this request to view the state and any provided messages for that zone.
For more information about Availability Zones, Local Zones, and Wavelength Zones, see Regions and zones in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeAvailabilityZonesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeAvailabilityZonesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeAvailabilityZones - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeAwsNetworkPerformanceMetricSubscriptions: get: x-aws-operation-name: DescribeAwsNetworkPerformanceMetricSubscriptions operationId: GET_DescribeAwsNetworkPerformanceMetricSubscriptions description: Describes the current Infrastructure Performance metric subscriptions. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeAwsNetworkPerformanceMetricSubscriptionsResult' parameters: - name: MaxResults in: query required: false description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
schema:
type: integer
minimum: 0
maximum: 100
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAwsNetworkPerformanceMetricSubscriptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeAwsNetworkPerformanceMetricSubscriptions
operationId: POST_DescribeAwsNetworkPerformanceMetricSubscriptions
description: Describes the current Infrastructure Performance metric subscriptions.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeAwsNetworkPerformanceMetricSubscriptionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeAwsNetworkPerformanceMetricSubscriptionsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeAwsNetworkPerformanceMetricSubscriptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeBundleTasks:
get:
x-aws-operation-name: DescribeBundleTasks
operationId: GET_DescribeBundleTasks
description: '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 bundle task IDs.
Default: Describes all your bundle tasks.
' schema: type: array items: allOf: - $ref: '#/components/schemas/BundleId' - xml: name: BundleId - name: Filter in: query required: false description: 'The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeBundleTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeBundleTasks
operationId: POST_DescribeBundleTasks
description: '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.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeByoipCidrsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: true
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeByoipCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeByoipCidrs
operationId: POST_DescribeByoipCidrs
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeByoipCidrsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeByoipCidrsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeByoipCidrs - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeCapacityReservationFleets: get: x-aws-operation-name: DescribeCapacityReservationFleets operationId: GET_DescribeCapacityReservationFleets description: Describes one or more Capacity Reservation Fleets. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeCapacityReservationFleetsResult' parameters: - name: CapacityReservationFleetId in: query required: false description: The IDs of the Capacity Reservation Fleets to describe. schema: type: array items: allOf: - $ref: '#/components/schemas/CapacityReservationFleetId' - xml: name: item - name: NextToken in: query required: false description: The token to use to retrieve the next page of results. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returnednextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
schema:
type: integer
minimum: 1
maximum: 100
- name: Filter
in: query
required: false
description: One or more filters.
state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
tenancy - The tenancy of the Fleet (default | dedicated).
allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCapacityReservationFleets
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeCapacityReservationFleets
operationId: POST_DescribeCapacityReservationFleets
description: Describes one or more Capacity Reservation Fleets.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCapacityReservationFleetsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCapacityReservationFleetsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCapacityReservationFleets
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeCapacityReservations:
get:
x-aws-operation-name: DescribeCapacityReservations
operationId: GET_DescribeCapacityReservations
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCapacityReservationsResult'
parameters:
- name: CapacityReservationId
in: query
required: false
description: The ID of the Capacity Reservation.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/CapacityReservationId'
- xml:
name: item
- name: NextToken
in: query
required: false
description: The token to use to retrieve the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
schema:
type: integer
minimum: 1
maximum: 1000
- name: Filter
in: query
required: false
description: 'One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCapacityReservations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeCapacityReservations
operationId: POST_DescribeCapacityReservations
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCapacityReservationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCapacityReservationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCapacityReservations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeCarrierGateways:
get:
x-aws-operation-name: DescribeCarrierGateways
operationId: GET_DescribeCarrierGateways
description: Describes one or more of your carrier gateways.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCarrierGatewaysResult'
parameters:
- name: CarrierGatewayId
in: query
required: false
description: One or more carrier gateway IDs.
schema:
type: array
items:
$ref: '#/components/schemas/CarrierGatewayId'
- name: Filter
in: query
required: false
description: 'One or more filters.
carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC associated with the carrier gateway.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCarrierGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeCarrierGateways
operationId: POST_DescribeCarrierGateways
description: Describes one or more of your carrier gateways.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCarrierGatewaysResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCarrierGatewaysRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCarrierGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeClassicLinkInstances:
get:
x-aws-operation-name: DescribeClassicLinkInstances
operationId: GET_DescribeClassicLinkInstances
description: This action is deprecated.
Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' parameters: - name: Filter in: query required: false description: 'The filters.
group-id - The ID of a VPC security group that''s associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: false
description: The instance IDs. Must be instances linked to a VPC through ClassicLink.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: InstanceId
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Constraint: If the value is greater than 1000, we return only 1000 items.
' schema: type: integer minimum: 5 maximum: 1000 - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeClassicLinkInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeClassicLinkInstances operationId: POST_DescribeClassicLinkInstances description:This action is deprecated.
Describes one or more of your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeClassicLinkInstancesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeClassicLinkInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeClientVpnAuthorizationRules: get: x-aws-operation-name: DescribeClientVpnAuthorizationRules operationId: GET_DescribeClientVpnAuthorizationRules description: Describes the authorization rules for a specified Client VPN endpoint. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token to retrieve the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the authorization rule applies.
group-id - The ID of the Active Directory group to which the authorization rule grants access.
One or more filters. Filter names and values are case-sensitive.
connection-id - The ID of the connection.
username - For Active Directory client authentication, the user name of the client who established the client connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeClientVpnConnections
operationId: POST_DescribeClientVpnConnections
description: Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnConnectionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnConnectionsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeClientVpnEndpoints:
get:
x-aws-operation-name: DescribeClientVpnEndpoints
operationId: GET_DescribeClientVpnEndpoints
description: Describes one or more Client VPN endpoints in the account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
parameters:
- name: ClientVpnEndpointId
in: query
required: false
description: The ID of the Client VPN endpoint.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- xml:
name: item
- name: MaxResults
in: query
required: false
description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token to retrieve the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol (tcp | udp).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnEndpoints
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeClientVpnEndpoints
operationId: POST_DescribeClientVpnEndpoints
description: Describes one or more Client VPN endpoints in the account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnEndpointsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnEndpoints
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeClientVpnRoutes:
get:
x-aws-operation-name: DescribeClientVpnRoutes
operationId: GET_DescribeClientVpnRoutes
description: Describes the routes for the specified Client VPN endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnRoutesResult'
parameters:
- name: ClientVpnEndpointId
in: query
required: true
description: The ID of the Client VPN endpoint.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint (associate | add-route).
target-subnet - The ID of the subnet through which traffic is routed.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnRoutes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeClientVpnRoutes
operationId: POST_DescribeClientVpnRoutes
description: Describes the routes for the specified Client VPN endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnRoutesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnRoutesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnRoutes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeClientVpnTargetNetworks:
get:
x-aws-operation-name: DescribeClientVpnTargetNetworks
operationId: GET_DescribeClientVpnTargetNetworks
description: Describes the target networks associated with the specified Client VPN endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
parameters:
- name: ClientVpnEndpointId
in: query
required: true
description: The ID of the Client VPN endpoint.
schema:
type: string
- name: AssociationIds
in: query
required: false
description: The IDs of the target network associations.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: MaxResults
in: query
required: false
description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token to retrieve the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association.
target-network-id - The ID of the subnet specified as the target network.
vpc-id - The ID of the VPC in which the target network is located.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnTargetNetworks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeClientVpnTargetNetworks
operationId: POST_DescribeClientVpnTargetNetworks
description: Describes the target networks associated with the specified Client VPN endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeClientVpnTargetNetworksRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeClientVpnTargetNetworks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeCoipPools:
get:
x-aws-operation-name: DescribeCoipPools
operationId: GET_DescribeCoipPools
description: Describes the specified customer-owned address pools or all of your customer-owned address pools.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCoipPoolsResult'
parameters:
- name: PoolId
in: query
required: false
description: The IDs of the address pools.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv4PoolCoipId'
- xml:
name: item
- name: Filter
in: query
required: false
description: One or more filters.
coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCoipPools
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeCoipPools
operationId: POST_DescribeCoipPools
description: Describes the specified customer-owned address pools or all of your customer-owned address pools.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCoipPoolsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeCoipPoolsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCoipPools
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeConversionTasks:
get:
x-aws-operation-name: DescribeConversionTasks
operationId: GET_DescribeConversionTasks
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeConversionTasksResult' parameters: - name: ConversionTaskId in: query required: false description: The conversion task IDs. schema: type: array items: allOf: - $ref: '#/components/schemas/ConversionTaskId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeConversionTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeConversionTasks
operationId: POST_DescribeConversionTasks
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeConversionTasksResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeConversionTasksRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeConversionTasks - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeCustomerGateways: get: x-aws-operation-name: DescribeCustomerGateways operationId: GET_DescribeCustomerGateways description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeCustomerGatewaysResult' parameters: - name: CustomerGatewayId in: query required: false description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' schema: type: array items: allOf: - $ref: '#/components/schemas/CustomerGatewayId' - xml: name: CustomerGatewayId - name: Filter in: query required: false description: 'One or more filters.
bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway device''s external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeCustomerGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeCustomerGateways
operationId: POST_DescribeCustomerGateways
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeCustomerGatewaysResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeCustomerGatewaysRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeCustomerGateways - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeDhcpOptions: get: x-aws-operation-name: DescribeDhcpOptions operationId: GET_DescribeDhcpOptions description: 'Describes one or more of your DHCP options sets.
For more information, see DHCP options sets in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeDhcpOptionsResult' parameters: - name: DhcpOptionsId in: query required: false description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' schema: type: array items: allOf: - $ref: '#/components/schemas/DhcpOptionsId' - xml: name: DhcpOptionsId - name: Filter in: query required: false description: 'The filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeDhcpOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeDhcpOptions
operationId: POST_DescribeDhcpOptions
description: 'Describes one or more of your DHCP options sets.
For more information, see DHCP options sets in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeDhcpOptionsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeDhcpOptionsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeDhcpOptions - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeEgressOnlyInternetGateways: get: x-aws-operation-name: DescribeEgressOnlyInternetGateways operationId: GET_DescribeEgressOnlyInternetGateways description: Describes one or more of your egress-only internet gateways. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EgressOnlyInternetGatewayId
in: query
required: false
description: The IDs of the egress-only internet gateways.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- xml:
name: item
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 255
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: Filter
in: query
required: false
description: 'The filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'The filters.
availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.
elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).
elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).
elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.
instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.
NextToken value. This value can be between 5 and 1000.'
schema:
type: integer
minimum: 10
maximum: 1000
- name: NextToken
in: query
required: false
description: The token to request the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeElasticGpus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeElasticGpus
operationId: POST_DescribeElasticGpus
description: 'Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeElasticGpusResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeElasticGpusRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeElasticGpus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeExportImageTasks:
get:
x-aws-operation-name: DescribeExportImageTasks
operationId: GET_DescribeExportImageTasks
description: Describes the specified export image tasks or all of your export image tasks.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeExportImageTasksResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: ExportImageTaskId
in: query
required: false
description: The IDs of the export image tasks.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ExportImageTaskId'
- xml:
name: ExportImageTaskId
- name: MaxResults
in: query
required: false
description: The maximum number of results to return in a single call.
schema:
type: integer
minimum: 1
maximum: 500
- name: NextToken
in: query
required: false
description: A token that indicates the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeExportImageTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeExportImageTasks
operationId: POST_DescribeExportImageTasks
description: Describes the specified export image tasks or all of your export image tasks.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeExportImageTasksResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeExportImageTasksRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeExportImageTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeExportTasks:
get:
x-aws-operation-name: DescribeExportTasks
operationId: GET_DescribeExportTasks
description: Describes the specified export instance tasks or all of your export instance tasks.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeExportTasksResult'
parameters:
- name: ExportTaskId
in: query
required: false
description: The export task IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ExportTaskId'
- xml:
name: ExportTaskId
- name: Filter
in: query
required: false
description: the filters for the export tasks.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeExportTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeExportTasks
operationId: POST_DescribeExportTasks
description: Describes the specified export instance tasks or all of your export instance tasks.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeExportTasksResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeExportTasksRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeExportTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeFastLaunchImages:
get:
x-aws-operation-name: DescribeFastLaunchImages
operationId: GET_DescribeFastLaunchImages
description: Describe details for Windows AMIs that are configured for faster launching.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFastLaunchImagesResult'
parameters:
- name: ImageId
in: query
required: false
description: Details for one or more Windows AMI image IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImageId'
- xml:
name: ImageId
- name: Filter
in: query
required: false
description: Use the following filters to streamline results.
resource-type - The resource type for pre-provisioning.
launch-template - The launch template that is associated with the pre-provisioned Windows AMI.
owner-id - The owner ID for the pre-provisioning resource.
state - The current state of fast launching for the Windows AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeFastLaunchImages
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeFastLaunchImages
operationId: POST_DescribeFastLaunchImages
description: Describe details for Windows AMIs that are configured for faster launching.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFastLaunchImagesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFastLaunchImagesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeFastLaunchImages
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeFastSnapshotRestores:
get:
x-aws-operation-name: DescribeFastSnapshotRestores
operationId: GET_DescribeFastSnapshotRestores
description: Describes the state of fast snapshot restores for your snapshots.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFastSnapshotRestoresResult'
parameters:
- name: Filter
in: query
required: false
description: 'The filters. The possible values are:
availability-zone: The Availability Zone of the snapshot.
owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.
snapshot-id: The ID of the snapshot.
state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeFastSnapshotRestores
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeFastSnapshotRestores
operationId: POST_DescribeFastSnapshotRestores
description: Describes the state of fast snapshot restores for your snapshots.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFastSnapshotRestoresResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFastSnapshotRestoresRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeFastSnapshotRestores
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeFleetHistory:
get:
x-aws-operation-name: DescribeFleetHistory
operationId: GET_DescribeFleetHistory
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetHistoryResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EventType
in: query
required: false
description: 'The type of events to describe. By default, all events are described.'
schema:
type: string
enum:
- instance-change
- fleet-change
- service-error
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: FleetId
in: query
required: true
description: The ID of the EC2 Fleet.
schema:
type: string
- name: StartTime
in: query
required: true
description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
schema:
type: string
format: date-time
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeFleetHistory
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeFleetHistory
operationId: POST_DescribeFleetHistory
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetHistoryResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetHistoryRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeFleetHistory - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeFleetInstances: get: x-aws-operation-name: DescribeFleetInstances operationId: GET_DescribeFleetInstances description: 'Describes the running instances for the specified EC2 Fleet.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetInstancesResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: FleetId
in: query
required: true
description: The ID of the EC2 Fleet.
schema:
type: string
- name: Filter
in: query
required: false
description: The filters.
instance-type - The instance type.
Describes the running instances for the specified EC2 Fleet.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeFleetInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeFleets: get: x-aws-operation-name: DescribeFleets operationId: GET_DescribeFleets description: 'Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: FleetId
in: query
required: false
description: 'The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The filters.
activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).
Describes the specified EC2 Fleets or all of your EC2 Fleets.
For more information, see Monitor your EC2 Fleet in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeFleetsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeFleets - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeFlowLogs: get: x-aws-operation-name: DescribeFlowLogs operationId: GET_DescribeFlowLogs description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFlowLogsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination for the flow log data (cloud-watch-logs | s3 | kinesis-data-firehose).
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' schema: type: array items: allOf: - $ref: '#/components/schemas/VpcFlowLogId' - xml: name: item - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer - name: NextToken in: query required: false description: The token to request the next page of items. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeFlowLogs - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeFlowLogs operationId: POST_DescribeFlowLogs description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFlowLogsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeFlowLogsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeFlowLogs - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeFpgaImageAttribute: get: x-aws-operation-name: DescribeFpgaImageAttribute operationId: GET_DescribeFpgaImageAttribute description: Describes the specified attribute of the specified Amazon FPGA Image (AFI). responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeFpgaImageAttributeResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FpgaImageId
in: query
required: true
description: The ID of the AFI.
schema:
type: string
- name: Attribute
in: query
required: true
description: The AFI attribute.
schema:
type: string
enum:
- description
- name
- loadPermission
- productCodes
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeFpgaImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeFpgaImageAttribute
operationId: POST_DescribeFpgaImageAttribute
description: Describes the specified attribute of the specified Amazon FPGA Image (AFI).
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFpgaImageAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFpgaImageAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeFpgaImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeFpgaImages:
get:
x-aws-operation-name: DescribeFpgaImages
operationId: GET_DescribeFpgaImages
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeFpgaImagesResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FpgaImageId
in: query
required: false
description: The AFI IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/FpgaImageId'
- xml:
name: item
- name: Owner
in: query
required: false
description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: Owner
- name: Filter
in: query
required: false
description: 'The filters.
create-time - The creation time of the AFI.
fpga-image-id - The FPGA image identifier (AFI ID).
fpga-image-global-id - The global FPGA image identifier (AGFI ID).
name - The name of the AFI.
owner-id - The Amazon Web Services account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
state - The state of the AFI (pending | failed | available | unavailable).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' parameters: - name: Filter in: query required: false description: 'The filters.
instance-family - The instance family of the offering (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
schema:
type: integer
minimum: 5
maximum: 500
- name: MinDuration
in: query
required: false
description: 'This is the minimum duration of the reservation you''d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token to use to retrieve the next page of results.
schema:
type: string
- name: OfferingId
in: query
required: false
description: The ID of the reservation offering.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeHostReservationOfferings
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeHostReservationOfferings
operationId: POST_DescribeHostReservationOfferings
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeHostReservationOfferingsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeHostReservationOfferingsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeHostReservationOfferings - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeHostReservations: get: x-aws-operation-name: DescribeHostReservations operationId: GET_DescribeHostReservations description: Describes reservations that are associated with Dedicated Hosts in your account. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeHostReservationsResult' parameters: - name: Filter in: query required: false description: 'The filters.
instance-family - The instance family (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
state - The state of the reservation (payment-pending | payment-failed | active | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token to use to retrieve the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeHostReservations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeHostReservations
operationId: POST_DescribeHostReservations
description: Describes reservations that are associated with Dedicated Hosts in your account.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeHostReservationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeHostReservationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeHostReservations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeHosts:
get:
x-aws-operation-name: DescribeHosts
operationId: GET_DescribeHosts
description: 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.
The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
' schema: type: integer - name: NextToken in: query required: false description: The token to use to retrieve the next page of results. schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeHosts - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeHosts operationId: POST_DescribeHosts description: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.
The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating).
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.
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 '
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIdFormat
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeIdFormat
operationId: POST_DescribeIdFormat
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeIdentityIdFormatResult' parameters: - name: PrincipalArn in: query required: true description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.' schema: type: string - name: Resource in: query required: false description: 'The type of resource:bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIdentityIdFormat
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeIdentityIdFormat
operationId: POST_DescribeIdentityIdFormat
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeIdentityIdFormatResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeIdentityIdFormatRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeIdentityIdFormat - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeImageAttribute: get: x-aws-operation-name: DescribeImageAttribute operationId: GET_DescribeImageAttribute description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImageAttribute' parameters: - name: Attribute in: query required: true description: 'The AMI attribute.
Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeImageAttribute
operationId: POST_DescribeImageAttribute
description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ImageAttribute'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeImageAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeImages:
get:
x-aws-operation-name: DescribeImages
operationId: GET_DescribeImages
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeImagesResult' parameters: - name: ExecutableBy in: query required: false description: 'Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. The only supported value is windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' schema: type: array items: allOf: - $ref: '#/components/schemas/ImageId' - xml: name: ImageId - name: Owner in: query required: false description: 'Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs,self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: Owner
- name: IncludeDeprecated
in: query
required: false
description: 'Specifies whether to include deprecated AMIs.
Default: No deprecated AMIs are included in the response.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeImages
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeImages
operationId: POST_DescribeImages
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeImagesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeImagesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeImages - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeImportImageTasks: get: x-aws-operation-name: DescribeImportImageTasks operationId: GET_DescribeImportImageTasks description: Displays details about an import virtual machine or import snapshot tasks that are already created. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeImportImageTasksResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filters
in: query
required: false
description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: ImportTaskId
in: query
required: false
description: The IDs of the import image tasks.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportImageTaskId'
- xml:
name: ImportTaskId
- name: MaxResults
in: query
required: false
description: The maximum number of results to return in a single call.
schema:
type: integer
- name: NextToken
in: query
required: false
description: A token that indicates the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeImportImageTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeImportImageTasks
operationId: POST_DescribeImportImageTasks
description: Displays details about an import virtual machine or import snapshot tasks that are already created.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeImportImageTasksResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeImportImageTasksRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeImportImageTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeImportSnapshotTasks:
get:
x-aws-operation-name: DescribeImportSnapshotTasks
operationId: GET_DescribeImportSnapshotTasks
description: Describes your import snapshot tasks.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filters
in: query
required: false
description: The filters.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: ImportTaskId
in: query
required: false
description: A list of import snapshot task IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportSnapshotTaskId'
- xml:
name: ImportTaskId
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: A token that indicates the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeImportSnapshotTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeImportSnapshotTasks
operationId: POST_DescribeImportSnapshotTasks
description: Describes your import snapshot tasks.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeImportSnapshotTasksRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeImportSnapshotTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeInstanceAttribute:
get:
x-aws-operation-name: DescribeInstanceAttribute
operationId: GET_DescribeInstanceAttribute
description: '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 '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/InstanceAttribute'
parameters:
- name: Attribute
in: query
required: true
description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeInstanceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeInstanceAttribute
operationId: POST_DescribeInstanceAttribute
description: '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 '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/InstanceAttribute'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeInstanceAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeInstanceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeInstanceConnectEndpoints:
get:
x-aws-operation-name: DescribeInstanceConnectEndpoints
operationId: GET_DescribeInstanceConnectEndpoints
description: Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeInstanceConnectEndpointsResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 1
maximum: 50
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters.
instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint.
state - The state of the EC2 Instance Connect Endpoint (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).
subnet-id - The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key.
vpc-id - The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: The filters.
instance-id - The ID of the instance.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
' schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same call.
' schema: type: integer minimum: 5 maximum: 1000 - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeInstanceCreditSpecifications - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeInstanceCreditSpecifications operationId: POST_DescribeInstanceCreditSpecifications description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeInstanceCreditSpecifications - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeInstanceEventNotificationAttributes: get: x-aws-operation-name: DescribeInstanceEventNotificationAttributes operationId: GET_DescribeInstanceEventNotificationAttributes description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeInstanceEventNotificationAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeInstanceEventNotificationAttributes
operationId: POST_DescribeInstanceEventNotificationAttributes
description: Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeInstanceEventNotificationAttributesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeInstanceEventNotificationAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeInstanceEventWindows:
get:
x-aws-operation-name: DescribeInstanceEventWindows
operationId: GET_DescribeInstanceEventWindows
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceEventWindowId
in: query
required: false
description: The IDs of the event windows.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- xml:
name: InstanceEventWindowId
- name: Filter
in: query
required: false
description: 'One or more filters.
dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
event-window-name - The event windows associated with the specified names.
instance-id - The event windows associated with the specified instance ID.
instance-tag - The event windows associated with the specified tag and value.
instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.'
schema:
type: integer
minimum: 20
maximum: 500
- name: NextToken
in: query
required: false
description: The token to request the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeInstanceEventWindows
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeInstanceEventWindows
operationId: POST_DescribeInstanceEventWindows
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInstanceEventWindowsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeInstanceEventWindowsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeInstanceEventWindows - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeInstanceStatus: get: x-aws-operation-name: DescribeInstanceStatus operationId: GET_DescribeInstanceStatus description: '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 filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
' schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
' schema: type: integer - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IncludeAllInstances
in: query
required: false
description: 'When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: LocationType
in: query
required: false
description: The location type.
schema:
type: string
enum:
- region
- availability-zone
- availability-zone-id
- name: Filter
in: query
required: false
description: 'One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceType
in: query
required: false
description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.'
schema:
type: array
items:
$ref: '#/components/schemas/InstanceType'
minItems: 0
maxItems: 100
- name: Filter
in: query
required: false
description: 'One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, "25 Gigabit").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInstancesResult' parameters: - name: Filter in: query required: false description: 'The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
' schema: type: integer - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeInstances operationId: POST_DescribeInstances description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeInstancesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeInternetGateways: get: x-aws-operation-name: DescribeInternetGateways operationId: GET_DescribeInternetGateways description: Describes one or more of your internet gateways. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInternetGatewaysResult' parameters: - name: Filter in: query required: false description: 'The filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InternetGatewayId
in: query
required: false
description: 'The IDs of the internet gateways.
Default: Describes all your internet gateways.
' schema: type: array items: allOf: - $ref: '#/components/schemas/InternetGatewayId' - xml: name: item - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer minimum: 5 maximum: 1000 - name: Action in: query required: true schema: type: string enum: - DescribeInternetGateways - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeInternetGateways operationId: POST_DescribeInternetGateways description: Describes one or more of your internet gateways. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeInternetGatewaysResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeInternetGatewaysRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeInternetGateways - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeIpamPools: get: x-aws-operation-name: DescribeIpamPools operationId: GET_DescribeIpamPools description: Get information about your IPAM pools. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeIpamPoolsResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: The maximum number of results to return in the request.
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: IpamPoolId
in: query
required: false
description: The IDs of the IPAM pools you would like information on.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamPools
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeIpamPools
operationId: POST_DescribeIpamPools
description: Get information about your IPAM pools.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamPoolsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamPoolsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamPools
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeIpamResourceDiscoveries:
get:
x-aws-operation-name: DescribeIpamResourceDiscoveries
operationId: GET_DescribeIpamResourceDiscoveries
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamResourceDiscoveriesResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: IpamResourceDiscoveryId
in: query
required: false
description: The IPAM resource discovery IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: NextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: The maximum number of resource discoveries to return in one page of results.
schema:
type: integer
minimum: 5
maximum: 1000
- name: Filter
in: query
required: false
description: The resource discovery filters.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamResourceDiscoveries
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeIpamResourceDiscoveries
operationId: POST_DescribeIpamResourceDiscoveries
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamResourceDiscoveriesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamResourceDiscoveriesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamResourceDiscoveries
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeIpamResourceDiscoveryAssociations:
get:
x-aws-operation-name: DescribeIpamResourceDiscoveryAssociations
operationId: GET_DescribeIpamResourceDiscoveryAssociations
description: Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamResourceDiscoveryAssociationsResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: IpamResourceDiscoveryAssociationId
in: query
required: false
description: The resource discovery association IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: NextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: The maximum number of resource discovery associations to return in one page of results.
schema:
type: integer
minimum: 5
maximum: 1000
- name: Filter
in: query
required: false
description: The resource discovery association filters.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamResourceDiscoveryAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeIpamResourceDiscoveryAssociations
operationId: POST_DescribeIpamResourceDiscoveryAssociations
description: Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM..
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamResourceDiscoveryAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamResourceDiscoveryAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamResourceDiscoveryAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeIpamScopes:
get:
x-aws-operation-name: DescribeIpamScopes
operationId: GET_DescribeIpamScopes
description: Get information about your IPAM scopes.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamScopesResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: The maximum number of results to return in the request.
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: IpamScopeId
in: query
required: false
description: The IDs of the scopes you want information on.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamScopes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeIpamScopes
operationId: POST_DescribeIpamScopes
description: Get information about your IPAM scopes.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamScopesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeIpamScopesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpamScopes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeIpams:
get:
x-aws-operation-name: DescribeIpams
operationId: GET_DescribeIpams
description: 'Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeIpamsResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: The maximum number of results to return in the request.
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: IpamId
in: query
required: false
description: The IDs of the IPAMs you want information on.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeIpams
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeIpams
operationId: POST_DescribeIpams
description: 'Get information about your IPAM pools.
For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeIpamsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeIpamsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeIpams - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeIpv6Pools: get: x-aws-operation-name: DescribeIpv6Pools operationId: GET_DescribeIpv6Pools description: Describes your IPv6 address pools. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeIpv6PoolsResult' parameters: - name: PoolId in: query required: false description: The IDs of the IPv6 address pools. schema: type: array items: allOf: - $ref: '#/components/schemas/Ipv6PoolEc2Id' - xml: name: item - name: NextToken in: query required: false description: The token for the next page of results. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
schema:
type: integer
minimum: 1
maximum: 1000
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeKeyPairsResult' parameters: - name: Filter in: query required: false description: 'The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key pair names.
Default: Describes all of your key pairs.
' schema: type: array items: allOf: - $ref: '#/components/schemas/KeyPairName' - xml: name: KeyName - name: KeyPairId in: query required: false description: The IDs of the key pairs. schema: type: array items: allOf: - $ref: '#/components/schemas/KeyPairId' - xml: name: KeyPairId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IncludePublicKey
in: query
required: false
description: 'If true, the public key material is included in the response.
Default: false
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeKeyPairsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeKeyPairsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeKeyPairs - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeLaunchTemplateVersions: get: x-aws-operation-name: DescribeLaunchTemplateVersions operationId: GET_DescribeLaunchTemplateVersions description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeLaunchTemplateVersionsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: LaunchTemplateId
in: query
required: false
description: 'The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
' schema: type: string - name: LaunchTemplateName in: query required: false description: 'The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
' schema: type: string pattern: '[a-zA-Z0-9\(\)\.\-/_]+' minLength: 3 maxLength: 128 - name: LaunchTemplateVersion in: query required: false description: 'One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same request. You cannot specify numbers.
NextToken value. This value can be between 1 and 200.'
schema:
type: integer
- name: Filter
in: query
required: false
description: One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID is displayed in the response for imageId.
If false, and if a Systems Manager parameter is specified for ImageId, the parameter is displayed in the response for imageId.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: LaunchTemplateId
in: query
required: false
description: One or more launch template IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- xml:
name: item
- name: LaunchTemplateName
in: query
required: false
description: One or more launch template names.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateName'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'One or more filters.
create-time - The time the launch template was created.
launch-template-name - The name of the launch template.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 1 and 200.'
schema:
type: integer
minimum: 1
maximum: 200
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLaunchTemplates
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeLaunchTemplates
operationId: POST_DescribeLaunchTemplates
description: Describes one or more launch templates.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLaunchTemplatesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLaunchTemplatesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLaunchTemplates
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations:
get:
x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
operationId: GET_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
description: Describes the associations between virtual interface groups and local gateway route tables.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult'
parameters:
- name: LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
in: query
required: false
description: The IDs of the associations.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
- xml:
name: item
- name: Filter
in: query
required: false
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
state - The state of the association.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
operationId: POST_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
description: Describes the associations between virtual interface groups and local gateway route tables.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeLocalGatewayRouteTableVpcAssociations:
get:
x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations
operationId: GET_DescribeLocalGatewayRouteTableVpcAssociations
description: Describes the specified associations between VPCs and local gateway route tables.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult'
parameters:
- name: LocalGatewayRouteTableVpcAssociationId
in: query
required: false
description: The IDs of the associations.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
- xml:
name: item
- name: Filter
in: query
required: false
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the association.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association.
state - The state of the association.
vpc-id - The ID of the VPC.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayRouteTableVpcAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeLocalGatewayRouteTableVpcAssociations
operationId: POST_DescribeLocalGatewayRouteTableVpcAssociations
description: Describes the specified associations between VPCs and local gateway route tables.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTableVpcAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayRouteTableVpcAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeLocalGatewayRouteTables:
get:
x-aws-operation-name: DescribeLocalGatewayRouteTables
operationId: GET_DescribeLocalGatewayRouteTables
description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult'
parameters:
- name: LocalGatewayRouteTableId
in: query
required: false
description: The IDs of the local gateway route tables.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- xml:
name: item
- name: Filter
in: query
required: false
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.
state - The state of the local gateway route table.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayRouteTables
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeLocalGatewayRouteTables
operationId: POST_DescribeLocalGatewayRouteTables
description: 'Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTablesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayRouteTablesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayRouteTables
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeLocalGatewayVirtualInterfaceGroups:
get:
x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups
operationId: GET_DescribeLocalGatewayVirtualInterfaceGroups
description: Describes the specified local gateway virtual interface groups.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult'
parameters:
- name: LocalGatewayVirtualInterfaceGroupId
in: query
required: false
description: The IDs of the virtual interface groups.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- xml:
name: item
- name: Filter
in: query
required: false
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayVirtualInterfaceGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeLocalGatewayVirtualInterfaceGroups
operationId: POST_DescribeLocalGatewayVirtualInterfaceGroups
description: Describes the specified local gateway virtual interface groups.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfaceGroupsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayVirtualInterfaceGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeLocalGatewayVirtualInterfaces:
get:
x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces
operationId: GET_DescribeLocalGatewayVirtualInterfaces
description: Describes the specified local gateway virtual interfaces.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult'
parameters:
- name: LocalGatewayVirtualInterfaceId
in: query
required: false
description: The IDs of the virtual interfaces.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
- xml:
name: item
- name: Filter
in: query
required: false
description: One or more filters.
local-address - The local address.
local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
vlan - The ID of the VLAN.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayVirtualInterfaces
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeLocalGatewayVirtualInterfaces
operationId: POST_DescribeLocalGatewayVirtualInterfaces
description: Describes the specified local gateway virtual interfaces.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewayVirtualInterfacesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGatewayVirtualInterfaces
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeLocalGateways:
get:
x-aws-operation-name: DescribeLocalGateways
operationId: GET_DescribeLocalGateways
description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewaysResult'
parameters:
- name: LocalGatewayId
in: query
required: false
description: The IDs of the local gateways.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- xml:
name: item
- name: Filter
in: query
required: false
description: One or more filters.
local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeLocalGateways
operationId: POST_DescribeLocalGateways
description: 'Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewaysResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeLocalGatewaysRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeLocalGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeManagedPrefixLists:
get:
x-aws-operation-name: DescribeManagedPrefixLists
operationId: GET_DescribeManagedPrefixLists
description: 'Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeManagedPrefixListsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
nextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: PrefixListId
in: query
required: false
description: One or more prefix list IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeManagedPrefixLists
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeManagedPrefixLists
operationId: POST_DescribeManagedPrefixLists
description: 'Describes your managed prefix lists and any Amazon Web Services-managed prefix lists.
To view the entries for your prefix list, use GetManagedPrefixListEntries.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeManagedPrefixListsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeManagedPrefixListsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeManagedPrefixLists - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeMovingAddresses: get: x-aws-operation-name: DescribeMovingAddresses operationId: GET_DescribeMovingAddresses description: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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeMovingAddressesResult' parameters: - name: Filter in: query required: false description:One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
' schema: type: integer minimum: 5 maximum: 1000 - name: NextToken in: query required: false description: The token for the next page of results. schema: type: string - name: PublicIp in: query required: false description: One or more Elastic IP addresses. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: Action in: query required: true schema: type: string enum: - DescribeMovingAddresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeMovingAddresses operationId: POST_DescribeMovingAddresses description: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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeMovingAddressesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeMovingAddressesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeMovingAddresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeNatGateways: get: x-aws-operation-name: DescribeNatGateways operationId: GET_DescribeNatGateways description: Describes one or more of your NAT gateways. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeNatGatewaysResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'The filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeNetworkAclsResult' parameters: - name: Filter in: query required: false description: 'The filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.egress - A Boolean that indicates the type of rule. Specify true for egress rules, or false for ingress rules.
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkAclId
in: query
required: false
description: 'The IDs of the network ACLs.
Default: Describes all your network ACLs.
' schema: type: array items: allOf: - $ref: '#/components/schemas/NetworkAclId' - xml: name: item - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer minimum: 5 maximum: 1000 - name: Action in: query required: true schema: type: string enum: - DescribeNetworkAcls - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeNetworkAcls operationId: POST_DescribeNetworkAcls description: 'Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeNetworkAclsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeNetworkAclsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeNetworkAcls - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeNetworkInsightsAccessScopeAnalyses: get: x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses operationId: GET_DescribeNetworkInsightsAccessScopeAnalyses description: Describes the specified Network Access Scope analyses. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult' parameters: - name: NetworkInsightsAccessScopeAnalysisId in: query required: false description: The IDs of the Network Access Scope analyses. schema: type: array items: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - xml: name: item - name: NetworkInsightsAccessScopeId in: query required: false description: The ID of the Network Access Scope. schema: type: string - name: AnalysisStartTimeBegin in: query required: false description: Filters the results based on the start time. The analysis must have started on or after this time. schema: type: string format: date-time - name: AnalysisStartTimeEnd in: query required: false description: Filters the results based on the start time. The analysis must have started on or before this time. schema: type: string format: date-time - name: Filter in: query required: false description: There are no supported filters. schema: type: array items: allOf: - $ref: '#/components/schemas/Filter' - xml: name: Filter - name: MaxResults in: query required: false description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsAccessScopeAnalyses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeNetworkInsightsAccessScopeAnalyses
operationId: POST_DescribeNetworkInsightsAccessScopeAnalyses
description: Describes the specified Network Access Scope analyses.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAccessScopeAnalysesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsAccessScopeAnalyses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeNetworkInsightsAccessScopes:
get:
x-aws-operation-name: DescribeNetworkInsightsAccessScopes
operationId: GET_DescribeNetworkInsightsAccessScopes
description: Describes the specified Network Access Scopes.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult'
parameters:
- name: NetworkInsightsAccessScopeId
in: query
required: false
description: The IDs of the Network Access Scopes.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- xml:
name: item
- name: Filter
in: query
required: false
description: There are no supported filters.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsAccessScopes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeNetworkInsightsAccessScopes
operationId: POST_DescribeNetworkInsightsAccessScopes
description: Describes the specified Network Access Scopes.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAccessScopesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsAccessScopes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeNetworkInsightsAnalyses:
get:
x-aws-operation-name: DescribeNetworkInsightsAnalyses
operationId: GET_DescribeNetworkInsightsAnalyses
description: Describes one or more of your network insights analyses.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult'
parameters:
- name: NetworkInsightsAnalysisId
in: query
required: false
description: The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- xml:
name: item
- name: NetworkInsightsPathId
in: query
required: false
description: The ID of the path. You must specify either a path ID or analysis IDs.
schema:
type: string
- name: AnalysisStartTime
in: query
required: false
description: The time when the network insights analyses started.
schema:
type: string
format: date-time
- name: AnalysisEndTime
in: query
required: false
description: The time when the network insights analyses ended.
schema:
type: string
format: date-time
- name: Filter
in: query
required: false
description: 'The filters. The following are the possible values:
path-found - A Boolean value that indicates whether a feasible path is found.
status - The status of the analysis (running | succeeded | failed).
nextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsAnalyses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeNetworkInsightsAnalyses
operationId: POST_DescribeNetworkInsightsAnalyses
description: Describes one or more of your network insights analyses.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAnalysesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsAnalysesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsAnalyses
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeNetworkInsightsPaths:
get:
x-aws-operation-name: DescribeNetworkInsightsPaths
operationId: GET_DescribeNetworkInsightsPaths
description: Describes one or more of your paths.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsPathsResult'
parameters:
- name: NetworkInsightsPathId
in: query
required: false
description: The IDs of the paths.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathId'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'The filters. The following are the possible values:
destination - The ID of the resource.
filter-at-source.source-address - The source IPv4 address at the source.
filter-at-source.source-port-range - The source port range at the source.
filter-at-source.destination-address - The destination IPv4 address at the source.
filter-at-source.destination-port-range - The destination port range at the source.
filter-at-destination.source-address - The source IPv4 address at the destination.
filter-at-destination.source-port-range - The source port range at the destination.
filter-at-destination.destination-address - The destination IPv4 address at the destination.
filter-at-destination.destination-port-range - The destination port range at the destination.
protocol - The protocol.
source - The ID of the resource.
nextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsPaths
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeNetworkInsightsPaths
operationId: POST_DescribeNetworkInsightsPaths
description: Describes one or more of your paths.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsPathsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInsightsPathsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInsightsPaths
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeNetworkInterfaceAttribute:
get:
x-aws-operation-name: DescribeNetworkInterfaceAttribute
operationId: GET_DescribeNetworkInterfaceAttribute
description: Describes a network interface attribute. You can specify only one attribute at a time.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
parameters:
- name: Attribute
in: query
required: false
description: The attribute of the network interface. This parameter is required.
schema:
type: string
enum:
- description
- groupSet
- sourceDestCheck
- attachment
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInterfaceId
in: query
required: true
description: The ID of the network interface.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInterfaceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeNetworkInterfaceAttribute
operationId: POST_DescribeNetworkInterfaceAttribute
description: Describes a network interface attribute. You can specify only one attribute at a time.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInterfaceAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeNetworkInterfaceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeNetworkInterfacePermissions:
get:
x-aws-operation-name: DescribeNetworkInterfacePermissions
operationId: GET_DescribeNetworkInterfacePermissions
description: 'Describes the permissions for your network interfaces. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
parameters:
- name: NetworkInterfacePermissionId
in: query
required: false
description: The network interface permission IDs.
schema:
type: array
items:
$ref: '#/components/schemas/NetworkInterfacePermissionId'
- name: Filter
in: query
required: false
description: One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInterfaceId
in: query
required: false
description: 'The network interface IDs.
Default: Describes all your network interfaces.
' schema: type: array items: allOf: - $ref: '#/components/schemas/NetworkInterfaceId' - xml: name: item - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.' schema: type: integer minimum: 5 maximum: 1000 - name: Action in: query required: true schema: type: string enum: - DescribeNetworkInterfaces - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeNetworkInterfaces operationId: POST_DescribeNetworkInterfaces description: Describes one or more of your network interfaces. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeNetworkInterfacesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeNetworkInterfacesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeNetworkInterfaces - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribePlacementGroups: get: x-aws-operation-name: DescribePlacementGroups operationId: GET_DescribePlacementGroups description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribePlacementGroupsResult' parameters: - name: Filter in: query required: false description: 'The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack).
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupName
in: query
required: false
description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' schema: type: array items: $ref: '#/components/schemas/PlacementGroupName' - name: GroupId in: query required: false description: The IDs of the placement groups. schema: type: array items: allOf: - $ref: '#/components/schemas/PlacementGroupId' - xml: name: GroupId - name: Action in: query required: true schema: type: string enum: - DescribePlacementGroups - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribePlacementGroups operationId: POST_DescribePlacementGroups description: 'Describes the specified placement groups or all of your placement groups. For more information, see Placement groups in the Amazon EC2 User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribePlacementGroupsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribePlacementGroupsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribePlacementGroups - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribePrefixLists: get: x-aws-operation-name: DescribePrefixLists operationId: GET_DescribePrefixLists description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribePrefixListsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
nextToken value.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: PrefixListId
in: query
required: false
description: One or more prefix list IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePrefixLists
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribePrefixLists
operationId: POST_DescribePrefixLists
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribePrefixListsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribePrefixListsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribePrefixLists - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribePrincipalIdFormat: get: x-aws-operation-name: DescribePrincipalIdFormat operationId: GET_DescribePrincipalIdFormat description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Resource
in: query
required: false
description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. '
schema:
type: integer
minimum: 1
maximum: 1000
- name: NextToken
in: query
required: false
description: The token to request the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribePrincipalIdFormat
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribePrincipalIdFormat
operationId: POST_DescribePrincipalIdFormat
description: '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.
nextToken value.'
schema:
type: integer
minimum: 1
maximum: 10
- name: Filter
in: query
required: false
description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.
For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeRegionsResult' parameters: - name: Filter in: query required: false description: 'The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: AllRegions
in: query
required: false
description: 'Indicates whether to display all Regions, including Regions that are disabled for your account.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeRegions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeRegions
operationId: POST_DescribeRegions
description: 'Describes the Regions that are enabled for your account, or all Regions.
For a list of the Regions supported by Amazon EC2, see Amazon Elastic Compute Cloud endpoints and quotas.
For information about enabling and disabling Regions for your account, see Managing Amazon Web Services Regions in the Amazon Web Services General Reference.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeRegionsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeRegionsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeRegions - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeReplaceRootVolumeTasks: get: x-aws-operation-name: DescribeReplaceRootVolumeTasks operationId: GET_DescribeReplaceRootVolumeTasks description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult' parameters: - name: ReplaceRootVolumeTaskId in: query required: false description: The ID of the root volume replacement task to view. schema: type: array items: allOf: - $ref: '#/components/schemas/ReplaceRootVolumeTaskId' - xml: name: ReplaceRootVolumeTaskId - name: Filter in: query required: false description: 'Filter to use:
instance-id - The ID of the instance for which the root volume replacement task was created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReplaceRootVolumeTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeReplaceRootVolumeTasks
operationId: POST_DescribeReplaceRootVolumeTasks
description: 'Describes a root volume replacement task. For more information, see Replace a root volume in the Amazon Elastic Compute Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeReplaceRootVolumeTasksResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeReplaceRootVolumeTasksRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReplaceRootVolumeTasks
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeReservedInstances:
get:
x-aws-operation-name: DescribeReservedInstances
operationId: GET_DescribeReservedInstances
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesResult' parameters: - name: Filter in: query required: false description: 'One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' schema: type: array items: allOf: - $ref: '#/components/schemas/ReservationId' - xml: name: ReservedInstancesId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: OfferingType
in: query
required: false
description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.'
schema:
type: string
enum:
- Heavy Utilization
- Medium Utilization
- Light Utilization
- No Upfront
- Partial Upfront
- All Upfront
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReservedInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeReservedInstances
operationId: POST_DescribeReservedInstances
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeReservedInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeReservedInstancesListings: get: x-aws-operation-name: DescribeReservedInstancesListings operationId: GET_DescribeReservedInstancesListings description: 'Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' parameters: - name: Filter in: query required: false description:One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
Describes your account''s Reserved Instance listings in the Reserved Instance Marketplace.
The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances.
As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase.
As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you''re searching for with what''s available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesListingsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesListingsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeReservedInstancesListings - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeReservedInstancesModifications: get: x-aws-operation-name: DescribeReservedInstancesModifications operationId: GET_DescribeReservedInstancesModifications description: 'Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' parameters: - name: Filter in: query required: false description:One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesModificationsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesModificationsRequest' parameters: - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeReservedInstancesModifications - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeReservedInstancesOfferings: get: x-aws-operation-name: DescribeReservedInstancesOfferings operationId: GET_DescribeReservedInstancesOfferings description: 'Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' parameters: - name: AvailabilityZone in: query required: false description: The Availability Zone in which the Reserved Instance can be used. schema: type: string - name: Filter in: query required: false description: 'One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
m1.small). For more information, see Instance types in the Amazon EC2 User Guide.'
schema:
type: string
enum:
- a1.medium
- a1.large
- a1.xlarge
- a1.2xlarge
- a1.4xlarge
- a1.metal
- c1.medium
- c1.xlarge
- c3.large
- c3.xlarge
- c3.2xlarge
- c3.4xlarge
- c3.8xlarge
- c4.large
- c4.xlarge
- c4.2xlarge
- c4.4xlarge
- c4.8xlarge
- c5.large
- c5.xlarge
- c5.2xlarge
- c5.4xlarge
- c5.9xlarge
- c5.12xlarge
- c5.18xlarge
- c5.24xlarge
- c5.metal
- c5a.large
- c5a.xlarge
- c5a.2xlarge
- c5a.4xlarge
- c5a.8xlarge
- c5a.12xlarge
- c5a.16xlarge
- c5a.24xlarge
- c5ad.large
- c5ad.xlarge
- c5ad.2xlarge
- c5ad.4xlarge
- c5ad.8xlarge
- c5ad.12xlarge
- c5ad.16xlarge
- c5ad.24xlarge
- c5d.large
- c5d.xlarge
- c5d.2xlarge
- c5d.4xlarge
- c5d.9xlarge
- c5d.12xlarge
- c5d.18xlarge
- c5d.24xlarge
- c5d.metal
- c5n.large
- c5n.xlarge
- c5n.2xlarge
- c5n.4xlarge
- c5n.9xlarge
- c5n.18xlarge
- c5n.metal
- c6g.medium
- c6g.large
- c6g.xlarge
- c6g.2xlarge
- c6g.4xlarge
- c6g.8xlarge
- c6g.12xlarge
- c6g.16xlarge
- c6g.metal
- c6gd.medium
- c6gd.large
- c6gd.xlarge
- c6gd.2xlarge
- c6gd.4xlarge
- c6gd.8xlarge
- c6gd.12xlarge
- c6gd.16xlarge
- c6gd.metal
- c6gn.medium
- c6gn.large
- c6gn.xlarge
- c6gn.2xlarge
- c6gn.4xlarge
- c6gn.8xlarge
- c6gn.12xlarge
- c6gn.16xlarge
- c6i.large
- c6i.xlarge
- c6i.2xlarge
- c6i.4xlarge
- c6i.8xlarge
- c6i.12xlarge
- c6i.16xlarge
- c6i.24xlarge
- c6i.32xlarge
- c6i.metal
- cc1.4xlarge
- cc2.8xlarge
- cg1.4xlarge
- cr1.8xlarge
- d2.xlarge
- d2.2xlarge
- d2.4xlarge
- d2.8xlarge
- d3.xlarge
- d3.2xlarge
- d3.4xlarge
- d3.8xlarge
- d3en.xlarge
- d3en.2xlarge
- d3en.4xlarge
- d3en.6xlarge
- d3en.8xlarge
- d3en.12xlarge
- dl1.24xlarge
- f1.2xlarge
- f1.4xlarge
- f1.16xlarge
- g2.2xlarge
- g2.8xlarge
- g3.4xlarge
- g3.8xlarge
- g3.16xlarge
- g3s.xlarge
- g4ad.xlarge
- g4ad.2xlarge
- g4ad.4xlarge
- g4ad.8xlarge
- g4ad.16xlarge
- g4dn.xlarge
- g4dn.2xlarge
- g4dn.4xlarge
- g4dn.8xlarge
- g4dn.12xlarge
- g4dn.16xlarge
- g4dn.metal
- g5.xlarge
- g5.2xlarge
- g5.4xlarge
- g5.8xlarge
- g5.12xlarge
- g5.16xlarge
- g5.24xlarge
- g5.48xlarge
- g5g.xlarge
- g5g.2xlarge
- g5g.4xlarge
- g5g.8xlarge
- g5g.16xlarge
- g5g.metal
- hi1.4xlarge
- hpc6a.48xlarge
- hs1.8xlarge
- h1.2xlarge
- h1.4xlarge
- h1.8xlarge
- h1.16xlarge
- i2.xlarge
- i2.2xlarge
- i2.4xlarge
- i2.8xlarge
- i3.large
- i3.xlarge
- i3.2xlarge
- i3.4xlarge
- i3.8xlarge
- i3.16xlarge
- i3.metal
- i3en.large
- i3en.xlarge
- i3en.2xlarge
- i3en.3xlarge
- i3en.6xlarge
- i3en.12xlarge
- i3en.24xlarge
- i3en.metal
- im4gn.large
- im4gn.xlarge
- im4gn.2xlarge
- im4gn.4xlarge
- im4gn.8xlarge
- im4gn.16xlarge
- inf1.xlarge
- inf1.2xlarge
- inf1.6xlarge
- inf1.24xlarge
- is4gen.medium
- is4gen.large
- is4gen.xlarge
- is4gen.2xlarge
- is4gen.4xlarge
- is4gen.8xlarge
- m1.small
- m1.medium
- m1.large
- m1.xlarge
- m2.xlarge
- m2.2xlarge
- m2.4xlarge
- m3.medium
- m3.large
- m3.xlarge
- m3.2xlarge
- m4.large
- m4.xlarge
- m4.2xlarge
- m4.4xlarge
- m4.10xlarge
- m4.16xlarge
- m5.large
- m5.xlarge
- m5.2xlarge
- m5.4xlarge
- m5.8xlarge
- m5.12xlarge
- m5.16xlarge
- m5.24xlarge
- m5.metal
- m5a.large
- m5a.xlarge
- m5a.2xlarge
- m5a.4xlarge
- m5a.8xlarge
- m5a.12xlarge
- m5a.16xlarge
- m5a.24xlarge
- m5ad.large
- m5ad.xlarge
- m5ad.2xlarge
- m5ad.4xlarge
- m5ad.8xlarge
- m5ad.12xlarge
- m5ad.16xlarge
- m5ad.24xlarge
- m5d.large
- m5d.xlarge
- m5d.2xlarge
- m5d.4xlarge
- m5d.8xlarge
- m5d.12xlarge
- m5d.16xlarge
- m5d.24xlarge
- m5d.metal
- m5dn.large
- m5dn.xlarge
- m5dn.2xlarge
- m5dn.4xlarge
- m5dn.8xlarge
- m5dn.12xlarge
- m5dn.16xlarge
- m5dn.24xlarge
- m5dn.metal
- m5n.large
- m5n.xlarge
- m5n.2xlarge
- m5n.4xlarge
- m5n.8xlarge
- m5n.12xlarge
- m5n.16xlarge
- m5n.24xlarge
- m5n.metal
- m5zn.large
- m5zn.xlarge
- m5zn.2xlarge
- m5zn.3xlarge
- m5zn.6xlarge
- m5zn.12xlarge
- m5zn.metal
- m6a.large
- m6a.xlarge
- m6a.2xlarge
- m6a.4xlarge
- m6a.8xlarge
- m6a.12xlarge
- m6a.16xlarge
- m6a.24xlarge
- m6a.32xlarge
- m6a.48xlarge
- m6g.metal
- m6g.medium
- m6g.large
- m6g.xlarge
- m6g.2xlarge
- m6g.4xlarge
- m6g.8xlarge
- m6g.12xlarge
- m6g.16xlarge
- m6gd.metal
- m6gd.medium
- m6gd.large
- m6gd.xlarge
- m6gd.2xlarge
- m6gd.4xlarge
- m6gd.8xlarge
- m6gd.12xlarge
- m6gd.16xlarge
- m6i.large
- m6i.xlarge
- m6i.2xlarge
- m6i.4xlarge
- m6i.8xlarge
- m6i.12xlarge
- m6i.16xlarge
- m6i.24xlarge
- m6i.32xlarge
- m6i.metal
- mac1.metal
- p2.xlarge
- p2.8xlarge
- p2.16xlarge
- p3.2xlarge
- p3.8xlarge
- p3.16xlarge
- p3dn.24xlarge
- p4d.24xlarge
- r3.large
- r3.xlarge
- r3.2xlarge
- r3.4xlarge
- r3.8xlarge
- r4.large
- r4.xlarge
- r4.2xlarge
- r4.4xlarge
- r4.8xlarge
- r4.16xlarge
- r5.large
- r5.xlarge
- r5.2xlarge
- r5.4xlarge
- r5.8xlarge
- r5.12xlarge
- r5.16xlarge
- r5.24xlarge
- r5.metal
- r5a.large
- r5a.xlarge
- r5a.2xlarge
- r5a.4xlarge
- r5a.8xlarge
- r5a.12xlarge
- r5a.16xlarge
- r5a.24xlarge
- r5ad.large
- r5ad.xlarge
- r5ad.2xlarge
- r5ad.4xlarge
- r5ad.8xlarge
- r5ad.12xlarge
- r5ad.16xlarge
- r5ad.24xlarge
- r5b.large
- r5b.xlarge
- r5b.2xlarge
- r5b.4xlarge
- r5b.8xlarge
- r5b.12xlarge
- r5b.16xlarge
- r5b.24xlarge
- r5b.metal
- r5d.large
- r5d.xlarge
- r5d.2xlarge
- r5d.4xlarge
- r5d.8xlarge
- r5d.12xlarge
- r5d.16xlarge
- r5d.24xlarge
- r5d.metal
- r5dn.large
- r5dn.xlarge
- r5dn.2xlarge
- r5dn.4xlarge
- r5dn.8xlarge
- r5dn.12xlarge
- r5dn.16xlarge
- r5dn.24xlarge
- r5dn.metal
- r5n.large
- r5n.xlarge
- r5n.2xlarge
- r5n.4xlarge
- r5n.8xlarge
- r5n.12xlarge
- r5n.16xlarge
- r5n.24xlarge
- r5n.metal
- r6g.medium
- r6g.large
- r6g.xlarge
- r6g.2xlarge
- r6g.4xlarge
- r6g.8xlarge
- r6g.12xlarge
- r6g.16xlarge
- r6g.metal
- r6gd.medium
- r6gd.large
- r6gd.xlarge
- r6gd.2xlarge
- r6gd.4xlarge
- r6gd.8xlarge
- r6gd.12xlarge
- r6gd.16xlarge
- r6gd.metal
- r6i.large
- r6i.xlarge
- r6i.2xlarge
- r6i.4xlarge
- r6i.8xlarge
- r6i.12xlarge
- r6i.16xlarge
- r6i.24xlarge
- r6i.32xlarge
- r6i.metal
- t1.micro
- t2.nano
- t2.micro
- t2.small
- t2.medium
- t2.large
- t2.xlarge
- t2.2xlarge
- t3.nano
- t3.micro
- t3.small
- t3.medium
- t3.large
- t3.xlarge
- t3.2xlarge
- t3a.nano
- t3a.micro
- t3a.small
- t3a.medium
- t3a.large
- t3a.xlarge
- t3a.2xlarge
- t4g.nano
- t4g.micro
- t4g.small
- t4g.medium
- t4g.large
- t4g.xlarge
- t4g.2xlarge
- u-6tb1.56xlarge
- u-6tb1.112xlarge
- u-9tb1.112xlarge
- u-12tb1.112xlarge
- u-6tb1.metal
- u-9tb1.metal
- u-12tb1.metal
- u-18tb1.metal
- u-24tb1.metal
- vt1.3xlarge
- vt1.6xlarge
- vt1.24xlarge
- x1.16xlarge
- x1.32xlarge
- x1e.xlarge
- x1e.2xlarge
- x1e.4xlarge
- x1e.8xlarge
- x1e.16xlarge
- x1e.32xlarge
- x2iezn.2xlarge
- x2iezn.4xlarge
- x2iezn.6xlarge
- x2iezn.8xlarge
- x2iezn.12xlarge
- x2iezn.metal
- x2gd.medium
- x2gd.large
- x2gd.xlarge
- x2gd.2xlarge
- x2gd.4xlarge
- x2gd.8xlarge
- x2gd.12xlarge
- x2gd.16xlarge
- x2gd.metal
- z1d.large
- z1d.xlarge
- z1d.2xlarge
- z1d.3xlarge
- z1d.6xlarge
- z1d.12xlarge
- z1d.metal
- x2idn.16xlarge
- x2idn.24xlarge
- x2idn.32xlarge
- x2iedn.xlarge
- x2iedn.2xlarge
- x2iedn.4xlarge
- x2iedn.8xlarge
- x2iedn.16xlarge
- x2iedn.24xlarge
- x2iedn.32xlarge
- c6a.large
- c6a.xlarge
- c6a.2xlarge
- c6a.4xlarge
- c6a.8xlarge
- c6a.12xlarge
- c6a.16xlarge
- c6a.24xlarge
- c6a.32xlarge
- c6a.48xlarge
- c6a.metal
- m6a.metal
- i4i.large
- i4i.xlarge
- i4i.2xlarge
- i4i.4xlarge
- i4i.8xlarge
- i4i.16xlarge
- i4i.32xlarge
- i4i.metal
- x2idn.metal
- x2iedn.metal
- c7g.medium
- c7g.large
- c7g.xlarge
- c7g.2xlarge
- c7g.4xlarge
- c7g.8xlarge
- c7g.12xlarge
- c7g.16xlarge
- mac2.metal
- c6id.large
- c6id.xlarge
- c6id.2xlarge
- c6id.4xlarge
- c6id.8xlarge
- c6id.12xlarge
- c6id.16xlarge
- c6id.24xlarge
- c6id.32xlarge
- c6id.metal
- m6id.large
- m6id.xlarge
- m6id.2xlarge
- m6id.4xlarge
- m6id.8xlarge
- m6id.12xlarge
- m6id.16xlarge
- m6id.24xlarge
- m6id.32xlarge
- m6id.metal
- r6id.large
- r6id.xlarge
- r6id.2xlarge
- r6id.4xlarge
- r6id.8xlarge
- r6id.12xlarge
- r6id.16xlarge
- r6id.24xlarge
- r6id.32xlarge
- r6id.metal
- r6a.large
- r6a.xlarge
- r6a.2xlarge
- r6a.4xlarge
- r6a.8xlarge
- r6a.12xlarge
- r6a.16xlarge
- r6a.24xlarge
- r6a.32xlarge
- r6a.48xlarge
- r6a.metal
- p4de.24xlarge
- u-3tb1.56xlarge
- u-18tb1.112xlarge
- u-24tb1.112xlarge
- trn1.2xlarge
- trn1.32xlarge
- hpc6id.32xlarge
- c6in.large
- c6in.xlarge
- c6in.2xlarge
- c6in.4xlarge
- c6in.8xlarge
- c6in.12xlarge
- c6in.16xlarge
- c6in.24xlarge
- c6in.32xlarge
- m6in.large
- m6in.xlarge
- m6in.2xlarge
- m6in.4xlarge
- m6in.8xlarge
- m6in.12xlarge
- m6in.16xlarge
- m6in.24xlarge
- m6in.32xlarge
- m6idn.large
- m6idn.xlarge
- m6idn.2xlarge
- m6idn.4xlarge
- m6idn.8xlarge
- m6idn.12xlarge
- m6idn.16xlarge
- m6idn.24xlarge
- m6idn.32xlarge
- r6in.large
- r6in.xlarge
- r6in.2xlarge
- r6in.4xlarge
- r6in.8xlarge
- r6in.12xlarge
- r6in.16xlarge
- r6in.24xlarge
- r6in.32xlarge
- r6idn.large
- r6idn.xlarge
- r6idn.2xlarge
- r6idn.4xlarge
- r6idn.8xlarge
- r6idn.12xlarge
- r6idn.16xlarge
- r6idn.24xlarge
- r6idn.32xlarge
- c7g.metal
- m7g.medium
- m7g.large
- m7g.xlarge
- m7g.2xlarge
- m7g.4xlarge
- m7g.8xlarge
- m7g.12xlarge
- m7g.16xlarge
- m7g.metal
- r7g.medium
- r7g.large
- r7g.xlarge
- r7g.2xlarge
- r7g.4xlarge
- r7g.8xlarge
- r7g.12xlarge
- r7g.16xlarge
- r7g.metal
- c6in.metal
- m6in.metal
- m6idn.metal
- r6in.metal
- r6idn.metal
- inf2.xlarge
- inf2.8xlarge
- inf2.24xlarge
- inf2.48xlarge
- trn1n.32xlarge
- i4g.large
- i4g.xlarge
- i4g.2xlarge
- i4g.4xlarge
- i4g.8xlarge
- i4g.16xlarge
- hpc7g.4xlarge
- hpc7g.8xlarge
- hpc7g.16xlarge
- c7gn.medium
- c7gn.large
- c7gn.xlarge
- c7gn.2xlarge
- c7gn.4xlarge
- c7gn.8xlarge
- c7gn.12xlarge
- c7gn.16xlarge
- name: MaxDuration
in: query
required: false
description: 'The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
' schema: type: integer - name: MaxInstanceCount in: query required: false description: 'The maximum number of instances to filter when searching for offerings.
Default: 20
' schema: type: integer - name: MinDuration in: query required: false description: 'The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
' schema: type: integer - name: OfferingClass in: query required: false description: The offering class of the Reserved Instance. Can bestandard or convertible.
schema:
type: string
enum:
- standard
- convertible
- name: ProductDescription
in: query
required: false
description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
schema:
type: string
enum:
- Linux/UNIX
- Linux/UNIX (Amazon VPC)
- Windows
- Windows (Amazon VPC)
- name: ReservedInstancesOfferingId
in: query
required: false
description: One or more Reserved Instances offering IDs.
schema:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesOfferingId'
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceTenancy
in: query
required: false
description: 'The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
' schema: type: integer - name: NextToken in: query required: false description: The token to retrieve the next page of results. schema: type: string - name: OfferingType in: query required: false description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to theMedium Utilization Reserved Instance offering type. '
schema:
type: string
enum:
- Heavy Utilization
- Medium Utilization
- Light Utilization
- No Upfront
- Partial Upfront
- All Upfront
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeReservedInstancesOfferings
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeReservedInstancesOfferings
operationId: POST_DescribeReservedInstancesOfferings
description: 'Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeReservedInstancesOfferingsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeReservedInstancesOfferings - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeRouteTables: get: x-aws-operation-name: DescribeRouteTables operationId: GET_DescribeRouteTables description: 'Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeRouteTablesResult' parameters: - name: Filter in: query required: false description: 'The filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: RouteTableId
in: query
required: false
description: 'The IDs of the route tables.
Default: Describes all your route tables.
' schema: type: array items: allOf: - $ref: '#/components/schemas/RouteTableId' - xml: name: item - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer minimum: 5 maximum: 100 - name: Action in: query required: true schema: type: string enum: - DescribeRouteTables - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeRouteTables operationId: POST_DescribeRouteTables description: 'Describes one or more of your route tables.
Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations.
For more information, see Route tables in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeRouteTablesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeRouteTablesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeRouteTables - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeScheduledInstanceAvailability: get: x-aws-operation-name: DescribeScheduledInstanceAvailability operationId: GET_DescribeScheduledInstanceAvailability description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
schema:
type: integer
minimum: 5
maximum: 300
- name: MaxSlotDurationInHours
in: query
required: false
description: 'The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.'
schema:
type: integer
- name: MinSlotDurationInHours
in: query
required: false
description: 'The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next set of results.
schema:
type: string
- name: Recurrence
in: query
required: true
description: The schedule recurrence.
schema:
type: object
properties:
Frequency:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The frequency (Daily, Weekly, or Monthly).'
Interval:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.'
OccurrenceDays:
allOf:
- $ref: '#/components/schemas/OccurrenceDayRequestSet'
- xml:
name: OccurrenceDay
description: 'The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can''t specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.'
OccurrenceRelativeToEnd:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
OccurrenceUnit:
allOf:
- $ref: '#/components/schemas/String'
- description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
description: Describes the recurring schedule for a Scheduled Instance.
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeScheduledInstanceAvailability
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeScheduledInstanceAvailability
operationId: POST_DescribeScheduledInstanceAvailability
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeScheduledInstanceAvailability - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeScheduledInstances: get: x-aws-operation-name: DescribeScheduledInstances operationId: GET_DescribeScheduledInstances description: Describes the specified Scheduled Instances or all your Scheduled Instances. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeScheduledInstancesResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next set of results.
schema:
type: string
- name: ScheduledInstanceId
in: query
required: false
description: The Scheduled Instance IDs.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceId'
- xml:
name: ScheduledInstanceId
- name: SlotStartTimeRange
in: query
required: false
description: The time period for the first schedule to start.
schema:
type: object
properties:
EarliestTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The earliest date and time, in UTC, for the Scheduled Instance to start.'
LatestTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The latest date and time, in UTC, for the Scheduled Instance to start.'
description: Describes the time period for a Scheduled Instance to start its first schedule.
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeScheduledInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeScheduledInstances
operationId: POST_DescribeScheduledInstances
description: Describes the specified Scheduled Instances or all your Scheduled Instances.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeScheduledInstancesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeScheduledInstancesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeScheduledInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeSecurityGroupReferences:
get:
x-aws-operation-name: DescribeSecurityGroupReferences
operationId: GET_DescribeSecurityGroupReferences
description: Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupId
in: query
required: true
description: The IDs of the security groups in your account.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSecurityGroupReferences
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSecurityGroupReferences
operationId: POST_DescribeSecurityGroupReferences
description: Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupReferencesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSecurityGroupReferences
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeSecurityGroupRules:
get:
x-aws-operation-name: DescribeSecurityGroupRules
operationId: GET_DescribeSecurityGroupRules
description: Describes one or more of your security group rules.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupRulesResult'
parameters:
- name: Filter
in: query
required: false
description: 'One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSecurityGroupRules
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSecurityGroupRules
operationId: POST_DescribeSecurityGroupRules
description: Describes one or more of your security group rules.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupRulesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupRulesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSecurityGroupRules
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeSecurityGroups:
get:
x-aws-operation-name: DescribeSecurityGroups
operationId: GET_DescribeSecurityGroups
description: Describes the specified security groups or all of your security groups.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupsResult'
parameters:
- name: Filter
in: query
required: false
description: 'The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
' schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupId' - xml: name: groupId - name: GroupName in: query required: false description: '[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.
Default: Describes all of your security groups.
' schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupName' - xml: name: GroupName - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSecurityGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSecurityGroups
operationId: POST_DescribeSecurityGroups
description: Describes the specified security groups or all of your security groups.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSecurityGroupsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSecurityGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeSnapshotAttribute:
get:
x-aws-operation-name: DescribeSnapshotAttribute
operationId: GET_DescribeSnapshotAttribute
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSnapshotAttributeResult' parameters: - name: Attribute in: query required: true description: The snapshot attribute you would like to view. schema: type: string enum: - productCodes - createVolumePermission - name: SnapshotId in: query required: true description: The ID of the EBS snapshot. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSnapshotAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSnapshotAttribute
operationId: POST_DescribeSnapshotAttribute
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSnapshotAttributeResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeSnapshotAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeSnapshotAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeSnapshotTierStatus: get: x-aws-operation-name: DescribeSnapshotTierStatus operationId: GET_DescribeSnapshotTierStatus description: Describes the storage tier status of one or more Amazon EBS snapshots. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSnapshotTierStatusResult' parameters: - name: Filter in: query required: false description:The filters.
snapshot-id - The snapshot ID.
volume-id - The ID of the volume the snapshot is for.
last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSnapshotTierStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSnapshotTierStatus
operationId: POST_DescribeSnapshotTierStatus
description: Describes the storage tier status of one or more Amazon EBS snapshots.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSnapshotTierStatusResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSnapshotTierStatusRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSnapshotTierStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeSnapshots:
get:
x-aws-operation-name: DescribeSnapshots
operationId: GET_DescribeSnapshots
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSnapshotsResult' parameters: - name: Filter in: query required: false description: 'The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
storage-tier - The storage tier of the snapshot (archive | standard).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
self, and amazon.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: Owner
- name: RestorableBy
in: query
required: false
description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
schema:
type: array
items:
$ref: '#/components/schemas/String'
- name: SnapshotId
in: query
required: false
description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' schema: type: array items: allOf: - $ref: '#/components/schemas/SnapshotId' - xml: name: SnapshotId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSnapshots
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSnapshots
operationId: POST_DescribeSnapshots
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSnapshotsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeSnapshotsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeSnapshots - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeSpotDatafeedSubscription: get: x-aws-operation-name: DescribeSpotDatafeedSubscription operationId: GET_DescribeSpotDatafeedSubscription description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotDatafeedSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSpotDatafeedSubscription
operationId: POST_DescribeSpotDatafeedSubscription
description: 'Describes the data feed for Spot Instances. For more information, see Spot Instance data feed in the Amazon EC2 User Guide for Linux Instances.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotDatafeedSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeSpotFleetInstances:
get:
x-aws-operation-name: DescribeSpotFleetInstances
operationId: GET_DescribeSpotFleetInstances
description: Describes the running instances for the specified Spot Fleet.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 1
maximum: 1000
- name: NextToken
in: query
required: false
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
schema:
type: string
- name: SpotFleetRequestId
in: query
required: true
description: The ID of the Spot Fleet request.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotFleetInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSpotFleetInstances
operationId: POST_DescribeSpotFleetInstances
description: Describes the running instances for the specified Spot Fleet.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeSpotFleetInstancesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotFleetInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeSpotFleetRequestHistory:
get:
x-aws-operation-name: DescribeSpotFleetRequestHistory
operationId: GET_DescribeSpotFleetRequestHistory
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EventType
in: query
required: false
description: 'The type of events to describe. By default, all events are described.'
schema:
type: string
enum:
- instanceChange
- fleetRequestChange
- error
- information
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 1
maximum: 1000
- name: NextToken
in: query
required: false
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
schema:
type: string
- name: SpotFleetRequestId
in: query
required: true
description: The ID of the Spot Fleet request.
schema:
type: string
- name: StartTime
in: query
required: true
description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
schema:
type: string
format: date-time
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotFleetRequestHistory
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSpotFleetRequestHistory
operationId: POST_DescribeSpotFleetRequestHistory
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeSpotFleetRequestHistory - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeSpotFleetRequests: get: x-aws-operation-name: DescribeSpotFleetRequests operationId: GET_DescribeSpotFleetRequests description:Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
schema:
type: string
- name: SpotFleetRequestId
in: query
required: false
description: The IDs of the Spot Fleet requests.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotFleetRequests
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSpotFleetRequests
operationId: POST_DescribeSpotFleetRequests
description: Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotFleetRequestsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeSpotFleetRequests - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeSpotInstanceRequests: get: x-aws-operation-name: DescribeSpotInstanceRequests operationId: GET_DescribeSpotInstanceRequests description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' parameters: - name: Filter in: query required: false description: 'The filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SpotInstanceRequestId
in: query
required: false
description: The IDs of the Spot Instance requests.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotInstanceRequestId'
- xml:
name: SpotInstanceRequestId
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotInstanceRequests
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSpotInstanceRequests
operationId: POST_DescribeSpotInstanceRequests
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotInstanceRequestsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeSpotInstanceRequests - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeSpotPriceHistory: get: x-aws-operation-name: DescribeSpotPriceHistory operationId: GET_DescribeSpotPriceHistory description: 'Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' parameters: - name: Filter in: query required: false description: 'The filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EndTime
in: query
required: false
description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
schema:
type: string
format: date-time
- name: InstanceType
in: query
required: false
description: Filters the results by the specified instance types.
schema:
type: array
items:
$ref: '#/components/schemas/InstanceType'
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: ProductDescription
in: query
required: false
description: Filters the results by the specified basic product descriptions.
schema:
type: array
items:
$ref: '#/components/schemas/String'
- name: StartTime
in: query
required: false
description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
schema:
type: string
format: date-time
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSpotPriceHistory
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSpotPriceHistory
operationId: POST_DescribeSpotPriceHistory
description: 'Describes the Spot price history. For more information, see Spot Instance pricing history in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotPriceHistoryResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeSpotPriceHistoryRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeSpotPriceHistory - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeStaleSecurityGroups: get: x-aws-operation-name: DescribeStaleSecurityGroups operationId: GET_DescribeStaleSecurityGroups description: 'Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeStaleSecurityGroupsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 255
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
minLength: 1
maxLength: 1024
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeStaleSecurityGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeStaleSecurityGroups
operationId: POST_DescribeStaleSecurityGroups
description: 'Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in the same VPC or in a peer VPC, or if they reference a security group in a peer VPC for which the VPC peering connection has been deleted.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeStaleSecurityGroupsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeStaleSecurityGroupsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeStaleSecurityGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeStoreImageTasks:
get:
x-aws-operation-name: DescribeStoreImageTasks
operationId: GET_DescribeStoreImageTasks
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeStoreImageTasksResult' parameters: - name: ImageId in: query required: false description: The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request. schema: type: array items: allOf: - $ref: '#/components/schemas/ImageId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'The filters.
task-state - Returns tasks in a certain state (InProgress | Completed | Failed)
bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the ImageIDs parameter in the same call.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeStoreImageTasksResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeStoreImageTasksRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeStoreImageTasks - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeSubnets: get: x-aws-operation-name: DescribeSubnets operationId: GET_DescribeSubnets description: 'Describes one or more of your subnets.
For more information, see Subnets in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSubnetsResult' parameters: - name: Filter in: query required: false description: 'The filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.
default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.
enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).
private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
The IDs of the subnets.
Default: Describes all your subnets.
' schema: type: array items: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: SubnetId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeSubnets
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeSubnets
operationId: POST_DescribeSubnets
description: 'Describes one or more of your subnets.
For more information, see Subnets in the Amazon VPC User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeSubnetsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeSubnetsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeSubnets - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeTags: get: x-aws-operation-name: DescribeTags operationId: GET_DescribeTags description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeTagsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeTagsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeTagsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeTags - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeTrafficMirrorFilters: get: x-aws-operation-name: DescribeTrafficMirrorFilters operationId: GET_DescribeTrafficMirrorFilters description: Describes one or more Traffic Mirror filters. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult' parameters: - name: TrafficMirrorFilterId in: query required: false description: The ID of the Traffic Mirror filter. schema: type: array items: allOf: - $ref: '#/components/schemas/TrafficMirrorFilterId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
description: The Traffic Mirror filter description.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficMirrorFilters
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTrafficMirrorFilters
operationId: POST_DescribeTrafficMirrorFilters
description: Describes one or more Traffic Mirror filters.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorFiltersResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorFiltersRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficMirrorFilters
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTrafficMirrorSessions:
get:
x-aws-operation-name: DescribeTrafficMirrorSessions
operationId: GET_DescribeTrafficMirrorSessions
description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult'
parameters:
- name: TrafficMirrorSessionId
in: query
required: false
description: The ID of the Traffic Mirror session.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSessionId'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
description: The Traffic Mirror session description.
network-interface-id: The ID of the Traffic Mirror session network interface.
owner-id: The ID of the account that owns the Traffic Mirror session.
packet-length: The assigned number of packets to mirror.
session-number: The assigned session number.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
virtual-network-id: The virtual network ID of the Traffic Mirror session.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficMirrorSessions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTrafficMirrorSessions
operationId: POST_DescribeTrafficMirrorSessions
description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorSessionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorSessionsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficMirrorSessions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTrafficMirrorTargets:
get:
x-aws-operation-name: DescribeTrafficMirrorTargets
operationId: GET_DescribeTrafficMirrorTargets
description: Information about one or more Traffic Mirror targets.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult'
parameters:
- name: TrafficMirrorTargetId
in: query
required: false
description: The ID of the Traffic Mirror targets.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetId'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
description: The Traffic Mirror target description.
network-interface-id: The ID of the Traffic Mirror session network interface.
network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
owner-id: The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficMirrorTargets
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTrafficMirrorTargets
operationId: POST_DescribeTrafficMirrorTargets
description: Information about one or more Traffic Mirror targets.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorTargetsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTrafficMirrorTargetsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrafficMirrorTargets
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayAttachments:
get:
x-aws-operation-name: DescribeTransitGatewayAttachments
operationId: GET_DescribeTransitGatewayAttachments
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
parameters:
- name: TransitGatewayAttachmentIds
in: query
required: false
description: The IDs of the attachments.
schema:
type: array
items:
$ref: '#/components/schemas/TransitGatewayAttachmentId'
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayAttachments
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayAttachments
operationId: POST_DescribeTransitGatewayAttachments
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayAttachmentsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayAttachments
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayConnectPeers:
get:
x-aws-operation-name: DescribeTransitGatewayConnectPeers
operationId: GET_DescribeTransitGatewayConnectPeers
description: Describes one or more Connect peers.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult'
parameters:
- name: TransitGatewayConnectPeerIds
in: query
required: false
description: The IDs of the Connect peers.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerId'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayConnectPeers
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayConnectPeers
operationId: POST_DescribeTransitGatewayConnectPeers
description: Describes one or more Connect peers.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayConnectPeersResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayConnectPeersRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayConnectPeers
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayConnects:
get:
x-aws-operation-name: DescribeTransitGatewayConnects
operationId: GET_DescribeTransitGatewayConnects
description: Describes one or more Connect attachments.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayConnectsResult'
parameters:
- name: TransitGatewayAttachmentIds
in: query
required: false
description: The IDs of the attachments.
schema:
type: array
items:
$ref: '#/components/schemas/TransitGatewayAttachmentId'
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayConnects
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayConnects
operationId: POST_DescribeTransitGatewayConnects
description: Describes one or more Connect attachments.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayConnectsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayConnectsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayConnects
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayMulticastDomains:
get:
x-aws-operation-name: DescribeTransitGatewayMulticastDomains
operationId: GET_DescribeTransitGatewayMulticastDomains
description: Describes one or more transit gateway multicast domains.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult'
parameters:
- name: TransitGatewayMulticastDomainIds
in: query
required: false
description: The ID of the transit gateway multicast domain.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayMulticastDomains
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayMulticastDomains
operationId: POST_DescribeTransitGatewayMulticastDomains
description: Describes one or more transit gateway multicast domains.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayMulticastDomainsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayMulticastDomains
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayPeeringAttachments:
get:
x-aws-operation-name: DescribeTransitGatewayPeeringAttachments
operationId: GET_DescribeTransitGatewayPeeringAttachments
description: Describes your transit gateway peering attachments.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult'
parameters:
- name: TransitGatewayAttachmentIds
in: query
required: false
description: One or more IDs of the transit gateway peering attachments.
schema:
type: array
items:
$ref: '#/components/schemas/TransitGatewayAttachmentId'
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayPeeringAttachments
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayPeeringAttachments
operationId: POST_DescribeTransitGatewayPeeringAttachments
description: Describes your transit gateway peering attachments.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayPeeringAttachmentsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayPeeringAttachments
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayPolicyTables:
get:
x-aws-operation-name: DescribeTransitGatewayPolicyTables
operationId: GET_DescribeTransitGatewayPolicyTables
description: 'Describes one or more transit gateway route policy tables. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayPolicyTablesResult'
parameters:
- name: TransitGatewayPolicyTableIds
in: query
required: false
description: The IDs of the transit gateway policy tables.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- xml:
name: item
- name: Filter
in: query
required: false
description: The filters associated with the transit gateway policy table.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayPolicyTables
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayPolicyTables
operationId: POST_DescribeTransitGatewayPolicyTables
description: 'Describes one or more transit gateway route policy tables. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayPolicyTablesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayPolicyTablesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayPolicyTables
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayRouteTableAnnouncements:
get:
x-aws-operation-name: DescribeTransitGatewayRouteTableAnnouncements
operationId: GET_DescribeTransitGatewayRouteTableAnnouncements
description: Describes one or more transit gateway route table advertisements.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTableAnnouncementsResult'
parameters:
- name: TransitGatewayRouteTableAnnouncementIds
in: query
required: false
description: The IDs of the transit gateway route tables that are being advertised.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- xml:
name: item
- name: Filter
in: query
required: false
description: The filters associated with the transit gateway policy table.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayRouteTableAnnouncements
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayRouteTableAnnouncements
operationId: POST_DescribeTransitGatewayRouteTableAnnouncements
description: Describes one or more transit gateway route table advertisements.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTableAnnouncementsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTableAnnouncementsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayRouteTableAnnouncements
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayRouteTables:
get:
x-aws-operation-name: DescribeTransitGatewayRouteTables
operationId: GET_DescribeTransitGatewayRouteTables
description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
parameters:
- name: TransitGatewayRouteTableIds
in: query
required: false
description: The IDs of the transit gateway route tables.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
state - The state of the route table (available | deleting | deleted | pending).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayRouteTables
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayRouteTables
operationId: POST_DescribeTransitGatewayRouteTables
description: 'Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTablesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayRouteTables
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGatewayVpcAttachments:
get:
x-aws-operation-name: DescribeTransitGatewayVpcAttachments
operationId: GET_DescribeTransitGatewayVpcAttachments
description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
parameters:
- name: TransitGatewayAttachmentIds
in: query
required: false
description: The IDs of the attachments.
schema:
type: array
items:
$ref: '#/components/schemas/TransitGatewayAttachmentId'
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayVpcAttachments
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGatewayVpcAttachments
operationId: POST_DescribeTransitGatewayVpcAttachments
description: 'Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGatewayVpcAttachments
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTransitGateways:
get:
x-aws-operation-name: DescribeTransitGateways
operationId: GET_DescribeTransitGateways
description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewaysResult'
parameters:
- name: TransitGatewayIds
in: query
required: false
description: The IDs of the transit gateways.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTransitGateways
operationId: POST_DescribeTransitGateways
description: 'Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewaysResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeTransitGatewaysRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTransitGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeTrunkInterfaceAssociations:
get:
x-aws-operation-name: DescribeTrunkInterfaceAssociations
operationId: GET_DescribeTrunkInterfaceAssociations
description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Describes one or more network interface trunk associations.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' parameters: - name: AssociationId in: query required: false description: The IDs of the associations. schema: type: array items: allOf: - $ref: '#/components/schemas/TrunkInterfaceAssociationId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: One or more filters.
gre-key - The ID of a trunk interface association.
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 255
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeTrunkInterfaceAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeTrunkInterfaceAssociations
operationId: POST_DescribeTrunkInterfaceAssociations
description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Describes one or more network interface trunk associations.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeTrunkInterfaceAssociationsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeTrunkInterfaceAssociations - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVerifiedAccessEndpoints: get: x-aws-operation-name: DescribeVerifiedAccessEndpoints operationId: GET_DescribeVerifiedAccessEndpoints description: Describes the specified Amazon Web Services Verified Access endpoints. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVerifiedAccessEndpointsResult' parameters: - name: VerifiedAccessEndpointId in: query required: false description: The ID of the Verified Access endpoint. schema: type: array items: allOf: - $ref: '#/components/schemas/VerifiedAccessEndpointId' - xml: name: item - name: VerifiedAccessInstanceId in: query required: false description: The ID of the Verified Access instance. schema: type: string - name: VerifiedAccessGroupId in: query required: false description: The ID of the Verified Access group. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessEndpoints
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVerifiedAccessEndpoints
operationId: POST_DescribeVerifiedAccessEndpoints
description: Describes the specified Amazon Web Services Verified Access endpoints.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessEndpointsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessEndpointsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessEndpoints
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVerifiedAccessGroups:
get:
x-aws-operation-name: DescribeVerifiedAccessGroups
operationId: GET_DescribeVerifiedAccessGroups
description: Describes the specified Verified Access groups.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessGroupsResult'
parameters:
- name: VerifiedAccessGroupId
in: query
required: false
description: The ID of the Verified Access groups.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- xml:
name: item
- name: VerifiedAccessInstanceId
in: query
required: false
description: The ID of the Verified Access instance.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVerifiedAccessGroups
operationId: POST_DescribeVerifiedAccessGroups
description: Describes the specified Verified Access groups.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessGroupsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessGroupsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVerifiedAccessInstanceLoggingConfigurations:
get:
x-aws-operation-name: DescribeVerifiedAccessInstanceLoggingConfigurations
operationId: GET_DescribeVerifiedAccessInstanceLoggingConfigurations
description: Describes the specified Amazon Web Services Verified Access instances.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessInstanceLoggingConfigurationsResult'
parameters:
- name: VerifiedAccessInstanceId
in: query
required: false
description: The IDs of the Verified Access instances.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- xml:
name: item
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 1
maximum: 10
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessInstanceLoggingConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVerifiedAccessInstanceLoggingConfigurations
operationId: POST_DescribeVerifiedAccessInstanceLoggingConfigurations
description: Describes the specified Amazon Web Services Verified Access instances.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessInstanceLoggingConfigurationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessInstanceLoggingConfigurationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessInstanceLoggingConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVerifiedAccessInstances:
get:
x-aws-operation-name: DescribeVerifiedAccessInstances
operationId: GET_DescribeVerifiedAccessInstances
description: Describes the specified Amazon Web Services Verified Access instances.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessInstancesResult'
parameters:
- name: VerifiedAccessInstanceId
in: query
required: false
description: The IDs of the Verified Access instances.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- xml:
name: item
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 200
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVerifiedAccessInstances
operationId: POST_DescribeVerifiedAccessInstances
description: Describes the specified Amazon Web Services Verified Access instances.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessInstancesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessInstancesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVerifiedAccessTrustProviders:
get:
x-aws-operation-name: DescribeVerifiedAccessTrustProviders
operationId: GET_DescribeVerifiedAccessTrustProviders
description: Describes the specified Amazon Web Services Verified Access trust providers.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessTrustProvidersResult'
parameters:
- name: VerifiedAccessTrustProviderId
in: query
required: false
description: The IDs of the Verified Access trust providers.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderId'
- xml:
name: item
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 200
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters. Filter names and values are case-sensitive.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessTrustProviders
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVerifiedAccessTrustProviders
operationId: POST_DescribeVerifiedAccessTrustProviders
description: Describes the specified Amazon Web Services Verified Access trust providers.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessTrustProvidersResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVerifiedAccessTrustProvidersRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVerifiedAccessTrustProviders
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVolumeAttribute:
get:
x-aws-operation-name: DescribeVolumeAttribute
operationId: GET_DescribeVolumeAttribute
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumeAttributeResult' parameters: - name: Attribute in: query required: true description: The attribute of the volume. This parameter is required. schema: type: string enum: - autoEnableIO - productCodes - name: VolumeId in: query required: true description: The ID of the volume. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVolumeAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVolumeAttribute
operationId: POST_DescribeVolumeAttribute
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumeAttributeResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumeAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeVolumeAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVolumeStatus: get: x-aws-operation-name: DescribeVolumeStatus operationId: GET_DescribeVolumeStatus description: '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 Elastic Compute Cloud 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 filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
The IDs of the volumes.
Default: Describes all your volumes.
' schema: type: array items: allOf: - $ref: '#/components/schemas/VolumeId' - xml: name: VolumeId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVolumeStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVolumeStatus
operationId: POST_DescribeVolumeStatus
description: '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 Elastic Compute Cloud 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.)
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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumesResult' parameters: - name: Filter in: query required: false description: 'The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVolumes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVolumes
operationId: POST_DescribeVolumes
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeVolumes - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVolumesModifications: get: x-aws-operation-name: DescribeVolumesModifications operationId: GET_DescribeVolumesModifications description: 'Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumesModificationsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VolumeId
in: query
required: false
description: The IDs of the volumes.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeId'
- xml:
name: VolumeId
- name: Filter
in: query
required: false
description: 'The filters.
modification-state - The current modification state (modifying | optimizing | completed | failed).
original-iops - The original IOPS rate of the volume.
original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
start-time - The modification start time.
target-iops - The target IOPS rate of the volume.
target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id - The ID of the volume.
Describes the most recent volume modification request for the specified EBS volumes.
If a volume has never been modified, some information in the output will be null. If a volume has been modified more than once, the output includes only the most recent modification request.
You can also use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. For more information, see Monitor the progress of volume modifications in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumesModificationsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVolumesModificationsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeVolumesModifications - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVpcAttribute: get: x-aws-operation-name: DescribeVpcAttribute operationId: GET_DescribeVpcAttribute description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcAttributeResult' parameters: - name: Attribute in: query required: true description: The VPC attribute. schema: type: string enum: - enableDnsSupport - enableDnsHostnames - enableNetworkAddressUsageMetrics - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpcAttribute
operationId: POST_DescribeVpcAttribute
description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVpcClassicLink:
get:
x-aws-operation-name: DescribeVpcClassicLink
operationId: GET_DescribeVpcClassicLink
description: This action is deprecated.
Describes the ClassicLink status of the specified VPCs.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcClassicLinkResult' parameters: - name: Filter in: query required: false description: 'The filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcId
in: query
required: false
description: The VPCs for which you want to describe the ClassicLink status.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: VpcId
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcClassicLink
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpcClassicLink
operationId: POST_DescribeVpcClassicLink
description: This action is deprecated.
Describes the ClassicLink status of the specified VPCs.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcClassicLinkResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcClassicLinkRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeVpcClassicLink - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVpcClassicLinkDnsSupport: get: x-aws-operation-name: DescribeVpcClassicLinkDnsSupport operationId: GET_DescribeVpcClassicLinkDnsSupport description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult' parameters: - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer minimum: 5 maximum: 255 - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string minLength: 1 maxLength: 1024 - name: VpcIds in: query required: false description: The IDs of the VPCs. schema: type: array items: allOf: - $ref: '#/components/schemas/VpcId' - xml: name: VpcId - name: Action in: query required: true schema: type: string enum: - DescribeVpcClassicLinkDnsSupport - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeVpcClassicLinkDnsSupport operationId: POST_DescribeVpcClassicLinkDnsSupport description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeVpcClassicLinkDnsSupport - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVpcEndpointConnectionNotifications: get: x-aws-operation-name: DescribeVpcEndpointConnectionNotifications operationId: GET_DescribeVpcEndpointConnectionNotifications description: Describes the connection notifications for VPC endpoints and VPC endpoint services. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ConnectionNotificationId
in: query
required: false
description: The ID of the notification.
schema:
type: string
- name: Filter
in: query
required: false
description: The filters.
connection-notification-arn - The ARN of the SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification (Enabled | Disabled).
connection-notification-type - The type of notification (Topic).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.
NextToken value.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token to request the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointConnectionNotifications
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpcEndpointConnectionNotifications
operationId: POST_DescribeVpcEndpointConnectionNotifications
description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointConnectionNotifications
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVpcEndpointConnections:
get:
x-aws-operation-name: DescribeVpcEndpointConnections
operationId: GET_DescribeVpcEndpointConnections
description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token to retrieve the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpcEndpointConnections
operationId: POST_DescribeVpcEndpointConnections
description: 'Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVpcEndpointServiceConfigurations:
get:
x-aws-operation-name: DescribeVpcEndpointServiceConfigurations
operationId: GET_DescribeVpcEndpointServiceConfigurations
description: Describes the VPC endpoint service configurations in your account (your services).
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: false
description: The IDs of the endpoint services.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'The filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token to retrieve the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointServiceConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpcEndpointServiceConfigurations
operationId: POST_DescribeVpcEndpointServiceConfigurations
description: Describes the VPC endpoint service configurations in your account (your services).
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointServiceConfigurations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVpcEndpointServicePermissions:
get:
x-aws-operation-name: DescribeVpcEndpointServicePermissions
operationId: GET_DescribeVpcEndpointServicePermissions
description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The ID of the service.
schema:
type: string
- name: Filter
in: query
required: false
description: The filters.
principal - The ARN of the principal.
principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token to retrieve the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointServicePermissions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpcEndpointServicePermissions
operationId: POST_DescribeVpcEndpointServicePermissions
description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcEndpointServicePermissions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVpcEndpointServices:
get:
x-aws-operation-name: DescribeVpcEndpointServices
operationId: GET_DescribeVpcEndpointServices
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceName
in: query
required: false
description: The service names.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'The filters.
owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway | GatewayLoadBalancer).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' schema: type: integer - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a prior call.) schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeVpcEndpointServices - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeVpcEndpointServices operationId: POST_DescribeVpcEndpointServices description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcEndpointId
in: query
required: false
description: The IDs of the VPC endpoints.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- xml:
name: item
- name: Filter
in: query
required: false
description: 'The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' schema: type: integer - name: NextToken in: query required: false description: The token for the next set of items to return. (You received this token from a prior call.) schema: type: string - name: Action in: query required: true schema: type: string enum: - DescribeVpcEndpoints - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeVpcEndpoints operationId: POST_DescribeVpcEndpoints description: Describes your VPC endpoints. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcEndpointsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcEndpointsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeVpcEndpoints - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVpcPeeringConnections: get: x-aws-operation-name: DescribeVpcPeeringConnections operationId: GET_DescribeVpcPeeringConnections description: Describes one or more of your VPC peering connections. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult' parameters: - name: Filter in: query required: false description: 'The filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
required: false
description: 'The IDs of the VPC peering connections.
Default: Describes all your VPC peering connections.
' schema: type: array items: allOf: - $ref: '#/components/schemas/VpcPeeringConnectionId' - xml: name: item - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer minimum: 5 maximum: 1000 - name: Action in: query required: true schema: type: string enum: - DescribeVpcPeeringConnections - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DescribeVpcPeeringConnections operationId: POST_DescribeVpcPeeringConnections description: Describes one or more of your VPC peering connections. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcPeeringConnectionsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - DescribeVpcPeeringConnections - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVpcs: get: x-aws-operation-name: DescribeVpcs operationId: GET_DescribeVpcs description: Describes one or more of your VPCs. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpcsResult' parameters: - name: Filter in: query required: false description: 'The filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
The IDs of the VPCs.
Default: Describes all your VPCs.
' schema: type: array items: allOf: - $ref: '#/components/schemas/VpcId' - xml: name: VpcId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpcs
operationId: POST_DescribeVpcs
description: Describes one or more of your VPCs.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DescribeVpcsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpcs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DescribeVpnConnections:
get:
x-aws-operation-name: DescribeVpnConnections
operationId: GET_DescribeVpnConnections
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpnConnectionsResult' parameters: - name: Filter in: query required: false description: 'One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' schema: type: array items: allOf: - $ref: '#/components/schemas/VpnConnectionId' - xml: name: VpnConnectionId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpnConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpnConnections
operationId: POST_DescribeVpnConnections
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpnConnectionsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVpnConnectionsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeVpnConnections - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DescribeVpnGateways: get: x-aws-operation-name: DescribeVpnGateways operationId: GET_DescribeVpnGateways description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpnGatewaysResult' parameters: - name: Filter in: query required: false description: 'One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
' schema: type: array items: allOf: - $ref: '#/components/schemas/VpnGatewayId' - xml: name: VpnGatewayId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DescribeVpnGateways
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DescribeVpnGateways
operationId: POST_DescribeVpnGateways
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DescribeVpnGatewaysResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DescribeVpnGatewaysRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DescribeVpnGateways - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DetachClassicLinkVpc: get: x-aws-operation-name: DetachClassicLinkVpc operationId: GET_DetachClassicLinkVpc description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DetachClassicLinkVpcResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance to unlink from the VPC.
schema:
type: string
- name: VpcId
in: query
required: true
description: The ID of the VPC to which the instance is linked.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DetachClassicLinkVpc
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DetachClassicLinkVpc
operationId: POST_DetachClassicLinkVpc
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DetachClassicLinkVpcResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DetachClassicLinkVpcRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DetachClassicLinkVpc - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DetachInternetGateway: get: x-aws-operation-name: DetachInternetGateway operationId: GET_DetachInternetGateway description: '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.' responses: '200': description: Success parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InternetGatewayId
in: query
required: true
description: The ID of the internet gateway.
schema:
type: string
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DetachInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DetachInternetGateway
operationId: POST_DetachInternetGateway
description: '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.'
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DetachInternetGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DetachInternetGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DetachNetworkInterface:
get:
x-aws-operation-name: DetachNetworkInterface
operationId: GET_DetachNetworkInterface
description: Detaches a network interface from an instance.
responses:
'200':
description: Success
parameters:
- name: AttachmentId
in: query
required: true
description: The ID of the attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Force
in: query
required: false
description: 'Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DetachVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DetachVerifiedAccessTrustProvider
operationId: POST_DetachVerifiedAccessTrustProvider
description: Detaches the specified Amazon Web Services Verified Access trust provider from the specified Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DetachVerifiedAccessTrustProviderResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DetachVerifiedAccessTrustProviderRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DetachVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DetachVolume:
get:
x-aws-operation-name: DetachVolume
operationId: GET_DetachVolume
description: '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.
For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/VolumeAttachment' parameters: - name: Device in: query required: false description: The device name. schema: type: string - name: Force in: query required: false description: 'Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won''t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.' schema: type: boolean - name: InstanceId in: query required: false description: 'The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.' schema: type: string - name: VolumeId in: query required: true description: The ID of the volume. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DetachVolume
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DetachVolume
operationId: POST_DetachVolume
description: '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.
For more information, see Detach an Amazon EBS volume in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/VolumeAttachment' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DetachVolumeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DetachVolume - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DetachVpnGateway: get: x-aws-operation-name: DetachVpnGateway operationId: GET_DetachVpnGateway description: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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DetachVpnGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DetachVpnGateway
operationId: POST_DetachVpnGateway
description: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableAddressTransfer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableAddressTransfer
operationId: POST_DisableAddressTransfer
description: 'Disables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableAddressTransferResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableAddressTransferRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableAddressTransfer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisableAwsNetworkPerformanceMetricSubscription:
get:
x-aws-operation-name: DisableAwsNetworkPerformanceMetricSubscription
operationId: GET_DisableAwsNetworkPerformanceMetricSubscription
description: Disables Infrastructure Performance metric subscriptions.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableAwsNetworkPerformanceMetricSubscriptionResult'
parameters:
- name: Source
in: query
required: false
description: 'The source Region or Availability Zone that the metric subscription is disabled for. For example, us-east-1.'
schema:
type: string
- name: Destination
in: query
required: false
description: 'The target Region or Availability Zone that the metric subscription is disabled for. For example, eu-north-1.'
schema:
type: string
- name: Metric
in: query
required: false
description: The metric used for the disabled subscription.
schema:
type: string
enum:
- aggregate-latency
- name: Statistic
in: query
required: false
description: 'The statistic used for the disabled subscription. '
schema:
type: string
enum:
- p50
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableAwsNetworkPerformanceMetricSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableAwsNetworkPerformanceMetricSubscription
operationId: POST_DisableAwsNetworkPerformanceMetricSubscription
description: Disables Infrastructure Performance metric subscriptions.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableAwsNetworkPerformanceMetricSubscriptionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableAwsNetworkPerformanceMetricSubscriptionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableAwsNetworkPerformanceMetricSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisableEbsEncryptionByDefault:
get:
x-aws-operation-name: DisableEbsEncryptionByDefault
operationId: GET_DisableEbsEncryptionByDefault
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableEbsEncryptionByDefault
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableEbsEncryptionByDefault
operationId: POST_DisableEbsEncryptionByDefault
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableEbsEncryptionByDefaultResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisableEbsEncryptionByDefaultRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisableEbsEncryptionByDefault - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisableFastLaunch: get: x-aws-operation-name: DisableFastLaunch operationId: GET_DisableFastLaunch description: 'Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
To change these settings, you must own the AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableFastLaunch
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableFastLaunch
operationId: POST_DisableFastLaunch
description: 'Discontinue faster launching for a Windows AMI, and clean up existing pre-provisioned snapshots. When you disable faster launching, the AMI uses the standard launch process for each instance. All pre-provisioned snapshots must be removed before you can enable faster launching again.
To change these settings, you must own the AMI.
us-east-2a.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: AvailabilityZone
- name: SourceSnapshotId
in: query
required: true
description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- xml:
name: SnapshotId
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableFastSnapshotRestores
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableFastSnapshotRestores
operationId: POST_DisableFastSnapshotRestores
description: Disables fast snapshot restores for the specified snapshots in the specified Availability Zones.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableFastSnapshotRestoresResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableFastSnapshotRestoresRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableFastSnapshotRestores
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisableImageDeprecation:
get:
x-aws-operation-name: DisableImageDeprecation
operationId: GET_DisableImageDeprecation
description: 'Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableImageDeprecationResult' parameters: - name: ImageId in: query required: true description: The ID of the AMI. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableImageDeprecation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableImageDeprecation
operationId: POST_DisableImageDeprecation
description: 'Cancels the deprecation of the specified AMI.
For more information, see Deprecate an AMI in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableImageDeprecationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisableImageDeprecationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisableImageDeprecation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisableIpamOrganizationAdminAccount: get: x-aws-operation-name: DisableIpamOrganizationAdminAccount operationId: GET_DisableIpamOrganizationAdminAccount description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. ' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: DelegatedAdminAccountId
in: query
required: true
description: The Organizations member account ID that you want to disable as IPAM account.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableIpamOrganizationAdminAccount
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableIpamOrganizationAdminAccount
operationId: POST_DisableIpamOrganizationAdminAccount
description: 'Disable the IPAM account. For more information, see Enable integration with Organizations in the Amazon VPC IPAM User Guide. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableIpamOrganizationAdminAccountResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableIpamOrganizationAdminAccountRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableIpamOrganizationAdminAccount
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisableSerialConsoleAccess:
get:
x-aws-operation-name: DisableSerialConsoleAccess
operationId: GET_DisableSerialConsoleAccess
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableSerialConsoleAccessResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableSerialConsoleAccess
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableSerialConsoleAccess
operationId: POST_DisableSerialConsoleAccess
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableSerialConsoleAccessResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableSerialConsoleAccessRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableSerialConsoleAccess
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisableTransitGatewayRouteTablePropagation:
get:
x-aws-operation-name: DisableTransitGatewayRouteTablePropagation
operationId: GET_DisableTransitGatewayRouteTablePropagation
description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the propagation route table.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: false
description: The ID of the attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TransitGatewayRouteTableAnnouncementId
in: query
required: false
description: The ID of the route table announcement.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableTransitGatewayRouteTablePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableTransitGatewayRouteTablePropagation
operationId: POST_DisableTransitGatewayRouteTablePropagation
description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableTransitGatewayRouteTablePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisableVgwRoutePropagation:
get:
x-aws-operation-name: DisableVgwRoutePropagation
operationId: GET_DisableVgwRoutePropagation
description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
responses:
'200':
description: Success
parameters:
- name: GatewayId
in: query
required: true
description: The ID of the virtual private gateway.
schema:
type: string
- name: RouteTableId
in: query
required: true
description: The ID of the route table.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableVgwRoutePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableVgwRoutePropagation
operationId: POST_DisableVgwRoutePropagation
description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisableVgwRoutePropagationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableVgwRoutePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisableVpcClassicLink:
get:
x-aws-operation-name: DisableVpcClassicLink
operationId: GET_DisableVpcClassicLink
description: This action is deprecated.
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableVpcClassicLinkResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisableVpcClassicLink
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisableVpcClassicLink
operationId: POST_DisableVpcClassicLink
description: This action is deprecated.
Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableVpcClassicLinkResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisableVpcClassicLinkRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisableVpcClassicLink - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisableVpcClassicLinkDnsSupport: get: x-aws-operation-name: DisableVpcClassicLinkDnsSupport operationId: GET_DisableVpcClassicLinkDnsSupport description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' parameters: - name: VpcId in: query required: false description: The ID of the VPC. schema: type: string - name: Action in: query required: true schema: type: string enum: - DisableVpcClassicLinkDnsSupport - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DisableVpcClassicLinkDnsSupport operationId: POST_DisableVpcClassicLinkDnsSupport description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisableVpcClassicLinkDnsSupport - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateAddress: get: x-aws-operation-name: DisassociateAddress operationId: GET_DisassociateAddress description: '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.
' responses: '200': description: Success parameters: - name: AssociationId in: query required: false description: The association ID. This parameter is required. schema: type: string - name: PublicIp in: query required: false description: Deprecated. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateAddress
operationId: POST_DisassociateAddress
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateAddressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateAddress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateClientVpnTargetNetwork: get: x-aws-operation-name: DisassociateClientVpnTargetNetwork operationId: GET_DisassociateClientVpnTargetNetwork description: '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
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateClientVpnTargetNetwork
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateClientVpnTargetNetwork
operationId: POST_DisassociateClientVpnTargetNetwork
description: '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
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateEnclaveCertificateIamRole
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateEnclaveCertificateIamRole
operationId: POST_DisassociateEnclaveCertificateIamRole
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateEnclaveCertificateIamRoleRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateEnclaveCertificateIamRole
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisassociateIamInstanceProfile:
get:
x-aws-operation-name: DisassociateIamInstanceProfile
operationId: GET_DisassociateIamInstanceProfile
description: Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' parameters: - name: AssociationId in: query required: true description: The ID of the IAM instance profile association. schema: type: string - name: Action in: query required: true schema: type: string enum: - DisassociateIamInstanceProfile - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DisassociateIamInstanceProfile operationId: POST_DisassociateIamInstanceProfile description:Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateIamInstanceProfileRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateIamInstanceProfile - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateInstanceEventWindow: get: x-aws-operation-name: DisassociateInstanceEventWindow operationId: GET_DisassociateInstanceEventWindow description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceEventWindowId
in: query
required: true
description: The ID of the event window.
schema:
type: string
- name: AssociationTarget
in: query
required: true
description: One or more targets to disassociate from the specified event window.
schema:
type: object
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdList'
- xml:
name: InstanceId
description: The IDs of the instances to disassociate from the event window.
InstanceTags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: InstanceTag
description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
DedicatedHostIds:
allOf:
- $ref: '#/components/schemas/DedicatedHostIdList'
- xml:
name: DedicatedHostId
description: The IDs of the Dedicated Hosts to disassociate from the event window.
description: The targets to disassociate from the specified event window.
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateInstanceEventWindow
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateInstanceEventWindow
operationId: POST_DisassociateInstanceEventWindow
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateInstanceEventWindowResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateInstanceEventWindowRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateInstanceEventWindow - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateIpamResourceDiscovery: get: x-aws-operation-name: DisassociateIpamResourceDiscovery operationId: GET_DisassociateIpamResourceDiscovery description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateIpamResourceDiscoveryResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamResourceDiscoveryAssociationId
in: query
required: true
description: A resource discovery association ID.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateIpamResourceDiscovery
operationId: POST_DisassociateIpamResourceDiscovery
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateIpamResourceDiscoveryResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateIpamResourceDiscoveryRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisassociateNatGatewayAddress:
get:
x-aws-operation-name: DisassociateNatGatewayAddress
operationId: GET_DisassociateNatGatewayAddress
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateNatGatewayAddressResult' parameters: - name: NatGatewayId in: query required: true description: The ID of the NAT gateway. schema: type: string - name: AssociationId in: query required: true description: The association IDs of EIPs that have been associated with the NAT gateway. schema: type: array items: allOf: - $ref: '#/components/schemas/ElasticIpAssociationId' - xml: name: item - name: MaxDrainDurationSeconds in: query required: false description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds. schema: type: integer minimum: 1 maximum: 4000 - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateNatGatewayAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateNatGatewayAddress
operationId: POST_DisassociateNatGatewayAddress
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateNatGatewayAddressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateNatGatewayAddressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateNatGatewayAddress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateRouteTable: get: x-aws-operation-name: DisassociateRouteTable operationId: GET_DisassociateRouteTable description: '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.
' responses: '200': description: Success parameters: - name: AssociationId in: query required: true description: The association ID representing the current association between the route table and subnet or gateway. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateRouteTable
operationId: POST_DisassociateRouteTable
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateRouteTableRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateRouteTable - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateSubnetCidrBlock: get: x-aws-operation-name: DisassociateSubnetCidrBlock operationId: GET_DisassociateSubnetCidrBlock description: '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. ' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' parameters: - name: AssociationId in: query required: true description: The association ID for the CIDR block. schema: type: string - name: Action in: query required: true schema: type: string enum: - DisassociateSubnetCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DisassociateSubnetCidrBlock operationId: POST_DisassociateSubnetCidrBlock description: '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. ' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateSubnetCidrBlockResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateSubnetCidrBlockRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateSubnetCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateTransitGatewayMulticastDomain: get: x-aws-operation-name: DisassociateTransitGatewayMulticastDomain operationId: GET_DisassociateTransitGatewayMulticastDomain description: 'Disassociates the specified subnets from the transit gateway multicast domain. ' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult' parameters: - name: TransitGatewayMulticastDomainId in: query required: true description: The ID of the transit gateway multicast domain. schema: type: string - name: TransitGatewayAttachmentId in: query required: true description: The ID of the attachment. schema: type: string - name: SubnetIds in: query required: true description: The IDs of the subnets; schema: type: array items: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateTransitGatewayMulticastDomain
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateTransitGatewayMulticastDomain
operationId: POST_DisassociateTransitGatewayMulticastDomain
description: 'Disassociates the specified subnets from the transit gateway multicast domain. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayMulticastDomainRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateTransitGatewayMulticastDomain
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisassociateTransitGatewayPolicyTable:
get:
x-aws-operation-name: DisassociateTransitGatewayPolicyTable
operationId: GET_DisassociateTransitGatewayPolicyTable
description: Removes the association between an an attachment and a policy table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayPolicyTableResult'
parameters:
- name: TransitGatewayPolicyTableId
in: query
required: true
description: The ID of the disassociated policy table.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the transit gateway attachment to disassociate from the policy table.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateTransitGatewayPolicyTable
operationId: POST_DisassociateTransitGatewayPolicyTable
description: Removes the association between an an attachment and a policy table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayPolicyTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayPolicyTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateTransitGatewayPolicyTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisassociateTransitGatewayRouteTable:
get:
x-aws-operation-name: DisassociateTransitGatewayRouteTable
operationId: GET_DisassociateTransitGatewayRouteTable
description: Disassociates a resource attachment from a transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateTransitGatewayRouteTable
operationId: POST_DisassociateTransitGatewayRouteTable
description: Disassociates a resource attachment from a transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayRouteTableRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateTransitGatewayRouteTable
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=DisassociateTrunkInterface:
get:
x-aws-operation-name: DisassociateTrunkInterface
operationId: GET_DisassociateTrunkInterface
description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Removes an association between a branch network interface with a trunk network interface.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' parameters: - name: AssociationId in: query required: true description: The ID of the association schema: type: string - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- DisassociateTrunkInterface
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: DisassociateTrunkInterface
operationId: POST_DisassociateTrunkInterface
description: 'This API action is currently in limited preview only. If you are interested in using this feature, contact your account manager.
Removes an association between a branch network interface with a trunk network interface.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateTrunkInterfaceResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateTrunkInterfaceRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateTrunkInterface - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=DisassociateVpcCidrBlock: get: x-aws-operation-name: DisassociateVpcCidrBlock operationId: GET_DisassociateVpcCidrBlock description: '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).
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' parameters: - name: AssociationId in: query required: true description: The association ID for the CIDR block. schema: type: string - name: Action in: query required: true schema: type: string enum: - DisassociateVpcCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: DisassociateVpcCidrBlock operationId: POST_DisassociateVpcCidrBlock description: '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).
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/DisassociateVpcCidrBlockRequest' parameters: - name: Action in: query required: true schema: type: string enum: - DisassociateVpcCidrBlock - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=EnableAddressTransfer: get: x-aws-operation-name: EnableAddressTransfer operationId: GET_EnableAddressTransfer description: 'Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableAddressTransferResult' parameters: - name: AllocationId in: query required: true description: The allocation ID of an Elastic IP address. schema: type: string - name: TransferAccountId in: query required: true description: The ID of the account that you want to transfer the Elastic IP address to. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableAddressTransfer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableAddressTransfer
operationId: POST_EnableAddressTransfer
description: 'Enables Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableAddressTransferResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableAddressTransferRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableAddressTransfer
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=EnableAwsNetworkPerformanceMetricSubscription:
get:
x-aws-operation-name: EnableAwsNetworkPerformanceMetricSubscription
operationId: GET_EnableAwsNetworkPerformanceMetricSubscription
description: Enables Infrastructure Performance subscriptions.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableAwsNetworkPerformanceMetricSubscriptionResult'
parameters:
- name: Source
in: query
required: false
description: 'The source Region or Availability Zone that the metric subscription is enabled for. For example, us-east-1.'
schema:
type: string
- name: Destination
in: query
required: false
description: 'The target Region or Availability Zone that the metric subscription is enabled for. For example, eu-west-1.'
schema:
type: string
- name: Metric
in: query
required: false
description: The metric used for the enabled subscription.
schema:
type: string
enum:
- aggregate-latency
- name: Statistic
in: query
required: false
description: The statistic used for the enabled subscription.
schema:
type: string
enum:
- p50
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableAwsNetworkPerformanceMetricSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableAwsNetworkPerformanceMetricSubscription
operationId: POST_EnableAwsNetworkPerformanceMetricSubscription
description: Enables Infrastructure Performance subscriptions.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableAwsNetworkPerformanceMetricSubscriptionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableAwsNetworkPerformanceMetricSubscriptionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableAwsNetworkPerformanceMetricSubscription
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=EnableEbsEncryptionByDefault:
get:
x-aws-operation-name: EnableEbsEncryptionByDefault
operationId: GET_EnableEbsEncryptionByDefault
description: '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 Elastic Compute Cloud 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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableEbsEncryptionByDefault
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableEbsEncryptionByDefault
operationId: POST_EnableEbsEncryptionByDefault
description: '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 Elastic Compute Cloud 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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableEbsEncryptionByDefaultResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/EnableEbsEncryptionByDefaultRequest' parameters: - name: Action in: query required: true schema: type: string enum: - EnableEbsEncryptionByDefault - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=EnableFastLaunch: get: x-aws-operation-name: EnableFastLaunch operationId: GET_EnableFastLaunch description: 'When you enable faster launching 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.
To change these settings, you must own the AMI.
snapshot, which is the default value.'
schema:
type: string
- name: SnapshotConfiguration
in: query
required: false
description: Configuration settings for creating and managing the snapshots that are used for pre-provisioning the Windows AMI for faster launching. The associated ResourceType must be snapshot.
schema:
type: object
properties:
TargetResourceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
- name: LaunchTemplate
in: query
required: false
description: 'The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.'
schema:
type: object
required:
- Version
properties:
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: The ID of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the launch template to use for faster launching for a Windows AMI.
Version:
allOf:
- $ref: '#/components/schemas/String'
- description: The version of the launch template to use for faster launching for a Windows AMI.
description: 'Request to create a launch template for a fast-launch enabled Windows AMI.
Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
6 or greater.
schema:
type: integer
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableFastLaunch
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableFastLaunch
operationId: POST_EnableFastLaunch
description: 'When you enable faster launching 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.
To change these settings, you must own the AMI.
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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' parameters: - name: AvailabilityZone in: query required: true description: 'One or more Availability Zones. For example,us-east-2a.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: AvailabilityZone
- name: SourceSnapshotId
in: query
required: true
description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another Amazon Web Services account.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- xml:
name: SnapshotId
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableFastSnapshotRestores
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableFastSnapshotRestores
operationId: POST_EnableFastSnapshotRestores
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableFastSnapshotRestoresResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/EnableFastSnapshotRestoresRequest' parameters: - name: Action in: query required: true schema: type: string enum: - EnableFastSnapshotRestores - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=EnableImageDeprecation: get: x-aws-operation-name: EnableImageDeprecation operationId: GET_EnableImageDeprecation description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableImageDeprecationResult' parameters: - name: ImageId in: query required: true description: The ID of the AMI. schema: type: string - name: DeprecateAt in: query required: true description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableImageDeprecation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableImageDeprecation
operationId: POST_EnableImageDeprecation
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableImageDeprecationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/EnableImageDeprecationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - EnableImageDeprecation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=EnableIpamOrganizationAdminAccount: get: x-aws-operation-name: EnableIpamOrganizationAdminAccount operationId: GET_EnableIpamOrganizationAdminAccount description: '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. ' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: DelegatedAdminAccountId
in: query
required: true
description: The Organizations member account ID that you want to enable as the IPAM account.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableIpamOrganizationAdminAccount
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableIpamOrganizationAdminAccount
operationId: POST_EnableIpamOrganizationAdminAccount
description: '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. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableIpamOrganizationAdminAccountResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableIpamOrganizationAdminAccountRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableIpamOrganizationAdminAccount
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=EnableReachabilityAnalyzerOrganizationSharing:
get:
x-aws-operation-name: EnableReachabilityAnalyzerOrganizationSharing
operationId: GET_EnableReachabilityAnalyzerOrganizationSharing
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableReachabilityAnalyzerOrganizationSharingResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableReachabilityAnalyzerOrganizationSharing
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableReachabilityAnalyzerOrganizationSharing
operationId: POST_EnableReachabilityAnalyzerOrganizationSharing
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableReachabilityAnalyzerOrganizationSharingResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/EnableReachabilityAnalyzerOrganizationSharingRequest' parameters: - name: Action in: query required: true schema: type: string enum: - EnableReachabilityAnalyzerOrganizationSharing - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=EnableSerialConsoleAccess: get: x-aws-operation-name: EnableSerialConsoleAccess operationId: GET_EnableSerialConsoleAccess description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableSerialConsoleAccessResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableSerialConsoleAccess
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableSerialConsoleAccess
operationId: POST_EnableSerialConsoleAccess
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableSerialConsoleAccessResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableSerialConsoleAccessRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableSerialConsoleAccess
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=EnableTransitGatewayRouteTablePropagation:
get:
x-aws-operation-name: EnableTransitGatewayRouteTablePropagation
operationId: GET_EnableTransitGatewayRouteTablePropagation
description: Enables the specified attachment to propagate routes to the specified propagation route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the propagation route table.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: false
description: The ID of the attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TransitGatewayRouteTableAnnouncementId
in: query
required: false
description: The ID of the transit gateway route table announcement.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableTransitGatewayRouteTablePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableTransitGatewayRouteTablePropagation
operationId: POST_EnableTransitGatewayRouteTablePropagation
description: Enables the specified attachment to propagate routes to the specified propagation route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableTransitGatewayRouteTablePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=EnableVgwRoutePropagation:
get:
x-aws-operation-name: EnableVgwRoutePropagation
operationId: GET_EnableVgwRoutePropagation
description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
responses:
'200':
description: Success
parameters:
- name: GatewayId
in: query
required: true
description: 'The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. '
schema:
type: string
- name: RouteTableId
in: query
required: true
description: 'The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableVgwRoutePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableVgwRoutePropagation
operationId: POST_EnableVgwRoutePropagation
description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableVgwRoutePropagationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableVgwRoutePropagation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=EnableVolumeIO:
get:
x-aws-operation-name: EnableVolumeIO
operationId: GET_EnableVolumeIO
description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
responses:
'200':
description: Success
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VolumeId
in: query
required: true
description: The ID of the volume.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableVolumeIO
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableVolumeIO
operationId: POST_EnableVolumeIO
description: Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/EnableVolumeIORequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableVolumeIO
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=EnableVpcClassicLink:
get:
x-aws-operation-name: EnableVpcClassicLink
operationId: GET_EnableVpcClassicLink
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- EnableVpcClassicLink
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: EnableVpcClassicLink
operationId: POST_EnableVpcClassicLink
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' parameters: - name: VpcId in: query required: false description: The ID of the VPC. schema: type: string - name: Action in: query required: true schema: type: string enum: - EnableVpcClassicLinkDnsSupport - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: EnableVpcClassicLinkDnsSupport operationId: POST_EnableVpcClassicLinkDnsSupport description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportRequest' parameters: - name: Action in: query required: true schema: type: string enum: - EnableVpcClassicLinkDnsSupport - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ExportClientVpnClientCertificateRevocationList: get: x-aws-operation-name: ExportClientVpnClientCertificateRevocationList operationId: GET_ExportClientVpnClientCertificateRevocationList description: Downloads the client certificate revocation list for the specified Client VPN endpoint. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ExportClientVpnClientCertificateRevocationList
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ExportClientVpnClientCertificateRevocationList
operationId: POST_ExportClientVpnClientCertificateRevocationList
description: Downloads the client certificate revocation list for the specified Client VPN endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ExportClientVpnClientCertificateRevocationList
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ExportClientVpnClientConfiguration:
get:
x-aws-operation-name: ExportClientVpnClientConfiguration
operationId: GET_ExportClientVpnClientConfiguration
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
parameters:
- name: ClientVpnEndpointId
in: query
required: true
description: The ID of the Client VPN endpoint.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ExportClientVpnClientConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ExportClientVpnClientConfiguration
operationId: POST_ExportClientVpnClientConfiguration
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportClientVpnClientConfigurationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ExportClientVpnClientConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ExportImage:
get:
x-aws-operation-name: ExportImage
operationId: GET_ExportImage
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportImageResult'
parameters:
- name: ClientToken
in: query
required: false
description: Token to enable idempotency for export image requests.
schema:
type: string
- name: Description
in: query
required: false
description: A description of the image being exported. The maximum length is 255 characters.
schema:
type: string
- name: DiskImageFormat
in: query
required: true
description: The disk image format.
schema:
type: string
enum:
- VMDK
- RAW
- VHD
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ImageId
in: query
required: true
description: The ID of the image.
schema:
type: string
- name: S3ExportLocation
in: query
required: true
description: The Amazon S3 bucket for the destination image. The destination bucket must exist.
schema:
type: object
required:
- S3Bucket
properties:
S3Bucket:
allOf:
- $ref: '#/components/schemas/String'
- description: The destination Amazon S3 bucket.
S3Prefix:
allOf:
- $ref: '#/components/schemas/String'
- description: The prefix (logical hierarchy) in the bucket.
description: Describes the destination for an export image task.
- name: RoleName
in: query
required: false
description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.'
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to apply to the export image task during creation.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- ExportImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ExportImage
operationId: POST_ExportImage
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportImageResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ExportImageRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ExportImage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ExportTransitGatewayRoutes:
get:
x-aws-operation-name: ExportTransitGatewayRoutes
operationId: GET_ExportTransitGatewayRoutes
description: 'Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' parameters: - name: TransitGatewayRouteTableId in: query required: true description: The ID of the route table. schema: type: string - name: Filter in: query required: false description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ExportTransitGatewayRoutes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ExportTransitGatewayRoutes
operationId: POST_ExportTransitGatewayRoutes
description: 'Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range.
The routes are saved to the specified bucket in a JSON file. For more information, see Export Route Tables to Amazon S3 in Transit Gateways.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ExportTransitGatewayRoutesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ExportTransitGatewayRoutesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ExportTransitGatewayRoutes - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetAssociatedEnclaveCertificateIamRoles: get: x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles operationId: GET_GetAssociatedEnclaveCertificateIamRoles description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult' parameters: - name: CertificateArn in: query required: true description: 'The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetAssociatedEnclaveCertificateIamRoles
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetAssociatedEnclaveCertificateIamRoles
operationId: POST_GetAssociatedEnclaveCertificateIamRoles
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAssociatedEnclaveCertificateIamRolesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetAssociatedEnclaveCertificateIamRoles
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetAssociatedIpv6PoolCidrs:
get:
x-aws-operation-name: GetAssociatedIpv6PoolCidrs
operationId: GET_GetAssociatedIpv6PoolCidrs
description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult'
parameters:
- name: PoolId
in: query
required: true
description: The ID of the IPv6 address pool.
schema:
type: string
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 1
maximum: 1000
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetAssociatedIpv6PoolCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetAssociatedIpv6PoolCidrs
operationId: POST_GetAssociatedIpv6PoolCidrs
description: Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAssociatedIpv6PoolCidrsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetAssociatedIpv6PoolCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetAwsNetworkPerformanceData:
get:
x-aws-operation-name: GetAwsNetworkPerformanceData
operationId: GET_GetAwsNetworkPerformanceData
description: Gets network performance data.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAwsNetworkPerformanceDataResult'
parameters:
- name: DataQuery
in: query
required: false
description: A list of network performance data queries.
schema:
type: array
items:
$ref: '#/components/schemas/DataQuery'
- name: StartTime
in: query
required: false
description: 'The starting time for the performance data request. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.'
schema:
type: string
format: date-time
- name: EndTime
in: query
required: false
description: 'The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.'
schema:
type: string
format: date-time
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetAwsNetworkPerformanceData
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetAwsNetworkPerformanceData
operationId: POST_GetAwsNetworkPerformanceData
description: Gets network performance data.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAwsNetworkPerformanceDataResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetAwsNetworkPerformanceDataRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetAwsNetworkPerformanceData
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetCapacityReservationUsage:
get:
x-aws-operation-name: GetCapacityReservationUsage
operationId: GET_GetCapacityReservationUsage
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetCapacityReservationUsageResult'
parameters:
- name: CapacityReservationId
in: query
required: true
description: The ID of the Capacity Reservation.
schema:
type: string
- name: NextToken
in: query
required: false
description: The token to use to retrieve the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
' schema: type: integer minimum: 1 maximum: 1000 - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetCapacityReservationUsage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetCapacityReservationUsage
operationId: POST_GetCapacityReservationUsage
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetCapacityReservationUsageResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetCapacityReservationUsageRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetCapacityReservationUsage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetCoipPoolUsage:
get:
x-aws-operation-name: GetCoipPoolUsage
operationId: GET_GetCoipPoolUsage
description: Describes the allocations from the specified customer-owned address pool.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetCoipPoolUsageResult'
parameters:
- name: PoolId
in: query
required: true
description: The ID of the address pool.
schema:
type: string
- name: Filter
in: query
required: false
description: One or more filters.
coip-address-usage.allocation-id - The allocation ID of the address.
coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
coip-address-usage.co-ip - The customer-owned IP address.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetCoipPoolUsage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetCoipPoolUsage
operationId: POST_GetCoipPoolUsage
description: Describes the allocations from the specified customer-owned address pool.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetCoipPoolUsageResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetCoipPoolUsageRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetCoipPoolUsage
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetConsoleOutput:
get:
x-aws-operation-name: GetConsoleOutput
operationId: GET_GetConsoleOutput
description: 'Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetConsoleOutputResult' parameters: - name: InstanceId in: query required: true description: The ID of the instance. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Latest
in: query
required: false
description: 'When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors.
By default, the console output returns buffered information that was posted shortly after an instance transition state (start, stop, reboot, or terminate). This information is available for at least one hour after the most recent post. Only the most recent 64 KB of console output is available.
You can optionally retrieve the latest serial console output at any time during the instance lifecycle. This option is supported on instance types that use the Nitro hypervisor.
For more information, see Instance console output in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetConsoleOutputResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetConsoleOutputRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetConsoleOutput - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetConsoleScreenshot: get: x-aws-operation-name: GetConsoleScreenshot operationId: GET_GetConsoleScreenshot description:Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetConsoleScreenshotResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: WakeUp
in: query
required: false
description: 'When set to true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetConsoleScreenshot
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetConsoleScreenshot
operationId: POST_GetConsoleScreenshot
description: Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetConsoleScreenshotResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetConsoleScreenshotRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetConsoleScreenshot - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetDefaultCreditSpecification: get: x-aws-operation-name: GetDefaultCreditSpecification operationId: GET_GetDefaultCreditSpecification description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceFamily
in: query
required: true
description: The instance family.
schema:
type: string
enum:
- t2
- t3
- t3a
- t4g
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetDefaultCreditSpecification
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetDefaultCreditSpecification
operationId: POST_GetDefaultCreditSpecification
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetDefaultCreditSpecificationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetDefaultCreditSpecificationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetDefaultCreditSpecification - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetEbsDefaultKmsKeyId: get: x-aws-operation-name: GetEbsDefaultKmsKeyId operationId: GET_GetEbsDefaultKmsKeyId description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetEbsDefaultKmsKeyId
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetEbsDefaultKmsKeyId
operationId: POST_GetEbsDefaultKmsKeyId
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetEbsDefaultKmsKeyIdRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetEbsDefaultKmsKeyId - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetEbsEncryptionByDefault: get: x-aws-operation-name: GetEbsEncryptionByDefault operationId: GET_GetEbsEncryptionByDefault description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetEbsEncryptionByDefault
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetEbsEncryptionByDefault
operationId: POST_GetEbsEncryptionByDefault
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetEbsEncryptionByDefaultResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetEbsEncryptionByDefaultRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetEbsEncryptionByDefault - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetFlowLogsIntegrationTemplate: get: x-aws-operation-name: GetFlowLogsIntegrationTemplate operationId: GET_GetFlowLogsIntegrationTemplate description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FlowLogId
in: query
required: true
description: The ID of the flow log.
schema:
type: string
- name: ConfigDeliveryS3DestinationArn
in: query
required: true
description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.'
schema:
type: string
- name: IntegrateService
in: query
required: true
description: Information about the service integration.
schema:
type: object
properties:
AthenaIntegrations:
allOf:
- $ref: '#/components/schemas/AthenaIntegrationsSet'
- xml:
name: AthenaIntegration
description: Information about the integration with Amazon Athena.
description: Describes service integrations with VPC Flow logs.
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetFlowLogsIntegrationTemplate
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetFlowLogsIntegrationTemplate
operationId: POST_GetFlowLogsIntegrationTemplate
description: '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.
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
schema:
type: integer
minimum: 1
maximum: 1000
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetGroupsForCapacityReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetGroupsForCapacityReservation
operationId: POST_GetGroupsForCapacityReservation
description: Lists the resource groups to which a Capacity Reservation has been added.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetGroupsForCapacityReservationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetGroupsForCapacityReservationRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetGroupsForCapacityReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetHostReservationPurchasePreview:
get:
x-aws-operation-name: GetHostReservationPurchasePreview
operationId: GET_GetHostReservationPurchasePreview
description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' parameters: - name: HostIdSet in: query required: true description: The IDs of the Dedicated Hosts with which the reservation is associated. schema: type: array items: allOf: - $ref: '#/components/schemas/DedicatedHostId' - xml: name: item - name: OfferingId in: query required: true description: The offering ID of the reservation. schema: type: string - name: Action in: query required: true schema: type: string enum: - GetHostReservationPurchasePreview - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: GetHostReservationPurchasePreview operationId: POST_GetHostReservationPurchasePreview description: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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetHostReservationPurchasePreviewRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetHostReservationPurchasePreview - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetInstanceTypesFromInstanceRequirements: get: x-aws-operation-name: GetInstanceTypesFromInstanceRequirements operationId: GET_GetInstanceTypesFromInstanceRequirements description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ArchitectureType
in: query
required: true
description: The processor architecture type.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ArchitectureType'
- xml:
name: item
minItems: 0
maxItems: 3
- name: VirtualizationType
in: query
required: true
description: The virtualization type.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VirtualizationType'
- xml:
name: item
minItems: 0
maxItems: 2
- name: InstanceRequirements
in: query
required: true
description: The attributes required for the instance types.
schema:
type: object
required:
- VCpuCount
- MemoryMiB
properties:
VCpuCount:
allOf:
- $ref: '#/components/schemas/VCpuCountRangeRequest'
- description: The minimum and maximum number of vCPUs.
MemoryMiB:
allOf:
- $ref: '#/components/schemas/MemoryMiBRequest'
- description: 'The minimum and maximum amount of memory, in MiB.'
CpuManufacturers:
allOf:
- $ref: '#/components/schemas/CpuManufacturerSet'
- xml:
name: CpuManufacturer
description: 'The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don''t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
' MemoryGiBPerVCpu: allOf: - $ref: '#/components/schemas/MemoryGiBPerVCpuRequest' - description: 'The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' ExcludedInstanceTypes: allOf: - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - xml: name: ExcludedInstanceType description: 'The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can''t specify AllowedInstanceTypes.
Default: No excluded instance types
' InstanceGenerations: allOf: - $ref: '#/components/schemas/InstanceGenerationSet' - xml: name: InstanceGeneration description: 'Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
' SpotMaxPricePercentageOverLowestPrice: allOf: - $ref: '#/components/schemas/Integer' - description: 'The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
' LocalStorage: allOf: - $ref: '#/components/schemas/LocalStorage' - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: hdd and ssd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
' BaselineEbsBandwidthMbps: allOf: - $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest' - description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' AcceleratorTypes: allOf: - $ref: '#/components/schemas/AcceleratorTypeSet' - xml: name: AcceleratorType description: 'The accelerator types that must be on the instance type.
To include instance types with GPU hardware, specify gpu.
To include instance types with FPGA hardware, specify fpga.
To include instance types with inference hardware, specify inference.
Default: Any accelerator type
' AcceleratorCount: allOf: - $ref: '#/components/schemas/AcceleratorCountRequest' - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' AcceleratorManufacturers: allOf: - $ref: '#/components/schemas/AcceleratorManufacturerSet' - xml: name: AcceleratorManufacturer description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' AcceleratorNames: allOf: - $ref: '#/components/schemas/AcceleratorNameSet' - xml: name: AcceleratorName description: 'The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.
Default: Any accelerator
' AcceleratorTotalMemoryMiB: allOf: - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' NetworkBandwidthGbps: allOf: - $ref: '#/components/schemas/NetworkBandwidthGbpsRequest' - description: 'The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' AllowedInstanceTypes: allOf: - $ref: '#/components/schemas/AllowedInstanceTypeSet' - xml: name: AllowedInstanceType description: 'The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
If you specify AllowedInstanceTypes, you can''t specify ExcludedInstanceTypes.
Default: All instance types
' description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can''t specify InstanceRequirements.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: Action in: query required: true schema: type: string enum: - GetInstanceTypesFromInstanceRequirements - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: GetInstanceTypesFromInstanceRequirements operationId: POST_GetInstanceTypesFromInstanceRequirements description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetInstanceTypesFromInstanceRequirementsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - GetInstanceTypesFromInstanceRequirements - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetInstanceUefiData: get: x-aws-operation-name: GetInstanceUefiData operationId: GET_GetInstanceUefiData description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetInstanceUefiDataResult' parameters: - name: InstanceId in: query required: true description: The ID of the instance from which to retrieve the UEFI data. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetInstanceUefiData
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetInstanceUefiData
operationId: POST_GetInstanceUefiData
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetInstanceUefiDataResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetInstanceUefiDataRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetInstanceUefiData - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetIpamAddressHistory: get: x-aws-operation-name: GetIpamAddressHistory operationId: GET_GetIpamAddressHistory description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetIpamAddressHistoryResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Cidr
in: query
required: true
description: 'The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.'
schema:
type: string
- name: IpamScopeId
in: query
required: true
description: The ID of the IPAM scope that the CIDR is in.
schema:
type: string
- name: VpcId
in: query
required: false
description: The ID of the VPC you want your history records filtered by.
schema:
type: string
- name: StartTime
in: query
required: false
description: 'The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.'
schema:
type: string
format: date-time
- name: EndTime
in: query
required: false
description: 'The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.'
schema:
type: string
format: date-time
- name: MaxResults
in: query
required: false
description: The maximum number of historical results you would like returned per page. Defaults to 100.
schema:
type: integer
minimum: 1
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamAddressHistory
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetIpamAddressHistory
operationId: POST_GetIpamAddressHistory
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamAddressHistoryResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamAddressHistoryRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamAddressHistory
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetIpamDiscoveredAccounts:
get:
x-aws-operation-name: GetIpamDiscoveredAccounts
operationId: GET_GetIpamDiscoveredAccounts
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamDiscoveredAccountsResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: IpamResourceDiscoveryId
in: query
required: true
description: A resource discovery ID.
schema:
type: string
- name: DiscoveryRegion
in: query
required: true
description: The Amazon Web Services Region that the account information is returned from.
schema:
type: string
- name: Filter
in: query
required: false
description: Discovered account filters.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: NextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: The maximum number of discovered accounts to return in one page of results.
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamDiscoveredAccounts
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetIpamDiscoveredAccounts
operationId: POST_GetIpamDiscoveredAccounts
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamDiscoveredAccountsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamDiscoveredAccountsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamDiscoveredAccounts
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetIpamDiscoveredResourceCidrs:
get:
x-aws-operation-name: GetIpamDiscoveredResourceCidrs
operationId: GET_GetIpamDiscoveredResourceCidrs
description: '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. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamDiscoveredResourceCidrsResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: IpamResourceDiscoveryId
in: query
required: true
description: A resource discovery ID.
schema:
type: string
- name: ResourceRegion
in: query
required: true
description: A resource Region.
schema:
type: string
- name: Filter
in: query
required: false
description: Filters.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: NextToken
in: query
required: false
description: Specify the pagination token from a previous request to retrieve the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: The maximum number of discovered resource CIDRs to return in one page of results.
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamDiscoveredResourceCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetIpamDiscoveredResourceCidrs
operationId: POST_GetIpamDiscoveredResourceCidrs
description: '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. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamDiscoveredResourceCidrsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamDiscoveredResourceCidrsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamDiscoveredResourceCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetIpamPoolAllocations:
get:
x-aws-operation-name: GetIpamPoolAllocations
operationId: GET_GetIpamPoolAllocations
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the IPAM pool you want to see the allocations for.
schema:
type: string
- name: IpamPoolAllocationId
in: query
required: false
description: The ID of the allocation.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: The maximum number of results you would like returned per page.
schema:
type: integer
minimum: 1000
maximum: 100000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamPoolAllocations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetIpamPoolAllocations
operationId: POST_GetIpamPoolAllocations
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the IPAM pool you want the CIDR for.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: The maximum number of results to return in the request.
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamPoolCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetIpamPoolCidrs
operationId: POST_GetIpamPoolCidrs
description: Get the CIDRs provisioned to an IPAM pool.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamPoolCidrsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamPoolCidrsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamPoolCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetIpamResourceCidrs:
get:
x-aws-operation-name: GetIpamResourceCidrs
operationId: GET_GetIpamResourceCidrs
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamResourceCidrsResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: Filter
in: query
required: false
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: The maximum number of results to return in the request.
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: IpamScopeId
in: query
required: true
description: The ID of the scope that the resource is in.
schema:
type: string
- name: IpamPoolId
in: query
required: false
description: The ID of the IPAM pool that the resource is in.
schema:
type: string
- name: ResourceId
in: query
required: false
description: The ID of the resource.
schema:
type: string
- name: ResourceType
in: query
required: false
description: The resource type.
schema:
type: string
enum:
- vpc
- subnet
- eip
- public-ipv4-pool
- ipv6-pool
- name: ResourceTag
in: query
required: false
description: The resource tag.
schema:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.'
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The value for the tag.
description: A tag on an IPAM resource.
- name: ResourceOwner
in: query
required: false
description: The ID of the Amazon Web Services account that owns the resource.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamResourceCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetIpamResourceCidrs
operationId: POST_GetIpamResourceCidrs
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamResourceCidrsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetIpamResourceCidrsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetIpamResourceCidrs
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetLaunchTemplateData:
get:
x-aws-operation-name: GetLaunchTemplateData
operationId: GET_GetLaunchTemplateData
description: '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, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetLaunchTemplateData
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetLaunchTemplateData
operationId: POST_GetLaunchTemplateData
description: '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, DescribeInstanceAttribute, and DescribeElasticGpus. Or, you can allow describe* depending on your instance requirements.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 255
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetManagedPrefixListAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetManagedPrefixListAssociations
operationId: POST_GetManagedPrefixListAssociations
description: Gets information about the resources that are associated with the specified managed prefix list.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetManagedPrefixListAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetManagedPrefixListAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetManagedPrefixListAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetManagedPrefixListEntries:
get:
x-aws-operation-name: GetManagedPrefixListEntries
operationId: GET_GetManagedPrefixListEntries
description: Gets information about the entries for a specified managed prefix list.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetManagedPrefixListEntriesResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list.
schema:
type: string
- name: TargetVersion
in: query
required: false
description: The version of the prefix list for which to return the entries. The default is the current version.
schema:
type: integer
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetManagedPrefixListEntries
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetManagedPrefixListEntries
operationId: POST_GetManagedPrefixListEntries
description: Gets information about the entries for a specified managed prefix list.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetManagedPrefixListEntriesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetManagedPrefixListEntriesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetManagedPrefixListEntries
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetNetworkInsightsAccessScopeAnalysisFindings:
get:
x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings
operationId: GET_GetNetworkInsightsAccessScopeAnalysisFindings
description: Gets the findings for the specified Network Access Scope analysis.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult'
parameters:
- name: NetworkInsightsAccessScopeAnalysisId
in: query
required: true
description: The ID of the Network Access Scope analysis.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 1
maximum: 100
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetNetworkInsightsAccessScopeAnalysisFindings
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetNetworkInsightsAccessScopeAnalysisFindings
operationId: POST_GetNetworkInsightsAccessScopeAnalysisFindings
description: Gets the findings for the specified Network Access Scope analysis.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetNetworkInsightsAccessScopeAnalysisFindingsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetNetworkInsightsAccessScopeAnalysisFindings
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetNetworkInsightsAccessScopeContent:
get:
x-aws-operation-name: GetNetworkInsightsAccessScopeContent
operationId: GET_GetNetworkInsightsAccessScopeContent
description: Gets the content for the specified Network Access Scope.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult'
parameters:
- name: NetworkInsightsAccessScopeId
in: query
required: true
description: The ID of the Network Access Scope.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetNetworkInsightsAccessScopeContent
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetNetworkInsightsAccessScopeContent
operationId: POST_GetNetworkInsightsAccessScopeContent
description: Gets the content for the specified Network Access Scope.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetNetworkInsightsAccessScopeContentRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetNetworkInsightsAccessScopeContent
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetPasswordData:
get:
x-aws-operation-name: GetPasswordData
operationId: GET_GetPasswordData
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetPasswordDataResult' parameters: - name: InstanceId in: query required: true description: The ID of the Windows instance. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetPasswordData
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetPasswordData
operationId: POST_GetPasswordData
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetPasswordDataResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetPasswordDataRequest' parameters: - name: Action in: query required: true schema: type: string enum: - GetPasswordData - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetReservedInstancesExchangeQuote: get: x-aws-operation-name: GetReservedInstancesExchangeQuote operationId: GET_GetReservedInstancesExchangeQuote description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ReservedInstanceId
in: query
required: true
description: The IDs of the Convertible Reserved Instances to exchange.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservationId'
- xml:
name: ReservedInstanceId
- name: TargetConfiguration
in: query
required: false
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TargetConfigurationRequest'
- xml:
name: TargetConfigurationRequest
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetReservedInstancesExchangeQuote
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetReservedInstancesExchangeQuote
operationId: POST_GetReservedInstancesExchangeQuote
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetReservedInstancesExchangeQuoteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetReservedInstancesExchangeQuote
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetSerialConsoleAccessStatus:
get:
x-aws-operation-name: GetSerialConsoleAccessStatus
operationId: GET_GetSerialConsoleAccessStatus
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetSerialConsoleAccessStatusResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetSerialConsoleAccessStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetSerialConsoleAccessStatus
operationId: POST_GetSerialConsoleAccessStatus
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetSerialConsoleAccessStatusResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetSerialConsoleAccessStatusRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetSerialConsoleAccessStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetSpotPlacementScores:
get:
x-aws-operation-name: GetSpotPlacementScores
operationId: GET_GetSpotPlacementScores
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetSpotPlacementScoresResult' parameters: - name: InstanceType in: query required: false description: 'The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an m3.xlarge with and without instance storage), the returned placement score will always be low.
If you specify InstanceTypes, you can''t specify InstanceRequirementsWithMetadata.
The unit for the target capacity.
Default: units (translates to number of instances)
Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.
' schema: type: boolean - name: RegionName in: query required: false description: 'The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,us-east-1.'
schema:
type: array
items:
$ref: '#/components/schemas/String'
minItems: 0
maxItems: 10
- name: InstanceRequirementsWithMetadata
in: query
required: false
description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadata, you can''t specify InstanceTypes.
The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 10
maximum: 1000
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetSpotPlacementScores
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetSpotPlacementScores
operationId: POST_GetSpotPlacementScores
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetSpotPlacementScoresResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/GetSpotPlacementScoresRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: Action in: query required: true schema: type: string enum: - GetSpotPlacementScores - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=GetSubnetCidrReservations: get: x-aws-operation-name: GetSubnetCidrReservations operationId: GET_GetSubnetCidrReservations description: Gets information about the subnet CIDR reservations. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/GetSubnetCidrReservationsResult' parameters: - name: Filter in: query required: false description: 'One or more filters.
reservationType - The type of reservation (prefix | explicit).
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetSubnetCidrReservations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetSubnetCidrReservations
operationId: POST_GetSubnetCidrReservations
description: Gets information about the subnet CIDR reservations.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetSubnetCidrReservationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetSubnetCidrReservationsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetSubnetCidrReservations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetTransitGatewayAttachmentPropagations:
get:
x-aws-operation-name: GetTransitGatewayAttachmentPropagations
operationId: GET_GetTransitGatewayAttachmentPropagations
description: Lists the route tables to which the specified resource attachment propagates routes.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
parameters:
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the attachment.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayAttachmentPropagations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetTransitGatewayAttachmentPropagations
operationId: POST_GetTransitGatewayAttachmentPropagations
description: Lists the route tables to which the specified resource attachment propagates routes.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayAttachmentPropagations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetTransitGatewayMulticastDomainAssociations:
get:
x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations
operationId: GET_GetTransitGatewayMulticastDomainAssociations
description: Gets information about the associations for the transit gateway multicast domain.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult'
parameters:
- name: TransitGatewayMulticastDomainId
in: query
required: true
description: The ID of the transit gateway multicast domain.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The type of resource. The valid value is: vpc.
state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayMulticastDomainAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetTransitGatewayMulticastDomainAssociations
operationId: POST_GetTransitGatewayMulticastDomainAssociations
description: Gets information about the associations for the transit gateway multicast domain.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayMulticastDomainAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayMulticastDomainAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetTransitGatewayPolicyTableAssociations:
get:
x-aws-operation-name: GetTransitGatewayPolicyTableAssociations
operationId: GET_GetTransitGatewayPolicyTableAssociations
description: Gets a list of the transit gateway policy table associations.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPolicyTableAssociationsResult'
parameters:
- name: TransitGatewayPolicyTableId
in: query
required: true
description: The ID of the transit gateway policy table.
schema:
type: string
- name: Filter
in: query
required: false
description: The filters associated with the transit gateway policy table.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayPolicyTableAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetTransitGatewayPolicyTableAssociations
operationId: POST_GetTransitGatewayPolicyTableAssociations
description: Gets a list of the transit gateway policy table associations.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPolicyTableAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPolicyTableAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayPolicyTableAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetTransitGatewayPolicyTableEntries:
get:
x-aws-operation-name: GetTransitGatewayPolicyTableEntries
operationId: GET_GetTransitGatewayPolicyTableEntries
description: Returns a list of transit gateway policy table entries.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPolicyTableEntriesResult'
parameters:
- name: TransitGatewayPolicyTableId
in: query
required: true
description: The ID of the transit gateway policy table.
schema:
type: string
- name: Filter
in: query
required: false
description: The filters associated with the transit gateway policy table.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
- name: MaxResults
in: query
required: false
description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayPolicyTableEntries
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetTransitGatewayPolicyTableEntries
operationId: POST_GetTransitGatewayPolicyTableEntries
description: Returns a list of transit gateway policy table entries.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPolicyTableEntriesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPolicyTableEntriesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayPolicyTableEntries
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetTransitGatewayPrefixListReferences:
get:
x-aws-operation-name: GetTransitGatewayPrefixListReferences
operationId: GET_GetTransitGatewayPrefixListReferences
description: Gets information about the prefix list references in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked (true | false).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference (pending | available | modifying | deleting).
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayPrefixListReferences
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetTransitGatewayPrefixListReferences
operationId: POST_GetTransitGatewayPrefixListReferences
description: Gets information about the prefix list references in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayPrefixListReferencesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayPrefixListReferences
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetTransitGatewayRouteTableAssociations:
get:
x-aws-operation-name: GetTransitGatewayRouteTableAssociations
operationId: GET_GetTransitGatewayRouteTableAssociations
description: Gets information about the associations for the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayRouteTableAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetTransitGatewayRouteTableAssociations
operationId: POST_GetTransitGatewayRouteTableAssociations
description: Gets information about the associations for the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayRouteTableAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetTransitGatewayRouteTablePropagations:
get:
x-aws-operation-name: GetTransitGatewayRouteTablePropagations
operationId: GET_GetTransitGatewayRouteTablePropagations
description: Gets information about the route table propagations for the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayRouteTablePropagations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetTransitGatewayRouteTablePropagations
operationId: POST_GetTransitGatewayRouteTablePropagations
description: Gets information about the route table propagations for the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetTransitGatewayRouteTablePropagations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetVerifiedAccessEndpointPolicy:
get:
x-aws-operation-name: GetVerifiedAccessEndpointPolicy
operationId: GET_GetVerifiedAccessEndpointPolicy
description: Get the Verified Access policy associated with the endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVerifiedAccessEndpointPolicyResult'
parameters:
- name: VerifiedAccessEndpointId
in: query
required: true
description: The ID of the Verified Access endpoint.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVerifiedAccessEndpointPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetVerifiedAccessEndpointPolicy
operationId: POST_GetVerifiedAccessEndpointPolicy
description: Get the Verified Access policy associated with the endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVerifiedAccessEndpointPolicyResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVerifiedAccessEndpointPolicyRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVerifiedAccessEndpointPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetVerifiedAccessGroupPolicy:
get:
x-aws-operation-name: GetVerifiedAccessGroupPolicy
operationId: GET_GetVerifiedAccessGroupPolicy
description: Shows the contents of the Verified Access policy associated with the group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVerifiedAccessGroupPolicyResult'
parameters:
- name: VerifiedAccessGroupId
in: query
required: true
description: The ID of the Verified Access group.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVerifiedAccessGroupPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetVerifiedAccessGroupPolicy
operationId: POST_GetVerifiedAccessGroupPolicy
description: Shows the contents of the Verified Access policy associated with the group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVerifiedAccessGroupPolicyResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVerifiedAccessGroupPolicyRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVerifiedAccessGroupPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetVpnConnectionDeviceSampleConfiguration:
get:
x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration
operationId: GET_GetVpnConnectionDeviceSampleConfiguration
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult'
parameters:
- name: VpnConnectionId
in: query
required: true
description: The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.
schema:
type: string
- name: VpnConnectionDeviceTypeId
in: query
required: true
description: Device identifier provided by the GetVpnConnectionDeviceTypes API.
schema:
type: string
- name: InternetKeyExchangeVersion
in: query
required: false
description: 'The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVpnConnectionDeviceSampleConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetVpnConnectionDeviceSampleConfiguration
operationId: POST_GetVpnConnectionDeviceSampleConfiguration
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnConnectionDeviceSampleConfigurationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVpnConnectionDeviceSampleConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetVpnConnectionDeviceTypes:
get:
x-aws-operation-name: GetVpnConnectionDeviceTypes
operationId: GET_GetVpnConnectionDeviceTypes
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult'
parameters:
- name: MaxResults
in: query
required: false
description: 'The maximum number of results returned by GetVpnConnectionDeviceTypes in paginated output. When this parameter is used, GetVpnConnectionDeviceTypes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another GetVpnConnectionDeviceTypes request with the returned NextToken value. This value can be between 200 and 1000. If this parameter is not used, then GetVpnConnectionDeviceTypes returns all results.'
schema:
type: integer
minimum: 200
maximum: 1000
- name: NextToken
in: query
required: false
description: 'The NextToken value returned from a previous paginated GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. '
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVpnConnectionDeviceTypes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetVpnConnectionDeviceTypes
operationId: POST_GetVpnConnectionDeviceTypes
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnConnectionDeviceTypesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnConnectionDeviceTypesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVpnConnectionDeviceTypes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=GetVpnTunnelReplacementStatus:
get:
x-aws-operation-name: GetVpnTunnelReplacementStatus
operationId: GET_GetVpnTunnelReplacementStatus
description: Get details of available tunnel endpoint maintenance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnTunnelReplacementStatusResult'
parameters:
- name: VpnConnectionId
in: query
required: true
description: 'The ID of the Site-to-Site VPN connection. '
schema:
type: string
- name: VpnTunnelOutsideIpAddress
in: query
required: true
description: The external IP address of the VPN tunnel.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVpnTunnelReplacementStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: GetVpnTunnelReplacementStatus
operationId: POST_GetVpnTunnelReplacementStatus
description: Get details of available tunnel endpoint maintenance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnTunnelReplacementStatusResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/GetVpnTunnelReplacementStatusRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- GetVpnTunnelReplacementStatus
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ImportClientVpnClientCertificateRevocationList:
get:
x-aws-operation-name: ImportClientVpnClientCertificateRevocationList
operationId: GET_ImportClientVpnClientCertificateRevocationList
description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint to which the client certificate revocation list applies. schema: type: string - name: CertificateRevocationList in: query required: true description: 'The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the Client VPN Administrator Guide.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ImportClientVpnClientCertificateRevocationList
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ImportClientVpnClientCertificateRevocationList
operationId: POST_ImportClientVpnClientCertificateRevocationList
description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ImportClientVpnClientCertificateRevocationList - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ImportImage: get: x-aws-operation-name: ImportImage operationId: GET_ImportImage description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportImageResult' parameters: - name: Architecture in: query required: false description: 'The architecture of the virtual machine.
Valid values: i386 | x86_64
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Encrypted
in: query
required: false
description: 'Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
schema:
type: boolean
- name: Hypervisor
in: query
required: false
description: 'The target hypervisor platform.
Valid values: xen
An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' schema: type: string - name: LicenseType in: query required: false description: 'The license type to be used for the Amazon Machine Image (AMI) after importing.
Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.
The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.
Valid values: Windows | Linux
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportImageResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ImportImageRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ImportImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ImportInstance: get: x-aws-operation-name: ImportInstance operationId: GET_ImportInstance description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportInstanceResult' parameters: - name: Description in: query required: false description: A description for the instance being imported. schema: type: string - name: DiskImage in: query required: false description: The disk image. schema: type: array items: $ref: '#/components/schemas/DiskImage' - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: LaunchSpecification
in: query
required: false
description: The launch specification.
schema:
type: object
properties:
AdditionalInfo:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: additionalInfo
description: Reserved.
Architecture:
allOf:
- $ref: '#/components/schemas/ArchitectureValues'
- xml:
name: architecture
description: The architecture of the instance.
GroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdStringList'
- xml:
name: GroupId
description: The security group IDs.
GroupNames:
allOf:
- $ref: '#/components/schemas/SecurityGroupStringList'
- xml:
name: GroupName
description: The security group names.
InstanceInitiatedShutdownBehavior:
allOf:
- $ref: '#/components/schemas/ShutdownBehavior'
- xml:
name: instanceInitiatedShutdownBehavior
description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: 'The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.'
Monitoring:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: monitoring
description: Indicates whether monitoring is enabled.
Placement:
allOf:
- $ref: '#/components/schemas/Placement'
- xml:
name: placement
description: The placement information for the instance.
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateIpAddress
description: '[EC2-VPC] An available IP address from the IP address range of the subnet.'
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: subnetId
description: '[EC2-VPC] The ID of the subnet in which to launch the instance.'
UserData:
allOf:
- $ref: '#/components/schemas/UserData'
- xml:
name: userData
description: The Base64-encoded user data to make available to the instance.
description: Describes the launch specification for VM import.
- name: Platform
in: query
required: true
description: The instance operating system.
schema:
type: string
enum:
- Windows
- name: Action
in: query
required: true
schema:
type: string
enum:
- ImportInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ImportInstance
operationId: POST_ImportInstance
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportInstanceResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ImportInstanceRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ImportInstance - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ImportKeyPair: get: x-aws-operation-name: ImportKeyPair operationId: GET_ImportKeyPair description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportKeyPairResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: KeyName
in: query
required: true
description: A unique name for the key pair.
schema:
type: string
- name: PublicKeyMaterial
in: query
required: true
description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.'
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to apply to the imported key pair.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- ImportKeyPair
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ImportKeyPair
operationId: POST_ImportKeyPair
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportKeyPairResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ImportKeyPairRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ImportKeyPair - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ImportSnapshot: get: x-aws-operation-name: ImportSnapshot operationId: GET_ImportSnapshot description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportSnapshotResult' parameters: - name: ClientData in: query required: false description: The client-specific data. schema: type: object properties: Comment: allOf: - $ref: '#/components/schemas/String' - description: A user-defined comment about the disk upload. UploadEnd: allOf: - $ref: '#/components/schemas/DateTime' - description: The time that the disk upload ends. UploadSize: allOf: - $ref: '#/components/schemas/Double' - description: 'The size of the uploaded disk image, in GiB.' UploadStart: allOf: - $ref: '#/components/schemas/DateTime' - description: The time that the disk upload starts. description: Describes the client-specific data. - name: ClientToken in: query required: false description: Token to enable idempotency for VM import requests. schema: type: string - name: Description in: query required: false description: The description string for the import snapshot task. schema: type: string - name: DiskContainer in: query required: false description: Information about the disk container. schema: type: object properties: Description: allOf: - $ref: '#/components/schemas/String' - description: The description of the disk image being imported. Format: allOf: - $ref: '#/components/schemas/String' - description: 'The format of the disk image being imported.
Valid values: VHD | VMDK | RAW
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Encrypted
in: query
required: false
description: 'Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
schema:
type: boolean
- name: KmsKeyId
in: query
required: false
description: 'An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' schema: type: string - name: RoleName in: query required: false description: 'The name of the role to use when not using the default role, ''vmimport''.' schema: type: string - name: TagSpecification in: query required: false description: The tags to apply to the import snapshot task during creation. schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: Action in: query required: true schema: type: string enum: - ImportSnapshot - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ImportSnapshot operationId: POST_ImportSnapshot description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportSnapshotResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ImportSnapshotRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ImportSnapshot - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ImportVolume: get: x-aws-operation-name: ImportVolume operationId: GET_ImportVolume description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportVolumeResult' parameters: - name: AvailabilityZone in: query required: true description: The Availability Zone for the resulting EBS volume. schema: type: string - name: Description in: query required: false description: A description of the volume. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Image
in: query
required: true
description: The disk image.
schema:
type: object
required:
- Bytes
- Format
- ImportManifestUrl
properties:
Bytes:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: bytes
description: 'The size of the disk image, in GiB.'
Format:
allOf:
- $ref: '#/components/schemas/DiskImageFormat'
- xml:
name: format
description: The disk image format.
ImportManifestUrl:
allOf:
- $ref: '#/components/schemas/ImportManifestUrl'
- xml:
name: importManifestUrl
description: 'A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' description: Describes a disk image. - name: Volume in: query required: true description: The volume size. schema: type: object required: - Size properties: Size: allOf: - $ref: '#/components/schemas/Long' - xml: name: size description: 'The size of the volume, in GiB.' description: Describes an EBS volume. - name: Action in: query required: true schema: type: string enum: - ImportVolume - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ImportVolume operationId: POST_ImportVolume description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ImportVolumeResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ImportVolumeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ImportVolume - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ListImagesInRecycleBin: get: x-aws-operation-name: ListImagesInRecycleBin operationId: GET_ListImagesInRecycleBin description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ListImagesInRecycleBinResult' parameters: - name: ImageId in: query required: false description: The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request. schema: type: array items: allOf: - $ref: '#/components/schemas/ImageId' - xml: name: ImageId - name: NextToken in: query required: false description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. schema: type: string - name: MaxResults in: query required: false description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' schema: type: integer minimum: 1 maximum: 1000 - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ListImagesInRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ListImagesInRecycleBin
operationId: POST_ListImagesInRecycleBin
description: 'Lists one or more AMIs that are currently in the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ListImagesInRecycleBinResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ListImagesInRecycleBinRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- ListImagesInRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ListSnapshotsInRecycleBin:
get:
x-aws-operation-name: ListSnapshotsInRecycleBin
operationId: GET_ListSnapshotsInRecycleBin
description: Lists one or more snapshots that are currently in the Recycle Bin.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ListSnapshotsInRecycleBinResult'
parameters:
- name: MaxResults
in: query
required: false
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
schema:
type: string
- name: SnapshotId
in: query
required: false
description: The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- xml:
name: SnapshotId
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ListSnapshotsInRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ListSnapshotsInRecycleBin
operationId: POST_ListSnapshotsInRecycleBin
description: Lists one or more snapshots that are currently in the Recycle Bin.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ListSnapshotsInRecycleBinResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ListSnapshotsInRecycleBinRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- ListSnapshotsInRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyAddressAttribute:
get:
x-aws-operation-name: ModifyAddressAttribute
operationId: GET_ModifyAddressAttribute
description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyAddressAttributeResult'
parameters:
- name: AllocationId
in: query
required: true
description: '[EC2-VPC] The allocation ID.'
schema:
type: string
- name: DomainName
in: query
required: false
description: The domain name to modify for the IP address.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyAddressAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyAddressAttribute
operationId: POST_ModifyAddressAttribute
description: 'Modifies an attribute of the specified Elastic IP address. For requirements, see Using reverse DNS for email applications.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyAddressAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyAddressAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyAddressAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyAvailabilityZoneGroup:
get:
x-aws-operation-name: ModifyAvailabilityZoneGroup
operationId: GET_ModifyAvailabilityZoneGroup
description: 'Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName.
opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.'
schema:
type: string
enum:
- opted-in
- not-opted-in
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyAvailabilityZoneGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyAvailabilityZoneGroup
operationId: POST_ModifyAvailabilityZoneGroup
description: 'Changes the opt-in status of the Local Zone and Wavelength Zone group for your account.
Use DescribeAvailabilityZones to view the value for GroupName.
1000 in a single request.
schema:
type: integer
- name: EndDate
in: query
required: false
description: 'The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: AdditionalInfo
in: query
required: false
description: Reserved for future use.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyCapacityReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyCapacityReservation
operationId: POST_ModifyCapacityReservation
description: 'Modifies a Capacity Reservation''s capacity and the conditions under which it is to be released. You cannot change a Capacity Reservation''s instance type, EBS optimization, instance store settings, platform, Availability Zone, or instance eligibility. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyCapacityReservationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyCapacityReservationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyCapacityReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyCapacityReservationFleet:
get:
x-aws-operation-name: ModifyCapacityReservationFleet
operationId: GET_ModifyCapacityReservationFleet
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' parameters: - name: CapacityReservationFleetId in: query required: true description: The ID of the Capacity Reservation Fleet to modify. schema: type: string - name: TotalTargetCapacity in: query required: false description: '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.' schema: type: integer - name: EndDate in: query required: false description: 'The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can''t specify EndDate and RemoveEndDate in the same request.
' schema: type: string format: date-time - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: RemoveEndDate
in: query
required: false
description: 'Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can''t specify RemoveEndDate and EndDate in the same request.
' schema: type: boolean - name: Action in: query required: true schema: type: string enum: - ModifyCapacityReservationFleet - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyCapacityReservationFleet operationId: POST_ModifyCapacityReservationFleet description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyCapacityReservationFleetResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyCapacityReservationFleetRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyCapacityReservationFleet - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyClientVpnEndpoint: get: x-aws-operation-name: ModifyClientVpnEndpoint operationId: GET_ModifyClientVpnEndpoint description: Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyClientVpnEndpointResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint to modify. schema: type: string - name: ServerCertificateArn in: query required: false description: The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM). schema: type: string - name: ConnectionLogOptions in: query required: false description: '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
False to delete the existing DNS servers.
description: Information about the DNS server to be used.
- name: VpnPort
in: query
required: false
description: 'The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' schema: type: boolean - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SecurityGroupId
in: query
required: false
description: The IDs of one or more security groups to apply to the target network.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
- name: VpcId
in: query
required: false
description: The ID of the VPC to associate with the Client VPN endpoint.
schema:
type: string
- name: SelfServicePortal
in: query
required: false
description: Specify whether to enable the self-service portal for the Client VPN endpoint.
schema:
type: string
enum:
- enabled
- disabled
- name: ClientConnectOptions
in: query
required: false
description: The options for managing connection authorization for new client connections.
schema:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether client connect options are enabled. The default is false (not enabled).
LambdaFunctionArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
description: The options for managing connection authorization for new client connections.
- name: SessionTimeoutHours
in: query
required: false
description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
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
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceFamily
in: query
required: true
description: The instance family.
schema:
type: string
enum:
- t2
- t3
- t3a
- t4g
- name: CpuCredits
in: query
required: true
description: 'The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyDefaultCreditSpecificationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyDefaultCreditSpecificationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyDefaultCreditSpecification - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyEbsDefaultKmsKeyId: get: x-aws-operation-name: ModifyEbsDefaultKmsKeyId operationId: GET_ModifyEbsDefaultKmsKeyId description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' parameters: - name: KmsKeyId in: query required: true description: 'The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric KMS keys.
' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyEbsDefaultKmsKeyId
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyEbsDefaultKmsKeyId
operationId: POST_ModifyEbsDefaultKmsKeyId
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyEbsDefaultKmsKeyIdRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyEbsDefaultKmsKeyId - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyFleet: get: x-aws-operation-name: ModifyFleet operationId: GET_ModifyFleet description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyFleetResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ExcessCapacityTerminationPolicy
in: query
required: false
description: 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.
DefaultTargetCapacityType.'
OnDemandTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of On-Demand units to request.
SpotTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of Spot units to request.
DefaultTargetCapacityType:
allOf:
- $ref: '#/components/schemas/DefaultTargetCapacityType'
- description: 'The default TotalTargetCapacity, which is either Spot or On-Demand.'
TargetCapacityUnitType:
allOf:
- $ref: '#/components/schemas/TargetCapacityUnitType'
- description: 'The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyFleetResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyFleetRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyFleet - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyFpgaImageAttribute: get: x-aws-operation-name: ModifyFpgaImageAttribute operationId: GET_ModifyFpgaImageAttribute description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI). responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyFpgaImageAttributeResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FpgaImageId
in: query
required: true
description: The ID of the AFI.
schema:
type: string
- name: Attribute
in: query
required: false
description: The name of the attribute.
schema:
type: string
enum:
- description
- name
- loadPermission
- productCodes
- name: OperationType
in: query
required: false
description: The operation type.
schema:
type: string
enum:
- add
- remove
- name: UserId
in: query
required: false
description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: UserId
- name: UserGroup
in: query
required: false
description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: UserGroup
- name: ProductCode
in: query
required: false
description: 'The product codes. After you add a product code to an AFI, it can''t be removed. This parameter is valid only when modifying the productCodes attribute.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ProductCode
- name: LoadPermission
in: query
required: false
description: The load permission for the AFI.
schema:
type: object
properties:
Add:
allOf:
- $ref: '#/components/schemas/LoadPermissionListRequest'
- description: The load permissions to add.
Remove:
allOf:
- $ref: '#/components/schemas/LoadPermissionListRequest'
- description: The load permissions to remove.
description: Describes modifications to the load permissions of an Amazon FPGA image (AFI).
- name: Description
in: query
required: false
description: A description for the AFI.
schema:
type: string
- name: Name
in: query
required: false
description: A name for the AFI.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyFpgaImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyFpgaImageAttribute
operationId: POST_ModifyFpgaImageAttribute
description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyFpgaImageAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyFpgaImageAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyFpgaImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyHosts:
get:
x-aws-operation-name: ModifyHosts
operationId: GET_ModifyHosts
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyHostsResult' parameters: - name: AutoPlacement in: query required: false description: Specify whether to enable or disable auto-placement. schema: type: string enum: - 'on' - 'off' - name: HostId in: query required: true description: The IDs of the Dedicated Hosts to modify. schema: type: array items: allOf: - $ref: '#/components/schemas/DedicatedHostId' - xml: name: item - name: HostRecovery in: query required: false description: 'Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.' schema: type: string enum: - 'on' - 'off' - name: InstanceType in: query required: false description: 'Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
' schema: type: string - name: InstanceFamily in: query required: false description: 'Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' schema: type: string - name: HostMaintenance in: query required: false description: 'Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.' schema: type: string enum: - 'on' - 'off' - name: Action in: query required: true schema: type: string enum: - ModifyHosts - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyHosts operationId: POST_ModifyHosts description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyHostsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyHostsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyHosts - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyIdFormat: get: x-aws-operation-name: ModifyIdFormat operationId: GET_ModifyIdFormat description: '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.
The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
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.
all to modify the ID format for all IAM users, IAM roles, and the root user of the account.'
schema:
type: string
- name: Resource
in: query
required: true
description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
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.
' responses: '200': description: Success parameters: - name: Attribute in: query required: false description: 'The name of the attribute to modify.
Valid values: description | imdsSupport | launchPermission
Attribute parameter is launchPermission.
schema:
type: string
enum:
- add
- remove
- name: ProductCode
in: query
required: false
description: Not supported.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ProductCode
- name: UserGroup
in: query
required: false
description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: UserGroup
- name: UserId
in: query
required: false
description: The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: UserId
- name: Value
in: query
required: false
description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: OrganizationArn
in: query
required: false
description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: OrganizationArn
- name: OrganizationalUnitArn
in: query
required: false
description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: OrganizationalUnitArn
- name: ImdsSupport
in: query
required: false
description: 'Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can''t undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.
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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyImageAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyImageAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyInstanceAttribute: get: x-aws-operation-name: ModifyInstanceAttribute operationId: GET_ModifyInstanceAttribute description: '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.
' responses: '200': description: Success parameters: - name: SourceDestCheck in: query required: false description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value istrue, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: Attribute
in: query
required: false
description: 'The name of the attribute to modify.
You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
' schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification' - xml: name: item - name: DisableApiTermination in: query required: false description: 'If the value istrue, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.'
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EbsOptimized
in: query
required: false
description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: EnaSupport
in: query
required: false
description: Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
schema: type: object properties: Value: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: value description: The attribute value. The valid values aretrue or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: GroupId
in: query
required: false
description: 'Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it''s just the default security group for the VPC.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: groupId
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: InstanceInitiatedShutdownBehavior
in: query
required: false
description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The attribute value. The value is case-sensitive.
description: Describes a value for a resource attribute that is a String.
- name: InstanceType
in: query
required: false
description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned is InvalidInstanceAttributeValue.'
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The attribute value. The value is case-sensitive.
description: Describes a value for a resource attribute that is a String.
- name: Kernel
in: query
required: false
description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The attribute value. The value is case-sensitive.
description: Describes a value for a resource attribute that is a String.
- name: Ramdisk
in: query
required: false
description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The attribute value. The value is case-sensitive.
description: Describes a value for a resource attribute that is a String.
- name: SriovNetSupport
in: query
required: false
description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
schema: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - xml: name: value description: The attribute value. The value is case-sensitive. description: Describes a value for a resource attribute that is a String. - name: UserData in: query required: false description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' schema: type: object properties: Value: allOf: - $ref: '#/components/schemas/Blob' - xml: name: value - name: Value in: query required: false description: 'A new value for the attribute. Use only with thekernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.'
schema:
type: string
- name: DisableApiStop
in: query
required: false
description: 'Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.
' schema: type: object properties: Value: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: value description: The attribute value. The valid values aretrue or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyInstanceAttribute
operationId: POST_ModifyInstanceAttribute
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyInstanceAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyInstanceCapacityReservationAttributes: get: x-aws-operation-name: ModifyInstanceCapacityReservationAttributes operationId: GET_ModifyInstanceCapacityReservationAttributes description: 'Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in anyopen Capacity Reservation with matching attributes, or run On-Demand Instance capacity.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
parameters:
- name: InstanceId
in: query
required: true
description: The ID of the instance to be modified.
schema:
type: string
- name: CapacityReservationSpecification
in: query
required: true
description: Information about the Capacity Reservation targeting option.
schema:
type: object
properties:
CapacityReservationPreference:
allOf:
- $ref: '#/components/schemas/CapacityReservationPreference'
- description: '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.
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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceCapacityReservationAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyInstanceCapacityReservationAttributes
operationId: POST_ModifyInstanceCapacityReservationAttributes
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceCapacityReservationAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyInstanceCreditSpecification:
get:
x-aws-operation-name: ModifyInstanceCreditSpecification
operationId: GET_ModifyInstanceCreditSpecification
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: InstanceCreditSpecification
in: query
required: true
description: Information about the credit option for CPU usage.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceCreditSpecificationRequest'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceCreditSpecification
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyInstanceCreditSpecification
operationId: POST_ModifyInstanceCreditSpecification
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceCreditSpecificationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyInstanceCreditSpecification - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyInstanceEventStartTime: get: x-aws-operation-name: ModifyInstanceEventStartTime operationId: GET_ModifyInstanceEventStartTime description: Modifies the start time for a scheduled Amazon EC2 instance event. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceEventStartTimeResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance with the scheduled event.
schema:
type: string
- name: InstanceEventId
in: query
required: true
description: The ID of the event whose date and time you are modifying.
schema:
type: string
- name: NotBefore
in: query
required: true
description: The new date and time when the event will take place.
schema:
type: string
format: date-time
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceEventStartTime
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyInstanceEventStartTime
operationId: POST_ModifyInstanceEventStartTime
description: Modifies the start time for a scheduled Amazon EC2 instance event.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceEventStartTimeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceEventStartTimeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceEventStartTime
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyInstanceEventWindow:
get:
x-aws-operation-name: ModifyInstanceEventWindow
operationId: GET_ModifyInstanceEventWindow
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceEventWindowResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Name
in: query
required: false
description: The name of the event window.
schema:
type: string
- name: InstanceEventWindowId
in: query
required: true
description: The ID of the event window.
schema:
type: string
- name: TimeRange
in: query
required: false
description: The time ranges of the event window.
schema:
type: array
items:
$ref: '#/components/schemas/InstanceEventWindowTimeRangeRequest'
- name: CronExpression
in: query
required: false
description: 'The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' schema: type: string - name: Action in: query required: true schema: type: string enum: - ModifyInstanceEventWindow - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyInstanceEventWindow operationId: POST_ModifyInstanceEventWindow description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceEventWindowResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceEventWindowRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyInstanceEventWindow - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyInstanceMaintenanceOptions: get: x-aws-operation-name: ModifyInstanceMaintenanceOptions operationId: GET_ModifyInstanceMaintenanceOptions description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult' parameters: - name: InstanceId in: query required: true description: The ID of the instance. schema: type: string - name: AutoRecovery in: query required: false description: Disables the automatic recovery behavior of your instance or sets it to default. schema: type: string enum: - disabled - default - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceMaintenanceOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyInstanceMaintenanceOptions
operationId: POST_ModifyInstanceMaintenanceOptions
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceMaintenanceOptionsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstanceMaintenanceOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyInstanceMetadataOptions:
get:
x-aws-operation-name: ModifyInstanceMetadataOptions
operationId: GET_ModifyInstanceMetadataOptions
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyInstanceMetadataOptionsResult'
parameters:
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: HttpTokens
in: query
required: false
description: 'IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to required).
optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
' schema: type: integer - name: HttpEndpoint in: query required: false description: 'Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled, you cannot access your instance metadata.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: HttpProtocolIpv6
in: query
required: false
description: Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
schema:
type: string
enum:
- disabled
- enabled
- name: InstanceMetadataTags
in: query
required: false
description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
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 launched, 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.
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string ("").
' schema: type: string - name: HostId in: query required: false description: The ID of the Dedicated Host with which to associate the instance. schema: type: string - name: InstanceId in: query required: true description: The ID of the instance that you are modifying. schema: type: string - name: Tenancy in: query required: false description: 'The tenancy for the instance.
For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can''t change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.
partition.
schema:
type: integer
- name: HostResourceGroupArn
in: query
required: false
description: The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.
schema:
type: string
- name: GroupId
in: query
required: false
description: The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyInstancePlacement
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyInstancePlacement
operationId: POST_ModifyInstancePlacement
description: '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 launched, 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamId
in: query
required: true
description: The ID of the IPAM you want to modify.
schema:
type: string
- name: Description
in: query
required: false
description: The description of the IPAM you want to modify.
schema:
type: string
- name: AddOperatingRegion
in: query
required: false
description: 'Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' schema: type: array items: $ref: '#/components/schemas/AddIpamOperatingRegion' minItems: 0 maxItems: 50 - name: RemoveOperatingRegion in: query required: false description: The operating Regions to remove. schema: type: array items: $ref: '#/components/schemas/RemoveIpamOperatingRegion' minItems: 0 maxItems: 50 - name: Action in: query required: true schema: type: string enum: - ModifyIpam - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyIpam operationId: POST_ModifyIpam description: 'Modify the configurations of an IPAM. ' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyIpam - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyIpamPool: get: x-aws-operation-name: ModifyIpamPool operationId: GET_ModifyIpamPool description: 'Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamPoolResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the IPAM pool you want to modify.
schema:
type: string
- name: Description
in: query
required: false
description: The description of the IPAM pool you want to modify.
schema:
type: string
- name: AutoImport
in: query
required: false
description: 'If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' schema: type: boolean - name: AllocationMinNetmaskLength in: query required: false description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length. schema: type: integer minimum: 0 maximum: 128 - name: AllocationMaxNetmaskLength in: query required: false description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length. schema: type: integer minimum: 0 maximum: 128 - name: AllocationDefaultNetmaskLength in: query required: false description: '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.' schema: type: integer minimum: 0 maximum: 128 - name: ClearAllocationDefaultNetmaskLength in: query required: false description: Clear the default netmask length allocation rule for this pool. schema: type: boolean - name: AddAllocationResourceTag in: query required: false description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' schema: type: array items: allOf: - $ref: '#/components/schemas/RequestIpamResourceTag' - xml: name: item - name: RemoveAllocationResourceTag in: query required: false description: Remove tag allocation rules from a pool. schema: type: array items: allOf: - $ref: '#/components/schemas/RequestIpamResourceTag' - xml: name: item - name: Action in: query required: true schema: type: string enum: - ModifyIpamPool - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyIpamPool operationId: POST_ModifyIpamPool description: 'Modify the configurations of an IPAM pool.
For more information, see Modify a pool in the Amazon VPC IPAM User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamPoolResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamPoolRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyIpamPool - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyIpamResourceCidr: get: x-aws-operation-name: ModifyIpamResourceCidr operationId: GET_ModifyIpamResourceCidr description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamResourceCidrResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ResourceId
in: query
required: true
description: The ID of the resource you want to modify.
schema:
type: string
- name: ResourceCidr
in: query
required: true
description: The CIDR of the resource you want to modify.
schema:
type: string
- name: ResourceRegion
in: query
required: true
description: The Amazon Web Services Region of the resource you want to modify.
schema:
type: string
- name: CurrentIpamScopeId
in: query
required: true
description: The ID of the current scope that the resource CIDR is in.
schema:
type: string
- name: DestinationIpamScopeId
in: query
required: false
description: The ID of the scope you want to transfer the resource CIDR to.
schema:
type: string
- name: Monitored
in: query
required: true
description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyIpamResourceCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyIpamResourceCidr
operationId: POST_ModifyIpamResourceCidr
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamResourceCidrResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamResourceCidrRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyIpamResourceCidr - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyIpamResourceDiscovery: get: x-aws-operation-name: ModifyIpamResourceDiscovery operationId: GET_ModifyIpamResourceDiscovery description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyIpamResourceDiscoveryResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamResourceDiscoveryId
in: query
required: true
description: A resource discovery ID.
schema:
type: string
- name: Description
in: query
required: false
description: A resource discovery description.
schema:
type: string
- name: AddOperatingRegion
in: query
required: false
description: Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
schema:
type: array
items:
$ref: '#/components/schemas/AddIpamOperatingRegion'
minItems: 0
maxItems: 50
- name: RemoveOperatingRegion
in: query
required: false
description: Remove operating Regions.
schema:
type: array
items:
$ref: '#/components/schemas/RemoveIpamOperatingRegion'
minItems: 0
maxItems: 50
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyIpamResourceDiscovery
operationId: POST_ModifyIpamResourceDiscovery
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyIpamResourceDiscoveryResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyIpamResourceDiscoveryRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyIpamResourceDiscovery
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyIpamScope:
get:
x-aws-operation-name: ModifyIpamScope
operationId: GET_ModifyIpamScope
description: Modify an IPAM scope.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyIpamScopeResult'
parameters:
- name: DryRun
in: query
required: false
description: '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.'
schema:
type: boolean
- name: IpamScopeId
in: query
required: true
description: The ID of the scope you want to modify.
schema:
type: string
- name: Description
in: query
required: false
description: The description of the scope you want to modify.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyIpamScope
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyIpamScope
operationId: POST_ModifyIpamScope
description: Modify an IPAM scope.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyIpamScopeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyIpamScopeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyIpamScope
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyLaunchTemplate:
get:
x-aws-operation-name: ModifyLaunchTemplate
operationId: GET_ModifyLaunchTemplate
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyLaunchTemplateResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraint: Maximum 128 ASCII characters.
' schema: type: string - name: LaunchTemplateId in: query required: false description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: DestinationPrefixListId
in: query
required: false
description: ' The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request. '
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyLocalGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyLocalGatewayRoute
operationId: POST_ModifyLocalGatewayRoute
description: Modifies the specified local gateway route.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyLocalGatewayRouteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyLocalGatewayRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyLocalGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyManagedPrefixList:
get:
x-aws-operation-name: ModifyManagedPrefixList
operationId: GET_ModifyManagedPrefixList
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyManagedPrefixListResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list.
schema:
type: string
- name: CurrentVersion
in: query
required: false
description: The current version of the prefix list.
schema:
type: integer
- name: PrefixListName
in: query
required: false
description: A name for the prefix list.
schema:
type: string
- name: AddEntry
in: query
required: false
description: One or more entries to add to the prefix list.
schema:
type: array
items:
$ref: '#/components/schemas/AddPrefixListEntry'
minItems: 0
maxItems: 100
- name: RemoveEntry
in: query
required: false
description: One or more entries to remove from the prefix list.
schema:
type: array
items:
$ref: '#/components/schemas/RemovePrefixListEntry'
minItems: 0
maxItems: 100
- name: MaxEntries
in: query
required: false
description: 'The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
' schema: type: integer - name: Action in: query required: true schema: type: string enum: - ModifyManagedPrefixList - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyManagedPrefixList operationId: POST_ModifyManagedPrefixList description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyManagedPrefixListResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyManagedPrefixListRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyManagedPrefixList - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyNetworkInterfaceAttribute: get: x-aws-operation-name: ModifyNetworkInterfaceAttribute operationId: GET_ModifyNetworkInterfaceAttribute description: 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. responses: '200': description: Success parameters: - name: Attachment in: query required: false description: 'Information about the interface attachment. If modifying thedelete on termination attribute, you must specify the ID of the interface attachment.'
schema:
type: object
properties:
AttachmentId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttachmentId'
- xml:
name: attachmentId
description: The ID of the network interface attachment.
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: Indicates whether the network interface is deleted when the instance is terminated.
description: Describes an attachment change.
- name: Description
in: query
required: false
description: A description for the network interface.
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The attribute value. The value is case-sensitive.
description: Describes a value for a resource attribute that is a String.
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SecurityGroupId
in: query
required: false
description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: SecurityGroupId
- name: NetworkInterfaceId
in: query
required: true
description: The ID of the network interface.
schema:
type: string
- name: SourceDestCheck
in: query
required: false
description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: EnaSrdSpecification
in: query
required: false
description: Updates the ENA Express configuration for the network interface that’s attached to the instance.
schema:
type: object
properties:
EnaSrdEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether ENA Express is enabled for the network interface.
EnaSrdUdpSpecification:
allOf:
- $ref: '#/components/schemas/EnaSrdUdpSpecification'
- description: Configures ENA Express for UDP network traffic.
description: '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.
' - name: EnablePrimaryIpv6 in: query required: false description: 'If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.' schema: type: boolean - name: Action in: query required: true schema: type: string enum: - ModifyNetworkInterfaceAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyNetworkInterfaceAttribute operationId: POST_ModifyNetworkInterfaceAttribute description: 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. responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyNetworkInterfaceAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyNetworkInterfaceAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyPrivateDnsNameOptions: get: x-aws-operation-name: ModifyPrivateDnsNameOptions operationId: GET_ModifyPrivateDnsNameOptions description: Modifies the options for instance hostnames for the specified instance. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: PrivateDnsHostnameType
in: query
required: false
description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
schema:
type: string
enum:
- ip-name
- resource-name
- name: EnableResourceNameDnsARecord
in: query
required: false
description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
schema:
type: boolean
- name: EnableResourceNameDnsAAAARecord
in: query
required: false
description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyPrivateDnsNameOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyPrivateDnsNameOptions
operationId: POST_ModifyPrivateDnsNameOptions
description: Modifies the options for instance hostnames for the specified instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyPrivateDnsNameOptionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyPrivateDnsNameOptionsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyPrivateDnsNameOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyReservedInstances:
get:
x-aws-operation-name: ModifyReservedInstances
operationId: GET_ModifyReservedInstances
description: 'Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyReservedInstancesResult' parameters: - name: ReservedInstancesId in: query required: true description: The IDs of the Reserved Instances to modify. schema: type: array items: allOf: - $ref: '#/components/schemas/ReservationId' - xml: name: ReservedInstancesId - name: ClientToken in: query required: false description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.' schema: type: string - name: ReservedInstancesConfigurationSetItemType in: query required: true description: The configuration settings for the Reserved Instances to modify. schema: type: array items: allOf: - $ref: '#/components/schemas/ReservedInstancesConfiguration' - xml: name: item - name: Action in: query required: true schema: type: string enum: - ModifyReservedInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ModifyReservedInstances operationId: POST_ModifyReservedInstances description: 'Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type.
For more information, see Modifying Reserved Instances in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyReservedInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyReservedInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyReservedInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifySecurityGroupRules: get: x-aws-operation-name: ModifySecurityGroupRules operationId: GET_ModifySecurityGroupRules description: Modifies the rules of a security group. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifySecurityGroupRulesResult' parameters: - name: GroupId in: query required: true description: The ID of the security group. schema: type: string - name: SecurityGroupRule in: query required: true description: Information about the security group properties to update. schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupRuleUpdate' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifySecurityGroupRules
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifySecurityGroupRules
operationId: POST_ModifySecurityGroupRules
description: Modifies the rules of a security group.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifySecurityGroupRulesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifySecurityGroupRulesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifySecurityGroupRules
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifySnapshotAttribute:
get:
x-aws-operation-name: ModifySnapshotAttribute
operationId: GET_ModifySnapshotAttribute
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success parameters: - name: Attribute in: query required: false description: The snapshot attribute to modify. Only volume creation permissions can be modified. schema: type: string enum: - productCodes - createVolumePermission - name: CreateVolumePermission in: query required: false description: A JSON representation of the snapshot attribute modification. schema: type: object properties: Add: allOf: - $ref: '#/components/schemas/CreateVolumePermissionList' - description: Adds the specified Amazon Web Services account ID or group to the list. Remove: allOf: - $ref: '#/components/schemas/CreateVolumePermissionList' - description: Removes the specified Amazon Web Services account ID or group from the list. description: Describes modifications to the list of create volume permissions for a volume. - name: UserGroup in: query required: false description: The group to modify for the snapshot. schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupName' - xml: name: GroupName - name: OperationType in: query required: false description: The type of operation to perform to the attribute. schema: type: string enum: - add - remove - name: SnapshotId in: query required: true description: The ID of the snapshot. schema: type: string - name: UserId in: query required: false description: The account ID to modify for the snapshot. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: UserId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifySnapshotAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifySnapshotAttribute
operationId: POST_ModifySnapshotAttribute
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifySnapshotAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifySnapshotAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifySnapshotTier: get: x-aws-operation-name: ModifySnapshotTier operationId: GET_ModifySnapshotTier description: '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 Elastic Compute Cloud User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifySnapshotTierResult' parameters: - name: SnapshotId in: query required: true description: The ID of the snapshot. schema: type: string - name: StorageTier in: query required: false description: The name of the storage tier. You must specifyarchive.
schema:
type: string
enum:
- archive
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifySnapshotTier
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifySnapshotTier
operationId: POST_ModifySnapshotTier
description: '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 Elastic Compute Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifySnapshotTierResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifySnapshotTierRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifySnapshotTier
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifySpotFleetRequest:
get:
x-aws-operation-name: ModifySpotFleetRequest
operationId: GET_ModifySpotFleetRequest
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifySpotFleetRequestResponse' parameters: - name: ExcessCapacityTerminationPolicy in: query required: false description:Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateConfig'
- xml:
name: item
- name: SpotFleetRequestId
in: query
required: true
description: The ID of the Spot Fleet request.
schema:
type: string
- name: TargetCapacity
in: query
required: false
description: The size of the fleet.
schema:
type: integer
- name: OnDemandTargetCapacity
in: query
required: false
description: The number of On-Demand Instances in the fleet.
schema:
type: integer
- name: Context
in: query
required: false
description: Reserved.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifySpotFleetRequest
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifySpotFleetRequest
operationId: POST_ModifySpotFleetRequest
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifySpotFleetRequestResponse' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifySpotFleetRequestRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifySpotFleetRequest - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifySubnetAttribute: get: x-aws-operation-name: ModifySubnetAttribute operationId: GET_ModifySubnetAttribute description: '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:
' responses: '200': description: Success parameters: - name: AssignIpv6AddressOnCreation in: query required: false description: 'Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that''s created when launching an instance into the subnet (the instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it''s created using version 2016-11-15 or later of the Amazon EC2 API.
true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: MapPublicIpOnLaunch
in: query
required: false
description: Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: SubnetId
in: query
required: true
description: The ID of the subnet.
schema:
type: string
- name: MapCustomerOwnedIpOnLaunch
in: query
required: false
description: 'Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: CustomerOwnedIpv4Pool
in: query
required: false
description: The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: PrivateDnsHostnameTypeOnLaunch
in: query
required: false
description: 'The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).'
schema:
type: string
enum:
- ip-name
- resource-name
- name: EnableResourceNameDnsARecordOnLaunch
in: query
required: false
description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: EnableResourceNameDnsAAAARecordOnLaunch
in: query
required: false
description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: EnableLniAtDeviceIndex
in: query
required: false
description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0). '
schema:
type: integer
- name: DisableLniAtDeviceIndex
in: query
required: false
description: ' Specify true to indicate that local network interfaces at the current position should be disabled. '
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifySubnetAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifySubnetAttribute
operationId: POST_ModifySubnetAttribute
description: '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:
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifySubnetAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifySubnetAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyTrafficMirrorFilterNetworkServices: get: x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices operationId: GET_ModifyTrafficMirrorFilterNetworkServices description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTrafficMirrorFilterNetworkServices
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyTrafficMirrorFilterNetworkServices
operationId: POST_ModifyTrafficMirrorFilterNetworkServices
description: '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.
The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
' schema: type: array items: $ref: '#/components/schemas/TrafficMirrorFilterRuleField' - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTrafficMirrorFilterRule
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyTrafficMirrorFilterRule
operationId: POST_ModifyTrafficMirrorFilterRule
description: Modifies the specified Traffic Mirror rule.
DestinationCidrBlock and SourceCidrBlock must both be an IPv4 range or an IPv6 range.
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.
schema: type: integer - name: VirtualNetworkId in: query required: false description: The virtual network ID of the Traffic Mirror session. schema: type: integer - name: Description in: query required: false description: The description to assign to the Traffic Mirror session. schema: type: string - name: RemoveField in: query required: false description: 'The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
' schema: type: array items: $ref: '#/components/schemas/TrafficMirrorSessionField' - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTrafficMirrorSession
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyTrafficMirrorSession
operationId: POST_ModifyTrafficMirrorSession
description: Modifies a Traffic Mirror session.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTrafficMirrorSessionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTrafficMirrorSessionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTrafficMirrorSession
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyTransitGateway:
get:
x-aws-operation-name: ModifyTransitGateway
operationId: GET_ModifyTransitGateway
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayResult'
parameters:
- name: TransitGatewayId
in: query
required: true
description: The ID of the transit gateway.
schema:
type: string
- name: Description
in: query
required: false
description: The description for the transit gateway.
schema:
type: string
- name: Options
in: query
required: false
description: The options to modify.
schema:
type: object
properties:
AddTransitGatewayCidrBlocks:
allOf:
- $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
- description: 'Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.'
RemoveTransitGatewayCidrBlocks:
allOf:
- $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
- description: Removes CIDR blocks for the transit gateway.
VpnEcmpSupport:
allOf:
- $ref: '#/components/schemas/VpnEcmpSupportValue'
- description: Enable or disable Equal Cost Multipath Protocol support.
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- description: Enable or disable DNS support.
AutoAcceptSharedAttachments:
allOf:
- $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue'
- description: Enable or disable automatic acceptance of attachment requests.
DefaultRouteTableAssociation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTableAssociationValue'
- description: Enable or disable automatic association with the default association route table.
AssociationDefaultRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the default association route table.
DefaultRouteTablePropagation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTablePropagationValue'
- description: Enable or disable automatic propagation of routes to the default propagation route table.
PropagationDefaultRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the default propagation route table.
AmazonSideAsn:
allOf:
- $ref: '#/components/schemas/Long'
- description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.
description: The transit gateway options. - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTransitGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyTransitGateway
operationId: POST_ModifyTransitGateway
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTransitGateway
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyTransitGatewayPrefixListReference:
get:
x-aws-operation-name: ModifyTransitGatewayPrefixListReference
operationId: GET_ModifyTransitGatewayPrefixListReference
description: Modifies a reference (route) to a prefix list in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list.
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
required: false
description: The ID of the attachment to which traffic is routed.
schema:
type: string
- name: Blackhole
in: query
required: false
description: Indicates whether to drop traffic that matches this route.
schema:
type: boolean
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTransitGatewayPrefixListReference
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyTransitGatewayPrefixListReference
operationId: POST_ModifyTransitGatewayPrefixListReference
description: Modifies a reference (route) to a prefix list in a specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayPrefixListReferenceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTransitGatewayPrefixListReference
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyTransitGatewayVpcAttachment:
get:
x-aws-operation-name: ModifyTransitGatewayVpcAttachment
operationId: GET_ModifyTransitGatewayVpcAttachment
description: Modifies the specified VPC attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
parameters:
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the attachment.
schema:
type: string
- name: AddSubnetIds
in: query
required: false
description: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
- name: RemoveSubnetIds
in: query
required: false
description: The IDs of one or more subnets to remove.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
- name: Options
in: query
required: false
description: The new VPC attachment options.
schema:
type: object
properties:
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- description: Enable or disable DNS support. The default is enable.
Ipv6Support:
allOf:
- $ref: '#/components/schemas/Ipv6SupportValue'
- description: Enable or disable IPv6 support. The default is enable.
ApplianceModeSupport:
allOf:
- $ref: '#/components/schemas/ApplianceModeSupportValue'
- description: '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.'
description: Describes the options for a VPC attachment.
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTransitGatewayVpcAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyTransitGatewayVpcAttachment
operationId: POST_ModifyTransitGatewayVpcAttachment
description: Modifies the specified VPC attachment.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyTransitGatewayVpcAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVerifiedAccessEndpoint:
get:
x-aws-operation-name: ModifyVerifiedAccessEndpoint
operationId: GET_ModifyVerifiedAccessEndpoint
description: Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessEndpointResult'
parameters:
- name: VerifiedAccessEndpointId
in: query
required: true
description: The ID of the Verified Access endpoint.
schema:
type: string
- name: VerifiedAccessGroupId
in: query
required: false
description: The ID of the Verified Access group.
schema:
type: string
- name: LoadBalancerOptions
in: query
required: false
description: The load balancer details if creating the Verified Access endpoint as load-balancertype.
schema:
type: object
properties:
SubnetIds:
allOf:
- $ref: '#/components/schemas/ModifyVerifiedAccessEndpointSubnetIdList'
- xml:
name: SubnetId
description: The IDs of the subnets.
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
description: Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the load-balancer type.
- name: NetworkInterfaceOptions
in: query
required: false
description: The network interface options.
schema:
type: object
properties:
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
description: Describes the options when modifying a Verified Access endpoint with the network-interface type.
- name: Description
in: query
required: false
description: A description for the Verified Access endpoint.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVerifiedAccessEndpoint
operationId: POST_ModifyVerifiedAccessEndpoint
description: Modifies the configuration of the specified Amazon Web Services Verified Access endpoint.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessEndpointResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessEndpointRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVerifiedAccessEndpointPolicy:
get:
x-aws-operation-name: ModifyVerifiedAccessEndpointPolicy
operationId: GET_ModifyVerifiedAccessEndpointPolicy
description: Modifies the specified Amazon Web Services Verified Access endpoint policy.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessEndpointPolicyResult'
parameters:
- name: VerifiedAccessEndpointId
in: query
required: true
description: The ID of the Verified Access endpoint.
schema:
type: string
- name: PolicyEnabled
in: query
required: true
description: The status of the Verified Access policy.
schema:
type: boolean
- name: PolicyDocument
in: query
required: false
description: The Verified Access policy document.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessEndpointPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVerifiedAccessEndpointPolicy
operationId: POST_ModifyVerifiedAccessEndpointPolicy
description: Modifies the specified Amazon Web Services Verified Access endpoint policy.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessEndpointPolicyResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessEndpointPolicyRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessEndpointPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVerifiedAccessGroup:
get:
x-aws-operation-name: ModifyVerifiedAccessGroup
operationId: GET_ModifyVerifiedAccessGroup
description: Modifies the specified Amazon Web Services Verified Access group configuration.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessGroupResult'
parameters:
- name: VerifiedAccessGroupId
in: query
required: true
description: The ID of the Verified Access group.
schema:
type: string
- name: VerifiedAccessInstanceId
in: query
required: false
description: The ID of the Verified Access instance.
schema:
type: string
- name: Description
in: query
required: false
description: A description for the Verified Access group.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVerifiedAccessGroup
operationId: POST_ModifyVerifiedAccessGroup
description: Modifies the specified Amazon Web Services Verified Access group configuration.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessGroupResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessGroupRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessGroup
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVerifiedAccessGroupPolicy:
get:
x-aws-operation-name: ModifyVerifiedAccessGroupPolicy
operationId: GET_ModifyVerifiedAccessGroupPolicy
description: Modifies the specified Amazon Web Services Verified Access group policy.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessGroupPolicyResult'
parameters:
- name: VerifiedAccessGroupId
in: query
required: true
description: The ID of the Verified Access group.
schema:
type: string
- name: PolicyEnabled
in: query
required: true
description: The status of the Verified Access policy.
schema:
type: boolean
- name: PolicyDocument
in: query
required: false
description: The Verified Access policy document.
schema:
type: string
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessGroupPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVerifiedAccessGroupPolicy
operationId: POST_ModifyVerifiedAccessGroupPolicy
description: Modifies the specified Amazon Web Services Verified Access group policy.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessGroupPolicyResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessGroupPolicyRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessGroupPolicy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVerifiedAccessInstance:
get:
x-aws-operation-name: ModifyVerifiedAccessInstance
operationId: GET_ModifyVerifiedAccessInstance
description: Modifies the configuration of the specified Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessInstanceResult'
parameters:
- name: VerifiedAccessInstanceId
in: query
required: true
description: The ID of the Verified Access instance.
schema:
type: string
- name: Description
in: query
required: false
description: A description for the Verified Access instance.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVerifiedAccessInstance
operationId: POST_ModifyVerifiedAccessInstance
description: Modifies the configuration of the specified Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessInstanceResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessInstanceRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessInstance
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVerifiedAccessInstanceLoggingConfiguration:
get:
x-aws-operation-name: ModifyVerifiedAccessInstanceLoggingConfiguration
operationId: GET_ModifyVerifiedAccessInstanceLoggingConfiguration
description: Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessInstanceLoggingConfigurationResult'
parameters:
- name: VerifiedAccessInstanceId
in: query
required: true
description: The ID of the Verified Access instance.
schema:
type: string
- name: AccessLogs
in: query
required: true
description: The configuration options for Verified Access instances.
schema:
type: object
properties:
S3:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogS3DestinationOptions'
- description: Sends Verified Access logs to Amazon S3.
CloudWatchLogs:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogCloudWatchLogsDestinationOptions'
- description: Sends Verified Access logs to CloudWatch Logs.
KinesisDataFirehose:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogKinesisDataFirehoseDestinationOptions'
- description: Sends Verified Access logs to Kinesis.
LogVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The logging version to use.
Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessInstanceLoggingConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVerifiedAccessInstanceLoggingConfiguration
operationId: POST_ModifyVerifiedAccessInstanceLoggingConfiguration
description: Modifies the logging configuration for the specified Amazon Web Services Verified Access instance.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessInstanceLoggingConfigurationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessInstanceLoggingConfigurationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessInstanceLoggingConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVerifiedAccessTrustProvider:
get:
x-aws-operation-name: ModifyVerifiedAccessTrustProvider
operationId: GET_ModifyVerifiedAccessTrustProvider
description: Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessTrustProviderResult'
parameters:
- name: VerifiedAccessTrustProviderId
in: query
required: true
description: The ID of the Verified Access trust provider.
schema:
type: string
- name: OidcOptions
in: query
required: false
description: The options for an OpenID Connect-compatible user-identity trust provider.
schema:
type: object
properties:
Issuer:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC issuer.
AuthorizationEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC authorization endpoint.
TokenEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC token endpoint.
UserInfoEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC user info endpoint.
ClientId:
allOf:
- $ref: '#/components/schemas/String'
- description: The client identifier.
ClientSecret:
allOf:
- $ref: '#/components/schemas/ClientSecretType'
- description: The client secret.
Scope:
allOf:
- $ref: '#/components/schemas/String'
- description: 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.
description: Options for an OpenID Connect-compatible user-identity trust provider.
- name: Description
in: query
required: false
description: A description for the Verified Access trust provider.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVerifiedAccessTrustProvider
operationId: POST_ModifyVerifiedAccessTrustProvider
description: Modifies the configuration of the specified Amazon Web Services Verified Access trust provider.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessTrustProviderResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVerifiedAccessTrustProviderRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVerifiedAccessTrustProvider
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVolume:
get:
x-aws-operation-name: ModifyVolume
operationId: GET_ModifyVolume
description: '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 (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).
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 a Linux file system or Extend a Windows file system.
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VolumeId
in: query
required: true
description: The ID of the volume.
schema:
type: string
- name: Size
in: query
required: false
description: 'The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
Default: The existing size is retained.
' schema: type: integer - name: VolumeType in: query required: false description: 'The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: The existing type is retained.
' schema: type: string enum: - standard - io1 - io2 - gp2 - sc1 - st1 - gp3 - name: Iops in: query required: false description: 'The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
' schema: type: integer - name: MultiAttachEnabled in: query required: false description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported withio1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVolume
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVolume
operationId: POST_ModifyVolume
description: '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 (Linux instances) or Amazon EBS Elastic Volumes (Windows instances).
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 a Linux file system or Extend a Windows file system.
You can use CloudWatch Events to check the status of a modification to an EBS volume. For information about CloudWatch Events, see the Amazon CloudWatch Events User Guide. You can also track the status of a modification using DescribeVolumesModifications. For information about tracking status changes using either method, see Monitor the progress of volume modifications.
With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance.
After modifying a volume, you must wait at least six hours and ensure that the volume is in the in-use or available state before you can modify the same volume. This is sometimes referred to as a cooldown period.
Modifies a volume attribute.
By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume.
You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable.
' responses: '200': description: Success parameters: - name: AutoEnableIO in: query required: false description: Indicates whether the volume should be auto-enabled for I/O operations. schema: type: object properties: Value: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: value description: The attribute value. The valid values aretrue or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: VolumeId
in: query
required: true
description: The ID of the volume.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVolumeAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVolumeAttribute
operationId: POST_ModifyVolumeAttribute
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyVolumeAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyVolumeAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyVpcAttribute: get: x-aws-operation-name: ModifyVpcAttribute operationId: GET_ModifyVpcAttribute description: Modifies the specified attribute of the specified VPC. responses: '200': description: Success parameters: - name: EnableDnsHostnames in: query required: false description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you''ve enabled DNS support.
' schema: type: object properties: Value: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: value description: The attribute value. The valid values aretrue or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: EnableDnsSupport
in: query
required: false
description: 'Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
' schema: type: object properties: Value: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: value description: The attribute value. The valid values aretrue or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: VpcId
in: query
required: true
description: The ID of the VPC.
schema:
type: string
- name: EnableNetworkAddressUsageMetrics
in: query
required: false
description: Indicates whether Network Address Usage metrics are enabled for your VPC.
schema:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcAttribute
operationId: POST_ModifyVpcAttribute
description: Modifies the specified attribute of the specified VPC.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVpcEndpoint:
get:
x-aws-operation-name: ModifyVpcEndpoint
operationId: GET_ModifyVpcEndpoint
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcEndpointId
in: query
required: true
description: The ID of the endpoint.
schema:
type: string
- name: ResetPolicy
in: query
required: false
description: (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
schema:
type: boolean
- name: PolicyDocument
in: query
required: false
description: (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.
schema:
type: string
- name: AddRouteTableId
in: query
required: false
description: (Gateway endpoint) The IDs of the route tables to associate with the endpoint.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: item
- name: RemoveRouteTableId
in: query
required: false
description: (Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: item
- name: AddSubnetId
in: query
required: false
description: '(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
- name: RemoveSubnetId
in: query
required: false
description: (Interface endpoint) The IDs of the subnets from which to remove the endpoint.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
- name: AddSecurityGroupId
in: query
required: false
description: (Interface endpoint) The IDs of the security groups to associate with the network interface.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
- name: RemoveSecurityGroupId
in: query
required: false
description: (Interface endpoint) The IDs of the security groups to disassociate from the network interface.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
- name: IpAddressType
in: query
required: false
description: The IP address type for the endpoint.
schema:
type: string
enum:
- ipv4
- dualstack
- ipv6
- name: DnsOptions
in: query
required: false
description: The DNS options for the endpoint.
schema:
type: object
properties:
DnsRecordIpType:
allOf:
- $ref: '#/components/schemas/DnsRecordIpType'
- description: The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
description: Describes the DNS options for an endpoint.
- name: PrivateDnsEnabled
in: query
required: false
description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcEndpoint
operationId: POST_ModifyVpcEndpoint
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpoint
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVpcEndpointConnectionNotification:
get:
x-aws-operation-name: ModifyVpcEndpointConnectionNotification
operationId: GET_ModifyVpcEndpointConnectionNotification
description: '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. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ConnectionNotificationId
in: query
required: true
description: The ID of the notification.
schema:
type: string
- name: ConnectionNotificationArn
in: query
required: false
description: The ARN for the SNS topic for the notification.
schema:
type: string
- name: ConnectionEvents
in: query
required: false
description: 'The events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpointConnectionNotification
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcEndpointConnectionNotification
operationId: POST_ModifyVpcEndpointConnectionNotification
description: '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. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpointConnectionNotification
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVpcEndpointServiceConfiguration:
get:
x-aws-operation-name: ModifyVpcEndpointServiceConfiguration
operationId: GET_ModifyVpcEndpointServiceConfiguration
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The ID of the service.
schema:
type: string
- name: PrivateDnsName
in: query
required: false
description: (Interface endpoint configuration) The private DNS name to assign to the endpoint service.
schema:
type: string
- name: RemovePrivateDnsName
in: query
required: false
description: (Interface endpoint configuration) Removes the private DNS name of the endpoint service.
schema:
type: boolean
- name: AcceptanceRequired
in: query
required: false
description: Indicates whether requests to create an endpoint to your service must be accepted.
schema:
type: boolean
- name: AddNetworkLoadBalancerArn
in: query
required: false
description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: RemoveNetworkLoadBalancerArn
in: query
required: false
description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: AddGatewayLoadBalancerArn
in: query
required: false
description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: RemoveGatewayLoadBalancerArn
in: query
required: false
description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: AddSupportedIpAddressType
in: query
required: false
description: The IP address types to add to your service configuration.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: RemoveSupportedIpAddressType
in: query
required: false
description: The IP address types to remove from your service configuration.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpointServiceConfiguration
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcEndpointServiceConfiguration
operationId: POST_ModifyVpcEndpointServiceConfiguration
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyVpcEndpointServiceConfiguration - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyVpcEndpointServicePayerResponsibility: get: x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility operationId: GET_ModifyVpcEndpointServicePayerResponsibility description: Modifies the payer responsibility for your VPC endpoint service. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The ID of the service.
schema:
type: string
- name: PayerResponsibility
in: query
required: true
description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.'
schema:
type: string
enum:
- ServiceOwner
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpointServicePayerResponsibility
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcEndpointServicePayerResponsibility
operationId: POST_ModifyVpcEndpointServicePayerResponsibility
description: Modifies the payer responsibility for your VPC endpoint service.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpcEndpointServicePayerResponsibilityRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpointServicePayerResponsibility
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVpcEndpointServicePermissions:
get:
x-aws-operation-name: ModifyVpcEndpointServicePermissions
operationId: GET_ModifyVpcEndpointServicePermissions
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The ID of the service.
schema:
type: string
- name: AddAllowedPrincipals
in: query
required: false
description: 'The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).'
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: RemoveAllowedPrincipals
in: query
required: false
description: The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcEndpointServicePermissions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcEndpointServicePermissions
operationId: POST_ModifyVpcEndpointServicePermissions
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyVpcEndpointServicePermissions - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyVpcPeeringConnectionOptions: get: x-aws-operation-name: ModifyVpcPeeringConnectionOptions operationId: GET_ModifyVpcPeeringConnectionOptions description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' parameters: - name: AccepterPeeringConnectionOptions in: query required: false description: The VPC peering connection options for the accepter VPC. schema: type: object properties: AllowDnsResolutionFromRemoteVpc: allOf: - $ref: '#/components/schemas/Boolean' - description: 'If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.' AllowEgressFromLocalClassicLinkToRemoteVpc: allOf: - $ref: '#/components/schemas/Boolean' - description: Deprecated. AllowEgressFromLocalVpcToRemoteClassicLink: allOf: - $ref: '#/components/schemas/Boolean' - description: Deprecated. description: The VPC peering connection options. - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: RequesterPeeringConnectionOptions
in: query
required: false
description: The VPC peering connection options for the requester VPC.
schema:
type: object
properties:
AllowDnsResolutionFromRemoteVpc:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.'
AllowEgressFromLocalClassicLinkToRemoteVpc:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Deprecated.
description: The VPC peering connection options.
- name: VpcPeeringConnectionId
in: query
required: true
description: The ID of the VPC peering connection.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcPeeringConnectionOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcPeeringConnectionOptions
operationId: POST_ModifyVpcPeeringConnectionOptions
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyVpcPeeringConnectionOptions - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyVpcTenancy: get: x-aws-operation-name: ModifyVpcTenancy operationId: GET_ModifyVpcTenancy description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcTenancyResult' parameters: - name: VpcId in: query required: true description: The ID of the VPC. schema: type: string - name: InstanceTenancy in: query required: true description: 'The instance tenancy attribute for the VPC. ' schema: type: string enum: - default - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpcTenancy
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpcTenancy
operationId: POST_ModifyVpcTenancy
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcTenancyResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyVpcTenancyRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyVpcTenancy - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyVpnConnection: get: x-aws-operation-name: ModifyVpnConnection operationId: GET_ModifyVpnConnection description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpnConnectionResult' parameters: - name: VpnConnectionId in: query required: true description: The ID of the VPN connection. schema: type: string - name: TransitGatewayId in: query required: false description: The ID of the transit gateway. schema: type: string - name: CustomerGatewayId in: query required: false description: The ID of the customer gateway at your end of the VPN connection. schema: type: string - name: VpnGatewayId in: query required: false description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpnConnection
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpnConnection
operationId: POST_ModifyVpnConnection
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpnConnectionResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyVpnConnectionRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyVpnConnection - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyVpnConnectionOptions: get: x-aws-operation-name: ModifyVpnConnectionOptions operationId: GET_ModifyVpnConnectionOptions description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' parameters: - name: VpnConnectionId in: query required: true description: 'The ID of the Site-to-Site VPN connection. ' schema: type: string - name: LocalIpv4NetworkCidr in: query required: false description: 'The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpnConnectionOptions
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpnConnectionOptions
operationId: POST_ModifyVpnConnectionOptions
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpnConnectionOptionsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ModifyVpnConnectionOptionsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ModifyVpnConnectionOptions - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ModifyVpnTunnelCertificate: get: x-aws-operation-name: ModifyVpnTunnelCertificate operationId: GET_ModifyVpnTunnelCertificate description: Modifies the VPN tunnel endpoint certificate. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ModifyVpnTunnelCertificateResult' parameters: - name: VpnConnectionId in: query required: true description: The ID of the Amazon Web Services Site-to-Site VPN connection. schema: type: string - name: VpnTunnelOutsideIpAddress in: query required: true description: The external IP address of the VPN tunnel. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpnTunnelCertificate
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ModifyVpnTunnelCertificate
operationId: POST_ModifyVpnTunnelCertificate
description: Modifies the VPN tunnel endpoint certificate.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpnTunnelCertificateResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpnTunnelCertificateRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ModifyVpnTunnelCertificate
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ModifyVpnTunnelOptions:
get:
x-aws-operation-name: ModifyVpnTunnelOptions
operationId: GET_ModifyVpnTunnelOptions
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ModifyVpnTunnelOptionsResult'
parameters:
- name: VpnConnectionId
in: query
required: true
description: The ID of the Amazon Web Services Site-to-Site VPN connection.
schema:
type: string
- name: VpnTunnelOutsideIpAddress
in: query
required: true
description: The external IP address of the VPN tunnel.
schema:
type: string
- name: TunnelOptions
in: query
required: true
description: The tunnel options to modify.
schema:
type: object
properties:
TunnelInsideCidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
' Phase1LifetimeSeconds: allOf: - $ref: '#/components/schemas/Integer' - description: 'The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
The number of seconds after which a DPD timeout occurs.
Constraints: A value greater than or equal to 30.
Default: 30
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SkipTunnelReplacement
in: query
required: false
description: 'Choose whether or not to trigger immediate tunnel replacement.
Valid values: True | False
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/MonitorInstancesResult' parameters: - name: InstanceId in: query required: true description: The IDs of the instances. schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- MonitorInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: MonitorInstances
operationId: POST_MonitorInstances
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/MonitorInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/MonitorInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - MonitorInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=MoveAddressToVpc: get: x-aws-operation-name: MoveAddressToVpc operationId: GET_MoveAddressToVpc description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/MoveAddressToVpcResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PublicIp
in: query
required: true
description: The Elastic IP address.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- MoveAddressToVpc
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: MoveAddressToVpc
operationId: POST_MoveAddressToVpc
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/MoveAddressToVpcResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/MoveAddressToVpcRequest' parameters: - name: Action in: query required: true schema: type: string enum: - MoveAddressToVpc - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=MoveByoipCidrToIpam: get: x-aws-operation-name: MoveByoipCidrToIpam operationId: GET_MoveByoipCidrToIpam description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/MoveByoipCidrToIpamResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Cidr
in: query
required: true
description: The BYOIP CIDR.
schema:
type: string
- name: IpamPoolId
in: query
required: true
description: The IPAM pool ID.
schema:
type: string
- name: IpamPoolOwner
in: query
required: true
description: The Amazon Web Services account ID of the owner of the IPAM pool.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- MoveByoipCidrToIpam
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: MoveByoipCidrToIpam
operationId: POST_MoveByoipCidrToIpam
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/MoveByoipCidrToIpamResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/MoveByoipCidrToIpamRequest' parameters: - name: Action in: query required: true schema: type: string enum: - MoveByoipCidrToIpam - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ProvisionByoipCidr: get: x-aws-operation-name: ProvisionByoipCidr operationId: GET_ProvisionByoipCidr description: 'Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
' schema: type: boolean - name: Description in: query required: false description: A description for the address range and the address pool. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PoolTagSpecification
in: query
required: false
description: The tags to apply to the address pool.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: MultiRegion
in: query
required: false
description: Reserved.
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ProvisionByoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ProvisionByoipCidr
operationId: POST_ProvisionByoipCidr
description: 'Provisions an IPv4 or IPv6 address range for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised using AdvertiseByoipCidr.
Amazon Web Services verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see Bring your own IP addresses (BYOIP) in the Amazon Elastic Compute Cloud User Guide.
Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from pending-provision to provisioned. To monitor the status of an address range, use DescribeByoipCidrs. To allocate an Elastic IP address from your IPv4 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the IPAM pool to which you want to assign a CIDR.
schema:
type: string
- name: Cidr
in: query
required: false
description: The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.
schema:
type: string
- name: CidrAuthorizationContext
in: query
required: false
description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
schema:
type: object
properties:
Message:
allOf:
- $ref: '#/components/schemas/String'
- description: The plain-text authorization message for the prefix and account.
Signature:
allOf:
- $ref: '#/components/schemas/String'
- description: The signed authorization message for the prefix and account.
description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
- name: NetmaskLength
in: query
required: false
description: The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.
schema:
type: integer
- name: ClientToken
in: query
required: false
description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ProvisionIpamPoolCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ProvisionIpamPoolCidr
operationId: POST_ProvisionIpamPoolCidr
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ProvisionIpamPoolCidrResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ProvisionIpamPoolCidrRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ProvisionIpamPoolCidr - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ProvisionPublicIpv4PoolCidr: get: x-aws-operation-name: ProvisionPublicIpv4PoolCidr operationId: GET_ProvisionPublicIpv4PoolCidr description: 'Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' parameters: - name: DryRun in: query required: false description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the IPAM pool you would like to use to allocate this CIDR.
schema:
type: string
- name: PoolId
in: query
required: true
description: The ID of the public IPv4 pool you would like to use for this CIDR.
schema:
type: string
- name: NetmaskLength
in: query
required: true
description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- ProvisionPublicIpv4PoolCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ProvisionPublicIpv4PoolCidr
operationId: POST_ProvisionPublicIpv4PoolCidr
description: 'Provision a CIDR to a public IPv4 pool.
For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ProvisionPublicIpv4PoolCidrRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ProvisionPublicIpv4PoolCidr - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=PurchaseHostReservation: get: x-aws-operation-name: PurchaseHostReservation operationId: GET_PurchaseHostReservation description: 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. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PurchaseHostReservationResult' parameters: - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' schema: type: string - name: CurrencyCode in: query required: false description: 'The currency in which thetotalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
schema:
type: string
enum:
- USD
- name: HostIdSet
in: query
required: true
description: The IDs of the Dedicated Hosts with which the reservation will be associated.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/DedicatedHostId'
- xml:
name: item
- name: LimitPrice
in: query
required: false
description: 'The specified limit is checked against the total upfront cost of the reservation (calculated as the offering''s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.'
schema:
type: string
- name: OfferingId
in: query
required: true
description: The ID of the offering.
schema:
type: string
- name: TagSpecification
in: query
required: false
description: The tags to apply to the Dedicated Host Reservation during purchase.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- PurchaseHostReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: PurchaseHostReservation
operationId: POST_PurchaseHostReservation
description: 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.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/PurchaseHostReservationResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/PurchaseHostReservationRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- PurchaseHostReservation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=PurchaseReservedInstancesOffering:
get:
x-aws-operation-name: PurchaseReservedInstancesOffering
operationId: GET_PurchaseReservedInstancesOffering
description: 'Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' parameters: - name: InstanceCount in: query required: true description: The number of Reserved Instances to purchase. schema: type: integer - name: ReservedInstancesOfferingId in: query required: true description: The ID of the Reserved Instance offering to purchase. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: LimitPrice
in: query
required: false
description: Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
schema:
type: object
properties:
Amount:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: amount
description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.'
description: Describes the limit price of a Reserved Instance offering.
- name: PurchaseTime
in: query
required: false
description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
schema:
type: string
format: date-time
- name: Action
in: query
required: true
schema:
type: string
enum:
- PurchaseReservedInstancesOffering
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: PurchaseReservedInstancesOffering
operationId: POST_PurchaseReservedInstancesOffering
description: 'Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing.
Use DescribeReservedInstancesOfferings to get a list of Reserved Instance offerings that match your specifications. After you''ve purchased a Reserved Instance, you can check for your new Reserved Instance with DescribeReservedInstances.
To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/PurchaseReservedInstancesOfferingRequest' parameters: - name: Action in: query required: true schema: type: string enum: - PurchaseReservedInstancesOffering - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=PurchaseScheduledInstances: get: x-aws-operation-name: PurchaseScheduledInstances operationId: GET_PurchaseScheduledInstances description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PurchaseScheduledInstancesResult' parameters: - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PurchaseRequest
in: query
required: true
description: The purchase requests.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/PurchaseRequest'
- xml:
name: PurchaseRequest
minItems: 1
- name: Action
in: query
required: true
schema:
type: string
enum:
- PurchaseScheduledInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: PurchaseScheduledInstances
operationId: POST_PurchaseScheduledInstances
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/PurchaseScheduledInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/PurchaseScheduledInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - PurchaseScheduledInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RebootInstances: get: x-aws-operation-name: RebootInstances operationId: GET_RebootInstances description: '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.
' responses: '200': description: Success parameters: - name: InstanceId in: query required: true description: The instance IDs. schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RebootInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RebootInstances
operationId: POST_RebootInstances
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/RebootInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RebootInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RegisterImage: get: x-aws-operation-name: RegisterImage operationId: GET_RegisterImage description: 'Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Create your own AMI in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understand AMI billing information in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterImageResult' parameters: - name: ImageLocation in: query required: false description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have theaws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.'
schema:
type: string
- name: Architecture
in: query
required: false
description: 'The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
' schema: type: array items: allOf: - $ref: '#/components/schemas/BlockDeviceMapping' - xml: name: BlockDeviceMapping - name: Description in: query required: false description: A description for your AMI. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EnaSupport
in: query
required: false
description: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
schema: type: boolean - name: KernelId in: query required: false description: The ID of the kernel. schema: type: string - name: Name in: query required: true description: 'A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' schema: type: string - name: BillingProduct in: query required: false description: 'The billing product codes. Your account must be authorized to specify billing product codes.
If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.
' schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: RamdiskId in: query required: false description: The ID of the RAM disk. schema: type: string - name: RootDeviceName in: query required: false description: 'The device name of the root device volume (for example,/dev/sda1).'
schema:
type: string
- name: SriovNetSupport
in: query
required: false
description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
schema: type: string - name: VirtualizationType in: query required: false description: 'The type of virtualization (hvm | paravirtual).
Default: paravirtual
The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
' schema: type: string enum: - legacy-bios - uefi - uefi-preferred - name: TpmSupport in: query required: false description: 'Set tov2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.'
schema:
type: string
enum:
- v2.0
- name: UefiData
in: query
required: false
description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.'
schema:
type: string
minLength: 0
maxLength: 64000
- name: ImdsSupport
in: query
required: false
description: 'Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
Registers an AMI. When you''re creating an AMI, this is the final step you must complete before you can launch an instance from the AMI. For more information about creating AMIs, see Create your own AMI in the Amazon Elastic Compute Cloud User Guide.
For Amazon EBS-backed instances, CreateImage creates and registers the AMI in a single request, so you don''t have to register the AMI yourself. We recommend that you always use CreateImage unless you have a specific reason to use RegisterImage.
If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image.
Register a snapshot of a root device volume
You can use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can''t set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted.
For more information, see Create a Linux AMI from a snapshot and Use encryption with Amazon EBS-backed AMIs in the Amazon Elastic Compute Cloud User Guide.
Amazon Web Services Marketplace product codes
If any snapshots have Amazon Web Services Marketplace product codes, they are copied to the new AMI.
Windows and some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the Amazon EC2 billing product code associated with an AMI to verify the subscription status for package updates. To create a new AMI for operating systems that require a billing product code, instead of registering the AMI, do the following to preserve the billing product code association:
Launch an instance from an existing AMI with that billing product code.
Customize the instance.
Create an AMI from the instance using CreateImage.
If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance will not be applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see Understand AMI billing information in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterImageResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RegisterImageRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RegisterImage - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RegisterInstanceEventNotificationAttributes: get: x-aws-operation-name: RegisterInstanceEventNotificationAttributes operationId: GET_RegisterInstanceEventNotificationAttributes description: 'Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceTagAttribute
in: query
required: true
description: Information about the tag keys to register.
schema:
type: object
properties:
IncludeAllTagsOfInstance:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to register all tag keys in the current Region. Specify true to register all tag keys.
InstanceTagKeys:
allOf:
- $ref: '#/components/schemas/InstanceTagKeySet'
- xml:
name: InstanceTagKey
description: The tag keys to register.
description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
- name: Action
in: query
required: true
schema:
type: string
enum:
- RegisterInstanceEventNotificationAttributes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RegisterInstanceEventNotificationAttributes
operationId: POST_RegisterInstanceEventNotificationAttributes
description: 'Registers a set of tag keys to include in scheduled event notifications for your resources.
To remove tags, use DeregisterInstanceEventNotificationAttributes.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RegisterInstanceEventNotificationAttributesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RegisterInstanceEventNotificationAttributes - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RegisterTransitGatewayMulticastGroupMembers: get: x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers operationId: GET_RegisterTransitGatewayMulticastGroupMembers description: 'Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' parameters: - name: TransitGatewayMulticastDomainId in: query required: true description: The ID of the transit gateway multicast domain. schema: type: string - name: GroupIpAddress in: query required: false description: The IP address assigned to the transit gateway multicast group. schema: type: string - name: NetworkInterfaceIds in: query required: true description: The group members' network interface IDs to register with the transit gateway multicast group. schema: type: array items: allOf: - $ref: '#/components/schemas/NetworkInterfaceId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RegisterTransitGatewayMulticastGroupMembers
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RegisterTransitGatewayMulticastGroupMembers
operationId: POST_RegisterTransitGatewayMulticastGroupMembers
description: 'Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For information about supported instances, see Multicast Consideration in Amazon VPC Transit Gateways.
After you add the members, use SearchTransitGatewayMulticastGroups to verify that the members were added to the transit gateway multicast group.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupMembersRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RegisterTransitGatewayMulticastGroupMembers - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RegisterTransitGatewayMulticastGroupSources: get: x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources operationId: GET_RegisterTransitGatewayMulticastGroupSources description: 'Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' parameters: - name: TransitGatewayMulticastDomainId in: query required: true description: The ID of the transit gateway multicast domain. schema: type: string - name: GroupIpAddress in: query required: false description: The IP address assigned to the transit gateway multicast group. schema: type: string - name: NetworkInterfaceIds in: query required: true description: The group sources' network interface IDs to register with the transit gateway multicast group. schema: type: array items: allOf: - $ref: '#/components/schemas/NetworkInterfaceId' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RegisterTransitGatewayMulticastGroupSources
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RegisterTransitGatewayMulticastGroupSources
operationId: POST_RegisterTransitGatewayMulticastGroupSources
description: 'Registers sources (network interfaces) with the specified transit gateway multicast group.
A multicast source is a network interface attached to a supported instance that sends multicast traffic. For information about supported instances, see Multicast Considerations in Amazon VPC Transit Gateways.
After you add the source, use SearchTransitGatewayMulticastGroups to verify that the source was added to the multicast group.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RegisterTransitGatewayMulticastGroupSourcesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RegisterTransitGatewayMulticastGroupSources - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RejectTransitGatewayMulticastDomainAssociations: get: x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations operationId: GET_RejectTransitGatewayMulticastDomainAssociations description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult' parameters: - name: TransitGatewayMulticastDomainId in: query required: false description: The ID of the transit gateway multicast domain. schema: type: string - name: TransitGatewayAttachmentId in: query required: false description: The ID of the transit gateway attachment. schema: type: string - name: SubnetIds in: query required: false description: The IDs of the subnets to associate with the transit gateway multicast domain. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectTransitGatewayMulticastDomainAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RejectTransitGatewayMulticastDomainAssociations
operationId: POST_RejectTransitGatewayMulticastDomainAssociations
description: Rejects a request to associate cross-account subnets with a transit gateway multicast domain.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectTransitGatewayMulticastDomainAssociationsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectTransitGatewayMulticastDomainAssociations
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=RejectTransitGatewayPeeringAttachment:
get:
x-aws-operation-name: RejectTransitGatewayPeeringAttachment
operationId: GET_RejectTransitGatewayPeeringAttachment
description: Rejects a transit gateway peering attachment request.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult'
parameters:
- name: TransitGatewayAttachmentId
in: query
required: true
description: The ID of the transit gateway peering attachment.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectTransitGatewayPeeringAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RejectTransitGatewayPeeringAttachment
operationId: POST_RejectTransitGatewayPeeringAttachment
description: Rejects a transit gateway peering attachment request.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectTransitGatewayPeeringAttachmentRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectTransitGatewayPeeringAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=RejectTransitGatewayVpcAttachment:
get:
x-aws-operation-name: RejectTransitGatewayVpcAttachment
operationId: GET_RejectTransitGatewayVpcAttachment
description: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectTransitGatewayVpcAttachment
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RejectTransitGatewayVpcAttachment
operationId: POST_RejectTransitGatewayVpcAttachment
description: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The ID of the service.
schema:
type: string
- name: VpcEndpointId
in: query
required: true
description: The IDs of the VPC endpoints.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectVpcEndpointConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RejectVpcEndpointConnections
operationId: POST_RejectVpcEndpointConnections
description: Rejects VPC endpoint connection requests to your VPC endpoint service.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectVpcEndpointConnectionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectVpcEndpointConnectionsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectVpcEndpointConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=RejectVpcPeeringConnection:
get:
x-aws-operation-name: RejectVpcPeeringConnection
operationId: GET_RejectVpcPeeringConnection
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
required: true
description: The ID of the VPC peering connection.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectVpcPeeringConnection
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RejectVpcPeeringConnection
operationId: POST_RejectVpcPeeringConnection
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RejectVpcPeeringConnectionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RejectVpcPeeringConnection
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ReleaseAddress:
get:
x-aws-operation-name: ReleaseAddress
operationId: GET_ReleaseAddress
description: '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.
' responses: '200': description: Success parameters: - name: AllocationId in: query required: false description: The allocation ID. This parameter is required. schema: type: string - name: PublicIp in: query required: false description: Deprecated. schema: type: string - name: NetworkBorderGroup in: query required: false description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReleaseAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReleaseAddress
operationId: POST_ReleaseAddress
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ReleaseAddressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ReleaseAddress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ReleaseHosts: get: x-aws-operation-name: ReleaseHosts operationId: GET_ReleaseHosts description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReleaseHostsResult' parameters: - name: HostId in: query required: true description: The IDs of the Dedicated Hosts to release. schema: type: array items: allOf: - $ref: '#/components/schemas/DedicatedHostId' - xml: name: item - name: Action in: query required: true schema: type: string enum: - ReleaseHosts - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ReleaseHosts operationId: POST_ReleaseHosts description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReleaseHostsResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ReleaseHostsRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ReleaseHosts - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ReleaseIpamPoolAllocation: get: x-aws-operation-name: ReleaseIpamPoolAllocation operationId: GET_ReleaseIpamPoolAllocation description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: IpamPoolId
in: query
required: true
description: The ID of the IPAM pool which contains the allocation you want to release.
schema:
type: string
- name: Cidr
in: query
required: true
description: The CIDR of the allocation you want to release.
schema:
type: string
- name: IpamPoolAllocationId
in: query
required: true
description: The ID of the allocation.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReleaseIpamPoolAllocation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReleaseIpamPoolAllocation
operationId: POST_ReleaseIpamPoolAllocation
description: '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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' parameters: - name: IamInstanceProfile in: query required: true description: The IAM instance profile. schema: type: object properties: Arn: allOf: - $ref: '#/components/schemas/String' - xml: name: arn description: The Amazon Resource Name (ARN) of the instance profile. Name: allOf: - $ref: '#/components/schemas/String' - xml: name: name description: The name of the instance profile. description: Describes an IAM instance profile. - name: AssociationId in: query required: true description: The ID of the existing IAM instance profile association. schema: type: string - name: Action in: query required: true schema: type: string enum: - ReplaceIamInstanceProfileAssociation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: ReplaceIamInstanceProfileAssociation operationId: POST_ReplaceIamInstanceProfileAssociation description: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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ReplaceIamInstanceProfileAssociation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ReplaceNetworkAclAssociation: get: x-aws-operation-name: ReplaceNetworkAclAssociation operationId: GET_ReplaceNetworkAclAssociation description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' parameters: - name: AssociationId in: query required: true description: The ID of the current association between the original network ACL and the subnet. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkAclId
in: query
required: true
description: The ID of the new network ACL to associate with the subnet.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceNetworkAclAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReplaceNetworkAclAssociation
operationId: POST_ReplaceNetworkAclAssociation
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReplaceNetworkAclAssociationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ReplaceNetworkAclAssociationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ReplaceNetworkAclAssociation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ReplaceNetworkAclEntry: get: x-aws-operation-name: ReplaceNetworkAclEntry operationId: GET_ReplaceNetworkAclEntry description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.' responses: '200': description: Success parameters: - name: CidrBlock in: query required: false description: 'The IPv4 network range to allow or deny, in CIDR notation (for example172.16.0.0/24).'
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Egress
in: query
required: true
description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' schema: type: boolean - name: Icmp in: query required: false description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' schema: type: object properties: Code: allOf: - $ref: '#/components/schemas/Integer' - xml: name: code description: The ICMP code. A value of -1 means all codes for the specified ICMP type. Type: allOf: - $ref: '#/components/schemas/Integer' - xml: name: type description: The ICMP type. A value of -1 means all types. description: Describes the ICMP type and code. - name: Ipv6CidrBlock in: query required: false description: 'The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).'
schema:
type: string
- name: NetworkAclId
in: query
required: true
description: The ID of the ACL.
schema:
type: string
- name: PortRange
in: query
required: false
description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
schema:
type: object
properties:
From:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: from
description: The first port in the range.
To:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: to
description: The last port in the range.
description: Describes a range of ports.
- name: Protocol
in: query
required: true
description: '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.'
schema:
type: string
- name: RuleAction
in: query
required: true
description: Indicates whether to allow or deny the traffic that matches the rule.
schema:
type: string
enum:
- allow
- deny
- name: RuleNumber
in: query
required: true
description: The rule number of the entry to replace.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceNetworkAclEntry
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReplaceNetworkAclEntry
operationId: POST_ReplaceNetworkAclEntry
description: 'Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon VPC User Guide.'
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ReplaceNetworkAclEntryRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceNetworkAclEntry
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ReplaceRoute:
get:
x-aws-operation-name: ReplaceRoute
operationId: GET_ReplaceRoute
description: '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.
' responses: '200': description: Success parameters: - name: DestinationCidrBlock in: query required: false description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. schema: type: string - name: DestinationIpv6CidrBlock in: query required: false description: The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table. schema: type: string - name: DestinationPrefixListId in: query required: false description: The ID of the prefix list for the route. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: VpcEndpointId
in: query
required: false
description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
schema:
type: string
- name: EgressOnlyInternetGatewayId
in: query
required: false
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
schema:
type: string
- name: GatewayId
in: query
required: false
description: The ID of an internet gateway or virtual private gateway.
schema:
type: string
- name: InstanceId
in: query
required: false
description: The ID of a NAT instance in your VPC.
schema:
type: string
- name: LocalTarget
in: query
required: false
description: Specifies whether to reset the local route to its default target (local).
schema:
type: boolean
- name: NatGatewayId
in: query
required: false
description: '[IPv4 traffic only] The ID of a NAT gateway.'
schema:
type: string
- name: TransitGatewayId
in: query
required: false
description: The ID of a transit gateway.
schema:
type: string
- name: LocalGatewayId
in: query
required: false
description: The ID of the local gateway.
schema:
type: string
- name: CarrierGatewayId
in: query
required: false
description: '[IPv4 traffic only] The ID of a carrier gateway.'
schema:
type: string
- name: NetworkInterfaceId
in: query
required: false
description: The ID of a network interface.
schema:
type: string
- name: RouteTableId
in: query
required: true
description: The ID of the route table.
schema:
type: string
- name: VpcPeeringConnectionId
in: query
required: false
description: The ID of a VPC peering connection.
schema:
type: string
- name: CoreNetworkArn
in: query
required: false
description: The Amazon Resource Name (ARN) of the core network.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReplaceRoute
operationId: POST_ReplaceRoute
description: '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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ReplaceRouteRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ReplaceRoute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ReplaceRouteTableAssociation: get: x-aws-operation-name: ReplaceRouteTableAssociation operationId: GET_ReplaceRouteTableAssociation description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' parameters: - name: AssociationId in: query required: true description: The association ID. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: RouteTableId
in: query
required: true
description: The ID of the new route table to associate with the subnet.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceRouteTableAssociation
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReplaceRouteTableAssociation
operationId: POST_ReplaceRouteTableAssociation
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReplaceRouteTableAssociationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ReplaceRouteTableAssociationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ReplaceRouteTableAssociation - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ReplaceTransitGatewayRoute: get: x-aws-operation-name: ReplaceTransitGatewayRoute operationId: GET_ReplaceTransitGatewayRoute description: Replaces the specified route in the specified transit gateway route table. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ReplaceTransitGatewayRouteResult' parameters: - name: DestinationCidrBlock in: query required: true description: The CIDR range used for the destination match. Routing decisions are based on the most specific match. schema: type: string - name: TransitGatewayRouteTableId in: query required: true description: The ID of the route table. schema: type: string - name: TransitGatewayAttachmentId in: query required: false description: The ID of the attachment. schema: type: string - name: Blackhole in: query required: false description: Indicates whether traffic matching this route is to be dropped. schema: type: boolean - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceTransitGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReplaceTransitGatewayRoute
operationId: POST_ReplaceTransitGatewayRoute
description: Replaces the specified route in the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ReplaceTransitGatewayRouteResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ReplaceTransitGatewayRouteRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceTransitGatewayRoute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ReplaceVpnTunnel:
get:
x-aws-operation-name: ReplaceVpnTunnel
operationId: GET_ReplaceVpnTunnel
description: Trigger replacement of specified VPN tunnel.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ReplaceVpnTunnelResult'
parameters:
- name: VpnConnectionId
in: query
required: true
description: 'The ID of the Site-to-Site VPN connection. '
schema:
type: string
- name: VpnTunnelOutsideIpAddress
in: query
required: true
description: The external IP address of the VPN tunnel.
schema:
type: string
- name: ApplyPendingMaintenance
in: query
required: false
description: Trigger pending tunnel endpoint maintenance.
schema:
type: boolean
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceVpnTunnel
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ReplaceVpnTunnel
operationId: POST_ReplaceVpnTunnel
description: Trigger replacement of specified VPN tunnel.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ReplaceVpnTunnelResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ReplaceVpnTunnelRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ReplaceVpnTunnel
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ReportInstanceStatus:
get:
x-aws-operation-name: ReportInstanceStatus
operationId: GET_ReportInstanceStatus
description: '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.
' responses: '200': description: Success parameters: - name: Description in: query required: false description: Descriptive text about the health state of your instance. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EndTime
in: query
required: false
description: The time at which the reported instance health state ended.
schema:
type: string
format: date-time
- name: InstanceId
in: query
required: true
description: The instances.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: InstanceId
- name: ReasonCode
in: query
required: true
description: 'The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
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.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ReportInstanceStatusRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ReportInstanceStatus - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RequestSpotFleet: get: x-aws-operation-name: RequestSpotFleet operationId: GET_RequestSpotFleet description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SpotFleetRequestConfig
in: query
required: true
description: The configuration for the Spot Fleet request.
schema:
type: object
required:
- IamFleetRole
- TargetCapacity
properties:
AllocationStrategy:
allOf:
- $ref: '#/components/schemas/AllocationStrategy'
- xml:
name: allocationStrategy
description: 'The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Spot Fleet requests instances from all of the Spot Instance pools that you specify.
Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn''t have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowestPrice
lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.'
SpotMaintenanceStrategies:
allOf:
- $ref: '#/components/schemas/SpotMaintenanceStrategies'
- xml:
name: spotMaintenanceStrategies
description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.'
ExcessCapacityTerminationPolicy:
allOf:
- $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
- xml:
name: excessCapacityTerminationPolicy
description: Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
TerminateInstancesWithExpiration.'
LaunchSpecifications:
allOf:
- $ref: '#/components/schemas/LaunchSpecsList'
- xml:
name: launchSpecifications
description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
LaunchTemplateConfigs:
allOf:
- $ref: '#/components/schemas/LaunchTemplateConfigList'
- xml:
name: launchTemplateConfigs
description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
SpotPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotPrice
description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
maintain, you can specify a target capacity of 0 and add capacity later.'
OnDemandTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: onDemandTargetCapacity
description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
OnDemandMaxTotalPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: onDemandMaxTotalPrice
description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
SpotMaxTotalPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotMaxTotalPrice
description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
TerminateInstancesWithExpiration:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: terminateInstancesWithExpiration
description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
Type:
allOf:
- $ref: '#/components/schemas/FleetType'
- xml:
name: type
description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.'
ValidFrom:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: validFrom
description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.'
ValidUntil:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: validUntil
description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.'
ReplaceUnhealthyInstances:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: replaceUnhealthyInstances
description: Indicates whether Spot Fleet should replace unhealthy instances.
InstanceInterruptionBehavior:
allOf:
- $ref: '#/components/schemas/InstanceInterruptionBehavior'
- xml:
name: instanceInterruptionBehavior
description: The behavior when a Spot Instance is interrupted. The default is terminate.
LoadBalancersConfig:
allOf:
- $ref: '#/components/schemas/LoadBalancersConfig'
- xml:
name: loadBalancersConfig
description: 'One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
' InstancePoolsToUseCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: instancePoolsToUseCount description: 'The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' Context: allOf: - $ref: '#/components/schemas/String' - xml: name: context description: Reserved. TargetCapacityUnitType: allOf: - $ref: '#/components/schemas/TargetCapacityUnitType' - xml: name: targetCapacityUnitType description: 'The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.'
description: Describes the configuration of a Spot Fleet request.
- name: Action
in: query
required: true
schema:
type: string
enum:
- RequestSpotFleet
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RequestSpotFleet
operationId: POST_RequestSpotFleet
description: 'Creates a Spot Fleet request.
The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.
You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.
Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.
You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the spot-fleet-request and instance resource types are supported.
For more information, see Spot Fleet requests in the Amazon EC2 User Guide.
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide.
Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
' schema: type: string - name: BlockDurationMinutes in: query required: false description: Deprecated. schema: type: integer - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceCount
in: query
required: false
description: 'The maximum number of Spot Instances to launch.
Default: 1
' schema: type: integer - name: LaunchGroup in: query required: false description: 'The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
' schema: type: string - name: LaunchSpecification in: query required: false description: The launch specification. schema: type: object properties: SecurityGroupIds: allOf: - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList' - xml: name: SecurityGroupId description: The IDs of the security groups. SecurityGroups: allOf: - $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList' - xml: name: SecurityGroup description: Not supported. AddressingType: allOf: - $ref: '#/components/schemas/String' - xml: name: addressingType description: Deprecated. BlockDeviceMappings: allOf: - $ref: '#/components/schemas/BlockDeviceMappingList' - xml: name: blockDeviceMapping description: 'The block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.' EbsOptimized: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: ebsOptimized description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
' NetworkInterfaces: allOf: - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - xml: name: NetworkInterface description: 'The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' Placement: allOf: - $ref: '#/components/schemas/SpotPlacement' - xml: name: placement description: The placement information for the instance. RamdiskId: allOf: - $ref: '#/components/schemas/RamdiskId' - xml: name: ramdiskId description: The ID of the RAM disk. SubnetId: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: subnetId description: The ID of the subnet in which to launch the instance. UserData: allOf: - $ref: '#/components/schemas/SensitiveUserData' - xml: name: userData description: The base64-encoded user data that instances use when starting up. User data is limited to 16 KB. description: Describes the launch specification for an instance. - name: SpotPrice in: query required: false description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
' schema: type: string format: date-time - name: ValidUntil in: query required: false description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags. '
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: InstanceInterruptionBehavior
in: query
required: false
description: The behavior when a Spot Instance is interrupted. The default is terminate.
schema:
type: string
enum:
- hibernate
- stop
- terminate
- name: Action
in: query
required: true
schema:
type: string
enum:
- RequestSpotInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RequestSpotInstances
operationId: POST_RequestSpotInstances
description: 'Creates a Spot Instance request.
For more information, see Spot Instance requests in the Amazon EC2 User Guide for Linux Instances.
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see Which is the best Spot request method to use? in the Amazon EC2 User Guide for Linux Instances.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetAddressAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ResetAddressAttribute
operationId: POST_ResetAddressAttribute
description: 'Resets the attribute of the specified IP address. For requirements, see Using reverse DNS for email applications.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ResetAddressAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ResetAddressAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetAddressAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ResetEbsDefaultKmsKeyId:
get:
x-aws-operation-name: ResetEbsDefaultKmsKeyId
operationId: GET_ResetEbsDefaultKmsKeyId
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetEbsDefaultKmsKeyId
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ResetEbsDefaultKmsKeyId
operationId: POST_ResetEbsDefaultKmsKeyId
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/ResetEbsDefaultKmsKeyIdRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ResetEbsDefaultKmsKeyId - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=ResetFpgaImageAttribute: get: x-aws-operation-name: ResetFpgaImageAttribute operationId: GET_ResetFpgaImageAttribute description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/ResetFpgaImageAttributeResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: FpgaImageId
in: query
required: true
description: The ID of the AFI.
schema:
type: string
- name: Attribute
in: query
required: false
description: The attribute.
schema:
type: string
enum:
- loadPermission
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetFpgaImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ResetFpgaImageAttribute
operationId: POST_ResetFpgaImageAttribute
description: Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/ResetFpgaImageAttributeResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ResetFpgaImageAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetFpgaImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ResetImageAttribute:
get:
x-aws-operation-name: ResetImageAttribute
operationId: GET_ResetImageAttribute
description: Resets an attribute of an AMI to its default value.
responses:
'200':
description: Success
parameters:
- name: Attribute
in: query
required: true
description: The attribute to reset (currently you can only reset the launch permission attribute).
schema:
type: string
enum:
- launchPermission
- name: ImageId
in: query
required: true
description: The ID of the AMI.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ResetImageAttribute
operationId: POST_ResetImageAttribute
description: Resets an attribute of an AMI to its default value.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ResetImageAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetImageAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ResetInstanceAttribute:
get:
x-aws-operation-name: ResetInstanceAttribute
operationId: GET_ResetInstanceAttribute
description: '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.
The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceId
in: query
required: true
description: The ID of the instance.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetInstanceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ResetInstanceAttribute
operationId: POST_ResetInstanceAttribute
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: NetworkInterfaceId
in: query
required: true
description: The ID of the network interface.
schema:
type: string
- name: SourceDestCheck
in: query
required: false
description: The source/destination checking attribute. Resets the value to true.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetNetworkInterfaceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ResetNetworkInterfaceAttribute
operationId: POST_ResetNetworkInterfaceAttribute
description: Resets a network interface attribute. You can specify only one attribute at a time.
responses:
'200':
description: Success
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/ResetNetworkInterfaceAttributeRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetNetworkInterfaceAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=ResetSnapshotAttribute:
get:
x-aws-operation-name: ResetSnapshotAttribute
operationId: GET_ResetSnapshotAttribute
description: 'Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success parameters: - name: Attribute in: query required: true description: 'The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.' schema: type: string enum: - productCodes - createVolumePermission - name: SnapshotId in: query required: true description: The ID of the snapshot. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- ResetSnapshotAttribute
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: ResetSnapshotAttribute
operationId: POST_ResetSnapshotAttribute
description: 'Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide.
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/ResetSnapshotAttributeRequest' parameters: - name: Action in: query required: true schema: type: string enum: - ResetSnapshotAttribute - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RestoreAddressToClassic: get: x-aws-operation-name: RestoreAddressToClassic operationId: GET_RestoreAddressToClassic description: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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RestoreAddressToClassicResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PublicIp
in: query
required: true
description: The Elastic IP address.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreAddressToClassic
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RestoreAddressToClassic
operationId: POST_RestoreAddressToClassic
description: 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.
responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RestoreAddressToClassicResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RestoreAddressToClassicRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RestoreAddressToClassic - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RestoreImageFromRecycleBin: get: x-aws-operation-name: RestoreImageFromRecycleBin operationId: GET_RestoreImageFromRecycleBin description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RestoreImageFromRecycleBinResult' parameters: - name: ImageId in: query required: true description: The ID of the AMI to restore. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreImageFromRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RestoreImageFromRecycleBin
operationId: POST_RestoreImageFromRecycleBin
description: 'Restores an AMI from the Recycle Bin. For more information, see Recycle Bin in the Amazon EC2 User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreImageFromRecycleBinResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreImageFromRecycleBinRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreImageFromRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=RestoreManagedPrefixListVersion:
get:
x-aws-operation-name: RestoreManagedPrefixListVersion
operationId: GET_RestoreManagedPrefixListVersion
description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreManagedPrefixListVersionResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: PrefixListId
in: query
required: true
description: The ID of the prefix list.
schema:
type: string
- name: PreviousVersion
in: query
required: true
description: The version to restore.
schema:
type: integer
- name: CurrentVersion
in: query
required: true
description: The current version number for the prefix list.
schema:
type: integer
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreManagedPrefixListVersion
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RestoreManagedPrefixListVersion
operationId: POST_RestoreManagedPrefixListVersion
description: Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreManagedPrefixListVersionResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreManagedPrefixListVersionRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreManagedPrefixListVersion
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=RestoreSnapshotFromRecycleBin:
get:
x-aws-operation-name: RestoreSnapshotFromRecycleBin
operationId: GET_RestoreSnapshotFromRecycleBin
description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult'
parameters:
- name: SnapshotId
in: query
required: true
description: The ID of the snapshot to restore.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreSnapshotFromRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RestoreSnapshotFromRecycleBin
operationId: POST_RestoreSnapshotFromRecycleBin
description: 'Restores a snapshot from the Recycle Bin. For more information, see Restore snapshots from the Recycle Bin in the Amazon Elastic Compute Cloud User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreSnapshotFromRecycleBinResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RestoreSnapshotFromRecycleBinRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreSnapshotFromRecycleBin
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=RestoreSnapshotTier:
get:
x-aws-operation-name: RestoreSnapshotTier
operationId: GET_RestoreSnapshotTier
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RestoreSnapshotTierResult' parameters: - name: SnapshotId in: query required: true description: The ID of the snapshot to restore. schema: type: string - name: TemporaryRestoreDays in: query required: false description: 'Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.
true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.'
schema:
type: boolean
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RestoreSnapshotTier
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RestoreSnapshotTier
operationId: POST_RestoreSnapshotTier
description: '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 Elastic Compute Cloud User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RestoreSnapshotTierResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RestoreSnapshotTierRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RestoreSnapshotTier - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RevokeClientVpnIngress: get: x-aws-operation-name: RevokeClientVpnIngress operationId: GET_RevokeClientVpnIngress description: 'Removes an ingress authorization rule from a Client VPN endpoint. ' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RevokeClientVpnIngressResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint with which the authorization rule is associated. schema: type: string - name: TargetNetworkCidr in: query required: true description: 'The IPv4 address range, in CIDR notation, of the network for which access is being removed.' schema: type: string - name: AccessGroupId in: query required: false description: 'The ID of the Active Directory group for which to revoke access. ' schema: type: string - name: RevokeAllGroups in: query required: false description: Indicates whether access should be revoked for all clients. schema: type: boolean - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RevokeClientVpnIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RevokeClientVpnIngress
operationId: POST_RevokeClientVpnIngress
description: 'Removes an ingress authorization rule from a Client VPN endpoint. '
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/RevokeClientVpnIngressResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/RevokeClientVpnIngressRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- RevokeClientVpnIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=RevokeSecurityGroupEgress:
get:
x-aws-operation-name: RevokeSecurityGroupEgress
operationId: GET_RevokeSecurityGroupEgress
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupId
in: query
required: true
description: The ID of the security group.
schema:
type: string
- name: IpPermissions
in: query
required: false
description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpPermission'
- xml:
name: item
- name: SecurityGroupRuleId
in: query
required: false
description: The IDs of the security group rules.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: CidrIp
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the CIDR.
schema:
type: string
- name: FromPort
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the port.
schema:
type: integer
- name: IpProtocol
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
schema:
type: string
- name: ToPort
in: query
required: false
description: Not supported. Use a set of IP permissions to specify the port.
schema:
type: integer
- name: SourceSecurityGroupName
in: query
required: false
description: Not supported. Use a set of IP permissions to specify a destination security group.
schema:
type: string
- name: SourceSecurityGroupOwnerId
in: query
required: false
description: Not supported. Use a set of IP permissions to specify a destination security group.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- RevokeSecurityGroupEgress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RevokeSecurityGroupEgress
operationId: POST_RevokeSecurityGroupEgress
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RevokeSecurityGroupEgressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RevokeSecurityGroupEgressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RevokeSecurityGroupEgress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RevokeSecurityGroupIngress: get: x-aws-operation-name: RevokeSecurityGroupIngress operationId: GET_RevokeSecurityGroupIngress description: '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.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' parameters: - name: CidrIp in: query required: false description: The CIDR IP address range. You can't specify this parameter when specifying a source security group. schema: type: string - name: FromPort in: query required: false description: 'If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types.' schema: type: integer - name: GroupId in: query required: false description: The ID of the security group. schema: type: string - name: GroupName in: query required: false description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' schema: type: string - name: IpPermissions in: query required: false description: The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions. schema: type: array items: allOf: - $ref: '#/components/schemas/IpPermission' - xml: name: item - name: IpProtocol in: query required: false description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.'
schema:
type: string
- name: SourceSecurityGroupName
in: query
required: false
description: '[Default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. The source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.'
schema:
type: string
- name: SourceSecurityGroupOwnerId
in: query
required: false
description: Not supported.
schema:
type: string
- name: ToPort
in: query
required: false
description: 'If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes.'
schema:
type: integer
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: SecurityGroupRuleId
in: query
required: false
description: The IDs of the security group rules.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- RevokeSecurityGroupIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RevokeSecurityGroupIngress
operationId: POST_RevokeSecurityGroupIngress
description: '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.
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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RevokeSecurityGroupIngressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RevokeSecurityGroupIngressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RevokeSecurityGroupIngress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RunInstances: get: x-aws-operation-name: RunInstances operationId: GET_RunInstances description: 'Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.
All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/Reservation' parameters: - name: BlockDeviceMapping in: query required: false description: 'The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.' schema: type: array items: allOf: - $ref: '#/components/schemas/BlockDeviceMapping' - xml: name: BlockDeviceMapping - name: ImageId in: query required: false description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template. schema: type: string - name: InstanceType in: query required: false description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.' schema: type: string enum: - a1.medium - a1.large - a1.xlarge - a1.2xlarge - a1.4xlarge - a1.metal - c1.medium - c1.xlarge - c3.large - c3.xlarge - c3.2xlarge - c3.4xlarge - c3.8xlarge - c4.large - c4.xlarge - c4.2xlarge - c4.4xlarge - c4.8xlarge - c5.large - c5.xlarge - c5.2xlarge - c5.4xlarge - c5.9xlarge - c5.12xlarge - c5.18xlarge - c5.24xlarge - c5.metal - c5a.large - c5a.xlarge - c5a.2xlarge - c5a.4xlarge - c5a.8xlarge - c5a.12xlarge - c5a.16xlarge - c5a.24xlarge - c5ad.large - c5ad.xlarge - c5ad.2xlarge - c5ad.4xlarge - c5ad.8xlarge - c5ad.12xlarge - c5ad.16xlarge - c5ad.24xlarge - c5d.large - c5d.xlarge - c5d.2xlarge - c5d.4xlarge - c5d.9xlarge - c5d.12xlarge - c5d.18xlarge - c5d.24xlarge - c5d.metal - c5n.large - c5n.xlarge - c5n.2xlarge - c5n.4xlarge - c5n.9xlarge - c5n.18xlarge - c5n.metal - c6g.medium - c6g.large - c6g.xlarge - c6g.2xlarge - c6g.4xlarge - c6g.8xlarge - c6g.12xlarge - c6g.16xlarge - c6g.metal - c6gd.medium - c6gd.large - c6gd.xlarge - c6gd.2xlarge - c6gd.4xlarge - c6gd.8xlarge - c6gd.12xlarge - c6gd.16xlarge - c6gd.metal - c6gn.medium - c6gn.large - c6gn.xlarge - c6gn.2xlarge - c6gn.4xlarge - c6gn.8xlarge - c6gn.12xlarge - c6gn.16xlarge - c6i.large - c6i.xlarge - c6i.2xlarge - c6i.4xlarge - c6i.8xlarge - c6i.12xlarge - c6i.16xlarge - c6i.24xlarge - c6i.32xlarge - c6i.metal - cc1.4xlarge - cc2.8xlarge - cg1.4xlarge - cr1.8xlarge - d2.xlarge - d2.2xlarge - d2.4xlarge - d2.8xlarge - d3.xlarge - d3.2xlarge - d3.4xlarge - d3.8xlarge - d3en.xlarge - d3en.2xlarge - d3en.4xlarge - d3en.6xlarge - d3en.8xlarge - d3en.12xlarge - dl1.24xlarge - f1.2xlarge - f1.4xlarge - f1.16xlarge - g2.2xlarge - g2.8xlarge - g3.4xlarge - g3.8xlarge - g3.16xlarge - g3s.xlarge - g4ad.xlarge - g4ad.2xlarge - g4ad.4xlarge - g4ad.8xlarge - g4ad.16xlarge - g4dn.xlarge - g4dn.2xlarge - g4dn.4xlarge - g4dn.8xlarge - g4dn.12xlarge - g4dn.16xlarge - g4dn.metal - g5.xlarge - g5.2xlarge - g5.4xlarge - g5.8xlarge - g5.12xlarge - g5.16xlarge - g5.24xlarge - g5.48xlarge - g5g.xlarge - g5g.2xlarge - g5g.4xlarge - g5g.8xlarge - g5g.16xlarge - g5g.metal - hi1.4xlarge - hpc6a.48xlarge - hs1.8xlarge - h1.2xlarge - h1.4xlarge - h1.8xlarge - h1.16xlarge - i2.xlarge - i2.2xlarge - i2.4xlarge - i2.8xlarge - i3.large - i3.xlarge - i3.2xlarge - i3.4xlarge - i3.8xlarge - i3.16xlarge - i3.metal - i3en.large - i3en.xlarge - i3en.2xlarge - i3en.3xlarge - i3en.6xlarge - i3en.12xlarge - i3en.24xlarge - i3en.metal - im4gn.large - im4gn.xlarge - im4gn.2xlarge - im4gn.4xlarge - im4gn.8xlarge - im4gn.16xlarge - inf1.xlarge - inf1.2xlarge - inf1.6xlarge - inf1.24xlarge - is4gen.medium - is4gen.large - is4gen.xlarge - is4gen.2xlarge - is4gen.4xlarge - is4gen.8xlarge - m1.small - m1.medium - m1.large - m1.xlarge - m2.xlarge - m2.2xlarge - m2.4xlarge - m3.medium - m3.large - m3.xlarge - m3.2xlarge - m4.large - m4.xlarge - m4.2xlarge - m4.4xlarge - m4.10xlarge - m4.16xlarge - m5.large - m5.xlarge - m5.2xlarge - m5.4xlarge - m5.8xlarge - m5.12xlarge - m5.16xlarge - m5.24xlarge - m5.metal - m5a.large - m5a.xlarge - m5a.2xlarge - m5a.4xlarge - m5a.8xlarge - m5a.12xlarge - m5a.16xlarge - m5a.24xlarge - m5ad.large - m5ad.xlarge - m5ad.2xlarge - m5ad.4xlarge - m5ad.8xlarge - m5ad.12xlarge - m5ad.16xlarge - m5ad.24xlarge - m5d.large - m5d.xlarge - m5d.2xlarge - m5d.4xlarge - m5d.8xlarge - m5d.12xlarge - m5d.16xlarge - m5d.24xlarge - m5d.metal - m5dn.large - m5dn.xlarge - m5dn.2xlarge - m5dn.4xlarge - m5dn.8xlarge - m5dn.12xlarge - m5dn.16xlarge - m5dn.24xlarge - m5dn.metal - m5n.large - m5n.xlarge - m5n.2xlarge - m5n.4xlarge - m5n.8xlarge - m5n.12xlarge - m5n.16xlarge - m5n.24xlarge - m5n.metal - m5zn.large - m5zn.xlarge - m5zn.2xlarge - m5zn.3xlarge - m5zn.6xlarge - m5zn.12xlarge - m5zn.metal - m6a.large - m6a.xlarge - m6a.2xlarge - m6a.4xlarge - m6a.8xlarge - m6a.12xlarge - m6a.16xlarge - m6a.24xlarge - m6a.32xlarge - m6a.48xlarge - m6g.metal - m6g.medium - m6g.large - m6g.xlarge - m6g.2xlarge - m6g.4xlarge - m6g.8xlarge - m6g.12xlarge - m6g.16xlarge - m6gd.metal - m6gd.medium - m6gd.large - m6gd.xlarge - m6gd.2xlarge - m6gd.4xlarge - m6gd.8xlarge - m6gd.12xlarge - m6gd.16xlarge - m6i.large - m6i.xlarge - m6i.2xlarge - m6i.4xlarge - m6i.8xlarge - m6i.12xlarge - m6i.16xlarge - m6i.24xlarge - m6i.32xlarge - m6i.metal - mac1.metal - p2.xlarge - p2.8xlarge - p2.16xlarge - p3.2xlarge - p3.8xlarge - p3.16xlarge - p3dn.24xlarge - p4d.24xlarge - r3.large - r3.xlarge - r3.2xlarge - r3.4xlarge - r3.8xlarge - r4.large - r4.xlarge - r4.2xlarge - r4.4xlarge - r4.8xlarge - r4.16xlarge - r5.large - r5.xlarge - r5.2xlarge - r5.4xlarge - r5.8xlarge - r5.12xlarge - r5.16xlarge - r5.24xlarge - r5.metal - r5a.large - r5a.xlarge - r5a.2xlarge - r5a.4xlarge - r5a.8xlarge - r5a.12xlarge - r5a.16xlarge - r5a.24xlarge - r5ad.large - r5ad.xlarge - r5ad.2xlarge - r5ad.4xlarge - r5ad.8xlarge - r5ad.12xlarge - r5ad.16xlarge - r5ad.24xlarge - r5b.large - r5b.xlarge - r5b.2xlarge - r5b.4xlarge - r5b.8xlarge - r5b.12xlarge - r5b.16xlarge - r5b.24xlarge - r5b.metal - r5d.large - r5d.xlarge - r5d.2xlarge - r5d.4xlarge - r5d.8xlarge - r5d.12xlarge - r5d.16xlarge - r5d.24xlarge - r5d.metal - r5dn.large - r5dn.xlarge - r5dn.2xlarge - r5dn.4xlarge - r5dn.8xlarge - r5dn.12xlarge - r5dn.16xlarge - r5dn.24xlarge - r5dn.metal - r5n.large - r5n.xlarge - r5n.2xlarge - r5n.4xlarge - r5n.8xlarge - r5n.12xlarge - r5n.16xlarge - r5n.24xlarge - r5n.metal - r6g.medium - r6g.large - r6g.xlarge - r6g.2xlarge - r6g.4xlarge - r6g.8xlarge - r6g.12xlarge - r6g.16xlarge - r6g.metal - r6gd.medium - r6gd.large - r6gd.xlarge - r6gd.2xlarge - r6gd.4xlarge - r6gd.8xlarge - r6gd.12xlarge - r6gd.16xlarge - r6gd.metal - r6i.large - r6i.xlarge - r6i.2xlarge - r6i.4xlarge - r6i.8xlarge - r6i.12xlarge - r6i.16xlarge - r6i.24xlarge - r6i.32xlarge - r6i.metal - t1.micro - t2.nano - t2.micro - t2.small - t2.medium - t2.large - t2.xlarge - t2.2xlarge - t3.nano - t3.micro - t3.small - t3.medium - t3.large - t3.xlarge - t3.2xlarge - t3a.nano - t3a.micro - t3a.small - t3a.medium - t3a.large - t3a.xlarge - t3a.2xlarge - t4g.nano - t4g.micro - t4g.small - t4g.medium - t4g.large - t4g.xlarge - t4g.2xlarge - u-6tb1.56xlarge - u-6tb1.112xlarge - u-9tb1.112xlarge - u-12tb1.112xlarge - u-6tb1.metal - u-9tb1.metal - u-12tb1.metal - u-18tb1.metal - u-24tb1.metal - vt1.3xlarge - vt1.6xlarge - vt1.24xlarge - x1.16xlarge - x1.32xlarge - x1e.xlarge - x1e.2xlarge - x1e.4xlarge - x1e.8xlarge - x1e.16xlarge - x1e.32xlarge - x2iezn.2xlarge - x2iezn.4xlarge - x2iezn.6xlarge - x2iezn.8xlarge - x2iezn.12xlarge - x2iezn.metal - x2gd.medium - x2gd.large - x2gd.xlarge - x2gd.2xlarge - x2gd.4xlarge - x2gd.8xlarge - x2gd.12xlarge - x2gd.16xlarge - x2gd.metal - z1d.large - z1d.xlarge - z1d.2xlarge - z1d.3xlarge - z1d.6xlarge - z1d.12xlarge - z1d.metal - x2idn.16xlarge - x2idn.24xlarge - x2idn.32xlarge - x2iedn.xlarge - x2iedn.2xlarge - x2iedn.4xlarge - x2iedn.8xlarge - x2iedn.16xlarge - x2iedn.24xlarge - x2iedn.32xlarge - c6a.large - c6a.xlarge - c6a.2xlarge - c6a.4xlarge - c6a.8xlarge - c6a.12xlarge - c6a.16xlarge - c6a.24xlarge - c6a.32xlarge - c6a.48xlarge - c6a.metal - m6a.metal - i4i.large - i4i.xlarge - i4i.2xlarge - i4i.4xlarge - i4i.8xlarge - i4i.16xlarge - i4i.32xlarge - i4i.metal - x2idn.metal - x2iedn.metal - c7g.medium - c7g.large - c7g.xlarge - c7g.2xlarge - c7g.4xlarge - c7g.8xlarge - c7g.12xlarge - c7g.16xlarge - mac2.metal - c6id.large - c6id.xlarge - c6id.2xlarge - c6id.4xlarge - c6id.8xlarge - c6id.12xlarge - c6id.16xlarge - c6id.24xlarge - c6id.32xlarge - c6id.metal - m6id.large - m6id.xlarge - m6id.2xlarge - m6id.4xlarge - m6id.8xlarge - m6id.12xlarge - m6id.16xlarge - m6id.24xlarge - m6id.32xlarge - m6id.metal - r6id.large - r6id.xlarge - r6id.2xlarge - r6id.4xlarge - r6id.8xlarge - r6id.12xlarge - r6id.16xlarge - r6id.24xlarge - r6id.32xlarge - r6id.metal - r6a.large - r6a.xlarge - r6a.2xlarge - r6a.4xlarge - r6a.8xlarge - r6a.12xlarge - r6a.16xlarge - r6a.24xlarge - r6a.32xlarge - r6a.48xlarge - r6a.metal - p4de.24xlarge - u-3tb1.56xlarge - u-18tb1.112xlarge - u-24tb1.112xlarge - trn1.2xlarge - trn1.32xlarge - hpc6id.32xlarge - c6in.large - c6in.xlarge - c6in.2xlarge - c6in.4xlarge - c6in.8xlarge - c6in.12xlarge - c6in.16xlarge - c6in.24xlarge - c6in.32xlarge - m6in.large - m6in.xlarge - m6in.2xlarge - m6in.4xlarge - m6in.8xlarge - m6in.12xlarge - m6in.16xlarge - m6in.24xlarge - m6in.32xlarge - m6idn.large - m6idn.xlarge - m6idn.2xlarge - m6idn.4xlarge - m6idn.8xlarge - m6idn.12xlarge - m6idn.16xlarge - m6idn.24xlarge - m6idn.32xlarge - r6in.large - r6in.xlarge - r6in.2xlarge - r6in.4xlarge - r6in.8xlarge - r6in.12xlarge - r6in.16xlarge - r6in.24xlarge - r6in.32xlarge - r6idn.large - r6idn.xlarge - r6idn.2xlarge - r6idn.4xlarge - r6idn.8xlarge - r6idn.12xlarge - r6idn.16xlarge - r6idn.24xlarge - r6idn.32xlarge - c7g.metal - m7g.medium - m7g.large - m7g.xlarge - m7g.2xlarge - m7g.4xlarge - m7g.8xlarge - m7g.12xlarge - m7g.16xlarge - m7g.metal - r7g.medium - r7g.large - r7g.xlarge - r7g.2xlarge - r7g.4xlarge - r7g.8xlarge - r7g.12xlarge - r7g.16xlarge - r7g.metal - c6in.metal - m6in.metal - m6idn.metal - r6in.metal - r6idn.metal - inf2.xlarge - inf2.8xlarge - inf2.24xlarge - inf2.48xlarge - trn1n.32xlarge - i4g.large - i4g.xlarge - i4g.2xlarge - i4g.4xlarge - i4g.8xlarge - i4g.16xlarge - hpc7g.4xlarge - hpc7g.8xlarge - hpc7g.16xlarge - c7gn.medium - c7gn.large - c7gn.xlarge - c7gn.2xlarge - c7gn.4xlarge - c7gn.8xlarge - c7gn.12xlarge - c7gn.16xlarge - name: Ipv6AddressCount in: query required: false description:The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
schema: type: integer - name: Ipv6Address in: query required: false description:The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceIpv6Address' - xml: name: item - name: KernelId in: query required: false description: 'The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
' schema: type: integer - name: MinCount in: query required: true description: 'The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
' schema: type: integer - name: Monitoring in: query required: false description: Specifies whether detailed monitoring is enabled for the instance. schema: type: object required: - Enabled properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: enabled description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' description: Describes the monitoring of an instance. - name: Placement in: query required: false description: The placement for the instance. schema: type: object properties: AvailabilityZone: allOf: - $ref: '#/components/schemas/String' - xml: name: availabilityZone description: 'The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported for CreateFleet.
' Affinity: allOf: - $ref: '#/components/schemas/String' - xml: name: affinity description: 'The affinity setting for the instance on the Dedicated Host.
This parameter is not supported for CreateFleet or ImportInstance.
' GroupName: allOf: - $ref: '#/components/schemas/PlacementGroupName' - xml: name: groupName description: 'The name of the placement group that the instance is in. If you specifyGroupName, you can''t specify GroupId.'
PartitionNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: partitionNumber
description: 'The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported for CreateFleet.
' HostId: allOf: - $ref: '#/components/schemas/String' - xml: name: hostId description: 'The ID of the Dedicated Host on which the instance resides.
This parameter is not supported for CreateFleet or ImportInstance.
' Tenancy: allOf: - $ref: '#/components/schemas/Tenancy' - xml: name: tenancy description: 'The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.
The ARN of the host resource group in which to launch the instances.
If you specify this parameter, either omit the Tenancy parameter or set it to host.
This parameter is not supported for CreateFleet.
' GroupId: allOf: - $ref: '#/components/schemas/PlacementGroupId' - xml: name: groupId description: 'The ID of the placement group that the instance is in. If you specifyGroupId, you can''t specify GroupName.'
description: Describes the placement of an instance.
- name: RamdiskId
in: query
required: false
description: 'The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
' schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupId' - xml: name: SecurityGroupId - name: SecurityGroup in: query required: false description: '[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
' schema: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupName' - xml: name: SecurityGroup - name: SubnetId in: query required: false description: 'The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
' schema: type: string - name: UserData in: query required: false description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' schema: type: string format: password - name: AdditionalInfo in: query required: false description: Reserved. schema: type: string - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' schema: type: string - name: DisableApiTermination in: query required: false description: 'If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: EbsOptimized
in: query
required: false
description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
schema: type: string - name: ElasticGpuSpecification in: query required: false description: 'An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.' schema: type: array items: allOf: - $ref: '#/components/schemas/ElasticGpuSpecification' - xml: name: item - name: ElasticInferenceAccelerator in: query required: false description: 'An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
' schema: type: array items: allOf: - $ref: '#/components/schemas/TagSpecification' - xml: name: item - name: LaunchTemplate in: query required: false description: 'The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.' schema: type: object properties: LaunchTemplateId: allOf: - $ref: '#/components/schemas/LaunchTemplateId' - description: 'The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The launch template version number, $Latest, or $Default.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
Default: The default version of the launch template.
' description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' - name: InstanceMarketOptions in: query required: false description: 'The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)
For T3 instances with host tenancy, only standard is supported.
The credit option for CPU usage of a T instance.
Valid values: standard | unlimited
1. Otherwise, specify the default value of 2.'
AmdSevSnp:
allOf:
- $ref: '#/components/schemas/AmdSevSnpSpecification'
- description: '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.'
description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
- name: CapacityReservationSpecification
in: query
required: false
description: 'Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance''s Capacity Reservation preference defaults to open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
schema:
type: object
properties:
CapacityReservationPreference:
allOf:
- $ref: '#/components/schemas/CapacityReservationPreference'
- description: '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.
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.
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
' schema: type: object properties: Configured: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Set to true to enable your instance for hibernation.
Default: false
IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to required).
optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' HttpEndpoint: allOf: - $ref: '#/components/schemas/InstanceMetadataEndpointState' - description: 'Enables or disables the HTTP metadata endpoint on your instances.
If you specify a value of disabled, you cannot access your instance metadata.
Default: enabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
' schema: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter totrue.'
description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
- name: PrivateDnsNameOptions
in: query
required: false
description: 'The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.'
schema:
type: object
properties:
HostnameType:
allOf:
- $ref: '#/components/schemas/HostnameType'
- description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
EnableResourceNameDnsARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
EnableResourceNameDnsAAAARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
description: Describes the options for instance hostnames.
- name: MaintenanceOptions
in: query
required: false
description: The maintenance and recovery options for the instance.
schema:
type: object
properties:
AutoRecovery:
allOf:
- $ref: '#/components/schemas/InstanceAutoRecoveryState'
- description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.'
description: The maintenance options for the instance.
- name: DisableApiStop
in: query
required: false
description: 'Indicates whether an instance is enabled for stop protection. For more information, see Stop protection. '
schema:
type: boolean
- name: EnablePrimaryIpv6
in: query
required: false
description: 'If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- RunInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: RunInstances
operationId: POST_RunInstances
description: 'Launches the specified number of instances using an AMI for which you have permissions.
You can specify a number of options, or leave the default options. The following rules apply:
If you don''t specify a subnet ID, we choose a default subnet from your default VPC for you. If you don''t have a default VPC, you must specify a subnet ID in the request.
All instances have a network interface with a primary private IPv4 address. If you don''t specify this address, we choose one from the IPv4 range of your subnet.
Not all instance types support IPv6 addresses. For more information, see Instance types.
If you don''t specify a security group ID, we use the default security group. For more information, see Security groups.
If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.
You can create a launch template, which is a resource that contains the parameters to launch an instance. When you launch an instance using RunInstances, you can specify the launch template instead of specifying the launch parameters.
To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.
An instance is ready for you to use when it''s in the running state. You can check the state of your instance using DescribeInstances. You can tag instances and EBS volumes during launch, after launch, or both. For more information, see CreateTags and Tagging your Amazon EC2 resources.
Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see Key pairs.
For troubleshooting, see What to do if an instance immediately terminates, and Troubleshooting connecting to your instance.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/Reservation' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RunInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RunInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=RunScheduledInstances: get: x-aws-operation-name: RunScheduledInstances operationId: GET_RunScheduledInstances description: 'Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RunScheduledInstancesResult' parameters: - name: ClientToken in: query required: false description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: InstanceCount
in: query
required: false
description: 'The number of instances.
Default: 1
' schema: type: integer - name: LaunchSpecification in: query required: true description: 'The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.' schema: type: object required: - ImageId properties: BlockDeviceMappings: allOf: - $ref: '#/components/schemas/ScheduledInstancesBlockDeviceMappingSet' - xml: name: BlockDeviceMapping description: The block device mapping entries. EbsOptimized: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
Launches the specified Scheduled Instances.
Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using PurchaseScheduledInstances.
You must launch a Scheduled Instance during its scheduled time period. You can''t stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes. For more information, see Scheduled Instances in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/RunScheduledInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/RunScheduledInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - RunScheduledInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=SearchLocalGatewayRoutes: get: x-aws-operation-name: SearchLocalGatewayRoutes operationId: GET_SearchLocalGatewayRoutes description: Searches for routes in the specified local gateway route table. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/SearchLocalGatewayRoutesResult' parameters: - name: LocalGatewayRouteTableId in: query required: true description: The ID of the local gateway route table. schema: type: string - name: Filter in: query required: false description: 'One or more filters.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route.
type - The route type.
nextToken value.'
schema:
type: integer
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- SearchLocalGatewayRoutes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: SearchLocalGatewayRoutes
operationId: POST_SearchLocalGatewayRoutes
description: Searches for routes in the specified local gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchLocalGatewayRoutesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchLocalGatewayRoutesRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- SearchLocalGatewayRoutes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=SearchTransitGatewayMulticastGroups:
get:
x-aws-operation-name: SearchTransitGatewayMulticastGroups
operationId: GET_SearchTransitGatewayMulticastGroups
description: Searches one or more transit gateway multicast groups and returns the group membership information.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult'
parameters:
- name: TransitGatewayMulticastDomainId
in: query
required: true
description: The ID of the transit gateway multicast domain.
schema:
type: string
- name: Filter
in: query
required: false
description: 'One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
schema:
type: integer
minimum: 5
maximum: 1000
- name: NextToken
in: query
required: false
description: The token for the next page of results.
schema:
type: string
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- SearchTransitGatewayMulticastGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: SearchTransitGatewayMulticastGroups
operationId: POST_SearchTransitGatewayMulticastGroups
description: Searches one or more transit gateway multicast groups and returns the group membership information.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchTransitGatewayMulticastGroupsRequest'
parameters:
- name: MaxResults
in: query
schema:
type: string
description: Pagination limit
required: false
- name: NextToken
in: query
schema:
type: string
description: Pagination token
required: false
- name: Action
in: query
required: true
schema:
type: string
enum:
- SearchTransitGatewayMulticastGroups
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=SearchTransitGatewayRoutes:
get:
x-aws-operation-name: SearchTransitGatewayRoutes
operationId: GET_SearchTransitGatewayRoutes
description: Searches for routes in the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
parameters:
- name: TransitGatewayRouteTableId
in: query
required: true
description: The ID of the transit gateway route table.
schema:
type: string
- name: Filter
in: query
required: true
description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- SearchTransitGatewayRoutes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: SearchTransitGatewayRoutes
operationId: POST_SearchTransitGatewayRoutes
description: Searches for routes in the specified transit gateway route table.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/SearchTransitGatewayRoutesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- SearchTransitGatewayRoutes
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=SendDiagnosticInterrupt:
get:
x-aws-operation-name: SendDiagnosticInterrupt
operationId: GET_SendDiagnosticInterrupt
description: 'Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).
' responses: '200': description: Success parameters: - name: InstanceId in: query required: true description: The ID of the instance. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- SendDiagnosticInterrupt
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: SendDiagnosticInterrupt
operationId: POST_SendDiagnosticInterrupt
description: 'Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a kernel panic (on Linux instances), or a blue screen/stop error (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a non-maskable interrupt (NMI).
In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.
Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.
For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see Send a diagnostic interrupt (for advanced users) (Linux instances) or Send a diagnostic interrupt (for advanced users) (Windows instances).
' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/SendDiagnosticInterruptRequest' parameters: - name: Action in: query required: true schema: type: string enum: - SendDiagnosticInterrupt - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=StartInstances: get: x-aws-operation-name: StartInstances operationId: GET_StartInstances description: '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 unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start your instance in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/StartInstancesResult' parameters: - name: InstanceId in: query required: true description: The IDs of the instances. schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: AdditionalInfo in: query required: false description: Reserved. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: StartInstances
operationId: POST_StartInstances
description: '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 unlimted CPU credit option, the request fails. The unlimited CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to standard, or change its tenancy to default or dedicated.
For more information, see Stop and start your instance in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/StartInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/StartInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - StartInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=StartNetworkInsightsAccessScopeAnalysis: get: x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis operationId: GET_StartNetworkInsightsAccessScopeAnalysis description: Starts analyzing the specified Network Access Scope. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult' parameters: - name: NetworkInsightsAccessScopeId in: query required: true description: The ID of the Network Access Scope. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: The tags to apply.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: true
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartNetworkInsightsAccessScopeAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: StartNetworkInsightsAccessScopeAnalysis
operationId: POST_StartNetworkInsightsAccessScopeAnalysis
description: Starts analyzing the specified Network Access Scope.
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/StartNetworkInsightsAccessScopeAnalysisRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartNetworkInsightsAccessScopeAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=StartNetworkInsightsAnalysis:
get:
x-aws-operation-name: StartNetworkInsightsAnalysis
operationId: GET_StartNetworkInsightsAnalysis
description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/StartNetworkInsightsAnalysisResult'
parameters:
- name: NetworkInsightsPathId
in: query
required: true
description: The ID of the path.
schema:
type: string
- name: AdditionalAccount
in: query
required: false
description: The member accounts that contain resources that the path can traverse.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
- name: FilterInArn
in: query
required: false
description: The Amazon Resource Names (ARN) of the resources that the path must traverse.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: item
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: TagSpecification
in: query
required: false
description: The tags to apply.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
- name: ClientToken
in: query
required: true
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartNetworkInsightsAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: StartNetworkInsightsAnalysis
operationId: POST_StartNetworkInsightsAnalysis
description: 'Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/StartNetworkInsightsAnalysisResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/StartNetworkInsightsAnalysisRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartNetworkInsightsAnalysis
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=StartVpcEndpointServicePrivateDnsVerification:
get:
x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification
operationId: GET_StartVpcEndpointServicePrivateDnsVerification
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' parameters: - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: ServiceId
in: query
required: true
description: The ID of the endpoint service.
schema:
type: string
- name: Action
in: query
required: true
schema:
type: string
enum:
- StartVpcEndpointServicePrivateDnsVerification
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: StartVpcEndpointServicePrivateDnsVerification
operationId: POST_StartVpcEndpointServicePrivateDnsVerification
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/StartVpcEndpointServicePrivateDnsVerificationRequest' parameters: - name: Action in: query required: true schema: type: string enum: - StartVpcEndpointServicePrivateDnsVerification - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=StopInstances: get: x-aws-operation-name: StopInstances operationId: GET_StopInstances description: 'Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/StopInstancesResult' parameters: - name: InstanceId in: query required: true description: The IDs of the instances. schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: Hibernate in: query required: false description: 'Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Force
in: query
required: false
description: 'Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
Stops an Amazon EBS-backed instance. For more information, see Stop and start your instance in the Amazon EC2 User Guide.
You can use the Stop action to hibernate an instance if the instance is enabled for hibernation and it meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
We don''t charge usage for a stopped instance, or data transfer fees; however, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can''t stop or hibernate instance store-backed instances. You can''t use the Stop action to hibernate Spot Instances, but you can specify that Amazon EC2 should hibernate Spot Instances when they are interrupted. For more information, see Hibernating interrupted Spot Instances in the Amazon EC2 User Guide.
When you stop or hibernate an instance, we shut it down. You can restart your instance at any time. Before stopping or hibernating an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM, but hibernating an instance does preserve data stored in RAM. If an instance cannot hibernate successfully, a normal shutdown occurs.
Stopping and hibernating an instance is different to rebooting or terminating it. For example, when you stop or hibernate an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, the root device and any other devices attached during the instance launch are automatically deleted. For more information about the differences between rebooting, stopping, hibernating, and terminating instances, see Instance lifecycle in the Amazon EC2 User Guide.
When you stop an instance, we attempt to shut it down forcibly after a short while. If your instance appears stuck in the stopping state after a period of time, there may be an issue with the underlying host computer. For more information, see Troubleshoot stopping your instance in the Amazon EC2 User Guide.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/StopInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/StopInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - StopInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=TerminateClientVpnConnections: get: x-aws-operation-name: TerminateClientVpnConnections operationId: GET_TerminateClientVpnConnections description: '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.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/TerminateClientVpnConnectionsResult' parameters: - name: ClientVpnEndpointId in: query required: true description: The ID of the Client VPN endpoint to which the client is connected. schema: type: string - name: ConnectionId in: query required: false description: The ID of the client connection to be terminated. schema: type: string - name: Username in: query required: false description: The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections. schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- TerminateClientVpnConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: TerminateClientVpnConnections
operationId: POST_TerminateClientVpnConnections
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/TerminateClientVpnConnectionsResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/TerminateClientVpnConnectionsRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- TerminateClientVpnConnections
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=TerminateInstances:
get:
x-aws-operation-name: TerminateInstances
operationId: GET_TerminateInstances
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/TerminateInstancesResult' parameters: - name: InstanceId in: query required: true description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- TerminateInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: TerminateInstances
operationId: POST_TerminateInstances
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/TerminateInstancesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/TerminateInstancesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - TerminateInstances - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=UnassignIpv6Addresses: get: x-aws-operation-name: UnassignIpv6Addresses operationId: GET_UnassignIpv6Addresses description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/UnassignIpv6AddressesResult' parameters: - name: Ipv6Addresses in: query required: false description: The IPv6 addresses to unassign from the network interface. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: Ipv6Prefix in: query required: false description: The IPv6 prefixes to unassign from the network interface. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: NetworkInterfaceId in: query required: true description: The ID of the network interface. schema: type: string - name: Action in: query required: true schema: type: string enum: - UnassignIpv6Addresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: UnassignIpv6Addresses operationId: POST_UnassignIpv6Addresses description: Unassigns one or more IPv6 addresses IPv4 Prefix Delegation prefixes from a network interface. responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/UnassignIpv6AddressesResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/UnassignIpv6AddressesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - UnassignIpv6Addresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=UnassignPrivateIpAddresses: get: x-aws-operation-name: UnassignPrivateIpAddresses operationId: GET_UnassignPrivateIpAddresses description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' responses: '200': description: Success parameters: - name: NetworkInterfaceId in: query required: true description: The ID of the network interface. schema: type: string - name: PrivateIpAddress in: query required: false description: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: PrivateIpAddress - name: Ipv4Prefix in: query required: false description: The IPv4 prefixes to unassign from the network interface. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: Action in: query required: true schema: type: string enum: - UnassignPrivateIpAddresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' parameters: - $ref: '#/components/parameters/X-Amz-Content-Sha256' - $ref: '#/components/parameters/X-Amz-Date' - $ref: '#/components/parameters/X-Amz-Algorithm' - $ref: '#/components/parameters/X-Amz-Credential' - $ref: '#/components/parameters/X-Amz-Security-Token' - $ref: '#/components/parameters/X-Amz-Signature' - $ref: '#/components/parameters/X-Amz-SignedHeaders' post: x-aws-operation-name: UnassignPrivateIpAddresses operationId: POST_UnassignPrivateIpAddresses description: 'Unassigns one or more secondary private IP addresses, or IPv4 Prefix Delegation prefixes from a network interface.' responses: '200': description: Success requestBody: content: text/xml: schema: $ref: '#/components/schemas/UnassignPrivateIpAddressesRequest' parameters: - name: Action in: query required: true schema: type: string enum: - UnassignPrivateIpAddresses - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=UnassignPrivateNatGatewayAddress: get: x-aws-operation-name: UnassignPrivateNatGatewayAddress operationId: GET_UnassignPrivateNatGatewayAddress description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/UnassignPrivateNatGatewayAddressResult' parameters: - name: NatGatewayId in: query required: true description: The ID of the NAT gateway. schema: type: string - name: PrivateIpAddress in: query required: true description: The private IPv4 addresses you want to unassign. schema: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item - name: MaxDrainDurationSeconds in: query required: false description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds. schema: type: integer minimum: 1 maximum: 4000 - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- UnassignPrivateNatGatewayAddress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: UnassignPrivateNatGatewayAddress
operationId: POST_UnassignPrivateNatGatewayAddress
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/UnassignPrivateNatGatewayAddressResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/UnassignPrivateNatGatewayAddressRequest' parameters: - name: Action in: query required: true schema: type: string enum: - UnassignPrivateNatGatewayAddress - name: Version in: query required: true schema: type: string enum: - '2016-11-15' /#Action=UnmonitorInstances: get: x-aws-operation-name: UnmonitorInstances operationId: GET_UnmonitorInstances description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/UnmonitorInstancesResult' parameters: - name: InstanceId in: query required: true description: The IDs of the instances. schema: type: array items: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: InstanceId - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- UnmonitorInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: UnmonitorInstances
operationId: POST_UnmonitorInstances
description: 'Disables detailed monitoring for a running instance. For more information, see Monitoring your instances and volumes in the Amazon EC2 User Guide.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UnmonitorInstancesResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/UnmonitorInstancesRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- UnmonitorInstances
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=UpdateSecurityGroupRuleDescriptionsEgress:
get:
x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress
operationId: GET_UpdateSecurityGroupRuleDescriptionsEgress
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupId
in: query
required: false
description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
schema:
type: string
- name: GroupName
in: query
required: false
description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name.'
schema:
type: string
- name: IpPermissions
in: query
required: false
description: The IP permissions for the security group rule. You must specify either the IP permissions or the description.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpPermission'
- xml:
name: item
- name: SecurityGroupRuleDescription
in: query
required: false
description: The description for the egress security group rules. You must specify either the description or the IP permissions.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleDescription'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateSecurityGroupRuleDescriptionsEgress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsEgress
operationId: POST_UpdateSecurityGroupRuleDescriptionsEgress
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateSecurityGroupRuleDescriptionsEgress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=UpdateSecurityGroupRuleDescriptionsIngress:
get:
x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress
operationId: GET_UpdateSecurityGroupRuleDescriptionsIngress
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
parameters:
- name: DryRun
in: query
required: false
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: GroupId
in: query
required: false
description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
schema:
type: string
- name: GroupName
in: query
required: false
description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.'
schema:
type: string
- name: IpPermissions
in: query
required: false
description: The IP permissions for the security group rule. You must specify either IP permissions or a description.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpPermission'
- xml:
name: item
- name: SecurityGroupRuleDescription
in: query
required: false
description: The description for the ingress security group rules. You must specify either a description or IP permissions.
schema:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleDescription'
- xml:
name: item
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateSecurityGroupRuleDescriptionsIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: UpdateSecurityGroupRuleDescriptionsIngress
operationId: POST_UpdateSecurityGroupRuleDescriptionsIngress
description: '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.'
responses:
'200':
description: Success
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
requestBody:
content:
text/xml:
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressRequest'
parameters:
- name: Action
in: query
required: true
schema:
type: string
enum:
- UpdateSecurityGroupRuleDescriptionsIngress
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
/#Action=WithdrawByoipCidr:
get:
x-aws-operation-name: WithdrawByoipCidr
operationId: GET_WithdrawByoipCidr
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/WithdrawByoipCidrResult' parameters: - name: Cidr in: query required: true description: 'The address range, in CIDR notation.' schema: type: string - name: DryRun in: query required: false description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
schema:
type: boolean
- name: Action
in: query
required: true
schema:
type: string
enum:
- WithdrawByoipCidr
- name: Version
in: query
required: true
schema:
type: string
enum:
- '2016-11-15'
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
x-aws-operation-name: WithdrawByoipCidr
operationId: POST_WithdrawByoipCidr
description: '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.
' responses: '200': description: Success content: text/xml: schema: $ref: '#/components/schemas/WithdrawByoipCidrResult' requestBody: content: text/xml: schema: $ref: '#/components/schemas/WithdrawByoipCidrRequest' parameters: - name: Action in: query required: true schema: type: string enum: - WithdrawByoipCidr - name: Version in: query required: true schema: type: string enum: - '2016-11-15' components: parameters: X-Amz-Content-Sha256: name: X-Amz-Content-Sha256 in: header schema: type: string required: false X-Amz-Date: name: X-Amz-Date in: header schema: type: string required: false X-Amz-Algorithm: name: X-Amz-Algorithm in: header schema: type: string required: false X-Amz-Credential: name: X-Amz-Credential in: header schema: type: string required: false X-Amz-Security-Token: name: X-Amz-Security-Token in: header schema: type: string required: false X-Amz-Signature: name: X-Amz-Signature in: header schema: type: string required: false X-Amz-SignedHeaders: name: X-Amz-SignedHeaders in: header schema: type: string required: false securitySchemes: hmac: type: apiKey name: Authorization in: header description: Amazon Signature authorization v4 x-amazon-apigateway-authtype: awsSigv4 schemas: AcceptAddressTransferResult: type: object properties: AddressTransfer: allOf: - $ref: '#/components/schemas/AddressTransfer' - xml: name: addressTransfer description: An Elastic IP address transfer. TagSpecification: type: object properties: ResourceType: allOf: - $ref: '#/components/schemas/ResourceType' - xml: name: resourceType description: The type of resource to tag on creation. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: Tag description: The tags to apply to the resource. description: 'The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.
The Valid Values lists all the resource types that can be tagged. However, the action you''re using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you''re using, you''ll get an error.
successful.
ReservationId:
type: string
TargetConfigurationRequest:
type: object
required:
- OfferingId
properties:
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
OfferingId:
allOf:
- $ref: '#/components/schemas/ReservedInstancesOfferingId'
- description: The Convertible Reserved Instance offering ID.
description: Details about the target configuration.
AcceptTransitGatewayMulticastDomainAssociationsResult:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- xml:
name: associations
description: Information about the multicast domain associations.
String:
type: string
AcceptTransitGatewayPeeringAttachmentResult:
type: object
properties:
TransitGatewayPeeringAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- xml:
name: transitGatewayPeeringAttachment
description: The transit gateway peering attachment.
AcceptTransitGatewayVpcAttachmentResult:
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- xml:
name: transitGatewayVpcAttachment
description: The VPC attachment.
AcceptVpcEndpointConnectionsResult:
type: object
properties:
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemSet'
- xml:
name: unsuccessful
description: 'Information about the interface endpoints that were not accepted, if applicable.'
VpcEndpointId:
type: string
AcceptVpcPeeringConnectionResult:
type: object
properties:
VpcPeeringConnection:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnection'
- xml:
name: vpcPeeringConnection
description: Information about the VPC peering connection.
AdvertiseByoipCidrResult:
type: object
properties:
ByoipCidr:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- xml:
name: byoipCidr
description: Information about the address range.
AllocateAddressResult:
type: object
example:
AllocationId: eipalloc-64d5890a
Domain: vpc
NetworkBorderGroup: us-east-1
PublicIp: 203.0.113.0
PublicIpv4Pool: amazon
properties:
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The Elastic IP address.
AllocationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: allocationId
description: The ID that represents the allocation of the Elastic IP address.
PublicIpv4Pool:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIpv4Pool
description: The ID of an address pool.
NetworkBorderGroup:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkBorderGroup
description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.'
Domain:
allOf:
- $ref: '#/components/schemas/DomainType'
- xml:
name: domain
description: The network (vpc).
CustomerOwnedIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: customerOwnedIp
description: The customer-owned IP address.
CustomerOwnedIpv4Pool:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: customerOwnedIpv4Pool
description: The ID of the customer-owned address pool.
CarrierIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: carrierIp
description: The carrier IP address. This option is only available for network interfaces that reside in a subnet in a Wavelength Zone.
AllocateHostsResult:
type: object
properties:
HostIds:
allOf:
- $ref: '#/components/schemas/ResponseHostIdList'
- xml:
name: hostIdSet
description: The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host.
description: Contains the output of AllocateHosts.
AssetId:
type: string
AllocateIpamPoolCidrResult:
type: object
properties:
IpamPoolAllocation:
allOf:
- $ref: '#/components/schemas/IpamPoolAllocation'
- xml:
name: ipamPoolAllocation
description: Information about the allocation created.
ApplySecurityGroupsToClientVpnTargetNetworkResult:
type: object
properties:
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet'
- xml:
name: securityGroupIds
description: The IDs of the applied security groups.
SecurityGroupId:
type: string
AssignIpv6AddressesResult:
type: object
properties:
AssignedIpv6Addresses:
allOf:
- $ref: '#/components/schemas/Ipv6AddressList'
- xml:
name: assignedIpv6Addresses
description: 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.
AssignedIpv6Prefixes:
allOf:
- $ref: '#/components/schemas/IpPrefixList'
- xml:
name: assignedIpv6PrefixSet
description: The IPv6 prefixes that are assigned to the network interface.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
AssignPrivateIpAddressesResult:
type: object
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
AssignedPrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/AssignedPrivateIpAddressList'
- xml:
name: assignedPrivateIpAddressesSet
description: The private IP addresses assigned to the network interface.
AssignedIpv4Prefixes:
allOf:
- $ref: '#/components/schemas/Ipv4PrefixesList'
- xml:
name: assignedIpv4PrefixSet
description: The IPv4 prefixes that are assigned to the network interface.
AssignPrivateNatGatewayAddressResult:
type: object
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- xml:
name: natGatewayId
description: The ID of the NAT gateway.
NatGatewayAddresses:
allOf:
- $ref: '#/components/schemas/NatGatewayAddressList'
- xml:
name: natGatewayAddressSet
description: NAT gateway IP addresses.
AssociateAddressResult:
type: object
example:
AssociationId: eipassoc-2bebb745
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The ID that represents the association of the Elastic IP address with an instance.
AssociateClientVpnTargetNetworkResult:
type: object
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The unique ID of the target network association.
Status:
allOf:
- $ref: '#/components/schemas/AssociationStatus'
- xml:
name: status
description: The current state of the target network association.
AssociateEnclaveCertificateIamRoleResult:
type: object
properties:
CertificateS3BucketName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: certificateS3BucketName
description: The name of the Amazon S3 bucket to which the certificate was uploaded.
CertificateS3ObjectKey:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: certificateS3ObjectKey
description: '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.'
EncryptionKmsKeyId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: encryptionKmsKeyId
description: The ID of the KMS key used to encrypt the private key of the certificate.
AssociateIamInstanceProfileResult:
type: object
example:
IamInstanceProfileAssociation:
AssociationId: iip-assoc-0e7736511a163c209
IamInstanceProfile:
Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
Id: AIPAJBLK7RKJKWDXVHIEC
InstanceId: i-123456789abcde123
State: associating
properties:
IamInstanceProfileAssociation:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociation'
- xml:
name: iamInstanceProfileAssociation
description: Information about the IAM instance profile association.
AssociateInstanceEventWindowResult:
type: object
properties:
InstanceEventWindow:
allOf:
- $ref: '#/components/schemas/InstanceEventWindow'
- xml:
name: instanceEventWindow
description: Information about the event window.
InstanceIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: item
TagList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Tag'
- xml:
name: item
DedicatedHostIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/DedicatedHostId'
- xml:
name: item
AssociateIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscoveryAssociation:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryAssociation'
- xml:
name: ipamResourceDiscoveryAssociation
description: A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM.
AssociateNatGatewayAddressResult:
type: object
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- xml:
name: natGatewayId
description: The ID of the NAT gateway.
NatGatewayAddresses:
allOf:
- $ref: '#/components/schemas/NatGatewayAddressList'
- xml:
name: natGatewayAddressSet
description: The IP addresses.
AllocationId:
type: string
AssociateRouteTableResult:
type: object
example:
AssociationId: rtbassoc-781d0d1a
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The route table association ID. This ID is required for disassociating the route table.
AssociationState:
allOf:
- $ref: '#/components/schemas/RouteTableAssociationState'
- xml:
name: associationState
description: The state of the association.
AssociateSubnetCidrBlockResult:
type: object
properties:
Ipv6CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
- xml:
name: ipv6CidrBlockAssociation
description: Information about the IPv6 association.
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetId
description: The ID of the subnet.
AssociateTransitGatewayMulticastDomainResult:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- xml:
name: associations
description: Information about the transit gateway multicast domain associations.
SubnetId:
type: string
AssociateTransitGatewayPolicyTableResult:
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableAssociation'
- xml:
name: association
description: Describes the association of a transit gateway and a transit gateway policy table.
AssociateTransitGatewayRouteTableResult:
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociation'
- xml:
name: association
description: The ID of the association.
AssociateTrunkInterfaceResult:
type: object
properties:
InterfaceAssociation:
allOf:
- $ref: '#/components/schemas/TrunkInterfaceAssociation'
- xml:
name: interfaceAssociation
description: Information about the association between the trunk network interface and branch network interface.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
AssociateVpcCidrBlockResult:
type: object
properties:
Ipv6CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- xml:
name: ipv6CidrBlockAssociation
description: Information about the IPv6 CIDR block association.
CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockAssociation'
- xml:
name: cidrBlockAssociation
description: Information about the IPv4 CIDR block association.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
AttachClassicLinkVpcResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
AttachNetworkInterfaceResult:
type: object
example:
AttachmentId: eni-attach-66c4350a
properties:
AttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: attachmentId
description: The ID of the network interface attachment.
NetworkCardIndex:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: networkCardIndex
description: The index of the network card.
description: Contains the output of AttachNetworkInterface.
Boolean:
type: boolean
EnaSrdUdpSpecification:
type: object
properties:
EnaSrdUdpEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether UDP traffic uses ENA Express. To specify this setting, you must first enable ENA Express.'
description: '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.'
AttachVerifiedAccessTrustProviderResult:
type: object
properties:
VerifiedAccessTrustProvider:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProvider'
- xml:
name: verifiedAccessTrustProvider
description: The ID of the Verified Access trust provider.
VerifiedAccessInstance:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstance'
- xml:
name: verifiedAccessInstance
description: The ID of the Verified Access instance.
VolumeAttachment:
type: object
example:
AttachTime: '2014-02-27T19:23:06.000Z'
Device: /dev/sdb
InstanceId: i-1234567890abcdef0
State: detaching
VolumeId: vol-049df61146c4d7901
properties:
AttachTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: attachTime
description: The time stamp when the attachment initiated.
Device:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: device
description: The device name.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
State:
allOf:
- $ref: '#/components/schemas/VolumeAttachmentState'
- xml:
name: status
description: The attachment state of the volume.
VolumeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeId
description: The ID of the volume.
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: Indicates whether the EBS volume is deleted on instance termination.
description: Describes volume attachment details.
AttachVpnGatewayResult:
type: object
properties:
VpcAttachment:
allOf:
- $ref: '#/components/schemas/VpcAttachment'
- xml:
name: attachment
description: Information about the attachment.
description: Contains the output of AttachVpnGateway.
AuthorizeClientVpnIngressResult:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- xml:
name: status
description: The current state of the authorization rule.
AuthorizeSecurityGroupEgressResult:
type: object
example: {}
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, returns an error.'
SecurityGroupRules:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleList'
- xml:
name: securityGroupRuleSet
description: Information about the outbound (egress) security group rules that were added.
IpPermission:
type: object
properties:
FromPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: fromPort
description: 'If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, this is the type number. A value of -1 indicates all ICMP/ICMPv6 types. If you specify all ICMP/ICMPv6 types, you must specify all ICMP/ICMPv6 codes.'
IpProtocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipProtocol
description: 'The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols. When authorizing security group rules, specifying -1 or a protocol number other than tcp, udp, icmp, or icmpv6 allows traffic on all ports, regardless of any port range you specify. For tcp, udp, and icmp, you must specify a port range. For icmpv6, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.
true if the request succeeds; otherwise, returns an error.'
SecurityGroupRules:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleList'
- xml:
name: securityGroupRuleSet
description: Information about the inbound (ingress) security group rules that were added.
BundleInstanceResult:
type: object
properties:
BundleTask:
allOf:
- $ref: '#/components/schemas/BundleTask'
- xml:
name: bundleInstanceTask
description: Information about the bundle task.
description: Contains the output of BundleInstance.
S3Storage:
type: object
properties:
AWSAccessKeyId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The access key ID of the owner of the bucket. Before you specify a value for your access key ID, review and follow the guidance in Best Practices for Amazon Web Services accounts in the Account ManagementReference Guide.'
Bucket:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: bucket
description: '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.'
Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: prefix
description: The beginning of the file name of the AMI.
UploadPolicy:
allOf:
- $ref: '#/components/schemas/Blob'
- xml:
name: uploadPolicy
description: An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.
UploadPolicySignature:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: uploadPolicySignature
description: The signature of the JSON document.
description: Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.
CancelBundleTaskResult:
type: object
properties:
BundleTask:
allOf:
- $ref: '#/components/schemas/BundleTask'
- xml:
name: bundleInstanceTask
description: Information about the bundle task.
description: Contains the output of CancelBundleTask.
CancelCapacityReservationResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
CancelCapacityReservationFleetsResult:
type: object
properties:
SuccessfulFleetCancellations:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetCancellationStateSet'
- xml:
name: successfulFleetCancellationSet
description: Information about the Capacity Reservation Fleets that were successfully cancelled.
FailedFleetCancellations:
allOf:
- $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResultSet'
- xml:
name: failedFleetCancellationSet
description: Information about the Capacity Reservation Fleets that could not be cancelled.
CapacityReservationFleetId:
type: string
CancelImageLaunchPermissionResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
CancelImportTaskResult:
type: object
properties:
ImportTaskId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: importTaskId
description: The ID of the task being canceled.
PreviousState:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: previousState
description: The current state of the task being canceled.
State:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: state
description: The current state of the task being canceled.
CancelReservedInstancesListingResult:
type: object
properties:
ReservedInstancesListings:
allOf:
- $ref: '#/components/schemas/ReservedInstancesListingList'
- xml:
name: reservedInstancesListingsSet
description: The Reserved Instance listing.
description: Contains the output of CancelReservedInstancesListing.
CancelSpotFleetRequestsResponse:
type: object
example:
SuccessfulFleetRequests:
- CurrentSpotFleetRequestState: cancelled_terminating
PreviousSpotFleetRequestState: active
SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
properties:
SuccessfulFleetRequests:
allOf:
- $ref: '#/components/schemas/CancelSpotFleetRequestsSuccessSet'
- xml:
name: successfulFleetRequestSet
description: Information about the Spot Fleet requests that are successfully canceled.
UnsuccessfulFleetRequests:
allOf:
- $ref: '#/components/schemas/CancelSpotFleetRequestsErrorSet'
- xml:
name: unsuccessfulFleetRequestSet
description: Information about the Spot Fleet requests that are not successfully canceled.
description: Contains the output of CancelSpotFleetRequests.
SpotFleetRequestId:
type: string
CancelSpotInstanceRequestsResult:
type: object
example:
CancelledSpotInstanceRequests:
- SpotInstanceRequestId: sir-08b93456
State: cancelled
properties:
CancelledSpotInstanceRequests:
allOf:
- $ref: '#/components/schemas/CancelledSpotInstanceRequestList'
- xml:
name: spotInstanceRequestSet
description: The Spot Instance requests.
description: Contains the output of CancelSpotInstanceRequests.
SpotInstanceRequestId:
type: string
ConfirmProductInstanceResult:
type: object
example:
OwnerId: '123456789012'
properties:
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The Amazon Web Services account ID of the instance owner. This is only present if the product code is attached to the instance.
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: The return value of the request. Returns true if the specified product code is owned by the requester and associated with the specified instance.
CopyFpgaImageResult:
type: object
properties:
FpgaImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: fpgaImageId
description: The ID of the new AFI.
CopyImageResult:
type: object
example:
ImageId: ami-438bea42
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The ID of the new AMI.
description: Contains the output of CopyImage.
CopySnapshotResult:
type: object
example:
SnapshotId: snap-066877671789bd71b
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the new snapshot.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags applied to the new snapshot.
CreateCapacityReservationResult:
type: object
properties:
CapacityReservation:
allOf:
- $ref: '#/components/schemas/CapacityReservation'
- xml:
name: capacityReservation
description: Information about the Capacity Reservation.
CreateCapacityReservationFleetResult:
type: object
properties:
CapacityReservationFleetId:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetId'
- xml:
name: capacityReservationFleetId
description: The ID of the Capacity Reservation Fleet.
State:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetState'
- xml:
name: state
description: The status of the Capacity Reservation Fleet.
TotalTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalTargetCapacity
description: The total number of capacity units for which the Capacity Reservation Fleet reserves capacity.
TotalFulfilledCapacity:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: totalFulfilledCapacity
description: The requested capacity units that have been successfully reserved.
InstanceMatchCriteria:
allOf:
- $ref: '#/components/schemas/FleetInstanceMatchCriteria'
- xml:
name: instanceMatchCriteria
description: The instance matching criteria for the Capacity Reservation Fleet.
AllocationStrategy:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: allocationStrategy
description: The allocation strategy used by the Capacity Reservation Fleet.
CreateTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: createTime
description: The date and time at which the Capacity Reservation Fleet was created.
EndDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: endDate
description: The date and time at which the Capacity Reservation Fleet expires.
Tenancy:
allOf:
- $ref: '#/components/schemas/FleetCapacityReservationTenancy'
- xml:
name: tenancy
description: Indicates the tenancy of Capacity Reservation Fleet.
FleetCapacityReservations:
allOf:
- $ref: '#/components/schemas/FleetCapacityReservationSet'
- xml:
name: fleetCapacityReservationSet
description: Information about the individual Capacity Reservations in the Capacity Reservation Fleet.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the Capacity Reservation Fleet.
ReservationFleetInstanceSpecification:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: The instance type for which the Capacity Reservation Fleet reserves capacity.
InstancePlatform:
allOf:
- $ref: '#/components/schemas/CapacityReservationInstancePlatform'
- description: The type of operating system for which the Capacity Reservation Fleet reserves capacity.
Weight:
allOf:
- $ref: '#/components/schemas/DoubleWithConstraints'
- description: 'The number of capacity units provided by the specified instance type. This value, together with the total target capacity that you specify for the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see Total target capacity in the Amazon EC2 User Guide.'
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
AvailabilityZoneId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.
EbsOptimized:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using EBS-optimized instance types.
Priority:
allOf:
- $ref: '#/components/schemas/IntegerWithConstraints'
- description: 'The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see Instance type priority in the Amazon EC2 User Guide.'
description: Information about an instance type to use in a Capacity Reservation Fleet.
CreateCarrierGatewayResult:
type: object
properties:
CarrierGateway:
allOf:
- $ref: '#/components/schemas/CarrierGateway'
- xml:
name: carrierGateway
description: Information about the carrier gateway.
CreateClientVpnEndpointResult:
type: object
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientVpnEndpointId
description: The ID of the Client VPN endpoint.
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointStatus'
- xml:
name: status
description: The current state of the Client VPN endpoint.
DnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: dnsName
description: The DNS name to be used by clients when establishing their VPN session.
ClientVpnAuthenticationRequest:
type: object
properties:
Type:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthenticationType'
- description: The type of client authentication to be used.
ActiveDirectory:
allOf:
- $ref: '#/components/schemas/DirectoryServiceAuthenticationRequest'
- description: 'Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.'
MutualAuthentication:
allOf:
- $ref: '#/components/schemas/CertificateAuthenticationRequest'
- description: 'Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.'
FederatedAuthentication:
allOf:
- $ref: '#/components/schemas/FederatedAuthenticationRequest'
- description: 'Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.'
description: 'Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.'
CreateClientVpnRouteResult:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnRouteStatus'
- xml:
name: status
description: The current state of the route.
CreateCoipCidrResult:
type: object
properties:
CoipCidr:
allOf:
- $ref: '#/components/schemas/CoipCidr'
- xml:
name: coipCidr
description: ' Information about a range of customer-owned IP addresses. '
CreateCoipPoolResult:
type: object
properties:
CoipPool:
allOf:
- $ref: '#/components/schemas/CoipPool'
- xml:
name: coipPool
description: Information about the CoIP address pool.
CreateCustomerGatewayResult:
type: object
example:
CustomerGateway:
BgpAsn: '65534'
CustomerGatewayId: cgw-0e11f167
IpAddress: 12.1.2.3
State: available
Type: ipsec.1
properties:
CustomerGateway:
allOf:
- $ref: '#/components/schemas/CustomerGateway'
- xml:
name: customerGateway
description: Information about the customer gateway.
description: Contains the output of CreateCustomerGateway.
CreateDefaultSubnetResult:
type: object
properties:
Subnet:
allOf:
- $ref: '#/components/schemas/Subnet'
- xml:
name: subnet
description: Information about the subnet.
CreateDefaultVpcResult:
type: object
properties:
Vpc:
allOf:
- $ref: '#/components/schemas/Vpc'
- xml:
name: vpc
description: Information about the VPC.
CreateDhcpOptionsResult:
type: object
example:
DhcpOptions:
DhcpConfigurations:
- Key: domain-name-servers
Values:
- Value: 10.2.5.2
- Value: 10.2.5.1
DhcpOptionsId: dopt-d9070ebb
properties:
DhcpOptions:
allOf:
- $ref: '#/components/schemas/DhcpOptions'
- xml:
name: dhcpOptions
description: A set of DHCP options.
NewDhcpConfiguration:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: key
Values:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: Value
CreateEgressOnlyInternetGatewayResult:
type: object
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
EgressOnlyInternetGateway:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGateway'
- xml:
name: egressOnlyInternetGateway
description: Information about the egress-only internet gateway.
CreateFleetResult:
type: object
properties:
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- xml:
name: fleetId
description: The ID of the EC2 Fleet.
Errors:
allOf:
- $ref: '#/components/schemas/CreateFleetErrorsSet'
- xml:
name: errorSet
description: Information about the instances that could not be launched by the fleet. Supported only for fleets of type instant.
Instances:
allOf:
- $ref: '#/components/schemas/CreateFleetInstancesSet'
- xml:
name: fleetInstanceSet
description: Information about the instances that were launched by the fleet. Supported only for fleets of type instant.
SpotAllocationStrategy:
type: string
enum:
- lowest-price
- diversified
- capacity-optimized
- capacity-optimized-prioritized
- price-capacity-optimized
FleetSpotMaintenanceStrategiesRequest:
type: object
properties:
CapacityRebalance:
allOf:
- $ref: '#/components/schemas/FleetSpotCapacityRebalanceRequest'
- description: The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.
description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
SpotInstanceInterruptionBehavior:
type: string
enum:
- hibernate
- stop
- terminate
Integer:
type: integer
FleetOnDemandAllocationStrategy:
type: string
enum:
- lowest-price
- prioritized
CapacityReservationOptionsRequest:
type: object
properties:
UsageStrategy:
allOf:
- $ref: '#/components/schemas/FleetCapacityReservationUsageStrategy'
- description: '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.
' description: '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.
' FleetLaunchTemplateConfigRequest: type: object properties: LaunchTemplateSpecification: allOf: - $ref: '#/components/schemas/FleetLaunchTemplateSpecificationRequest' - description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request. ' Overrides: allOf: - $ref: '#/components/schemas/FleetLaunchTemplateOverridesListRequest' - description: 'Any parameters that you specify override the same parameters in the launch template.
For fleets of type request and maintain, a maximum of 300 items is allowed across all launch templates.
/dev/sdh or xvdh).'
VirtualName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: virtualName
description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
' Ebs: allOf: - $ref: '#/components/schemas/EbsBlockDevice' - xml: name: ebs description: Parameters used to automatically set up EBS volumes when the instance is launched. NoDevice: allOf: - $ref: '#/components/schemas/String' - xml: name: noDevice description: '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.' description: 'Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.' CreateInstanceConnectEndpointResult: type: object properties: InstanceConnectEndpoint: allOf: - $ref: '#/components/schemas/Ec2InstanceConnectEndpoint' - xml: name: instanceConnectEndpoint description: Information about the EC2 Instance Connect Endpoint. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive idempotency token provided by the client in the the request.' CreateInstanceEventWindowResult: type: object properties: InstanceEventWindow: allOf: - $ref: '#/components/schemas/InstanceEventWindow' - xml: name: instanceEventWindow description: Information about the event window. InstanceEventWindowTimeRangeRequest: type: object properties: StartWeekDay: allOf: - $ref: '#/components/schemas/WeekDay' - description: The day on which the time range begins. StartHour: allOf: - $ref: '#/components/schemas/Hour' - description: The hour when the time range begins. EndWeekDay: allOf: - $ref: '#/components/schemas/WeekDay' - description: The day on which the time range ends. EndHour: allOf: - $ref: '#/components/schemas/Hour' - description: The hour when the time range ends. description: 'The start day and time and the end day and time of the time range, in UTC.' CreateInstanceExportTaskResult: type: object properties: ExportTask: allOf: - $ref: '#/components/schemas/ExportTask' - xml: name: exportTask description: Information about the export instance task. ContainerFormat: type: string enum: - ova DiskImageFormat: type: string enum: - VMDK - RAW - VHD CreateInternetGatewayResult: type: object example: InternetGateway: Attachments: [] InternetGatewayId: igw-c0a643a9 Tags: [] properties: InternetGateway: allOf: - $ref: '#/components/schemas/InternetGateway' - xml: name: internetGateway description: Information about the internet gateway. CreateIpamResult: type: object properties: Ipam: allOf: - $ref: '#/components/schemas/Ipam' - xml: name: ipam description: Information about the IPAM created. AddIpamOperatingRegion: type: object properties: RegionName: allOf: - $ref: '#/components/schemas/String' - description: The name of the operating Region. description: '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.
' CreateIpamPoolResult: type: object properties: IpamPool: allOf: - $ref: '#/components/schemas/IpamPool' - xml: name: ipamPool description: Information about the IPAM pool created. RequestIpamResourceTag: type: object properties: Key: allOf: - $ref: '#/components/schemas/String' - description: 'The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.' Value: allOf: - $ref: '#/components/schemas/String' - description: The value for the tag. description: A tag on an IPAM resource. CreateIpamResourceDiscoveryResult: type: object properties: IpamResourceDiscovery: allOf: - $ref: '#/components/schemas/IpamResourceDiscovery' - xml: name: ipamResourceDiscovery description: An IPAM resource discovery. CreateIpamScopeResult: type: object properties: IpamScope: allOf: - $ref: '#/components/schemas/IpamScope' - xml: name: ipamScope description: Information about the created scope. KeyPair: type: object properties: KeyFingerprint: allOf: - $ref: '#/components/schemas/String' - xml: name: keyFingerprint description: 'For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
true to enable detailed monitoring. Otherwise, basic monitoring is enabled.'
description: Describes the monitoring for the instance.
LaunchTemplatePlacementRequest:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The Availability Zone for the instance.
Affinity:
allOf:
- $ref: '#/components/schemas/String'
- description: The affinity setting for an instance on a Dedicated Host.
GroupName:
allOf:
- $ref: '#/components/schemas/PlacementGroupName'
- description: The name of the placement group for the instance.
HostId:
allOf:
- $ref: '#/components/schemas/DedicatedHostId'
- description: The ID of the Dedicated Host for the instance.
Tenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- description: The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
SpreadDomain:
allOf:
- $ref: '#/components/schemas/String'
- description: Reserved for future use.
HostResourceGroupArn:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the Tenancy parameter or set it to host.'
PartitionNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
GroupId:
allOf:
- $ref: '#/components/schemas/PlacementGroupId'
- description: The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
description: Describes the placement of an instance.
RamdiskId:
type: string
ShutdownBehavior:
type: string
enum:
- stop
- terminate
SensitiveUserData:
type: string
format: password
LaunchTemplateTagSpecificationRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequest'
- xml:
name: LaunchTemplateTagSpecificationRequest
ElasticGpuSpecificationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticGpuSpecification'
- xml:
name: ElasticGpuSpecification
LaunchTemplateElasticInferenceAcceleratorList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateElasticInferenceAccelerator'
- xml:
name: item
SecurityGroupIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: SecurityGroupId
SecurityGroupStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupName'
- xml:
name: SecurityGroup
LaunchTemplateInstanceMarketOptionsRequest:
type: object
properties:
MarketType:
allOf:
- $ref: '#/components/schemas/MarketType'
- description: The market type.
SpotOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpotMarketOptionsRequest'
- description: The options for Spot Instances.
description: The market (purchasing) option for the instances.
CreditSpecificationRequest:
type: object
required:
- CpuCredits
properties:
CpuCredits:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The credit option for CPU usage of a T instance.
Valid values: standard | unlimited
1. Otherwise, specify the default value of 2.'
AmdSevSnp:
allOf:
- $ref: '#/components/schemas/AmdSevSnpSpecification'
- description: '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.'
description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
LaunchTemplateCapacityReservationSpecificationRequest:
type: object
properties:
CapacityReservationPreference:
allOf:
- $ref: '#/components/schemas/CapacityReservationPreference'
- description: 'Indicates the instance''s Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.'
LaunchTemplateLicenseSpecificationListRequest:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateLicenseConfigurationRequest'
- xml:
name: item
LaunchTemplateHibernationOptionsRequest:
type: object
properties:
Configured:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If you set this parameter to true, the instance is enabled for hibernation.
Default: false
IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to required).
optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' HttpEndpoint: allOf: - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataEndpointState' - description: 'Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
true.'
description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
InstanceRequirementsRequest:
type: object
required:
- VCpuCount
- MemoryMiB
properties:
VCpuCount:
allOf:
- $ref: '#/components/schemas/VCpuCountRangeRequest'
- description: The minimum and maximum number of vCPUs.
MemoryMiB:
allOf:
- $ref: '#/components/schemas/MemoryMiBRequest'
- description: 'The minimum and maximum amount of memory, in MiB.'
CpuManufacturers:
allOf:
- $ref: '#/components/schemas/CpuManufacturerSet'
- xml:
name: CpuManufacturer
description: 'The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don''t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
' MemoryGiBPerVCpu: allOf: - $ref: '#/components/schemas/MemoryGiBPerVCpuRequest' - description: 'The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' ExcludedInstanceTypes: allOf: - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - xml: name: ExcludedInstanceType description: 'The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance family, type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can''t specify AllowedInstanceTypes.
Default: No excluded instance types
' InstanceGenerations: allOf: - $ref: '#/components/schemas/InstanceGenerationSet' - xml: name: InstanceGeneration description: 'Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
' SpotMaxPricePercentageOverLowestPrice: allOf: - $ref: '#/components/schemas/Integer' - description: 'The price protection threshold for Spot Instance. This is the maximum you’ll pay for an Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
' LocalStorage: allOf: - $ref: '#/components/schemas/LocalStorage' - description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: hdd and ssd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
' BaselineEbsBandwidthMbps: allOf: - $ref: '#/components/schemas/BaselineEbsBandwidthMbpsRequest' - description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' AcceleratorTypes: allOf: - $ref: '#/components/schemas/AcceleratorTypeSet' - xml: name: AcceleratorType description: 'The accelerator types that must be on the instance type.
To include instance types with GPU hardware, specify gpu.
To include instance types with FPGA hardware, specify fpga.
To include instance types with inference hardware, specify inference.
Default: Any accelerator type
' AcceleratorCount: allOf: - $ref: '#/components/schemas/AcceleratorCountRequest' - description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' AcceleratorManufacturers: allOf: - $ref: '#/components/schemas/AcceleratorManufacturerSet' - xml: name: AcceleratorManufacturer description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' AcceleratorNames: allOf: - $ref: '#/components/schemas/AcceleratorNameSet' - xml: name: AcceleratorName description: 'The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.
Default: Any accelerator
' AcceleratorTotalMemoryMiB: allOf: - $ref: '#/components/schemas/AcceleratorTotalMemoryMiBRequest' - description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' NetworkBandwidthGbps: allOf: - $ref: '#/components/schemas/NetworkBandwidthGbpsRequest' - description: 'The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see Amazon EC2 instance network bandwidth in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' AllowedInstanceTypes: allOf: - $ref: '#/components/schemas/AllowedInstanceTypeSet' - xml: name: AllowedInstanceType description: 'The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
If you specify AllowedInstanceTypes, you can''t specify ExcludedInstanceTypes.
Default: All instance types
' description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can''t specify InstanceRequirements.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' LaunchTemplatePrivateDnsNameOptionsRequest: type: object properties: HostnameType: allOf: - $ref: '#/components/schemas/HostnameType' - description: 'The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.' EnableResourceNameDnsARecord: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records. EnableResourceNameDnsAAAARecord: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. description: Describes the options for instance hostnames. LaunchTemplateInstanceMaintenanceOptionsRequest: type: object properties: AutoRecovery: allOf: - $ref: '#/components/schemas/LaunchTemplateAutoRecoveryState' - description: 'Disables the automatic recovery behavior of your instance or sets it to default. For more information, see Simplified automatic recovery.' description: The maintenance options of your instance. CreateLaunchTemplateVersionResult: type: object example: LaunchTemplateVersion: CreateTime: '2017-12-01T13:35:46.000Z' CreatedBy: 'arn:aws:iam::123456789012:root' DefaultVersion: false LaunchTemplateData: ImageId: ami-c998b6b2 InstanceType: t2.micro NetworkInterfaces: - AssociatePublicIpAddress: true DeviceIndex: 0 Ipv6Addresses: - Ipv6Address: '2001:db8:1234:1a00::123' SubnetId: subnet-7b16de0c LaunchTemplateId: lt-0abcd290751193123 LaunchTemplateName: my-template VersionDescription: WebVersion2 VersionNumber: 2 properties: LaunchTemplateVersion: allOf: - $ref: '#/components/schemas/LaunchTemplateVersion' - xml: name: launchTemplateVersion description: Information about the launch template version. Warning: allOf: - $ref: '#/components/schemas/ValidationWarning' - xml: name: warning description: '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.' CreateLocalGatewayRouteResult: type: object properties: Route: allOf: - $ref: '#/components/schemas/LocalGatewayRoute' - xml: name: route description: Information about the route. CreateLocalGatewayRouteTableResult: type: object properties: LocalGatewayRouteTable: allOf: - $ref: '#/components/schemas/LocalGatewayRouteTable' - xml: name: localGatewayRouteTable description: Information about the local gateway route table. CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult: type: object properties: LocalGatewayRouteTableVirtualInterfaceGroupAssociation: allOf: - $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociation' - xml: name: localGatewayRouteTableVirtualInterfaceGroupAssociation description: Information about the local gateway route table virtual interface group association. CreateLocalGatewayRouteTableVpcAssociationResult: type: object properties: LocalGatewayRouteTableVpcAssociation: allOf: - $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation' - xml: name: localGatewayRouteTableVpcAssociation description: Information about the association. CreateManagedPrefixListResult: type: object properties: PrefixList: allOf: - $ref: '#/components/schemas/ManagedPrefixList' - xml: name: prefixList description: Information about the prefix list. AddPrefixListEntry: type: object required: - Cidr properties: Cidr: allOf: - $ref: '#/components/schemas/String' - description: The CIDR block. Description: allOf: - $ref: '#/components/schemas/String' - description: 'A description for the entry.
Constraints: Up to 255 characters in length.
' description: An entry for a prefix list. CreateNatGatewayResult: type: object example: NatGateway: CreateTime: '2015-12-17T12:45:26.732Z' NatGatewayAddresses: - AllocationId: eipalloc-37fc1a52 NatGatewayId: nat-08d48af2a8e83edfd State: pending SubnetId: subnet-1a2b3c4d VpcId: vpc-1122aabb properties: ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request.' NatGateway: allOf: - $ref: '#/components/schemas/NatGateway' - xml: name: natGateway description: Information about the NAT gateway. CreateNetworkAclResult: type: object example: NetworkAcl: Associations: [] Entries: - CidrBlock: 0.0.0.0/0 Egress: true Protocol: '-1' RuleAction: deny RuleNumber: 32767 - CidrBlock: 0.0.0.0/0 Egress: false Protocol: '-1' RuleAction: deny RuleNumber: 32767 IsDefault: false NetworkAclId: acl-5fb85d36 Tags: [] VpcId: vpc-a01106c2 properties: NetworkAcl: allOf: - $ref: '#/components/schemas/NetworkAcl' - xml: name: networkAcl description: Information about the network ACL. CreateNetworkInsightsAccessScopeResult: type: object properties: NetworkInsightsAccessScope: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScope' - xml: name: networkInsightsAccessScope description: The Network Access Scope. NetworkInsightsAccessScopeContent: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScopeContent' - xml: name: networkInsightsAccessScopeContent description: The Network Access Scope content. AccessScopePathRequest: type: object properties: Source: allOf: - $ref: '#/components/schemas/PathStatementRequest' - description: The source. Destination: allOf: - $ref: '#/components/schemas/PathStatementRequest' - description: The destination. ThroughResources: allOf: - $ref: '#/components/schemas/ThroughResourcesStatementRequestList' - xml: name: ThroughResource description: The through resources. description: Describes a path. CreateNetworkInsightsPathResult: type: object properties: NetworkInsightsPath: allOf: - $ref: '#/components/schemas/NetworkInsightsPath' - xml: name: networkInsightsPath description: Information about the path. IpAddress: type: string pattern: '^([0-9]{1,3}.){3}[0-9]{1,3}$' minLength: 0 maxLength: 15 RequestFilterPortRange: type: object properties: FromPort: allOf: - $ref: '#/components/schemas/Port' - description: The first port in the range. ToPort: allOf: - $ref: '#/components/schemas/Port' - description: The last port in the range. description: Describes a port range. CreateNetworkInterfaceResult: type: object example: NetworkInterface: AvailabilityZone: us-east-1d Description: my network interface Groups: - GroupId: sg-903004f8 GroupName: default MacAddress: '02:1a:80:41:52:9c' NetworkInterfaceId: eni-e5aa89a3 OwnerId: '123456789012' PrivateIpAddress: 10.0.2.17 PrivateIpAddresses: - Primary: true PrivateIpAddress: 10.0.2.17 RequesterManaged: false SourceDestCheck: true Status: pending SubnetId: subnet-9d4a7b6c TagSet: [] VpcId: vpc-a01106c2 properties: NetworkInterface: allOf: - $ref: '#/components/schemas/NetworkInterface' - xml: name: networkInterface description: Information about the network interface. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: The token to use to retrieve the next page of results. This value isnull when there are no more results to return.
InstanceIpv6Address:
type: object
properties:
Ipv6Address:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6Address
description: The IPv6 address.
IsPrimaryIpv6:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isPrimaryIpv6
description: 'Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see RunInstances.'
description: Describes an IPv6 address.
PrivateIpAddressSpecification:
type: object
properties:
Primary:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: primary
description: Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateIpAddress
description: The private IPv4 address.
description: Describes a secondary private IPv4 address for a network interface.
Ipv4PrefixSpecificationRequest:
type: object
properties:
Ipv4Prefix:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.'
description: Describes the IPv4 prefix option for a network interface.
Ipv6PrefixSpecificationRequest:
type: object
properties:
Ipv6Prefix:
allOf:
- $ref: '#/components/schemas/String'
- description: The IPv6 prefix.
description: Describes the IPv4 prefix option for a network interface.
CreateNetworkInterfacePermissionResult:
type: object
properties:
InterfacePermission:
allOf:
- $ref: '#/components/schemas/NetworkInterfacePermission'
- xml:
name: interfacePermission
description: Information about the permission for the network interface.
description: Contains the output of CreateNetworkInterfacePermission.
CreatePlacementGroupResult:
type: object
example: {}
properties:
PlacementGroup:
allOf:
- $ref: '#/components/schemas/PlacementGroup'
- xml:
name: placementGroup
description: Information about the placement group.
CreatePublicIpv4PoolResult:
type: object
properties:
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- xml:
name: poolId
description: The ID of the public IPv4 pool.
CreateReplaceRootVolumeTaskResult:
type: object
properties:
ReplaceRootVolumeTask:
allOf:
- $ref: '#/components/schemas/ReplaceRootVolumeTask'
- xml:
name: replaceRootVolumeTask
description: Information about the root volume replacement task.
CreateReservedInstancesListingResult:
type: object
properties:
ReservedInstancesListings:
allOf:
- $ref: '#/components/schemas/ReservedInstancesListingList'
- xml:
name: reservedInstancesListingsSet
description: Information about the Standard Reserved Instance listing.
description: Contains the output of CreateReservedInstancesListing.
PriceScheduleSpecification:
type: object
properties:
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency is USD.'
Price:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: price
description: The fixed price for the term.
Term:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: term
description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.'
description: Describes the price for a Reserved Instance.
CreateRestoreImageTaskResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The AMI ID.
CreateRouteResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
CreateRouteTableResult:
type: object
example:
RouteTable:
Associations: []
PropagatingVgws: []
RouteTableId: rtb-22574640
Routes:
- DestinationCidrBlock: 10.0.0.0/16
GatewayId: local
State: active
Tags: []
VpcId: vpc-a01106c2
properties:
RouteTable:
allOf:
- $ref: '#/components/schemas/RouteTable'
- xml:
name: routeTable
description: Information about the route table.
CreateSecurityGroupResult:
type: object
example:
GroupId: sg-903004f8
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the security group.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the security group.
Snapshot:
type: object
example:
Description: This is my root volume snapshot.
OwnerId: 012345678910
SnapshotId: snap-066877671789bd71b
StartTime: '2014-02-28T21:06:01.000Z'
State: pending
Tags: []
VolumeId: vol-1234567890abcdef0
VolumeSize: 8
properties:
DataEncryptionKeyId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: dataEncryptionKeyId
description: 'The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by DescribeSnapshots.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description for the snapshot.
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: encrypted
description: Indicates whether the snapshot is encrypted.
KmsKeyId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kmsKeyId
description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the parent volume.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the EBS snapshot.
Progress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: progress
description: 'The progress of the snapshot, as a percentage.'
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: startTime
description: The time stamp when the snapshot was initiated.
State:
allOf:
- $ref: '#/components/schemas/SnapshotState'
- xml:
name: status
description: The snapshot state.
StateMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: 'Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper Key Management Service (KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by DescribeSnapshots.'
VolumeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeId
description: The ID of the volume that was used to create the snapshot. Snapshots created by the CopySnapshot action have an arbitrary volume ID that should not be used for any purpose.
VolumeSize:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: volumeSize
description: 'The size of the volume, in GiB.'
OwnerAlias:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerAlias
description: 'The Amazon Web Services owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console.'
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.'
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the snapshot.
StorageTier:
allOf:
- $ref: '#/components/schemas/StorageTier'
- xml:
name: storageTier
description: The storage tier in which the snapshot is stored. standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
RestoreExpiryTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: restoreExpiryTime
description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
SseType:
allOf:
- $ref: '#/components/schemas/SSEType'
- xml:
name: sseType
description: Reserved for future use.
description: Describes a snapshot.
CreateSnapshotsResult:
type: object
properties:
Snapshots:
allOf:
- $ref: '#/components/schemas/SnapshotSet'
- xml:
name: snapshotSet
description: List of snapshots.
InstanceIdWithVolumeResolver:
type: string
VolumeIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeId'
- xml:
name: VolumeId
CreateSpotDatafeedSubscriptionResult:
type: object
example:
SpotDatafeedSubscription:
Bucket: my-s3-bucket
OwnerId: '123456789012'
Prefix: spotdata
State: Active
properties:
SpotDatafeedSubscription:
allOf:
- $ref: '#/components/schemas/SpotDatafeedSubscription'
- xml:
name: spotDatafeedSubscription
description: The Spot Instance data feed subscription.
description: Contains the output of CreateSpotDatafeedSubscription.
CreateStoreImageTaskResult:
type: object
properties:
ObjectKey:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: objectKey
description: The name of the stored AMI object in the S3 bucket.
S3ObjectTag:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The key of the tag.
Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in length. May not begin with aws:.
The value of the tag.
Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.
' description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more information, see Categorizing your storage using tags in the Amazon Simple Storage Service User Guide.' CreateSubnetResult: type: object example: Subnet: AvailabilityZone: us-west-2c AvailableIpAddressCount: 251 CidrBlock: 10.0.1.0/24 State: pending SubnetId: subnet-9d4a7b6c VpcId: vpc-a01106c2 properties: Subnet: allOf: - $ref: '#/components/schemas/Subnet' - xml: name: subnet description: Information about the subnet. CreateSubnetCidrReservationResult: type: object properties: SubnetCidrReservation: allOf: - $ref: '#/components/schemas/SubnetCidrReservation' - xml: name: subnetCidrReservation description: Information about the created subnet CIDR reservation. TaggableResourceId: type: string Tag: type: object properties: Key: allOf: - $ref: '#/components/schemas/String' - xml: name: key description: 'The key of the tag.
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.
The value of the tag.
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.
' description: Describes a tag. CreateTrafficMirrorFilterResult: type: object properties: TrafficMirrorFilter: allOf: - $ref: '#/components/schemas/TrafficMirrorFilter' - xml: name: trafficMirrorFilter description: Information about the Traffic Mirror filter. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' CreateTrafficMirrorFilterRuleResult: type: object properties: TrafficMirrorFilterRule: allOf: - $ref: '#/components/schemas/TrafficMirrorFilterRule' - xml: name: trafficMirrorFilterRule description: The Traffic Mirror rule. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' CreateTrafficMirrorSessionResult: type: object properties: TrafficMirrorSession: allOf: - $ref: '#/components/schemas/TrafficMirrorSession' - xml: name: trafficMirrorSession description: Information about the Traffic Mirror session. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' CreateTrafficMirrorTargetResult: type: object properties: TrafficMirrorTarget: allOf: - $ref: '#/components/schemas/TrafficMirrorTarget' - xml: name: trafficMirrorTarget description: Information about the Traffic Mirror target. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' CreateTransitGatewayResult: type: object properties: TransitGateway: allOf: - $ref: '#/components/schemas/TransitGateway' - xml: name: transitGateway description: Information about the transit gateway. Long: type: integer AutoAcceptSharedAttachmentsValue: type: string enum: - enable - disable DefaultRouteTableAssociationValue: type: string enum: - enable - disable DefaultRouteTablePropagationValue: type: string enum: - enable - disable VpnEcmpSupportValue: type: string enum: - enable - disable DnsSupportValue: type: string enum: - enable - disable MulticastSupportValue: type: string enum: - enable - disable TransitGatewayCidrBlockStringList: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item CreateTransitGatewayConnectResult: type: object properties: TransitGatewayConnect: allOf: - $ref: '#/components/schemas/TransitGatewayConnect' - xml: name: transitGatewayConnect description: Information about the Connect attachment. ProtocolValue: type: string enum: - gre CreateTransitGatewayConnectPeerResult: type: object properties: TransitGatewayConnectPeer: allOf: - $ref: '#/components/schemas/TransitGatewayConnectPeer' - xml: name: transitGatewayConnectPeer description: Information about the Connect peer. CreateTransitGatewayMulticastDomainResult: type: object properties: TransitGatewayMulticastDomain: allOf: - $ref: '#/components/schemas/TransitGatewayMulticastDomain' - xml: name: transitGatewayMulticastDomain description: Information about the transit gateway multicast domain. Igmpv2SupportValue: type: string enum: - enable - disable StaticSourcesSupportValue: type: string enum: - enable - disable AutoAcceptSharedAssociationsValue: type: string enum: - enable - disable CreateTransitGatewayPeeringAttachmentResult: type: object properties: TransitGatewayPeeringAttachment: allOf: - $ref: '#/components/schemas/TransitGatewayPeeringAttachment' - xml: name: transitGatewayPeeringAttachment description: The transit gateway peering attachment. DynamicRoutingValue: type: string enum: - enable - disable CreateTransitGatewayPolicyTableResult: type: object properties: TransitGatewayPolicyTable: allOf: - $ref: '#/components/schemas/TransitGatewayPolicyTable' - xml: name: transitGatewayPolicyTable description: Describes the created transit gateway policy table. CreateTransitGatewayPrefixListReferenceResult: type: object properties: TransitGatewayPrefixListReference: allOf: - $ref: '#/components/schemas/TransitGatewayPrefixListReference' - xml: name: transitGatewayPrefixListReference description: Information about the prefix list reference. CreateTransitGatewayRouteResult: type: object properties: Route: allOf: - $ref: '#/components/schemas/TransitGatewayRoute' - xml: name: route description: Information about the route. CreateTransitGatewayRouteTableResult: type: object properties: TransitGatewayRouteTable: allOf: - $ref: '#/components/schemas/TransitGatewayRouteTable' - xml: name: transitGatewayRouteTable description: Information about the transit gateway route table. CreateTransitGatewayRouteTableAnnouncementResult: type: object properties: TransitGatewayRouteTableAnnouncement: allOf: - $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncement' - xml: name: transitGatewayRouteTableAnnouncement description: Provides details about the transit gateway route table announcement. CreateTransitGatewayVpcAttachmentResult: type: object properties: TransitGatewayVpcAttachment: allOf: - $ref: '#/components/schemas/TransitGatewayVpcAttachment' - xml: name: transitGatewayVpcAttachment description: Information about the VPC attachment. Ipv6SupportValue: type: string enum: - enable - disable ApplianceModeSupportValue: type: string enum: - enable - disable CreateVerifiedAccessEndpointResult: type: object properties: VerifiedAccessEndpoint: allOf: - $ref: '#/components/schemas/VerifiedAccessEndpoint' - xml: name: verifiedAccessEndpoint description: The ID of the Verified Access endpoint. VerifiedAccessEndpointProtocol: type: string enum: - http - https VerifiedAccessEndpointPortNumber: type: integer minimum: 1 maximum: 65535 LoadBalancerArn: type: string CreateVerifiedAccessEndpointSubnetIdList: type: array items: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: item NetworkInterfaceId: type: string CreateVerifiedAccessGroupResult: type: object properties: VerifiedAccessGroup: allOf: - $ref: '#/components/schemas/VerifiedAccessGroup' - xml: name: verifiedAccessGroup description: The ID of the Verified Access group. CreateVerifiedAccessInstanceResult: type: object properties: VerifiedAccessInstance: allOf: - $ref: '#/components/schemas/VerifiedAccessInstance' - xml: name: verifiedAccessInstance description: The ID of the Verified Access instance. CreateVerifiedAccessTrustProviderResult: type: object properties: VerifiedAccessTrustProvider: allOf: - $ref: '#/components/schemas/VerifiedAccessTrustProvider' - xml: name: verifiedAccessTrustProvider description: The ID of the Verified Access trust provider. ClientSecretType: type: string format: password Volume: type: object example: Attachments: [] AvailabilityZone: us-east-1a CreateTime: '2016-08-29T18:52:32.724Z' Iops: 1000 Size: 500 SnapshotId: snap-066877671789bd71b State: creating Tags: [] VolumeId: vol-1234567890abcdef0 VolumeType: io1 properties: Attachments: allOf: - $ref: '#/components/schemas/VolumeAttachmentList' - xml: name: attachmentSet description: Information about the volume attachments. AvailabilityZone: allOf: - $ref: '#/components/schemas/String' - xml: name: availabilityZone description: The Availability Zone for the volume. CreateTime: allOf: - $ref: '#/components/schemas/DateTime' - xml: name: createTime description: The time stamp when volume creation was initiated. Encrypted: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: encrypted description: Indicates whether the volume is encrypted. KmsKeyId: allOf: - $ref: '#/components/schemas/String' - xml: name: kmsKeyId description: The Amazon Resource Name (ARN) of the Key Management Service (KMS) KMS key that was used to protect the volume encryption key for the volume. OutpostArn: allOf: - $ref: '#/components/schemas/String' - xml: name: outpostArn description: The Amazon Resource Name (ARN) of the Outpost. Size: allOf: - $ref: '#/components/schemas/Integer' - xml: name: size description: 'The size of the volume, in GiBs.' SnapshotId: allOf: - $ref: '#/components/schemas/String' - xml: name: snapshotId description: 'The snapshot from which the volume was created, if applicable.' State: allOf: - $ref: '#/components/schemas/VolumeState' - xml: name: status description: The volume state. VolumeId: allOf: - $ref: '#/components/schemas/String' - xml: name: volumeId description: The ID of the volume. Iops: allOf: - $ref: '#/components/schemas/Integer' - xml: name: iops description: 'The number of I/O operations per second (IOPS). Forgp3, 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.'
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the volume.
VolumeType:
allOf:
- $ref: '#/components/schemas/VolumeType'
- xml:
name: volumeType
description: The volume type.
FastRestored:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: fastRestored
description: Indicates whether the volume was created using fast snapshot restore.
MultiAttachEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: multiAttachEnabled
description: Indicates whether Amazon EBS Multi-Attach is enabled.
Throughput:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: throughput
description: 'The throughput that the volume supports, in MiB/s.'
SseType:
allOf:
- $ref: '#/components/schemas/SSEType'
- xml:
name: sseType
description: Reserved for future use.
description: Describes a volume.
CreateVpcResult:
type: object
example:
Vpc:
CidrBlock: 10.0.0.0/16
DhcpOptionsId: dopt-7a8b9c2d
InstanceTenancy: default
State: pending
VpcId: vpc-a01106c2
properties:
Vpc:
allOf:
- $ref: '#/components/schemas/Vpc'
- xml:
name: vpc
description: Information about the VPC.
CreateVpcEndpointResult:
type: object
properties:
VpcEndpoint:
allOf:
- $ref: '#/components/schemas/VpcEndpoint'
- xml:
name: vpcEndpoint
description: Information about the endpoint.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
RouteTableId:
type: string
DnsRecordIpType:
type: string
enum:
- ipv4
- dualstack
- ipv6
- service-defined
CreateVpcEndpointConnectionNotificationResult:
type: object
properties:
ConnectionNotification:
allOf:
- $ref: '#/components/schemas/ConnectionNotification'
- xml:
name: connectionNotification
description: Information about the notification.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
CreateVpcEndpointServiceConfigurationResult:
type: object
properties:
ServiceConfiguration:
allOf:
- $ref: '#/components/schemas/ServiceConfiguration'
- xml:
name: serviceConfiguration
description: Information about the service configuration.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.'
CreateVpcPeeringConnectionResult:
type: object
properties:
VpcPeeringConnection:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnection'
- xml:
name: vpcPeeringConnection
description: Information about the VPC peering connection.
CreateVpnConnectionResult:
type: object
properties:
VpnConnection:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- xml:
name: vpnConnection
description: Information about the VPN connection.
description: Contains the output of CreateVpnConnection.
TunnelInsideIpVersion:
type: string
enum:
- ipv4
- ipv6
VpnTunnelOptionsSpecificationsList:
type: array
items:
$ref: '#/components/schemas/VpnTunnelOptionsSpecification'
TransitGatewayAttachmentId:
type: string
CreateVpnGatewayResult:
type: object
properties:
VpnGateway:
allOf:
- $ref: '#/components/schemas/VpnGateway'
- xml:
name: vpnGateway
description: Information about the virtual private gateway.
description: Contains the output of CreateVpnGateway.
DeleteCarrierGatewayResult:
type: object
properties:
CarrierGateway:
allOf:
- $ref: '#/components/schemas/CarrierGateway'
- xml:
name: carrierGateway
description: Information about the carrier gateway.
DeleteClientVpnEndpointResult:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointStatus'
- xml:
name: status
description: The current state of the Client VPN endpoint.
DeleteClientVpnRouteResult:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnRouteStatus'
- xml:
name: status
description: The current state of the route.
DeleteCoipCidrResult:
type: object
properties:
CoipCidr:
allOf:
- $ref: '#/components/schemas/CoipCidr'
- xml:
name: coipCidr
description: ' Information about a range of customer-owned IP addresses. '
DeleteCoipPoolResult:
type: object
properties:
CoipPool:
allOf:
- $ref: '#/components/schemas/CoipPool'
- xml:
name: coipPool
description: Information about the CoIP address pool.
DeleteEgressOnlyInternetGatewayResult:
type: object
properties:
ReturnCode:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: returnCode
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
DeleteFleetsResult:
type: object
properties:
SuccessfulFleetDeletions:
allOf:
- $ref: '#/components/schemas/DeleteFleetSuccessSet'
- xml:
name: successfulFleetDeletionSet
description: Information about the EC2 Fleets that are successfully deleted.
UnsuccessfulFleetDeletions:
allOf:
- $ref: '#/components/schemas/DeleteFleetErrorSet'
- xml:
name: unsuccessfulFleetDeletionSet
description: Information about the EC2 Fleets that are not successfully deleted.
FleetId:
type: string
DeleteFlowLogsResult:
type: object
properties:
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemSet'
- xml:
name: unsuccessful
description: Information about the flow logs that could not be deleted successfully.
VpcFlowLogId:
type: string
DeleteFpgaImageResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Is true if the request succeeds, and an error otherwise.'
DeleteInstanceConnectEndpointResult:
type: object
properties:
InstanceConnectEndpoint:
allOf:
- $ref: '#/components/schemas/Ec2InstanceConnectEndpoint'
- xml:
name: instanceConnectEndpoint
description: Information about the EC2 Instance Connect Endpoint.
DeleteInstanceEventWindowResult:
type: object
properties:
InstanceEventWindowState:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowStateChange'
- xml:
name: instanceEventWindowState
description: The state of the event window.
DeleteIpamResult:
type: object
properties:
Ipam:
allOf:
- $ref: '#/components/schemas/Ipam'
- xml:
name: ipam
description: Information about the results of the deletion.
DeleteIpamPoolResult:
type: object
properties:
IpamPool:
allOf:
- $ref: '#/components/schemas/IpamPool'
- xml:
name: ipamPool
description: Information about the results of the deletion.
DeleteIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscovery:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscovery'
- xml:
name: ipamResourceDiscovery
description: The IPAM resource discovery.
DeleteIpamScopeResult:
type: object
properties:
IpamScope:
allOf:
- $ref: '#/components/schemas/IpamScope'
- xml:
name: ipamScope
description: Information about the results of the deletion.
DeleteLaunchTemplateResult:
type: object
example:
LaunchTemplate:
CreateTime: '2017-11-23T16:46:25.000Z'
CreatedBy: 'arn:aws:iam::123456789012:root'
DefaultVersionNumber: 2
LatestVersionNumber: 2
LaunchTemplateId: lt-0abcd290751193123
LaunchTemplateName: my-template
properties:
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplate'
- xml:
name: launchTemplate
description: Information about the launch template.
DeleteLaunchTemplateVersionsResult:
type: object
example:
SuccessfullyDeletedLaunchTemplateVersions:
- LaunchTemplateId: lt-0abcd290751193123
LaunchTemplateName: my-template
VersionNumber: 1
UnsuccessfullyDeletedLaunchTemplateVersions: []
properties:
SuccessfullyDeletedLaunchTemplateVersions:
allOf:
- $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessSet'
- xml:
name: successfullyDeletedLaunchTemplateVersionSet
description: Information about the launch template versions that were successfully deleted.
UnsuccessfullyDeletedLaunchTemplateVersions:
allOf:
- $ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorSet'
- xml:
name: unsuccessfullyDeletedLaunchTemplateVersionSet
description: Information about the launch template versions that could not be deleted.
DeleteLocalGatewayRouteResult:
type: object
properties:
Route:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoute'
- xml:
name: route
description: Information about the route.
DeleteLocalGatewayRouteTableResult:
type: object
properties:
LocalGatewayRouteTable:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTable'
- xml:
name: localGatewayRouteTable
description: Information about the local gateway route table.
DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationResult:
type: object
properties:
LocalGatewayRouteTableVirtualInterfaceGroupAssociation:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociation'
- xml:
name: localGatewayRouteTableVirtualInterfaceGroupAssociation
description: Information about the association.
DeleteLocalGatewayRouteTableVpcAssociationResult:
type: object
properties:
LocalGatewayRouteTableVpcAssociation:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
- xml:
name: localGatewayRouteTableVpcAssociation
description: Information about the association.
DeleteManagedPrefixListResult:
type: object
properties:
PrefixList:
allOf:
- $ref: '#/components/schemas/ManagedPrefixList'
- xml:
name: prefixList
description: Information about the prefix list.
DeleteNatGatewayResult:
type: object
example:
NatGatewayId: nat-04ae55e711cec5680
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: natGatewayId
description: The ID of the NAT gateway.
DeleteNetworkInsightsAccessScopeResult:
type: object
properties:
NetworkInsightsAccessScopeId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- xml:
name: networkInsightsAccessScopeId
description: The ID of the Network Access Scope.
DeleteNetworkInsightsAccessScopeAnalysisResult:
type: object
properties:
NetworkInsightsAccessScopeAnalysisId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- xml:
name: networkInsightsAccessScopeAnalysisId
description: The ID of the Network Access Scope analysis.
DeleteNetworkInsightsAnalysisResult:
type: object
properties:
NetworkInsightsAnalysisId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- xml:
name: networkInsightsAnalysisId
description: The ID of the network insights analysis.
DeleteNetworkInsightsPathResult:
type: object
properties:
NetworkInsightsPathId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathId'
- xml:
name: networkInsightsPathId
description: The ID of the path.
DeleteNetworkInterfacePermissionResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds, otherwise returns an error.'
description: Contains the output for DeleteNetworkInterfacePermission.
DeletePublicIpv4PoolResult:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: returnValue
description: Information about the result of deleting the public IPv4 pool.
DeleteQueuedReservedInstancesResult:
type: object
properties:
SuccessfulQueuedPurchaseDeletions:
allOf:
- $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletionSet'
- xml:
name: successfulQueuedPurchaseDeletionSet
description: Information about the queued purchases that were successfully deleted.
FailedQueuedPurchaseDeletions:
allOf:
- $ref: '#/components/schemas/FailedQueuedPurchaseDeletionSet'
- xml:
name: failedQueuedPurchaseDeletionSet
description: Information about the queued purchases that could not be deleted.
DeleteSubnetCidrReservationResult:
type: object
properties:
DeletedSubnetCidrReservation:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservation'
- xml:
name: deletedSubnetCidrReservation
description: Information about the deleted subnet CIDR reservation.
DeleteTrafficMirrorFilterResult:
type: object
properties:
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorFilterId
description: The ID of the Traffic Mirror filter.
DeleteTrafficMirrorFilterRuleResult:
type: object
properties:
TrafficMirrorFilterRuleId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorFilterRuleId
description: The ID of the deleted Traffic Mirror rule.
DeleteTrafficMirrorSessionResult:
type: object
properties:
TrafficMirrorSessionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorSessionId
description: The ID of the deleted Traffic Mirror session.
DeleteTrafficMirrorTargetResult:
type: object
properties:
TrafficMirrorTargetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorTargetId
description: The ID of the deleted Traffic Mirror target.
DeleteTransitGatewayResult:
type: object
properties:
TransitGateway:
allOf:
- $ref: '#/components/schemas/TransitGateway'
- xml:
name: transitGateway
description: Information about the deleted transit gateway.
DeleteTransitGatewayConnectResult:
type: object
properties:
TransitGatewayConnect:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnect'
- xml:
name: transitGatewayConnect
description: Information about the deleted Connect attachment.
DeleteTransitGatewayConnectPeerResult:
type: object
properties:
TransitGatewayConnectPeer:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeer'
- xml:
name: transitGatewayConnectPeer
description: Information about the deleted Connect peer.
DeleteTransitGatewayMulticastDomainResult:
type: object
properties:
TransitGatewayMulticastDomain:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomain'
- xml:
name: transitGatewayMulticastDomain
description: Information about the deleted transit gateway multicast domain.
DeleteTransitGatewayPeeringAttachmentResult:
type: object
properties:
TransitGatewayPeeringAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- xml:
name: transitGatewayPeeringAttachment
description: The transit gateway peering attachment.
DeleteTransitGatewayPolicyTableResult:
type: object
properties:
TransitGatewayPolicyTable:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTable'
- xml:
name: transitGatewayPolicyTable
description: Provides details about the deleted transit gateway policy table.
DeleteTransitGatewayPrefixListReferenceResult:
type: object
properties:
TransitGatewayPrefixListReference:
allOf:
- $ref: '#/components/schemas/TransitGatewayPrefixListReference'
- xml:
name: transitGatewayPrefixListReference
description: Information about the deleted prefix list reference.
DeleteTransitGatewayRouteResult:
type: object
properties:
Route:
allOf:
- $ref: '#/components/schemas/TransitGatewayRoute'
- xml:
name: route
description: Information about the route.
DeleteTransitGatewayRouteTableResult:
type: object
properties:
TransitGatewayRouteTable:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTable'
- xml:
name: transitGatewayRouteTable
description: Information about the deleted transit gateway route table.
DeleteTransitGatewayRouteTableAnnouncementResult:
type: object
properties:
TransitGatewayRouteTableAnnouncement:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncement'
- xml:
name: transitGatewayRouteTableAnnouncement
description: Provides details about a deleted transit gateway route table.
DeleteTransitGatewayVpcAttachmentResult:
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- xml:
name: transitGatewayVpcAttachment
description: Information about the deleted VPC attachment.
DeleteVerifiedAccessEndpointResult:
type: object
properties:
VerifiedAccessEndpoint:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpoint'
- xml:
name: verifiedAccessEndpoint
description: The ID of the Verified Access endpoint.
DeleteVerifiedAccessGroupResult:
type: object
properties:
VerifiedAccessGroup:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroup'
- xml:
name: verifiedAccessGroup
description: The ID of the Verified Access group.
DeleteVerifiedAccessInstanceResult:
type: object
properties:
VerifiedAccessInstance:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstance'
- xml:
name: verifiedAccessInstance
description: The ID of the Verified Access instance.
DeleteVerifiedAccessTrustProviderResult:
type: object
properties:
VerifiedAccessTrustProvider:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProvider'
- xml:
name: verifiedAccessTrustProvider
description: The ID of the Verified Access trust provider.
DeleteVpcEndpointConnectionNotificationsResult:
type: object
properties:
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemSet'
- xml:
name: unsuccessful
description: Information about the notifications that could not be deleted successfully.
ConnectionNotificationId:
type: string
DeleteVpcEndpointServiceConfigurationsResult:
type: object
properties:
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemSet'
- xml:
name: unsuccessful
description: 'Information about the service configurations that were not deleted, if applicable.'
VpcEndpointServiceId:
type: string
DeleteVpcEndpointsResult:
type: object
properties:
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemSet'
- xml:
name: unsuccessful
description: Information about the VPC endpoints that were not successfully deleted.
DeleteVpcPeeringConnectionResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
DeprovisionByoipCidrResult:
type: object
properties:
ByoipCidr:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- xml:
name: byoipCidr
description: Information about the address range.
DeprovisionIpamPoolCidrResult:
type: object
properties:
IpamPoolCidr:
allOf:
- $ref: '#/components/schemas/IpamPoolCidr'
- xml:
name: ipamPoolCidr
description: The deprovisioned pool CIDR.
DeprovisionPublicIpv4PoolCidrResult:
type: object
properties:
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- xml:
name: poolId
description: The ID of the pool that you deprovisioned the CIDR from.
DeprovisionedAddresses:
allOf:
- $ref: '#/components/schemas/DeprovisionedAddressSet'
- xml:
name: deprovisionedAddressSet
description: The deprovisioned CIDRs.
DeregisterInstanceEventNotificationAttributesResult:
type: object
properties:
InstanceTagAttribute:
allOf:
- $ref: '#/components/schemas/InstanceTagNotificationAttribute'
- xml:
name: instanceTagAttribute
description: The resulting set of tag keys.
InstanceTagKeySet:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
DeregisterTransitGatewayMulticastGroupMembersResult:
type: object
properties:
DeregisteredMulticastGroupMembers:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupMembers'
- xml:
name: deregisteredMulticastGroupMembers
description: Information about the deregistered members.
DeregisterTransitGatewayMulticastGroupSourcesResult:
type: object
properties:
DeregisteredMulticastGroupSources:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDeregisteredGroupSources'
- xml:
name: deregisteredMulticastGroupSources
description: Information about the deregistered group sources.
DescribeAccountAttributesResult:
type: object
example:
AccountAttributes:
- AttributeName: supported-platforms
AttributeValues:
- AttributeValue: EC2
- AttributeValue: VPC
- AttributeName: vpc-max-security-groups-per-interface
AttributeValues:
- AttributeValue: '5'
- AttributeName: max-elastic-ips
AttributeValues:
- AttributeValue: '5'
- AttributeName: max-instances
AttributeValues:
- AttributeValue: '20'
- AttributeName: vpc-max-elastic-ips
AttributeValues:
- AttributeValue: '5'
- AttributeName: default-vpc
AttributeValues:
- AttributeValue: none
properties:
AccountAttributes:
allOf:
- $ref: '#/components/schemas/AccountAttributeList'
- xml:
name: accountAttributeSet
description: Information about the account attributes.
AccountAttributeName:
type: string
enum:
- supported-platforms
- default-vpc
DescribeAddressTransfersResult:
type: object
properties:
AddressTransfers:
allOf:
- $ref: '#/components/schemas/AddressTransferList'
- xml:
name: addressTransferSet
description: The Elastic IP address transfer.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: Specify the pagination token from a previous request to retrieve the next page of results.
DescribeAddressesResult:
type: object
example:
Addresses:
- Domain: standard
InstanceId: i-1234567890abcdef0
PublicIp: 198.51.100.0
- AllocationId: eipalloc-12345678
AssociationId: eipassoc-12345678
Domain: vpc
InstanceId: i-1234567890abcdef0
NetworkInterfaceId: eni-12345678
NetworkInterfaceOwnerId: '123456789012'
PrivateIpAddress: 10.0.1.241
PublicIp: 203.0.113.0
properties:
Addresses:
allOf:
- $ref: '#/components/schemas/AddressList'
- xml:
name: addressesSet
description: Information about the Elastic IP addresses.
Filter:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the filter. Filter names are case-sensitive.
Values:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: Value
description: 'The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.'
description: 'A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.
If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.
null when there are no more results to return.
DescribeAggregateIdFormatResult:
type: object
properties:
UseLongIdsAggregated:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: useLongIdsAggregated
description: Indicates whether all resource types in the Region are configured to use longer IDs. This value is only true if all users are configured to use longer IDs for all resources types in the Region.
Statuses:
allOf:
- $ref: '#/components/schemas/IdFormatList'
- xml:
name: statusSet
description: Information about each resource's ID format.
DescribeAvailabilityZonesResult:
type: object
example:
AvailabilityZones:
- Messages: []
RegionName: us-east-1
State: available
ZoneName: us-east-1b
- Messages: []
RegionName: us-east-1
State: available
ZoneName: us-east-1c
- Messages: []
RegionName: us-east-1
State: available
ZoneName: us-east-1d
- Messages: []
RegionName: us-east-1
State: available
ZoneName: us-east-1e
properties:
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneList'
- xml:
name: availabilityZoneInfo
description: 'Information about the Availability Zones, Local Zones, and Wavelength Zones.'
DescribeAwsNetworkPerformanceMetricSubscriptionsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Subscriptions:
allOf:
- $ref: '#/components/schemas/SubscriptionList'
- xml:
name: subscriptionSet
description: Describes the current Infrastructure Performance subscriptions.
DescribeBundleTasksResult:
type: object
properties:
BundleTasks:
allOf:
- $ref: '#/components/schemas/BundleTaskList'
- xml:
name: bundleInstanceTasksSet
description: Information about the bundle tasks.
BundleId:
type: string
DescribeByoipCidrsResult:
type: object
properties:
ByoipCidrs:
allOf:
- $ref: '#/components/schemas/ByoipCidrSet'
- xml:
name: byoipCidrSet
description: Information about your address ranges.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeCapacityReservationFleetsResult:
type: object
properties:
CapacityReservationFleets:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetSet'
- xml:
name: capacityReservationFleetSet
description: Information about the Capacity Reservation Fleets.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeCapacityReservationsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
CapacityReservations:
allOf:
- $ref: '#/components/schemas/CapacityReservationSet'
- xml:
name: capacityReservationSet
description: Information about the Capacity Reservations.
CapacityReservationId:
type: string
DescribeCarrierGatewaysResult:
type: object
properties:
CarrierGateways:
allOf:
- $ref: '#/components/schemas/CarrierGatewaySet'
- xml:
name: carrierGatewaySet
description: Information about the carrier gateway.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
CarrierGatewayId:
type: string
DescribeClassicLinkInstancesResult:
type: object
properties:
Instances:
allOf:
- $ref: '#/components/schemas/ClassicLinkInstanceList'
- xml:
name: instancesSet
description: Information about one or more linked EC2-Classic instances.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
InstanceId:
type: string
DescribeClientVpnAuthorizationRulesResult:
type: object
properties:
AuthorizationRules:
allOf:
- $ref: '#/components/schemas/AuthorizationRuleSet'
- xml:
name: authorizationRule
description: Information about the authorization rules.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeClientVpnConnectionsResult:
type: object
properties:
Connections:
allOf:
- $ref: '#/components/schemas/ClientVpnConnectionSet'
- xml:
name: connections
description: Information about the active and terminated client connections.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeClientVpnEndpointsResult:
type: object
properties:
ClientVpnEndpoints:
allOf:
- $ref: '#/components/schemas/EndpointSet'
- xml:
name: clientVpnEndpoint
description: Information about the Client VPN endpoints.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
ClientVpnEndpointId:
type: string
DescribeClientVpnRoutesResult:
type: object
properties:
Routes:
allOf:
- $ref: '#/components/schemas/ClientVpnRouteSet'
- xml:
name: routes
description: Information about the Client VPN endpoint routes.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeClientVpnTargetNetworksResult:
type: object
properties:
ClientVpnTargetNetworks:
allOf:
- $ref: '#/components/schemas/TargetNetworkSet'
- xml:
name: clientVpnTargetNetworks
description: Information about the associated target networks.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeCoipPoolsResult:
type: object
properties:
CoipPools:
allOf:
- $ref: '#/components/schemas/CoipPoolSet'
- xml:
name: coipPoolSet
description: Information about the address pools.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Ipv4PoolCoipId:
type: string
DescribeConversionTasksResult:
type: object
properties:
ConversionTasks:
allOf:
- $ref: '#/components/schemas/DescribeConversionTaskList'
- xml:
name: conversionTasks
description: Information about the conversion tasks.
ConversionTaskId:
type: string
DescribeCustomerGatewaysResult:
type: object
example:
CustomerGateways:
- BgpAsn: '65534'
CustomerGatewayId: cgw-0e11f167
IpAddress: 12.1.2.3
State: available
Type: ipsec.1
properties:
CustomerGateways:
allOf:
- $ref: '#/components/schemas/CustomerGatewayList'
- xml:
name: customerGatewaySet
description: Information about one or more customer gateways.
description: Contains the output of DescribeCustomerGateways.
CustomerGatewayId:
type: string
DescribeDhcpOptionsResult:
type: object
example:
DhcpOptions:
- DhcpConfigurations:
- Key: domain-name-servers
Values:
- Value: 10.2.5.2
- Value: 10.2.5.1
DhcpOptionsId: dopt-d9070ebb
properties:
DhcpOptions:
allOf:
- $ref: '#/components/schemas/DhcpOptionsList'
- xml:
name: dhcpOptionsSet
description: Information about one or more DHCP options sets.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DhcpOptionsId:
type: string
DescribeEgressOnlyInternetGatewaysResult:
type: object
properties:
EgressOnlyInternetGateways:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayList'
- xml:
name: egressOnlyInternetGatewaySet
description: Information about the egress-only internet gateways.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
EgressOnlyInternetGatewayId:
type: string
DescribeElasticGpusResult:
type: object
properties:
ElasticGpuSet:
allOf:
- $ref: '#/components/schemas/ElasticGpuSet'
- xml:
name: elasticGpuSet
description: Information about the Elastic Graphics accelerators.
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxResults
description: The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
ElasticGpuId:
type: string
DescribeExportImageTasksResult:
type: object
properties:
ExportImageTasks:
allOf:
- $ref: '#/components/schemas/ExportImageTaskList'
- xml:
name: exportImageTaskSet
description: Information about the export image tasks.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to get the next page of results. This value is null when there are no more results to return.
ExportImageTaskId:
type: string
DescribeExportTasksResult:
type: object
properties:
ExportTasks:
allOf:
- $ref: '#/components/schemas/ExportTaskList'
- xml:
name: exportTaskSet
description: Information about the export tasks.
ExportTaskId:
type: string
DescribeFastLaunchImagesResult:
type: object
properties:
FastLaunchImages:
allOf:
- $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessSet'
- xml:
name: fastLaunchImageSet
description: A collection of details about the fast-launch enabled Windows images that meet the requested criteria.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeFastSnapshotRestoresResult:
type: object
properties:
FastSnapshotRestores:
allOf:
- $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessSet'
- xml:
name: fastSnapshotRestoreSet
description: Information about the state of fast snapshot restores.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeFleetHistoryResult:
type: object
properties:
HistoryRecords:
allOf:
- $ref: '#/components/schemas/HistoryRecordSet'
- xml:
name: historyRecordSet
description: Information about the events in the history of the EC2 Fleet.
LastEvaluatedTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: lastEvaluatedTime
description: 'The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
null when there are no more items to return.
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- xml:
name: fleetId
description: The ID of the EC Fleet.
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: startTime
description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
DescribeFleetInstancesResult:
type: object
properties:
ActiveInstances:
allOf:
- $ref: '#/components/schemas/ActiveInstanceSet'
- xml:
name: activeInstanceSet
description: The running instances. This list is refreshed periodically and might be out of date.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- xml:
name: fleetId
description: The ID of the EC2 Fleet.
DescribeFleetsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Fleets:
allOf:
- $ref: '#/components/schemas/FleetSet'
- xml:
name: fleetSet
description: Information about the EC2 Fleets.
DescribeFlowLogsResult:
type: object
properties:
FlowLogs:
allOf:
- $ref: '#/components/schemas/FlowLogSet'
- xml:
name: flowLogSet
description: Information about the flow logs.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to request the next page of items. This value is null when there are no more items to return.
DescribeFpgaImageAttributeResult:
type: object
properties:
FpgaImageAttribute:
allOf:
- $ref: '#/components/schemas/FpgaImageAttribute'
- xml:
name: fpgaImageAttribute
description: Information about the attribute.
DescribeFpgaImagesResult:
type: object
properties:
FpgaImages:
allOf:
- $ref: '#/components/schemas/FpgaImageList'
- xml:
name: fpgaImageSet
description: Information about the FPGA images.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
FpgaImageId:
type: string
DescribeHostReservationOfferingsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
OfferingSet:
allOf:
- $ref: '#/components/schemas/HostOfferingSet'
- xml:
name: offeringSet
description: Information about the offerings.
DescribeHostReservationsResult:
type: object
properties:
HostReservationSet:
allOf:
- $ref: '#/components/schemas/HostReservationSet'
- xml:
name: hostReservationSet
description: Details about the reservation's configuration.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
HostReservationId:
type: string
DescribeHostsResult:
type: object
properties:
Hosts:
allOf:
- $ref: '#/components/schemas/HostList'
- xml:
name: hostSet
description: Information about the Dedicated Hosts.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DedicatedHostId:
type: string
DescribeIamInstanceProfileAssociationsResult:
type: object
example:
IamInstanceProfileAssociations:
- AssociationId: iip-assoc-0db249b1f25fa24b8
IamInstanceProfile:
Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
Id: AIPAJVQN4F5WVLGCJDRGM
InstanceId: i-09eb09efa73ec1dee
State: associated
properties:
IamInstanceProfileAssociations:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociationSet'
- xml:
name: iamInstanceProfileAssociationSet
description: Information about the IAM instance profile associations.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
IamInstanceProfileAssociationId:
type: string
DescribeIdFormatResult:
type: object
properties:
Statuses:
allOf:
- $ref: '#/components/schemas/IdFormatList'
- xml:
name: statusSet
description: Information about the ID format for the resource.
DescribeIdentityIdFormatResult:
type: object
properties:
Statuses:
allOf:
- $ref: '#/components/schemas/IdFormatList'
- xml:
name: statusSet
description: Information about the ID format for the resources.
ImageAttribute:
type: object
example:
ImageId: ami-5731123e
LaunchPermissions:
- UserId: '123456789012'
properties:
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/BlockDeviceMappingList'
- xml:
name: blockDeviceMapping
description: The block device mapping entries.
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The ID of the AMI.
LaunchPermissions:
allOf:
- $ref: '#/components/schemas/LaunchPermissionList'
- xml:
name: launchPermission
description: The launch permissions.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeList'
- xml:
name: productCodes
description: The product codes.
Description:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: description
description: A description for the AMI.
KernelId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: kernel
description: The kernel ID.
RamdiskId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: ramdisk
description: The RAM disk ID.
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: sriovNetSupport
description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
BootMode:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: bootMode
description: The boot mode.
TpmSupport:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: tpmSupport
description: 'If the image is configured for NitroTPM support, the value is v2.0.'
UefiData:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: uefiData
description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.'
LastLaunchedTime:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: lastLaunchedTime
description: 'The date and time, in ISO 8601 date-time format, when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported.
lastLaunchedTime data is available starting April 2017.
v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.'
description: Describes an image attribute.
DescribeImagesResult:
type: object
example:
Images:
- Architecture: x86_64
BlockDeviceMappings:
- DeviceName: /dev/sda1
Ebs:
DeleteOnTermination: true
SnapshotId: snap-1234567890abcdef0
VolumeSize: 8
VolumeType: standard
Description: An AMI for my server
Hypervisor: xen
ImageId: ami-5731123e
ImageLocation: 123456789012/My server
ImageType: machine
KernelId: aki-88aa75e1
Name: My server
OwnerId: '123456789012'
Public: false
RootDeviceName: /dev/sda1
RootDeviceType: ebs
State: available
VirtualizationType: paravirtual
properties:
Images:
allOf:
- $ref: '#/components/schemas/ImageList'
- xml:
name: imagesSet
description: Information about the images.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeImportImageTasksResult:
type: object
properties:
ImportImageTasks:
allOf:
- $ref: '#/components/schemas/ImportImageTaskList'
- xml:
name: importImageTaskSet
description: A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to get the next page of results. This value is null when there are no more results to return.
ImportImageTaskId:
type: string
DescribeImportSnapshotTasksResult:
type: object
properties:
ImportSnapshotTasks:
allOf:
- $ref: '#/components/schemas/ImportSnapshotTaskList'
- xml:
name: importSnapshotTaskSet
description: A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to get the next page of results. This value is null when there are no more results to return.
ImportSnapshotTaskId:
type: string
InstanceAttribute:
type: object
example:
BlockDeviceMappings:
- DeviceName: /dev/sda1
Ebs:
AttachTime: '2013-05-17T22:42:34.000Z'
DeleteOnTermination: true
Status: attached
VolumeId: vol-049df61146c4d7901
- DeviceName: /dev/sdf
Ebs:
AttachTime: '2013-09-10T23:07:00.000Z'
DeleteOnTermination: false
Status: attached
VolumeId: vol-049df61146c4d7901
InstanceId: i-1234567890abcdef0
properties:
Groups:
allOf:
- $ref: '#/components/schemas/GroupIdentifierList'
- xml:
name: groupSet
description: The security groups associated with the instance.
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/InstanceBlockDeviceMappingList'
- xml:
name: blockDeviceMapping
description: The block device mapping of the instance.
DisableApiTermination:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: disableApiTermination
description: 'If the value is true, you can''t terminate the instance through the Amazon EC2 console, CLI, or API; otherwise, you can.'
EnaSupport:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: enaSupport
description: Indicates whether enhanced networking with ENA is enabled.
EnclaveOptions:
allOf:
- $ref: '#/components/schemas/EnclaveOptions'
- xml:
name: enclaveOptions
description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true; otherwise, set it to false.'
EbsOptimized:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: ebsOptimized
description: Indicates whether the instance is optimized for Amazon EBS I/O.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
InstanceInitiatedShutdownBehavior:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: instanceInitiatedShutdownBehavior
description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
InstanceType:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: instanceType
description: The instance type.
KernelId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: kernel
description: The kernel ID.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeList'
- xml:
name: productCodes
description: A list of product codes.
RamdiskId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: ramdisk
description: The RAM disk ID.
RootDeviceName:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: rootDeviceName
description: 'The device name of the root device volume (for example, /dev/sda1).'
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: sourceDestCheck
description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: sriovNetSupport
description: Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
UserData:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: userData
description: The user data.
DisableApiStop:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: disableApiStop
description: 'To enable the instance for Amazon Web Services Stop Protection, set this parameter to true; otherwise, set it to false.'
description: Describes an instance attribute.
DescribeInstanceConnectEndpointsResult:
type: object
properties:
InstanceConnectEndpoints:
allOf:
- $ref: '#/components/schemas/InstanceConnectEndpointSet'
- xml:
name: instanceConnectEndpointSet
description: Information about the EC2 Instance Connect Endpoints.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeInstanceCreditSpecificationsResult:
type: object
properties:
InstanceCreditSpecifications:
allOf:
- $ref: '#/components/schemas/InstanceCreditSpecificationList'
- xml:
name: instanceCreditSpecificationSet
description: Information about the credit option for CPU usage of an instance.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeInstanceEventNotificationAttributesResult:
type: object
properties:
InstanceTagAttribute:
allOf:
- $ref: '#/components/schemas/InstanceTagNotificationAttribute'
- xml:
name: instanceTagAttribute
description: Information about the registered tag keys.
DescribeInstanceEventWindowsResult:
type: object
properties:
InstanceEventWindows:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowSet'
- xml:
name: instanceEventWindowSet
description: Information about the event windows.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: 'The token to use to retrieve the next page of results. This value is null when there are no more results to return. '
InstanceEventWindowId:
type: string
DescribeInstanceStatusResult:
type: object
example:
InstanceStatuses:
- AvailabilityZone: us-east-1d
InstanceId: i-1234567890abcdef0
InstanceState:
Code: 16
Name: running
InstanceStatus:
Details:
- Name: reachability
Status: passed
Status: ok
SystemStatus:
Details:
- Name: reachability
Status: passed
Status: ok
properties:
InstanceStatuses:
allOf:
- $ref: '#/components/schemas/InstanceStatusList'
- xml:
name: instanceStatusSet
description: Information about the status of the instances.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeInstanceTypeOfferingsResult:
type: object
properties:
InstanceTypeOfferings:
allOf:
- $ref: '#/components/schemas/InstanceTypeOfferingsList'
- xml:
name: instanceTypeOfferingSet
description: The instance types offered.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeInstanceTypesResult:
type: object
properties:
InstanceTypes:
allOf:
- $ref: '#/components/schemas/InstanceTypeInfoList'
- xml:
name: instanceTypeSet
description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeInstancesResult:
type: object
example: {}
properties:
Reservations:
allOf:
- $ref: '#/components/schemas/ReservationList'
- xml:
name: reservationSet
description: Information about the reservations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeInternetGatewaysResult:
type: object
example:
InternetGateways:
- Attachments:
- State: attached
VpcId: vpc-a01106c2
InternetGatewayId: igw-c0a643a9
Tags: []
properties:
InternetGateways:
allOf:
- $ref: '#/components/schemas/InternetGatewayList'
- xml:
name: internetGatewaySet
description: Information about one or more internet gateways.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
InternetGatewayId:
type: string
DescribeIpamPoolsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
IpamPools:
allOf:
- $ref: '#/components/schemas/IpamPoolSet'
- xml:
name: ipamPoolSet
description: Information about the IPAM pools.
DescribeIpamResourceDiscoveriesResult:
type: object
properties:
IpamResourceDiscoveries:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoverySet'
- xml:
name: ipamResourceDiscoverySet
description: The resource discoveries.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: Specify the pagination token from a previous request to retrieve the next page of results.
DescribeIpamResourceDiscoveryAssociationsResult:
type: object
properties:
IpamResourceDiscoveryAssociations:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryAssociationSet'
- xml:
name: ipamResourceDiscoveryAssociationSet
description: The resource discovery associations.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: Specify the pagination token from a previous request to retrieve the next page of results.
DescribeIpamScopesResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
IpamScopes:
allOf:
- $ref: '#/components/schemas/IpamScopeSet'
- xml:
name: ipamScopeSet
description: The scopes you want information on.
DescribeIpamsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Ipams:
allOf:
- $ref: '#/components/schemas/IpamSet'
- xml:
name: ipamSet
description: Information about the IPAMs.
DescribeIpv6PoolsResult:
type: object
properties:
Ipv6Pools:
allOf:
- $ref: '#/components/schemas/Ipv6PoolSet'
- xml:
name: ipv6PoolSet
description: Information about the IPv6 address pools.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Ipv6PoolEc2Id:
type: string
DescribeKeyPairsResult:
type: object
example:
KeyPairs:
- KeyFingerprint: '1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f'
KeyName: my-key-pair
properties:
KeyPairs:
allOf:
- $ref: '#/components/schemas/KeyPairList'
- xml:
name: keySet
description: Information about the key pairs.
KeyPairId:
type: string
DescribeLaunchTemplateVersionsResult:
type: object
example:
LaunchTemplateVersions:
- CreateTime: '2017-11-20T13:12:32.000Z'
CreatedBy: 'arn:aws:iam::123456789102:root'
DefaultVersion: false
LaunchTemplateData:
ImageId: ami-6057e21a
InstanceType: t2.medium
KeyName: kp-us-east
NetworkInterfaces:
- DeviceIndex: 0
Groups:
- sg-7c227019
SubnetId: subnet-1a2b3c4d
LaunchTemplateId: lt-068f72b72934aff71
LaunchTemplateName: Webservers
VersionNumber: 2
- CreateTime: '2017-11-20T12:52:33.000Z'
CreatedBy: 'arn:aws:iam::123456789102:root'
DefaultVersion: true
LaunchTemplateData:
ImageId: ami-aabbcc11
InstanceType: t2.medium
KeyName: kp-us-east
NetworkInterfaces:
- AssociatePublicIpAddress: true
DeleteOnTermination: false
DeviceIndex: 0
Groups:
- sg-7c227019
SubnetId: subnet-7b16de0c
UserData: ''
LaunchTemplateId: lt-068f72b72934aff71
LaunchTemplateName: Webservers
VersionNumber: 1
properties:
LaunchTemplateVersions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateVersionSet'
- xml:
name: launchTemplateVersionSet
description: Information about the launch template versions.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeLaunchTemplatesResult:
type: object
example:
LaunchTemplates:
- CreateTime: '2018-01-16T04:32:57.000Z'
CreatedBy: 'arn:aws:iam::123456789012:root'
DefaultVersionNumber: 1
LatestVersionNumber: 1
LaunchTemplateId: lt-01238c059e3466abc
LaunchTemplateName: my-template
properties:
LaunchTemplates:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSet'
- xml:
name: launchTemplates
description: Information about the launch templates.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
LaunchTemplateId:
type: string
LaunchTemplateName:
type: string
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
minLength: 3
maxLength: 128
DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsResult:
type: object
properties:
LocalGatewayRouteTableVirtualInterfaceGroupAssociations:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet'
- xml:
name: localGatewayRouteTableVirtualInterfaceGroupAssociationSet
description: Information about the associations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
type: string
DescribeLocalGatewayRouteTableVpcAssociationsResult:
type: object
properties:
LocalGatewayRouteTableVpcAssociations:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationSet'
- xml:
name: localGatewayRouteTableVpcAssociationSet
description: Information about the associations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
LocalGatewayRouteTableVpcAssociationId:
type: string
DescribeLocalGatewayRouteTablesResult:
type: object
properties:
LocalGatewayRouteTables:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableSet'
- xml:
name: localGatewayRouteTableSet
description: Information about the local gateway route tables.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
LocalGatewayRoutetableId:
type: string
DescribeLocalGatewayVirtualInterfaceGroupsResult:
type: object
properties:
LocalGatewayVirtualInterfaceGroups:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupSet'
- xml:
name: localGatewayVirtualInterfaceGroupSet
description: The virtual interface groups.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
LocalGatewayVirtualInterfaceGroupId:
type: string
DescribeLocalGatewayVirtualInterfacesResult:
type: object
properties:
LocalGatewayVirtualInterfaces:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceSet'
- xml:
name: localGatewayVirtualInterfaceSet
description: Information about the virtual interfaces.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
LocalGatewayVirtualInterfaceId:
type: string
DescribeLocalGatewaysResult:
type: object
properties:
LocalGateways:
allOf:
- $ref: '#/components/schemas/LocalGatewaySet'
- xml:
name: localGatewaySet
description: Information about the local gateways.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
LocalGatewayId:
type: string
DescribeManagedPrefixListsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
PrefixLists:
allOf:
- $ref: '#/components/schemas/ManagedPrefixListSet'
- xml:
name: prefixListSet
description: Information about the prefix lists.
DescribeMovingAddressesResult:
type: object
example:
MovingAddressStatuses:
- MoveStatus: movingToVpc
PublicIp: 198.51.100.0
properties:
MovingAddressStatuses:
allOf:
- $ref: '#/components/schemas/MovingAddressStatusSet'
- xml:
name: movingAddressStatusSet
description: The status for each Elastic IP address.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeNatGatewaysResult:
type: object
example:
NatGateways:
- CreateTime: '2015-12-01T12:26:55.983Z'
NatGatewayAddresses:
- AllocationId: eipalloc-89c620ec
NetworkInterfaceId: eni-9dec76cd
PrivateIp: 10.0.0.149
PublicIp: 198.11.222.333
NatGatewayId: nat-05dba92075d71c408
State: available
SubnetId: subnet-847e4dc2
VpcId: vpc-1a2b3c4d
properties:
NatGateways:
allOf:
- $ref: '#/components/schemas/NatGatewayList'
- xml:
name: natGatewaySet
description: Information about the NAT gateways.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
NatGatewayId:
type: string
DescribeNetworkAclsResult:
type: object
example:
NetworkAcls:
- Associations:
- NetworkAclAssociationId: aclassoc-66ea5f0b
NetworkAclId: acl-9aeb5ef7
SubnetId: subnet-65ea5f08
Entries:
- CidrBlock: 0.0.0.0/0
Egress: true
Protocol: '-1'
RuleAction: deny
RuleNumber: 32767
- CidrBlock: 0.0.0.0/0
Egress: false
Protocol: '-1'
RuleAction: deny
RuleNumber: 32767
IsDefault: false
NetworkAclId: acl-5fb85d36
Tags: []
VpcId: vpc-a01106c2
properties:
NetworkAcls:
allOf:
- $ref: '#/components/schemas/NetworkAclList'
- xml:
name: networkAclSet
description: Information about one or more network ACLs.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
NetworkAclId:
type: string
DescribeNetworkInsightsAccessScopeAnalysesResult:
type: object
properties:
NetworkInsightsAccessScopeAnalyses:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisList'
- xml:
name: networkInsightsAccessScopeAnalysisSet
description: The Network Access Scope analyses.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
NetworkInsightsAccessScopeAnalysisId:
type: string
DescribeNetworkInsightsAccessScopesResult:
type: object
properties:
NetworkInsightsAccessScopes:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeList'
- xml:
name: networkInsightsAccessScopeSet
description: The Network Access Scopes.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
NetworkInsightsAccessScopeId:
type: string
DescribeNetworkInsightsAnalysesResult:
type: object
properties:
NetworkInsightsAnalyses:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysisList'
- xml:
name: networkInsightsAnalysisSet
description: Information about the network insights analyses.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
NetworkInsightsAnalysisId:
type: string
DescribeNetworkInsightsPathsResult:
type: object
properties:
NetworkInsightsPaths:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathList'
- xml:
name: networkInsightsPathSet
description: Information about the paths.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
NetworkInsightsPathId:
type: string
DescribeNetworkInterfaceAttributeResult:
type: object
example:
NetworkInterfaceId: eni-686ea200
SourceDestCheck:
Value: true
properties:
Attachment:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttachment'
- xml:
name: attachment
description: The attachment (if any) of the network interface.
Description:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: description
description: The description of the network interface.
Groups:
allOf:
- $ref: '#/components/schemas/GroupIdentifierList'
- xml:
name: groupSet
description: The security groups associated with the network interface.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: sourceDestCheck
description: Indicates whether source/destination checking is enabled.
description: Contains the output of DescribeNetworkInterfaceAttribute.
DescribeNetworkInterfacePermissionsResult:
type: object
properties:
NetworkInterfacePermissions:
allOf:
- $ref: '#/components/schemas/NetworkInterfacePermissionList'
- xml:
name: networkInterfacePermissions
description: The network interface permissions.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
description: Contains the output for DescribeNetworkInterfacePermissions.
NetworkInterfacePermissionId:
type: string
DescribeNetworkInterfacesResult:
type: object
example:
NetworkInterfaces:
- Association:
AssociationId: eipassoc-0fbb766a
IpOwnerId: '123456789012'
PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com
PublicIp: 203.0.113.12
Attachment:
AttachTime: '2013-11-30T23:36:42.000Z'
AttachmentId: eni-attach-66c4350a
DeleteOnTermination: false
DeviceIndex: 1
InstanceId: i-1234567890abcdef0
InstanceOwnerId: '123456789012'
Status: attached
AvailabilityZone: us-east-1d
Description: my network interface
Groups:
- GroupId: sg-8637d3e3
GroupName: default
MacAddress: '02:2f:8f:b0:cf:75'
NetworkInterfaceId: eni-e5aa89a3
OwnerId: '123456789012'
PrivateDnsName: ip-10-0-1-17.ec2.internal
PrivateIpAddress: 10.0.1.17
PrivateIpAddresses:
- Association:
AssociationId: eipassoc-0fbb766a
IpOwnerId: '123456789012'
PublicDnsName: ec2-203-0-113-12.compute-1.amazonaws.com
PublicIp: 203.0.113.12
Primary: true
PrivateDnsName: ip-10-0-1-17.ec2.internal
PrivateIpAddress: 10.0.1.17
RequesterManaged: false
SourceDestCheck: true
Status: in-use
SubnetId: subnet-b61f49f0
TagSet: []
VpcId: vpc-a01106c2
properties:
NetworkInterfaces:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceList'
- xml:
name: networkInterfaceSet
description: Information about one or more network interfaces.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribePlacementGroupsResult:
type: object
properties:
PlacementGroups:
allOf:
- $ref: '#/components/schemas/PlacementGroupList'
- xml:
name: placementGroupSet
description: Information about the placement groups.
PlacementGroupName:
type: string
PlacementGroupId:
type: string
DescribePrefixListsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
PrefixLists:
allOf:
- $ref: '#/components/schemas/PrefixListSet'
- xml:
name: prefixListSet
description: All available prefix lists.
PrefixListResourceId:
type: string
DescribePrincipalIdFormatResult:
type: object
properties:
Principals:
allOf:
- $ref: '#/components/schemas/PrincipalIdFormatList'
- xml:
name: principalSet
description: Information about the ID format settings for the ARN.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribePublicIpv4PoolsResult:
type: object
properties:
PublicIpv4Pools:
allOf:
- $ref: '#/components/schemas/PublicIpv4PoolSet'
- xml:
name: publicIpv4PoolSet
description: Information about the address pools.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
Ipv4PoolEc2Id:
type: string
DescribeRegionsResult:
type: object
example:
Regions:
- Endpoint: ec2.ap-south-1.amazonaws.com
RegionName: ap-south-1
- Endpoint: ec2.eu-west-1.amazonaws.com
RegionName: eu-west-1
- Endpoint: ec2.ap-southeast-1.amazonaws.com
RegionName: ap-southeast-1
- Endpoint: ec2.ap-southeast-2.amazonaws.com
RegionName: ap-southeast-2
- Endpoint: ec2.eu-central-1.amazonaws.com
RegionName: eu-central-1
- Endpoint: ec2.ap-northeast-2.amazonaws.com
RegionName: ap-northeast-2
- Endpoint: ec2.ap-northeast-1.amazonaws.com
RegionName: ap-northeast-1
- Endpoint: ec2.us-east-1.amazonaws.com
RegionName: us-east-1
- Endpoint: ec2.sa-east-1.amazonaws.com
RegionName: sa-east-1
- Endpoint: ec2.us-west-1.amazonaws.com
RegionName: us-west-1
- Endpoint: ec2.us-west-2.amazonaws.com
RegionName: us-west-2
properties:
Regions:
allOf:
- $ref: '#/components/schemas/RegionList'
- xml:
name: regionInfo
description: Information about the Regions.
DescribeReplaceRootVolumeTasksResult:
type: object
properties:
ReplaceRootVolumeTasks:
allOf:
- $ref: '#/components/schemas/ReplaceRootVolumeTasks'
- xml:
name: replaceRootVolumeTaskSet
description: Information about the root volume replacement task.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
ReplaceRootVolumeTaskId:
type: string
DescribeReservedInstancesResult:
type: object
properties:
ReservedInstances:
allOf:
- $ref: '#/components/schemas/ReservedInstancesList'
- xml:
name: reservedInstancesSet
description: A list of Reserved Instances.
description: Contains the output for DescribeReservedInstances.
DescribeReservedInstancesListingsResult:
type: object
properties:
ReservedInstancesListings:
allOf:
- $ref: '#/components/schemas/ReservedInstancesListingList'
- xml:
name: reservedInstancesListingsSet
description: Information about the Reserved Instance listing.
description: Contains the output of DescribeReservedInstancesListings.
DescribeReservedInstancesModificationsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
ReservedInstancesModifications:
allOf:
- $ref: '#/components/schemas/ReservedInstancesModificationList'
- xml:
name: reservedInstancesModificationsSet
description: The Reserved Instance modification information.
description: Contains the output of DescribeReservedInstancesModifications.
ReservedInstancesModificationId:
type: string
DescribeReservedInstancesOfferingsResult:
type: object
properties:
ReservedInstancesOfferings:
allOf:
- $ref: '#/components/schemas/ReservedInstancesOfferingList'
- xml:
name: reservedInstancesOfferingsSet
description: A list of Reserved Instances offerings.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
description: Contains the output of DescribeReservedInstancesOfferings.
ReservedInstancesOfferingId:
type: string
DescribeRouteTablesResult:
type: object
example:
RouteTables:
- Associations:
- Main: true
RouteTableAssociationId: rtbassoc-d8ccddba
RouteTableId: rtb-1f382e7d
PropagatingVgws: []
RouteTableId: rtb-1f382e7d
Routes:
- DestinationCidrBlock: 10.0.0.0/16
GatewayId: local
State: active
Tags: []
VpcId: vpc-a01106c2
properties:
RouteTables:
allOf:
- $ref: '#/components/schemas/RouteTableList'
- xml:
name: routeTableSet
description: Information about one or more route tables.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
description: Contains the output of DescribeRouteTables.
DescribeScheduledInstanceAvailabilityResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
ScheduledInstanceAvailabilitySet:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceAvailabilitySet'
- xml:
name: scheduledInstanceAvailabilitySet
description: Information about the available Scheduled Instances.
description: Contains the output of DescribeScheduledInstanceAvailability.
DateTime:
type: string
format: date-time
OccurrenceDayRequestSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: OccurenceDay
DescribeScheduledInstancesResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token required to retrieve the next set of results. This value is null when there are no more results to return.
ScheduledInstanceSet:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceSet'
- xml:
name: scheduledInstanceSet
description: Information about the Scheduled Instances.
description: Contains the output of DescribeScheduledInstances.
ScheduledInstanceId:
type: string
DescribeSecurityGroupReferencesResult:
type: object
example:
SecurityGroupReferenceSet:
- GroupId: sg-903004f8
ReferencingVpcId: vpc-1a2b3c4d
VpcPeeringConnectionId: pcx-b04deed9
properties:
SecurityGroupReferenceSet:
allOf:
- $ref: '#/components/schemas/SecurityGroupReferences'
- xml:
name: securityGroupReferenceSet
description: Information about the VPCs with the referencing security groups.
DescribeSecurityGroupRulesResult:
type: object
properties:
SecurityGroupRules:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleList'
- xml:
name: securityGroupRuleSet
description: Information about security group rules.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeSecurityGroupsResult:
type: object
example: {}
properties:
SecurityGroups:
allOf:
- $ref: '#/components/schemas/SecurityGroupList'
- xml:
name: securityGroupInfo
description: Information about the security groups.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
SecurityGroupName:
type: string
DescribeSnapshotAttributeResult:
type: object
example:
CreateVolumePermissions: []
SnapshotId: snap-066877671789bd71b
properties:
CreateVolumePermissions:
allOf:
- $ref: '#/components/schemas/CreateVolumePermissionList'
- xml:
name: createVolumePermission
description: The users and groups that have the permissions for creating volumes from the snapshot.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeList'
- xml:
name: productCodes
description: The product codes.
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the EBS snapshot.
DescribeSnapshotTierStatusResult:
type: object
properties:
SnapshotTierStatuses:
allOf:
- $ref: '#/components/schemas/snapshotTierStatusSet'
- xml:
name: snapshotTierStatusSet
description: Information about the snapshot's storage tier.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeSnapshotsResult:
type: object
example:
NextToken: ''
Snapshots:
- Description: This is my copied snapshot.
OwnerId: 012345678910
Progress: 87%
SnapshotId: snap-066877671789bd71b
StartTime: '2014-02-28T21:37:27.000Z'
State: pending
VolumeId: vol-1234567890abcdef0
VolumeSize: 8
properties:
Snapshots:
allOf:
- $ref: '#/components/schemas/SnapshotList'
- xml:
name: snapshotSet
description: Information about the snapshots.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to return the next page of snapshots. This value is null when there are no more snapshots to return.
SnapshotId:
type: string
DescribeSpotDatafeedSubscriptionResult:
type: object
example:
SpotDatafeedSubscription:
Bucket: my-s3-bucket
OwnerId: '123456789012'
Prefix: spotdata
State: Active
properties:
SpotDatafeedSubscription:
allOf:
- $ref: '#/components/schemas/SpotDatafeedSubscription'
- xml:
name: spotDatafeedSubscription
description: The Spot Instance data feed subscription.
description: Contains the output of DescribeSpotDatafeedSubscription.
DescribeSpotFleetInstancesResponse:
type: object
example:
ActiveInstances:
- InstanceId: i-1234567890abcdef0
InstanceType: m3.medium
SpotInstanceRequestId: sir-08b93456
SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
properties:
ActiveInstances:
allOf:
- $ref: '#/components/schemas/ActiveInstanceSet'
- xml:
name: activeInstanceSet
description: The running instances. This list is refreshed periodically and might be out of date.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
description: Contains the output of DescribeSpotFleetInstances.
DescribeSpotFleetRequestHistoryResponse:
type: object
example:
HistoryRecords:
- EventInformation:
EventSubType: submitted
EventType: fleetRequestChange
Timestamp: '2015-05-26T23:17:20.697Z'
- EventInformation:
EventSubType: active
EventType: fleetRequestChange
Timestamp: '2015-05-26T23:17:20.873Z'
- EventInformation:
EventSubType: launched
InstanceId: i-1234567890abcdef0
EventType: instanceChange
Timestamp: '2015-05-26T23:21:21.712Z'
- EventInformation:
EventSubType: launched
InstanceId: i-1234567890abcdef1
EventType: instanceChange
Timestamp: '2015-05-26T23:21:21.816Z'
NextToken: CpHNsscimcV5oH7bSbub03CI2Qms5+ypNpNm+53MNlR0YcXAkp0xFlfKf91yVxSExmbtma3awYxMFzNA663ZskT0AHtJ6TCb2Z8bQC2EnZgyELbymtWPfpZ1ZbauVg+P+TfGlWxWWB/Vr5dk5d4LfdgA/DRAHUrYgxzrEXAMPLE=
SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
StartTime: '2015-05-26T00:00:00Z'
properties:
HistoryRecords:
allOf:
- $ref: '#/components/schemas/HistoryRecords'
- xml:
name: historyRecordSet
description: Information about the events in the history of the Spot Fleet request.
LastEvaluatedTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: lastEvaluatedTime
description: 'The last date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). All records up to this time were retrieved.
If nextToken indicates that there are more items, this value is not present.
null when there are no more items to return.
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: startTime
description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
description: Contains the output of DescribeSpotFleetRequestHistory.
DescribeSpotFleetRequestsResponse:
type: object
example:
SpotFleetRequestConfigs:
- SpotFleetRequestConfig:
IamFleetRole: 'arn:aws:iam::123456789012:role/my-spot-fleet-role'
LaunchSpecifications:
- EbsOptimized: false
ImageId: ami-1a2b3c4d
InstanceType: cc2.8xlarge
NetworkInterfaces:
- AssociatePublicIpAddress: true
DeleteOnTermination: false
DeviceIndex: 0
SecondaryPrivateIpAddressCount: 0
SubnetId: subnet-a61dafcf
- EbsOptimized: false
ImageId: ami-1a2b3c4d
InstanceType: r3.8xlarge
NetworkInterfaces:
- AssociatePublicIpAddress: true
DeleteOnTermination: false
DeviceIndex: 0
SecondaryPrivateIpAddressCount: 0
SubnetId: subnet-a61dafcf
SpotPrice: '0.05'
TargetCapacity: 20
SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
SpotFleetRequestState: active
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
SpotFleetRequestConfigs:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestConfigSet'
- xml:
name: spotFleetRequestConfigSet
description: Information about the configuration of your Spot Fleet.
description: Contains the output of DescribeSpotFleetRequests.
DescribeSpotInstanceRequestsResult:
type: object
example:
SpotInstanceRequests:
- CreateTime: '2014-04-30T18:14:55.000Z'
InstanceId: i-1234567890abcdef0
LaunchSpecification:
BlockDeviceMappings:
- DeviceName: /dev/sda1
Ebs:
DeleteOnTermination: true
VolumeSize: 8
VolumeType: standard
EbsOptimized: false
ImageId: ami-7aba833f
InstanceType: m1.small
KeyName: my-key-pair
SecurityGroups:
- GroupId: sg-e38f24a7
GroupName: my-security-group
LaunchedAvailabilityZone: us-west-1b
ProductDescription: Linux/UNIX
SpotInstanceRequestId: sir-08b93456
SpotPrice: '0.010000'
State: active
Status:
Code: fulfilled
Message: Your Spot request is fulfilled.
UpdateTime: '2014-04-30T18:16:21.000Z'
Type: one-time
properties:
SpotInstanceRequests:
allOf:
- $ref: '#/components/schemas/SpotInstanceRequestList'
- xml:
name: spotInstanceRequestSet
description: The Spot Instance requests.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
description: Contains the output of DescribeSpotInstanceRequests.
DescribeSpotPriceHistoryResult:
type: object
example:
SpotPriceHistory:
- AvailabilityZone: us-west-1a
InstanceType: m1.xlarge
ProductDescription: Linux/UNIX (Amazon VPC)
SpotPrice: '0.080000'
Timestamp: '2014-01-06T04:32:53.000Z'
- AvailabilityZone: us-west-1c
InstanceType: m1.xlarge
ProductDescription: Linux/UNIX (Amazon VPC)
SpotPrice: '0.080000'
Timestamp: '2014-01-05T11:28:26.000Z'
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
SpotPriceHistory:
allOf:
- $ref: '#/components/schemas/SpotPriceHistoryList'
- xml:
name: spotPriceHistorySet
description: The historical Spot prices.
description: Contains the output of DescribeSpotPriceHistory.
DescribeStaleSecurityGroupsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: 'The token to include in another request to get the next page of items. If there are no additional items to return, the string is empty.'
StaleSecurityGroupSet:
allOf:
- $ref: '#/components/schemas/StaleSecurityGroupSet'
- xml:
name: staleSecurityGroupSet
description: Information about the stale security groups.
DescribeStoreImageTasksResult:
type: object
properties:
StoreImageTaskResults:
allOf:
- $ref: '#/components/schemas/StoreImageTaskResultSet'
- xml:
name: storeImageTaskResultSet
description: The information about the AMI store tasks.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeSubnetsResult:
type: object
example:
Subnets:
- AvailabilityZone: us-east-1c
AvailableIpAddressCount: 251
CidrBlock: 10.0.1.0/24
DefaultForAz: false
MapPublicIpOnLaunch: false
State: available
SubnetId: subnet-9d4a7b6c
VpcId: vpc-a01106c2
properties:
Subnets:
allOf:
- $ref: '#/components/schemas/SubnetList'
- xml:
name: subnetSet
description: Information about one or more subnets.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeTagsResult:
type: object
example:
Tags:
- Key: Stack
ResourceId: i-1234567890abcdef8
ResourceType: instance
Value: test
- Key: Name
ResourceId: i-1234567890abcdef8
ResourceType: instance
Value: Beta Server
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Tags:
allOf:
- $ref: '#/components/schemas/TagDescriptionList'
- xml:
name: tagSet
description: The tags.
DescribeTrafficMirrorFiltersResult:
type: object
properties:
TrafficMirrorFilters:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterSet'
- xml:
name: trafficMirrorFilterSet
description: Information about one or more Traffic Mirror filters.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
TrafficMirrorFilterId:
type: string
DescribeTrafficMirrorSessionsResult:
type: object
properties:
TrafficMirrorSessions:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSessionSet'
- xml:
name: trafficMirrorSessionSet
description: 'Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
TrafficMirrorSessionId:
type: string
DescribeTrafficMirrorTargetsResult:
type: object
properties:
TrafficMirrorTargets:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetSet'
- xml:
name: trafficMirrorTargetSet
description: Information about one or more Traffic Mirror targets.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. The value is null when there are no more results to return.
TrafficMirrorTargetId:
type: string
DescribeTransitGatewayAttachmentsResult:
type: object
properties:
TransitGatewayAttachments:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentList'
- xml:
name: transitGatewayAttachments
description: Information about the attachments.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeTransitGatewayConnectPeersResult:
type: object
properties:
TransitGatewayConnectPeers:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerList'
- xml:
name: transitGatewayConnectPeerSet
description: Information about the Connect peers.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
TransitGatewayConnectPeerId:
type: string
DescribeTransitGatewayConnectsResult:
type: object
properties:
TransitGatewayConnects:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectList'
- xml:
name: transitGatewayConnectSet
description: Information about the Connect attachments.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeTransitGatewayMulticastDomainsResult:
type: object
properties:
TransitGatewayMulticastDomains:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainList'
- xml:
name: transitGatewayMulticastDomains
description: Information about the transit gateway multicast domains.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
TransitGatewayMulticastDomainId:
type: string
DescribeTransitGatewayPeeringAttachmentsResult:
type: object
properties:
TransitGatewayPeeringAttachments:
allOf:
- $ref: '#/components/schemas/TransitGatewayPeeringAttachmentList'
- xml:
name: transitGatewayPeeringAttachments
description: The transit gateway peering attachments.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeTransitGatewayPolicyTablesResult:
type: object
properties:
TransitGatewayPolicyTables:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableList'
- xml:
name: transitGatewayPolicyTables
description: Describes the transit gateway policy tables.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token for the next page of results.
TransitGatewayPolicyTableId:
type: string
DescribeTransitGatewayRouteTableAnnouncementsResult:
type: object
properties:
TransitGatewayRouteTableAnnouncements:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementList'
- xml:
name: transitGatewayRouteTableAnnouncements
description: Describes the transit gateway route table announcement.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token for the next page of results.
TransitGatewayRouteTableAnnouncementId:
type: string
DescribeTransitGatewayRouteTablesResult:
type: object
properties:
TransitGatewayRouteTables:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableList'
- xml:
name: transitGatewayRouteTables
description: Information about the transit gateway route tables.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
TransitGatewayRouteTableId:
type: string
DescribeTransitGatewayVpcAttachmentsResult:
type: object
properties:
TransitGatewayVpcAttachments:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachmentList'
- xml:
name: transitGatewayVpcAttachments
description: Information about the VPC attachments.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeTransitGatewaysResult:
type: object
properties:
TransitGateways:
allOf:
- $ref: '#/components/schemas/TransitGatewayList'
- xml:
name: transitGatewaySet
description: Information about the transit gateways.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
TransitGatewayId:
type: string
DescribeTrunkInterfaceAssociationsResult:
type: object
properties:
InterfaceAssociations:
allOf:
- $ref: '#/components/schemas/TrunkInterfaceAssociationList'
- xml:
name: interfaceAssociationSet
description: Information about the trunk associations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
TrunkInterfaceAssociationId:
type: string
DescribeVerifiedAccessEndpointsResult:
type: object
properties:
VerifiedAccessEndpoints:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointList'
- xml:
name: verifiedAccessEndpointSet
description: The ID of the Verified Access endpoint.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
VerifiedAccessEndpointId:
type: string
DescribeVerifiedAccessGroupsResult:
type: object
properties:
VerifiedAccessGroups:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupList'
- xml:
name: verifiedAccessGroupSet
description: The ID of the Verified Access group.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
VerifiedAccessGroupId:
type: string
DescribeVerifiedAccessInstanceLoggingConfigurationsResult:
type: object
properties:
LoggingConfigurations:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceLoggingConfigurationList'
- xml:
name: loggingConfigurationSet
description: The current logging configuration for the Verified Access instances.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
VerifiedAccessInstanceId:
type: string
DescribeVerifiedAccessInstancesResult:
type: object
properties:
VerifiedAccessInstances:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceList'
- xml:
name: verifiedAccessInstanceSet
description: The IDs of the Verified Access instances.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeVerifiedAccessTrustProvidersResult:
type: object
properties:
VerifiedAccessTrustProviders:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderList'
- xml:
name: verifiedAccessTrustProviderSet
description: The IDs of the Verified Access trust providers.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
VerifiedAccessTrustProviderId:
type: string
DescribeVolumeAttributeResult:
type: object
example:
AutoEnableIO:
Value: false
VolumeId: vol-049df61146c4d7901
properties:
AutoEnableIO:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: autoEnableIO
description: The state of autoEnableIO attribute.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeList'
- xml:
name: productCodes
description: A list of product codes.
VolumeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeId
description: The ID of the volume.
DescribeVolumeStatusResult:
type: object
example:
VolumeStatuses: []
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
VolumeStatuses:
allOf:
- $ref: '#/components/schemas/VolumeStatusList'
- xml:
name: volumeStatusSet
description: Information about the status of the volumes.
VolumeId:
type: string
DescribeVolumesResult:
type: object
example:
Volumes:
- Attachments:
- AttachTime: '2013-12-18T22:35:00.000Z'
DeleteOnTermination: true
Device: /dev/sda1
InstanceId: i-1234567890abcdef0
State: attached
VolumeId: vol-049df61146c4d7901
AvailabilityZone: us-east-1a
CreateTime: '2013-12-18T22:35:00.084Z'
Size: 8
SnapshotId: snap-1234567890abcdef0
State: in-use
VolumeId: vol-049df61146c4d7901
VolumeType: standard
properties:
Volumes:
allOf:
- $ref: '#/components/schemas/VolumeList'
- xml:
name: volumeSet
description: Information about the volumes.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeVolumesModificationsResult:
type: object
properties:
VolumesModifications:
allOf:
- $ref: '#/components/schemas/VolumeModificationList'
- xml:
name: volumeModificationSet
description: Information about the volume modifications.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null if there are no more items to return.
DescribeVpcAttributeResult:
type: object
example:
EnableDnsHostnames:
Value: true
VpcId: vpc-a01106c2
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
EnableDnsHostnames:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: enableDnsHostnames
description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is true, instances in the VPC get DNS hostnames; otherwise, they do not.'
EnableDnsSupport:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: enableDnsSupport
description: 'Indicates whether DNS resolution is enabled for the VPC. If this attribute is true, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not.'
EnableNetworkAddressUsageMetrics:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: enableNetworkAddressUsageMetrics
description: Indicates whether Network Address Usage metrics are enabled for your VPC.
DescribeVpcClassicLinkResult:
type: object
properties:
Vpcs:
allOf:
- $ref: '#/components/schemas/VpcClassicLinkList'
- xml:
name: vpcSet
description: The ClassicLink status of the VPCs.
VpcId:
type: string
DescribeVpcClassicLinkDnsSupportResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportNextToken'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
Vpcs:
allOf:
- $ref: '#/components/schemas/ClassicLinkDnsSupportList'
- xml:
name: vpcs
description: Information about the ClassicLink DNS support status of the VPCs.
DescribeVpcEndpointConnectionNotificationsResult:
type: object
properties:
ConnectionNotificationSet:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationSet'
- xml:
name: connectionNotificationSet
description: The notifications.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeVpcEndpointConnectionsResult:
type: object
properties:
VpcEndpointConnections:
allOf:
- $ref: '#/components/schemas/VpcEndpointConnectionSet'
- xml:
name: vpcEndpointConnectionSet
description: Information about the VPC endpoint connections.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeVpcEndpointServiceConfigurationsResult:
type: object
properties:
ServiceConfigurations:
allOf:
- $ref: '#/components/schemas/ServiceConfigurationSet'
- xml:
name: serviceConfigurationSet
description: Information about the services.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeVpcEndpointServicePermissionsResult:
type: object
properties:
AllowedPrincipals:
allOf:
- $ref: '#/components/schemas/AllowedPrincipalSet'
- xml:
name: allowedPrincipals
description: Information about the allowed principals.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DescribeVpcEndpointServicesResult:
type: object
properties:
ServiceNames:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: serviceNameSet
description: The supported services.
ServiceDetails:
allOf:
- $ref: '#/components/schemas/ServiceDetailSet'
- xml:
name: serviceDetailSet
description: Information about the service.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
DescribeVpcEndpointsResult:
type: object
properties:
VpcEndpoints:
allOf:
- $ref: '#/components/schemas/VpcEndpointSet'
- xml:
name: vpcEndpointSet
description: Information about the endpoints.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: 'The token to use when requesting the next set of items. If there are no additional items to return, the string is empty.'
DescribeVpcPeeringConnectionsResult:
type: object
properties:
VpcPeeringConnections:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionList'
- xml:
name: vpcPeeringConnectionSet
description: Information about the VPC peering connections.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
VpcPeeringConnectionId:
type: string
DescribeVpcsResult:
type: object
example:
Vpcs:
- CidrBlock: 10.0.0.0/16
DhcpOptionsId: dopt-7a8b9c2d
InstanceTenancy: default
IsDefault: false
State: available
Tags:
- Key: Name
Value: MyVPC
VpcId: vpc-a01106c2
properties:
Vpcs:
allOf:
- $ref: '#/components/schemas/VpcList'
- xml:
name: vpcSet
description: Information about one or more VPCs.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
DescribeVpnConnectionsResult:
type: object
properties:
VpnConnections:
allOf:
- $ref: '#/components/schemas/VpnConnectionList'
- xml:
name: vpnConnectionSet
description: Information about one or more VPN connections.
description: Contains the output of DescribeVpnConnections.
VpnConnectionId:
type: string
DescribeVpnGatewaysResult:
type: object
properties:
VpnGateways:
allOf:
- $ref: '#/components/schemas/VpnGatewayList'
- xml:
name: vpnGatewaySet
description: Information about one or more virtual private gateways.
description: Contains the output of DescribeVpnGateways.
VpnGatewayId:
type: string
DetachClassicLinkVpcResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
DetachVerifiedAccessTrustProviderResult:
type: object
properties:
VerifiedAccessTrustProvider:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProvider'
- xml:
name: verifiedAccessTrustProvider
description: The ID of the Verified Access trust provider.
VerifiedAccessInstance:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstance'
- xml:
name: verifiedAccessInstance
description: The ID of the Verified Access instance.
DisableAddressTransferResult:
type: object
properties:
AddressTransfer:
allOf:
- $ref: '#/components/schemas/AddressTransfer'
- xml:
name: addressTransfer
description: An Elastic IP address transfer.
DisableAwsNetworkPerformanceMetricSubscriptionResult:
type: object
properties:
Output:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: output
description: Indicates whether the unsubscribe action was successful.
DisableEbsEncryptionByDefaultResult:
type: object
properties:
EbsEncryptionByDefault:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ebsEncryptionByDefault
description: The updated status of encryption by default.
DisableFastLaunchResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- xml:
name: imageId
description: The ID of the image for which faster-launching has been turned off.
ResourceType:
allOf:
- $ref: '#/components/schemas/FastLaunchResourceType'
- xml:
name: resourceType
description: 'The pre-provisioning resource type that must be cleaned after turning off faster launching for the Windows AMI. Supported values include: snapshot.'
SnapshotConfiguration:
allOf:
- $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
- xml:
name: snapshotConfiguration
description: Parameters that were used for faster launching for the Windows AMI before faster launching was turned off. This informs the clean-up process.
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
- xml:
name: launchTemplate
description: The launch template that was used to launch Windows instances from pre-provisioned snapshots.
MaxParallelLaunches:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxParallelLaunches
description: The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The owner of the Windows AMI for which faster launching was turned off.
State:
allOf:
- $ref: '#/components/schemas/FastLaunchStateCode'
- xml:
name: state
description: The current state of faster launching for the specified Windows AMI.
StateTransitionReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: stateTransitionReason
description: The reason that the state changed for faster launching for the Windows AMI.
StateTransitionTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: stateTransitionTime
description: The time that the state changed for faster launching for the Windows AMI.
DisableFastSnapshotRestoresResult:
type: object
properties:
Successful:
allOf:
- $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessSet'
- xml:
name: successful
description: Information about the snapshots for which fast snapshot restores were successfully disabled.
Unsuccessful:
allOf:
- $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorSet'
- xml:
name: unsuccessful
description: Information about the snapshots for which fast snapshot restores could not be disabled.
DisableImageDeprecationResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
DisableIpamOrganizationAdminAccountResult:
type: object
properties:
Success:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: success
description: The result of disabling the IPAM account.
DisableSerialConsoleAccessResult:
type: object
properties:
SerialConsoleAccessEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: serialConsoleAccessEnabled
description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
DisableTransitGatewayRouteTablePropagationResult:
type: object
properties:
Propagation:
allOf:
- $ref: '#/components/schemas/TransitGatewayPropagation'
- xml:
name: propagation
description: Information about route propagation.
DisableVpcClassicLinkResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
DisableVpcClassicLinkDnsSupportResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
DisassociateClientVpnTargetNetworkResult:
type: object
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The ID of the target network association.
Status:
allOf:
- $ref: '#/components/schemas/AssociationStatus'
- xml:
name: status
description: The current state of the target network association.
DisassociateEnclaveCertificateIamRoleResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
DisassociateIamInstanceProfileResult:
type: object
example:
IamInstanceProfileAssociation:
AssociationId: iip-assoc-05020b59952902f5f
IamInstanceProfile:
Arn: 'arn:aws:iam::123456789012:instance-profile/admin-role'
Id: AIPAI5IVIHMFFYY2DKV5Y
InstanceId: i-123456789abcde123
State: disassociating
properties:
IamInstanceProfileAssociation:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociation'
- xml:
name: iamInstanceProfileAssociation
description: Information about the IAM instance profile association.
DisassociateInstanceEventWindowResult:
type: object
properties:
InstanceEventWindow:
allOf:
- $ref: '#/components/schemas/InstanceEventWindow'
- xml:
name: instanceEventWindow
description: Information about the event window.
DisassociateIpamResourceDiscoveryResult:
type: object
properties:
IpamResourceDiscoveryAssociation:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryAssociation'
- xml:
name: ipamResourceDiscoveryAssociation
description: A resource discovery association.
DisassociateNatGatewayAddressResult:
type: object
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- xml:
name: natGatewayId
description: The ID of the NAT gateway.
NatGatewayAddresses:
allOf:
- $ref: '#/components/schemas/NatGatewayAddressList'
- xml:
name: natGatewayAddressSet
description: Information about the NAT gateway IP addresses.
ElasticIpAssociationId:
type: string
DisassociateSubnetCidrBlockResult:
type: object
properties:
Ipv6CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
- xml:
name: ipv6CidrBlockAssociation
description: Information about the IPv6 CIDR block association.
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetId
description: The ID of the subnet.
DisassociateTransitGatewayMulticastDomainResult:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- xml:
name: associations
description: Information about the association.
DisassociateTransitGatewayPolicyTableResult:
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableAssociation'
- xml:
name: association
description: Returns details about the transit gateway policy table disassociation.
DisassociateTransitGatewayRouteTableResult:
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociation'
- xml:
name: association
description: Information about the association.
DisassociateTrunkInterfaceResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
DisassociateVpcCidrBlockResult:
type: object
properties:
Ipv6CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- xml:
name: ipv6CidrBlockAssociation
description: Information about the IPv6 CIDR block association.
CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockAssociation'
- xml:
name: cidrBlockAssociation
description: Information about the IPv4 CIDR block association.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
EnableAddressTransferResult:
type: object
properties:
AddressTransfer:
allOf:
- $ref: '#/components/schemas/AddressTransfer'
- xml:
name: addressTransfer
description: An Elastic IP address transfer.
EnableAwsNetworkPerformanceMetricSubscriptionResult:
type: object
properties:
Output:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: output
description: Indicates whether the subscribe action was successful.
EnableEbsEncryptionByDefaultResult:
type: object
properties:
EbsEncryptionByDefault:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ebsEncryptionByDefault
description: The updated status of encryption by default.
EnableFastLaunchResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- xml:
name: imageId
description: The image ID that identifies the Windows AMI for which faster launching was enabled.
ResourceType:
allOf:
- $ref: '#/components/schemas/FastLaunchResourceType'
- xml:
name: resourceType
description: The type of resource that was defined for pre-provisioning the Windows AMI for faster launching.
SnapshotConfiguration:
allOf:
- $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
- xml:
name: snapshotConfiguration
description: Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster launches from the Windows AMI. This property is returned when the associated resourceType is snapshot.
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
- xml:
name: launchTemplate
description: The launch template that is used when launching Windows instances from pre-provisioned snapshots.
MaxParallelLaunches:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxParallelLaunches
description: The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The owner ID for the Windows AMI for which faster launching was enabled.
State:
allOf:
- $ref: '#/components/schemas/FastLaunchStateCode'
- xml:
name: state
description: The current state of faster launching for the specified Windows AMI.
StateTransitionReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: stateTransitionReason
description: The reason that the state changed for faster launching for the Windows AMI.
StateTransitionTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: stateTransitionTime
description: The time that the state changed for faster launching for the Windows AMI.
EnableFastSnapshotRestoresResult:
type: object
properties:
Successful:
allOf:
- $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessSet'
- xml:
name: successful
description: Information about the snapshots for which fast snapshot restores were successfully enabled.
Unsuccessful:
allOf:
- $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorSet'
- xml:
name: unsuccessful
description: Information about the snapshots for which fast snapshot restores could not be enabled.
EnableImageDeprecationResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
EnableIpamOrganizationAdminAccountResult:
type: object
properties:
Success:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: success
description: The result of enabling the IPAM account.
EnableReachabilityAnalyzerOrganizationSharingResult:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: returnValue
description: 'Returns true if the request succeeds; otherwise, returns an error.'
EnableSerialConsoleAccessResult:
type: object
properties:
SerialConsoleAccessEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: serialConsoleAccessEnabled
description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
EnableTransitGatewayRouteTablePropagationResult:
type: object
properties:
Propagation:
allOf:
- $ref: '#/components/schemas/TransitGatewayPropagation'
- xml:
name: propagation
description: Information about route propagation.
EnableVpcClassicLinkResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
EnableVpcClassicLinkDnsSupportResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ExportClientVpnClientCertificateRevocationListResult:
type: object
properties:
CertificateRevocationList:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: certificateRevocationList
description: Information about the client certificate revocation list.
Status:
allOf:
- $ref: '#/components/schemas/ClientCertificateRevocationListStatus'
- xml:
name: status
description: The current state of the client certificate revocation list.
ExportClientVpnClientConfigurationResult:
type: object
properties:
ClientConfiguration:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientConfiguration
description: The contents of the Client VPN endpoint configuration file.
ExportImageResult:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the image being exported.
DiskImageFormat:
allOf:
- $ref: '#/components/schemas/DiskImageFormat'
- xml:
name: diskImageFormat
description: The disk image format for the exported image.
ExportImageTaskId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: exportImageTaskId
description: The ID of the export image task.
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The ID of the image.
RoleName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: roleName
description: The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket.
Progress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: progress
description: The percent complete of the export image task.
S3ExportLocation:
allOf:
- $ref: '#/components/schemas/ExportTaskS3Location'
- xml:
name: s3ExportLocation
description: Information about the destination Amazon S3 bucket.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.'
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: The status message for the export image task.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the export image task.
ExportTransitGatewayRoutesResult:
type: object
properties:
S3Location:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: s3Location
description: 'The URL of the exported file in Amazon S3. For example, s3://bucket_name/VPCTransitGateway/TransitGatewayRouteTables/file_name.'
GetAssociatedEnclaveCertificateIamRolesResult:
type: object
properties:
AssociatedRoles:
allOf:
- $ref: '#/components/schemas/AssociatedRolesList'
- xml:
name: associatedRoleSet
description: Information about the associated IAM roles.
GetAssociatedIpv6PoolCidrsResult:
type: object
properties:
Ipv6CidrAssociations:
allOf:
- $ref: '#/components/schemas/Ipv6CidrAssociationSet'
- xml:
name: ipv6CidrAssociationSet
description: Information about the IPv6 CIDR block associations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetAwsNetworkPerformanceDataResult:
type: object
properties:
DataResponses:
allOf:
- $ref: '#/components/schemas/DataResponses'
- xml:
name: dataResponseSet
description: The list of data responses.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
DataQuery:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A user-defined ID associated with a data query that''s returned in the dataResponse identifying the query. For example, if you set the Id to MyQuery01in the query, the dataResponse identifies the query as MyQuery01.'
Source:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The Region or Availability Zone that''s the source for the data query. For example, us-east-1.'
Destination:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The Region or Availability Zone that''s the target for the data query. For example, eu-north-1.'
Metric:
allOf:
- $ref: '#/components/schemas/MetricType'
- description: 'The metric, aggregation-latency, indicating that network latency is aggregated for the query. This is the only supported metric.'
Statistic:
allOf:
- $ref: '#/components/schemas/StatisticType'
- description: '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.'
Period:
allOf:
- $ref: '#/components/schemas/PeriodType'
- description: The aggregation period used for the data query.
description: 'A query used for retrieving network health data. '
GetCapacityReservationUsageResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: capacityReservationId
description: The ID of the Capacity Reservation.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: The type of instance for which the Capacity Reservation reserves capacity.
TotalInstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalInstanceCount
description: The number of instances for which the Capacity Reservation reserves capacity.
AvailableInstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: availableInstanceCount
description: The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.
State:
allOf:
- $ref: '#/components/schemas/CapacityReservationState'
- xml:
name: state
description: '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.
null when there are no more results to return.
CapacityReservationGroups:
allOf:
- $ref: '#/components/schemas/CapacityReservationGroupSet'
- xml:
name: capacityReservationGroupSet
description: Information about the resource groups to which the Capacity Reservation has been added.
GetHostReservationPurchasePreviewResult:
type: object
properties:
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
Purchase:
allOf:
- $ref: '#/components/schemas/PurchaseSet'
- xml:
name: purchase
description: The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it.
TotalHourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: totalHourlyPrice
description: The potential total hourly price of the reservation per hour.
TotalUpfrontPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: totalUpfrontPrice
description: The potential total upfront price. This is billed immediately.
GetInstanceTypesFromInstanceRequirementsResult:
type: object
properties:
InstanceTypes:
allOf:
- $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirementsSet'
- xml:
name: instanceTypeSet
description: The instance types with the specified instance attributes.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
ArchitectureType:
type: string
enum:
- i386
- x86_64
- arm64
- x86_64_mac
- arm64_mac
VirtualizationType:
type: string
enum:
- hvm
- paravirtual
VCpuCountRangeRequest:
type: object
required:
- Min
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The minimum number of vCPUs. To specify no minimum limit, specify 0.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of vCPUs. To specify no maximum limit, omit this parameter.'
description: The minimum and maximum number of vCPUs.
MemoryMiBRequest:
type: object
required:
- Min
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The minimum amount of memory, in MiB. To specify no minimum limit, specify 0.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.'
description: 'The minimum and maximum amount of memory, in MiB.'
CpuManufacturerSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CpuManufacturer'
- xml:
name: item
MemoryGiBPerVCpuRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.'
Max:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.'
description: 'The minimum and maximum amount of memory per vCPU, in GiB.'
ExcludedInstanceTypeSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ExcludedInstanceType'
- xml:
name: item
minItems: 0
maxItems: 400
InstanceGenerationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceGeneration'
- xml:
name: item
BareMetal:
type: string
enum:
- included
- required
- excluded
BurstablePerformance:
type: string
enum:
- included
- required
- excluded
NetworkInterfaceCountRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The minimum number of network interfaces. To specify no minimum limit, omit this parameter.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of network interfaces. To specify no maximum limit, omit this parameter.'
description: The minimum and maximum number of network interfaces.
LocalStorage:
type: string
enum:
- included
- required
- excluded
LocalStorageTypeSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalStorageType'
- xml:
name: item
TotalLocalStorageGBRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.'
Max:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.'
description: 'The minimum and maximum amount of total local storage, in GB.'
BaselineEbsBandwidthMbpsRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.'
description: '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.'
AcceleratorTypeSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AcceleratorType'
- xml:
name: item
AcceleratorCountRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The minimum number of accelerators. To specify no minimum limit, omit this parameter.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set Max to 0.'
description: '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.'
AcceleratorManufacturerSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AcceleratorManufacturer'
- xml:
name: item
AcceleratorNameSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AcceleratorName'
- xml:
name: item
AcceleratorTotalMemoryMiBRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.'
description: 'The minimum and maximum amount of total accelerator memory, in MiB.'
NetworkBandwidthGbpsRequest:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.'
Max:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.'
description: 'The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth in the Amazon EC2 User Guide.
null when there are no more results to return.
GetIpamDiscoveredAccountsResult:
type: object
properties:
IpamDiscoveredAccounts:
allOf:
- $ref: '#/components/schemas/IpamDiscoveredAccountSet'
- xml:
name: ipamDiscoveredAccountSet
description: Discovered accounts.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: Specify the pagination token from a previous request to retrieve the next page of results.
GetIpamDiscoveredResourceCidrsResult:
type: object
properties:
IpamDiscoveredResourceCidrs:
allOf:
- $ref: '#/components/schemas/IpamDiscoveredResourceCidrSet'
- xml:
name: ipamDiscoveredResourceCidrSet
description: Discovered resource CIDRs.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: Specify the pagination token from a previous request to retrieve the next page of results.
GetIpamPoolAllocationsResult:
type: object
properties:
IpamPoolAllocations:
allOf:
- $ref: '#/components/schemas/IpamPoolAllocationSet'
- xml:
name: ipamPoolAllocationSet
description: The IPAM pool allocations you want information on.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetIpamPoolCidrsResult:
type: object
properties:
IpamPoolCidrs:
allOf:
- $ref: '#/components/schemas/IpamPoolCidrSet'
- xml:
name: ipamPoolCidrSet
description: Information about the CIDRs provisioned to an IPAM pool.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetIpamResourceCidrsResult:
type: object
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
IpamResourceCidrs:
allOf:
- $ref: '#/components/schemas/IpamResourceCidrSet'
- xml:
name: ipamResourceCidrSet
description: The resource CIDRs.
GetLaunchTemplateDataResult:
type: object
example:
LaunchTemplateData:
BlockDeviceMappings:
- DeviceName: /dev/xvda
Ebs:
DeleteOnTermination: true
Encrypted: false
Iops: 100
SnapshotId: snap-02594938353ef77d3
VolumeSize: 8
VolumeType: gp2
EbsOptimized: false
ImageId: ami-32cf7b4a
InstanceType: t2.medium
KeyName: my-key-pair
Monitoring:
Enabled: false
NetworkInterfaces:
- AssociatePublicIpAddress: false
DeleteOnTermination: true
Description: ''
DeviceIndex: 0
Groups:
- sg-d14e1bb4
Ipv6Addresses: []
NetworkInterfaceId: eni-4338b5a9
PrivateIpAddress: 10.0.3.233
PrivateIpAddresses:
- Primary: true
PrivateIpAddress: 10.0.3.233
SubnetId: subnet-5264e837
Placement:
AvailabilityZone: us-east-2b
GroupName: ''
Tenancy: default
properties:
LaunchTemplateData:
allOf:
- $ref: '#/components/schemas/ResponseLaunchTemplateData'
- xml:
name: launchTemplateData
description: The instance data.
GetManagedPrefixListAssociationsResult:
type: object
properties:
PrefixListAssociations:
allOf:
- $ref: '#/components/schemas/PrefixListAssociationSet'
- xml:
name: prefixListAssociationSet
description: Information about the associations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetManagedPrefixListEntriesResult:
type: object
properties:
Entries:
allOf:
- $ref: '#/components/schemas/PrefixListEntrySet'
- xml:
name: entrySet
description: Information about the prefix list entries.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetNetworkInsightsAccessScopeAnalysisFindingsResult:
type: object
properties:
NetworkInsightsAccessScopeAnalysisId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- xml:
name: networkInsightsAccessScopeAnalysisId
description: The ID of the Network Access Scope analysis.
AnalysisStatus:
allOf:
- $ref: '#/components/schemas/AnalysisStatus'
- xml:
name: analysisStatus
description: The status of Network Access Scope Analysis.
AnalysisFindings:
allOf:
- $ref: '#/components/schemas/AccessScopeAnalysisFindingList'
- xml:
name: analysisFindingSet
description: The findings associated with Network Access Scope Analysis.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetNetworkInsightsAccessScopeContentResult:
type: object
properties:
NetworkInsightsAccessScopeContent:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeContent'
- xml:
name: networkInsightsAccessScopeContent
description: The Network Access Scope content.
GetPasswordDataResult:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the Windows instance.
PasswordData:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: passwordData
description: The password of the instance. Returns an empty string if the password is not available.
Timestamp:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: timestamp
description: The time the data was last updated.
GetReservedInstancesExchangeQuoteResult:
type: object
properties:
CurrencyCode:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: currencyCode
description: The currency of the transaction.
IsValidExchange:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isValidExchange
description: 'If true, the exchange is valid. If false, the exchange cannot be completed.'
OutputReservedInstancesWillExpireAt:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: outputReservedInstancesWillExpireAt
description: The new end date of the reservation term.
PaymentDue:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: paymentDue
description: The total true upfront charge for the exchange.
ReservedInstanceValueRollup:
allOf:
- $ref: '#/components/schemas/ReservationValue'
- xml:
name: reservedInstanceValueRollup
description: The cost associated with the Reserved Instance.
ReservedInstanceValueSet:
allOf:
- $ref: '#/components/schemas/ReservedInstanceReservationValueSet'
- xml:
name: reservedInstanceValueSet
description: The configuration of your Convertible Reserved Instances.
TargetConfigurationValueRollup:
allOf:
- $ref: '#/components/schemas/ReservationValue'
- xml:
name: targetConfigurationValueRollup
description: The cost associated with the Reserved Instance.
TargetConfigurationValueSet:
allOf:
- $ref: '#/components/schemas/TargetReservationValueSet'
- xml:
name: targetConfigurationValueSet
description: The values of the target Convertible Reserved Instances.
ValidationFailureReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: validationFailureReason
description: Describes the reason why the exchange cannot be completed.
description: Contains the output of GetReservedInstancesExchangeQuote.
GetSerialConsoleAccessStatusResult:
type: object
properties:
SerialConsoleAccessEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: serialConsoleAccessEnabled
description: 'If true, access to the EC2 serial console of all instances is enabled for your account. If false, access to the EC2 serial console of all instances is disabled for your account.'
GetSpotPlacementScoresResult:
type: object
properties:
SpotPlacementScores:
allOf:
- $ref: '#/components/schemas/SpotPlacementScores'
- xml:
name: spotPlacementScoreSet
description: 'The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score
reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity
at the time of the Spot placement score request. A score of 10 means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone.
If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the capacity-optimized allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the capacity-optimized allocation strategy.
Different Regions or Availability Zones might return the same score.
The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled.
null when there are no more items to return.
ArchitectureTypeSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ArchitectureType'
- xml:
name: item
minItems: 0
maxItems: 3
VirtualizationTypeSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/VirtualizationType'
- xml:
name: item
minItems: 0
maxItems: 2
GetSubnetCidrReservationsResult:
type: object
properties:
SubnetIpv4CidrReservations:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservationList'
- xml:
name: subnetIpv4CidrReservationSet
description: Information about the IPv4 subnet CIDR reservations.
SubnetIpv6CidrReservations:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservationList'
- xml:
name: subnetIpv6CidrReservationSet
description: Information about the IPv6 subnet CIDR reservations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetTransitGatewayAttachmentPropagationsResult:
type: object
properties:
TransitGatewayAttachmentPropagations:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentPropagationList'
- xml:
name: transitGatewayAttachmentPropagations
description: Information about the propagation route tables.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetTransitGatewayMulticastDomainAssociationsResult:
type: object
properties:
MulticastDomainAssociations:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociationList'
- xml:
name: multicastDomainAssociations
description: Information about the multicast domain associations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetTransitGatewayPolicyTableAssociationsResult:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableAssociationList'
- xml:
name: associations
description: Returns details about the transit gateway policy table association.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token for the next page of results.
GetTransitGatewayPolicyTableEntriesResult:
type: object
properties:
TransitGatewayPolicyTableEntries:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableEntryList'
- xml:
name: transitGatewayPolicyTableEntries
description: The entries for the transit gateway policy table.
GetTransitGatewayPrefixListReferencesResult:
type: object
properties:
TransitGatewayPrefixListReferences:
allOf:
- $ref: '#/components/schemas/TransitGatewayPrefixListReferenceSet'
- xml:
name: transitGatewayPrefixListReferenceSet
description: Information about the prefix list references.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetTransitGatewayRouteTableAssociationsResult:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAssociationList'
- xml:
name: associations
description: Information about the associations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetTransitGatewayRouteTablePropagationsResult:
type: object
properties:
TransitGatewayRouteTablePropagations:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTablePropagationList'
- xml:
name: transitGatewayRouteTablePropagations
description: Information about the route table propagations.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
GetVerifiedAccessEndpointPolicyResult:
type: object
properties:
PolicyEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: policyEnabled
description: The status of the Verified Access policy.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: policyDocument
description: The Verified Access policy document.
GetVerifiedAccessGroupPolicyResult:
type: object
properties:
PolicyEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: policyEnabled
description: The status of the Verified Access policy.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: policyDocument
description: The Verified Access policy document.
GetVpnConnectionDeviceSampleConfigurationResult:
type: object
properties:
VpnConnectionDeviceSampleConfiguration:
allOf:
- $ref: '#/components/schemas/VpnConnectionDeviceSampleConfiguration'
- xml:
name: vpnConnectionDeviceSampleConfiguration
description: Sample configuration file for the specified customer gateway device.
GetVpnConnectionDeviceTypesResult:
type: object
properties:
VpnConnectionDeviceTypes:
allOf:
- $ref: '#/components/schemas/VpnConnectionDeviceTypeList'
- xml:
name: vpnConnectionDeviceTypeSet
description: List of customer gateway devices that have a sample configuration file available for use.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- xml:
name: nextToken
description: 'The NextToken value to include in a future GetVpnConnectionDeviceTypes request. When the results of a GetVpnConnectionDeviceTypes request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.'
GetVpnTunnelReplacementStatusResult:
type: object
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- xml:
name: vpnConnectionId
description: 'The ID of the Site-to-Site VPN connection. '
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- xml:
name: transitGatewayId
description: The ID of the transit gateway associated with the VPN connection.
CustomerGatewayId:
allOf:
- $ref: '#/components/schemas/CustomerGatewayId'
- xml:
name: customerGatewayId
description: The ID of the customer gateway.
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- xml:
name: vpnGatewayId
description: The ID of the virtual private gateway.
VpnTunnelOutsideIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpnTunnelOutsideIpAddress
description: The external IP address of the VPN tunnel.
MaintenanceDetails:
allOf:
- $ref: '#/components/schemas/MaintenanceDetails'
- xml:
name: maintenanceDetails
description: Get details of pending tunnel endpoint maintenance.
ImportClientVpnClientCertificateRevocationListResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ImportImageResult:
type: object
properties:
Architecture:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: architecture
description: The architecture of the virtual machine.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the import task.
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: encrypted
description: Indicates whether the AMI is encrypted.
Hypervisor:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hypervisor
description: The target hypervisor of the import task.
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The ID of the Amazon Machine Image (AMI) created by the import task.
ImportTaskId:
allOf:
- $ref: '#/components/schemas/ImportImageTaskId'
- xml:
name: importTaskId
description: The task ID of the import image task.
KmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- xml:
name: kmsKeyId
description: The identifier for the symmetric KMS key that was used to create the encrypted AMI.
LicenseType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: licenseType
description: The license type of the virtual machine.
Platform:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: platform
description: The operating system of the virtual machine.
Progress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: progress
description: The progress of the task.
SnapshotDetails:
allOf:
- $ref: '#/components/schemas/SnapshotDetailList'
- xml:
name: snapshotDetailSet
description: Information about the snapshots.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: A brief status of the task.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: A detailed status message of the import task.
LicenseSpecifications:
allOf:
- $ref: '#/components/schemas/ImportImageLicenseSpecificationListResponse'
- xml:
name: licenseSpecifications
description: The ARNs of the license configurations.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the import image task.
UsageOperation:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: usageOperation
description: The usage operation value.
Double:
type: number
format: double
ImageDiskContainer:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the disk image.
DeviceName:
allOf:
- $ref: '#/components/schemas/String'
- description: The block device mapping for the disk.
Format:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The format of the disk image being imported.
Valid values: OVA | VHD | VHDX | VMDK | RAW
The Availability Zone of the instance.
If not specified, an Availability Zone will be automatically chosen for you based on the load balancing criteria for the Region.
This parameter is not supported for CreateFleet.
' Affinity: allOf: - $ref: '#/components/schemas/String' - xml: name: affinity description: 'The affinity setting for the instance on the Dedicated Host.
This parameter is not supported for CreateFleet or ImportInstance.
' GroupName: allOf: - $ref: '#/components/schemas/PlacementGroupName' - xml: name: groupName description: 'The name of the placement group that the instance is in. If you specifyGroupName, you can''t specify GroupId.'
PartitionNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: partitionNumber
description: 'The number of the partition that the instance is in. Valid only if the placement group strategy is set to partition.
This parameter is not supported for CreateFleet.
' HostId: allOf: - $ref: '#/components/schemas/String' - xml: name: hostId description: 'The ID of the Dedicated Host on which the instance resides.
This parameter is not supported for CreateFleet or ImportInstance.
' Tenancy: allOf: - $ref: '#/components/schemas/Tenancy' - xml: name: tenancy description: 'The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.
This parameter is not supported for CreateFleet. The host tenancy is not supported for ImportInstance or for T3 instances that are configured for the unlimited CPU credit option.
The ARN of the host resource group in which to launch the instances.
If you specify this parameter, either omit the Tenancy parameter or set it to host.
This parameter is not supported for CreateFleet.
' GroupId: allOf: - $ref: '#/components/schemas/PlacementGroupId' - xml: name: groupId description: 'The ID of the placement group that the instance is in. If you specifyGroupId, you can''t specify GroupName.'
description: Describes the placement of an instance.
UserData:
type: object
properties:
Data:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: data
description: 'The user data. If you are using an Amazon Web Services SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.'
description: Describes the user data for an instance.
ImportKeyPairResult:
type: object
properties:
KeyFingerprint:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: keyFingerprint
description: 'For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
null when there are no more items to return.
ListSnapshotsInRecycleBinResult:
type: object
properties:
Snapshots:
allOf:
- $ref: '#/components/schemas/SnapshotRecycleBinInfoList'
- xml:
name: snapshotSet
description: Information about the snapshots.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
ModifyAddressAttributeResult:
type: object
properties:
Address:
allOf:
- $ref: '#/components/schemas/AddressAttribute'
- xml:
name: address
description: Information about the Elastic IP address.
ModifyAvailabilityZoneGroupResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Is true if the request succeeds, and an error otherwise.'
ModifyCapacityReservationResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ModifyCapacityReservationFleetResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ModifyClientVpnEndpointResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ValueStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
ModifyDefaultCreditSpecificationResult:
type: object
properties:
InstanceFamilyCreditSpecification:
allOf:
- $ref: '#/components/schemas/InstanceFamilyCreditSpecification'
- xml:
name: instanceFamilyCreditSpecification
description: The default credit option for CPU usage of the instance family.
ModifyEbsDefaultKmsKeyIdResult:
type: object
properties:
KmsKeyId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kmsKeyId
description: The Amazon Resource Name (ARN) of the default KMS key for encryption by default.
ModifyFleetResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.'
ModifyFpgaImageAttributeResult:
type: object
properties:
FpgaImageAttribute:
allOf:
- $ref: '#/components/schemas/FpgaImageAttribute'
- xml:
name: fpgaImageAttribute
description: Information about the attribute.
LoadPermissionListRequest:
type: array
items:
allOf:
- $ref: '#/components/schemas/LoadPermissionRequest'
- xml:
name: item
ModifyHostsResult:
type: object
properties:
Successful:
allOf:
- $ref: '#/components/schemas/ResponseHostIdList'
- xml:
name: successful
description: The IDs of the Dedicated Hosts that were successfully modified.
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemList'
- xml:
name: unsuccessful
description: The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used.
LaunchPermissionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchPermission'
- xml:
name: item
InstanceBlockDeviceMappingSpecification:
type: object
properties:
DeviceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deviceName
description: 'The device name (for example, /dev/sdh or xvdh).'
Ebs:
allOf:
- $ref: '#/components/schemas/EbsInstanceBlockDeviceSpecification'
- xml:
name: ebs
description: Parameters used to automatically set up EBS volumes when the instance is launched.
NoDevice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: noDevice
description: suppress the specified device included in the block device mapping.
VirtualName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: virtualName
description: The virtual device name.
description: Describes a block device mapping entry.
Blob:
type: string
ModifyInstanceCapacityReservationAttributesResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
CapacityReservationPreference:
type: string
enum:
- open
- none
CapacityReservationTarget:
type: object
properties:
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/CapacityReservationId'
- description: The ID of the Capacity Reservation in which to run the instance.
CapacityReservationResourceGroupArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the Capacity Reservation resource group in which to run the instance.
description: Describes a target Capacity Reservation or Capacity Reservation group.
ModifyInstanceCreditSpecificationResult:
type: object
properties:
SuccessfulInstanceCreditSpecifications:
allOf:
- $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationSet'
- xml:
name: successfulInstanceCreditSpecificationSet
description: Information about the instances whose credit option for CPU usage was successfully modified.
UnsuccessfulInstanceCreditSpecifications:
allOf:
- $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationSet'
- xml:
name: unsuccessfulInstanceCreditSpecificationSet
description: Information about the instances whose credit option for CPU usage was not modified.
InstanceCreditSpecificationRequest:
type: object
required:
- InstanceId
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
CpuCredits:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The credit option for CPU usage of the instance.
Valid values: standard | unlimited
T3 instances with host tenancy do not support the unlimited CPU credit option.
true if the request succeeds, and an error otherwise.'
ModifyIpamResult:
type: object
properties:
Ipam:
allOf:
- $ref: '#/components/schemas/Ipam'
- xml:
name: ipam
description: The results of the modification.
RemoveIpamOperatingRegion:
type: object
properties:
RegionName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the operating Region you want to remove.
description: 'Remove an operating Region from an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide
' ModifyIpamPoolResult: type: object properties: IpamPool: allOf: - $ref: '#/components/schemas/IpamPool' - xml: name: ipamPool description: The results of the modification. ModifyIpamResourceCidrResult: type: object properties: IpamResourceCidr: allOf: - $ref: '#/components/schemas/IpamResourceCidr' - xml: name: ipamResourceCidr description: The CIDR of the resource. ModifyIpamResourceDiscoveryResult: type: object properties: IpamResourceDiscovery: allOf: - $ref: '#/components/schemas/IpamResourceDiscovery' - xml: name: ipamResourceDiscovery description: A resource discovery. ModifyIpamScopeResult: type: object properties: IpamScope: allOf: - $ref: '#/components/schemas/IpamScope' - xml: name: ipamScope description: The results of the modification. ModifyLaunchTemplateResult: type: object example: LaunchTemplate: CreateTime: '2017-12-01T13:35:46.000Z' CreatedBy: 'arn:aws:iam::123456789012:root' DefaultVersionNumber: 2 LatestVersionNumber: 2 LaunchTemplateId: lt-0abcd290751193123 LaunchTemplateName: WebServers properties: LaunchTemplate: allOf: - $ref: '#/components/schemas/LaunchTemplate' - xml: name: launchTemplate description: Information about the launch template. ModifyLocalGatewayRouteResult: type: object properties: Route: allOf: - $ref: '#/components/schemas/LocalGatewayRoute' - xml: name: route description: Information about the local gateway route table. ModifyManagedPrefixListResult: type: object properties: PrefixList: allOf: - $ref: '#/components/schemas/ManagedPrefixList' - xml: name: prefixList description: Information about the prefix list. RemovePrefixListEntry: type: object required: - Cidr properties: Cidr: allOf: - $ref: '#/components/schemas/String' - description: The CIDR block. description: An entry for a prefix list. NetworkInterfaceAttachmentId: type: string ModifyPrivateDnsNameOptionsResult: type: object properties: Return: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: return description: 'Returnstrue if the request succeeds; otherwise, it returns an error.'
ModifyReservedInstancesResult:
type: object
properties:
ReservedInstancesModificationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesModificationId
description: The ID for the modification.
description: Contains the output of ModifyReservedInstances.
ReservedInstancesConfiguration:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone for the modified Reserved Instances.
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: instanceCount
description: The number of modified Reserved Instances.
This is a required field for a request.
true if the request succeeds; otherwise, returns an error.'
SecurityGroupRuleUpdate:
type: object
required:
- SecurityGroupRuleId
properties:
SecurityGroupRuleId:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleId'
- description: The ID of the security group rule.
SecurityGroupRule:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleRequest'
- description: Information about the security group rule.
description: Describes an update to a security group rule.
CreateVolumePermissionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/CreateVolumePermission'
- xml:
name: item
ModifySnapshotTierResult:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
TieringStartTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: tieringStartTime
description: The date and time when the archive process was started.
ModifySpotFleetRequestResponse:
type: object
example:
Return: true
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'If the request succeeds, the response returns true. If the request fails, no response is returned, and instead an error message is returned.'
description: Contains the output of ModifySpotFleetRequest.
LaunchTemplateConfig:
type: object
properties:
LaunchTemplateSpecification:
allOf:
- $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
- xml:
name: launchTemplateSpecification
description: The launch template to use. Make sure that the launch template does not contain the NetworkInterfaceId parameter because you can't specify a network interface ID in a Spot Fleet.
Overrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateOverridesList'
- xml:
name: overrides
description: Any parameters that you specify override the same parameters in the launch template.
description: Describes a launch template and overrides.
ModifyTrafficMirrorFilterNetworkServicesResult:
type: object
properties:
TrafficMirrorFilter:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilter'
- xml:
name: trafficMirrorFilter
description: The Traffic Mirror filter that the network service is associated with.
TrafficMirrorNetworkService:
type: string
enum:
- amazon-dns
ModifyTrafficMirrorFilterRuleResult:
type: object
properties:
TrafficMirrorFilterRule:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterRule'
- xml:
name: trafficMirrorFilterRule
description: Modifies a Traffic Mirror rule.
TrafficMirrorFilterRuleField:
type: string
enum:
- destination-port-range
- source-port-range
- protocol
- description
ModifyTrafficMirrorSessionResult:
type: object
properties:
TrafficMirrorSession:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSession'
- xml:
name: trafficMirrorSession
description: Information about the Traffic Mirror session.
TrafficMirrorSessionField:
type: string
enum:
- packet-length
- description
- virtual-network-id
ModifyTransitGatewayResult:
type: object
properties:
TransitGateway:
allOf:
- $ref: '#/components/schemas/TransitGateway'
- xml:
name: transitGateway
description: Information about the transit gateway.
ModifyTransitGatewayPrefixListReferenceResult:
type: object
properties:
TransitGatewayPrefixListReference:
allOf:
- $ref: '#/components/schemas/TransitGatewayPrefixListReference'
- xml:
name: transitGatewayPrefixListReference
description: Information about the prefix list reference.
ModifyTransitGatewayVpcAttachmentResult:
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- xml:
name: transitGatewayVpcAttachment
description: Information about the modified attachment.
ModifyVerifiedAccessEndpointResult:
type: object
properties:
VerifiedAccessEndpoint:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpoint'
- xml:
name: verifiedAccessEndpoint
description: The Verified Access endpoint details.
ModifyVerifiedAccessEndpointSubnetIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
ModifyVerifiedAccessEndpointPolicyResult:
type: object
properties:
PolicyEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: policyEnabled
description: The status of the Verified Access policy.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: policyDocument
description: The Verified Access policy document.
ModifyVerifiedAccessGroupResult:
type: object
properties:
VerifiedAccessGroup:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroup'
- xml:
name: verifiedAccessGroup
description: Details of Verified Access group.
ModifyVerifiedAccessGroupPolicyResult:
type: object
properties:
PolicyEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: policyEnabled
description: The status of the Verified Access policy.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: policyDocument
description: The Verified Access policy document.
ModifyVerifiedAccessInstanceResult:
type: object
properties:
VerifiedAccessInstance:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstance'
- xml:
name: verifiedAccessInstance
description: The ID of the Verified Access instance.
ModifyVerifiedAccessInstanceLoggingConfigurationResult:
type: object
properties:
LoggingConfiguration:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceLoggingConfiguration'
- xml:
name: loggingConfiguration
description: The logging configuration for the Verified Access instance.
VerifiedAccessLogS3DestinationOptions:
type: object
required:
- Enabled
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether logging is enabled.
BucketName:
allOf:
- $ref: '#/components/schemas/String'
- description: The bucket name.
Prefix:
allOf:
- $ref: '#/components/schemas/String'
- description: The bucket prefix.
BucketOwner:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the Amazon Web Services account that owns the Amazon S3 bucket.
description: Options for Amazon S3 as a logging destination.
VerifiedAccessLogCloudWatchLogsDestinationOptions:
type: object
required:
- Enabled
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether logging is enabled.
LogGroup:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the CloudWatch Logs log group.
description: Options for CloudWatch Logs as a logging destination.
VerifiedAccessLogKinesisDataFirehoseDestinationOptions:
type: object
required:
- Enabled
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether logging is enabled.
DeliveryStream:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the delivery stream.
description: Describes Amazon Kinesis Data Firehose logging options.
ModifyVerifiedAccessTrustProviderResult:
type: object
properties:
VerifiedAccessTrustProvider:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProvider'
- xml:
name: verifiedAccessTrustProvider
description: The ID of the Verified Access trust provider.
ModifyVolumeResult:
type: object
properties:
VolumeModification:
allOf:
- $ref: '#/components/schemas/VolumeModification'
- xml:
name: volumeModification
description: Information about the volume modification.
ModifyVpcEndpointResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ModifyVpcEndpointConnectionNotificationResult:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ModifyVpcEndpointServiceConfigurationResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ModifyVpcEndpointServicePayerResponsibilityResult:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ModifyVpcEndpointServicePermissionsResult:
type: object
properties:
AddedPrincipals:
allOf:
- $ref: '#/components/schemas/AddedPrincipalSet'
- xml:
name: addedPrincipalSet
description: Information about the added principals.
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ModifyVpcPeeringConnectionOptionsResult:
type: object
properties:
AccepterPeeringConnectionOptions:
allOf:
- $ref: '#/components/schemas/PeeringConnectionOptions'
- xml:
name: accepterPeeringConnectionOptions
description: Information about the VPC peering connection options for the accepter VPC.
RequesterPeeringConnectionOptions:
allOf:
- $ref: '#/components/schemas/PeeringConnectionOptions'
- xml:
name: requesterPeeringConnectionOptions
description: Information about the VPC peering connection options for the requester VPC.
ModifyVpcTenancyResult:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, returns an error.'
ModifyVpnConnectionResult:
type: object
properties:
VpnConnection:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- xml:
name: vpnConnection
description: Information about the VPN connection.
ModifyVpnConnectionOptionsResult:
type: object
properties:
VpnConnection:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- xml:
name: vpnConnection
description: Information about the VPN connection.
ModifyVpnTunnelCertificateResult:
type: object
properties:
VpnConnection:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- xml:
name: vpnConnection
description: Information about the VPN connection.
ModifyVpnTunnelOptionsResult:
type: object
properties:
VpnConnection:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- xml:
name: vpnConnection
description: Information about the VPN connection.
preSharedKey:
type: string
format: password
Phase1EncryptionAlgorithmsRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Phase1EncryptionAlgorithmsRequestListValue'
- xml:
name: item
Phase2EncryptionAlgorithmsRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Phase2EncryptionAlgorithmsRequestListValue'
- xml:
name: item
Phase1IntegrityAlgorithmsRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Phase1IntegrityAlgorithmsRequestListValue'
- xml:
name: item
Phase2IntegrityAlgorithmsRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Phase2IntegrityAlgorithmsRequestListValue'
- xml:
name: item
Phase1DHGroupNumbersRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Phase1DHGroupNumbersRequestListValue'
- xml:
name: item
Phase2DHGroupNumbersRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Phase2DHGroupNumbersRequestListValue'
- xml:
name: item
IKEVersionsRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/IKEVersionsRequestListValue'
- xml:
name: item
VpnTunnelLogOptionsSpecification:
type: object
properties:
CloudWatchLogOptions:
allOf:
- $ref: '#/components/schemas/CloudWatchLogOptionsSpecification'
- description: Options for sending VPN tunnel logs to CloudWatch.
description: Options for logging VPN tunnel activity.
MonitorInstancesResult:
type: object
properties:
InstanceMonitorings:
allOf:
- $ref: '#/components/schemas/InstanceMonitoringList'
- xml:
name: instancesSet
description: The monitoring information.
MoveAddressToVpcResult:
type: object
example:
Status: MoveInProgress
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: allocationId
description: The allocation ID for the Elastic IP address.
Status:
allOf:
- $ref: '#/components/schemas/Status'
- xml:
name: status
description: The status of the move of the IP address.
MoveByoipCidrToIpamResult:
type: object
properties:
ByoipCidr:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- xml:
name: byoipCidr
description: The BYOIP CIDR.
ProvisionByoipCidrResult:
type: object
properties:
ByoipCidr:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- xml:
name: byoipCidr
description: Information about the address range.
ProvisionIpamPoolCidrResult:
type: object
properties:
IpamPoolCidr:
allOf:
- $ref: '#/components/schemas/IpamPoolCidr'
- xml:
name: ipamPoolCidr
description: Information about the provisioned CIDR.
ProvisionPublicIpv4PoolCidrResult:
type: object
properties:
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- xml:
name: poolId
description: The ID of the pool that you want to provision the CIDR to.
PoolAddressRange:
allOf:
- $ref: '#/components/schemas/PublicIpv4PoolRange'
- xml:
name: poolAddressRange
description: Information about the address range of the public IPv4 pool.
PurchaseHostReservationResult:
type: object
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency in which the totalUpfrontPrice and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
Purchase:
allOf:
- $ref: '#/components/schemas/PurchaseSet'
- xml:
name: purchase
description: Describes the details of the purchase.
TotalHourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: totalHourlyPrice
description: The total hourly price of the reservation calculated per hour.
TotalUpfrontPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: totalUpfrontPrice
description: The total amount charged to your account when you purchase the reservation.
PurchaseReservedInstancesOfferingResult:
type: object
properties:
ReservedInstancesId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesId
description: 'The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted pricing tier, the final Reserved Instances IDs might change. For more information, see Crossing pricing tiers in the Amazon Elastic Compute Cloud User Guide.'
description: Contains the output of PurchaseReservedInstancesOffering.
CurrencyCodeValues:
type: string
enum:
- USD
PurchaseScheduledInstancesResult:
type: object
properties:
ScheduledInstanceSet:
allOf:
- $ref: '#/components/schemas/PurchasedScheduledInstanceSet'
- xml:
name: scheduledInstanceSet
description: Information about the Scheduled Instances.
description: Contains the output of PurchaseScheduledInstances.
PurchaseRequest:
type: object
required:
- InstanceCount
- PurchaseToken
properties:
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of instances.
PurchaseToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The purchase token.
description: Describes a request to purchase Scheduled Instances.
RegisterImageResult:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The ID of the newly registered AMI.
description: Contains the output of RegisterImage.
RegisterInstanceEventNotificationAttributesResult:
type: object
properties:
InstanceTagAttribute:
allOf:
- $ref: '#/components/schemas/InstanceTagNotificationAttribute'
- xml:
name: instanceTagAttribute
description: The resulting set of tag keys.
RegisterTransitGatewayMulticastGroupMembersResult:
type: object
properties:
RegisteredMulticastGroupMembers:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupMembers'
- xml:
name: registeredMulticastGroupMembers
description: Information about the registered transit gateway multicast group members.
RegisterTransitGatewayMulticastGroupSourcesResult:
type: object
properties:
RegisteredMulticastGroupSources:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastRegisteredGroupSources'
- xml:
name: registeredMulticastGroupSources
description: Information about the transit gateway multicast group sources.
RejectTransitGatewayMulticastDomainAssociationsResult:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociations'
- xml:
name: associations
description: Information about the multicast domain associations.
RejectTransitGatewayPeeringAttachmentResult:
type: object
properties:
TransitGatewayPeeringAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- xml:
name: transitGatewayPeeringAttachment
description: The transit gateway peering attachment.
RejectTransitGatewayVpcAttachmentResult:
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- xml:
name: transitGatewayVpcAttachment
description: Information about the attachment.
RejectVpcEndpointConnectionsResult:
type: object
properties:
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemSet'
- xml:
name: unsuccessful
description: 'Information about the endpoints that were not rejected, if applicable.'
RejectVpcPeeringConnectionResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
ReleaseHostsResult:
type: object
properties:
Successful:
allOf:
- $ref: '#/components/schemas/ResponseHostIdList'
- xml:
name: successful
description: The IDs of the Dedicated Hosts that were successfully released.
Unsuccessful:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemList'
- xml:
name: unsuccessful
description: 'The IDs of the Dedicated Hosts that could not be released, including an error message.'
ReleaseIpamPoolAllocationResult:
type: object
properties:
Success:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: success
description: Indicates if the release was successful.
ReplaceIamInstanceProfileAssociationResult:
type: object
properties:
IamInstanceProfileAssociation:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociation'
- xml:
name: iamInstanceProfileAssociation
description: Information about the IAM instance profile association.
ReplaceNetworkAclAssociationResult:
type: object
example:
NewAssociationId: aclassoc-3999875b
properties:
NewAssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: newAssociationId
description: The ID of the new association.
ReplaceRouteTableAssociationResult:
type: object
example:
NewAssociationId: rtbassoc-3a1f0f58
properties:
NewAssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: newAssociationId
description: The ID of the new association.
AssociationState:
allOf:
- $ref: '#/components/schemas/RouteTableAssociationState'
- xml:
name: associationState
description: The state of the association.
ReplaceTransitGatewayRouteResult:
type: object
properties:
Route:
allOf:
- $ref: '#/components/schemas/TransitGatewayRoute'
- xml:
name: route
description: Information about the modified route.
ReplaceVpnTunnelResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: Confirmation of replace tunnel operation.
ReportInstanceReasonCodes:
type: string
enum:
- instance-stuck-in-state
- unresponsive
- not-accepting-credentials
- password-not-available
- performance-network
- performance-instance-store
- performance-ebs-volume
- performance-other
- other
RequestSpotFleetResponse:
type: object
example:
SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
properties:
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
description: Contains the output of RequestSpotFleet.
AllocationStrategy:
type: string
enum:
- lowestPrice
- diversified
- capacityOptimized
- capacityOptimizedPrioritized
- priceCapacityOptimized
OnDemandAllocationStrategy:
type: string
enum:
- lowestPrice
- prioritized
SpotMaintenanceStrategies:
type: object
properties:
CapacityRebalance:
allOf:
- $ref: '#/components/schemas/SpotCapacityRebalance'
- xml:
name: capacityRebalance
description: 'The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see Capacity rebalancing in the Amazon EC2 User Guide for Linux Instances.'
description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
ExcessCapacityTerminationPolicy:
type: string
enum:
- noTermination
- default
LaunchSpecsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotFleetLaunchSpecification'
- xml:
name: item
LaunchTemplateConfigList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateConfig'
- xml:
name: item
FleetType:
type: string
enum:
- request
- maintain
- instant
InstanceInterruptionBehavior:
type: string
enum:
- hibernate
- stop
- terminate
LoadBalancersConfig:
type: object
properties:
ClassicLoadBalancersConfig:
allOf:
- $ref: '#/components/schemas/ClassicLoadBalancersConfig'
- xml:
name: classicLoadBalancersConfig
description: The Classic Load Balancers.
TargetGroupsConfig:
allOf:
- $ref: '#/components/schemas/TargetGroupsConfig'
- xml:
name: targetGroupsConfig
description: The target groups.
description: Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.
TagSpecificationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TagSpecification'
- xml:
name: item
RequestSpotInstancesResult:
type: object
properties:
SpotInstanceRequests:
allOf:
- $ref: '#/components/schemas/SpotInstanceRequestList'
- xml:
name: spotInstanceRequestSet
description: The Spot Instance requests.
description: Contains the output of RequestSpotInstances.
RequestSpotLaunchSpecificationSecurityGroupIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
RequestSpotLaunchSpecificationSecurityGroupList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
BlockDeviceMappingList:
type: array
items:
allOf:
- $ref: '#/components/schemas/BlockDeviceMapping'
- xml:
name: item
IamInstanceProfileSpecification:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) of the instance profile.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the instance profile.
description: Describes an IAM instance profile.
RunInstancesMonitoringEnabled:
type: object
required:
- Enabled
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enabled
description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
description: Describes the monitoring of an instance.
InstanceNetworkInterfaceSpecificationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceNetworkInterfaceSpecification'
- xml:
name: item
SpotPlacement:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: 'The Availability Zone.
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "us-west-2a, us-west-2b".
' GroupName: allOf: - $ref: '#/components/schemas/PlacementGroupName' - xml: name: groupName description: The name of the placement group. Tenancy: allOf: - $ref: '#/components/schemas/Tenancy' - xml: name: tenancy description: The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy ofdedicated runs on single-tenant hardware. The host tenancy is not supported for Spot Instances.
description: Describes Spot Instance placement.
ResetAddressAttributeResult:
type: object
properties:
Address:
allOf:
- $ref: '#/components/schemas/AddressAttribute'
- xml:
name: address
description: Information about the IP address.
ResetEbsDefaultKmsKeyIdResult:
type: object
properties:
KmsKeyId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kmsKeyId
description: The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.
ResetFpgaImageAttributeResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Is true if the request succeeds, and an error otherwise.'
RestoreAddressToClassicResult:
type: object
properties:
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The Elastic IP address.
Status:
allOf:
- $ref: '#/components/schemas/Status'
- xml:
name: status
description: The move status for the IP address.
RestoreImageFromRecycleBinResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
RestoreManagedPrefixListVersionResult:
type: object
properties:
PrefixList:
allOf:
- $ref: '#/components/schemas/ManagedPrefixList'
- xml:
name: prefixList
description: Information about the prefix list.
RestoreSnapshotFromRecycleBinResult:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: 'The ARN of the Outpost on which the snapshot is stored. For more information, see Amazon EBS local snapshots on Outposts in the Amazon Elastic Compute Cloud User Guide.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description for the snapshot.
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: encrypted
description: Indicates whether the snapshot is encrypted.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the EBS snapshot.
Progress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: progress
description: 'The progress of the snapshot, as a percentage.'
StartTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: startTime
description: The time stamp when the snapshot was initiated.
State:
allOf:
- $ref: '#/components/schemas/SnapshotState'
- xml:
name: status
description: The state of the snapshot.
VolumeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeId
description: The ID of the volume that was used to create the snapshot.
VolumeSize:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: volumeSize
description: 'The size of the volume, in GiB.'
SseType:
allOf:
- $ref: '#/components/schemas/SSEType'
- xml:
name: sseType
description: Reserved for future use.
RestoreSnapshotTierResult:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
RestoreStartTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: restoreStartTime
description: The date and time when the snapshot restore process started.
RestoreDuration:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: restoreDuration
description: For temporary restores only. The number of days for which the archived snapshot is temporarily restored.
IsPermanentRestore:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isPermanentRestore
description: Indicates whether the snapshot is permanently restored. true indicates a permanent restore. false indicates a temporary restore.
RevokeClientVpnIngressResult:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- xml:
name: status
description: The current state of the authorization rule.
RevokeSecurityGroupEgressResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, returns an error.'
UnknownIpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- xml:
name: unknownIpPermissionSet
description: 'The outbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. '
RevokeSecurityGroupIngressResult:
type: object
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, returns an error.'
UnknownIpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- xml:
name: unknownIpPermissionSet
description: 'The inbound rules that were unknown to the service. In some cases, unknownIpPermissionSet might be in a different format from the request parameter. '
Reservation:
type: object
example: {}
properties:
Groups:
allOf:
- $ref: '#/components/schemas/GroupIdentifierList'
- xml:
name: groupSet
description: Not supported.
Instances:
allOf:
- $ref: '#/components/schemas/InstanceList'
- xml:
name: instancesSet
description: The instances.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the reservation.
RequesterId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: requesterId
description: 'The ID of the requester that launched the instances on your behalf (for example, Amazon Web Services Management Console or Auto Scaling).'
ReservationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservationId
description: The ID of the reservation.
description: 'Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.'
Tenancy:
type: string
enum:
- default
- dedicated
- host
InstanceNetworkInterfaceSpecification:
type: object
properties:
AssociatePublicIpAddress:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: associatePublicIpAddress
description: 'Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is true.'
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: 'If set to true, the interface is deleted when the instance is terminated. You can specify true only if creating a new network interface when launching an instance.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the network interface. Applies only if creating a network interface when launching an instance.
DeviceIndex:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: deviceIndex
description: 'The position of the network interface in the attachment order. A primary network interface has a device index of 0.
If you specify a network interface when launching an instance, you must specify the device index.
' Groups: allOf: - $ref: '#/components/schemas/SecurityGroupIdStringList' - xml: name: SecurityGroupId description: The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance. Ipv6AddressCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: ipv6AddressCount description: A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch. Ipv6Addresses: allOf: - $ref: '#/components/schemas/InstanceIpv6AddressList' - xml: name: ipv6AddressesSet description: The IPv6 addresses to assign to the network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch. NetworkInterfaceId: allOf: - $ref: '#/components/schemas/NetworkInterfaceId' - xml: name: networkInterfaceId description: 'The ID of the network interface.
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.
' PrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIpAddress description: 'The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' PrivateIpAddresses: allOf: - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' - xml: name: privateIpAddressesSet description: 'The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' SecondaryPrivateIpAddressCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: secondaryPrivateIpAddressCount description: 'The number of secondary private IPv4 addresses. You can''t specify this option and specify more than one private IP address using the private IP addresses option. You cannot specify this option if you''re launching more than one instance in a RunInstances request.' SubnetId: allOf: - $ref: '#/components/schemas/String' - xml: name: subnetId description: The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance. AssociateCarrierIpAddress: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether to assign a carrier IP address to the network interface.
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see Carrier IP address in the Amazon Web Services Wavelength Developer Guide.
' InterfaceType: allOf: - $ref: '#/components/schemas/String' - description: 'The type of network interface.
Valid values: interface | efa
The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0.
If you are using RequestSpotInstances to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use RunInstances.
' Ipv4Prefixes: allOf: - $ref: '#/components/schemas/Ipv4PrefixList' - xml: name: Ipv4Prefix description: The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use theIpv4PrefixCount option.
Ipv4PrefixCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
Ipv6Prefixes:
allOf:
- $ref: '#/components/schemas/Ipv6PrefixList'
- xml:
name: Ipv6Prefix
description: The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
Ipv6PrefixCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
PrimaryIpv6:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.'
description: Describes a network interface.
ElasticGpuSpecification:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The type of Elastic Graphics accelerator. For more information about the values to specify for Type, see Elastic Graphics Basics, specifically the Elastic Graphics accelerator column, in the Amazon Elastic Compute Cloud User Guide for Windows Instances.'
description: A specification for an Elastic Graphics accelerator.
ElasticInferenceAccelerator:
type: object
required:
- Type
properties:
Type:
allOf:
- $ref: '#/components/schemas/String'
- description: ' The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, eia1.xlarge, eia2.medium, eia2.large, and eia2.xlarge. '
Count:
allOf:
- $ref: '#/components/schemas/ElasticInferenceAcceleratorCount'
- description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' description: ' Describes an elastic inference accelerator. ' MarketType: type: string enum: - spot SpotMarketOptions: type: object properties: MaxPrice: allOf: - $ref: '#/components/schemas/String' - description: 'The maximum hourly price that you''re willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
hibernate or stop.'
BlockDurationMinutes:
allOf:
- $ref: '#/components/schemas/Integer'
- description: Deprecated.
ValidUntil:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request remains active until all instances launch or you cancel the request.
terminate.
description: The options for Spot Instances.
AmdSevSnpSpecification:
type: string
enum:
- enabled
- disabled
LicenseConfigurationRequest:
type: object
properties:
LicenseConfigurationArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the license configuration.
description: Describes a license configuration.
HttpTokensState:
type: string
enum:
- optional
- required
InstanceMetadataEndpointState:
type: string
enum:
- disabled
- enabled
InstanceMetadataProtocolState:
type: string
enum:
- disabled
- enabled
InstanceMetadataTagsState:
type: string
enum:
- disabled
- enabled
HostnameType:
type: string
enum:
- ip-name
- resource-name
InstanceAutoRecoveryState:
type: string
enum:
- disabled
- default
RunScheduledInstancesResult:
type: object
properties:
InstanceIdSet:
allOf:
- $ref: '#/components/schemas/InstanceIdSet'
- xml:
name: instanceIdSet
description: The IDs of the newly launched instances.
description: Contains the output of RunScheduledInstances.
ScheduledInstancesBlockDeviceMappingSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesBlockDeviceMapping'
- xml:
name: BlockDeviceMapping
ScheduledInstancesIamInstanceProfile:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN).
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name.
description: Describes an IAM instance profile for a Scheduled Instance.
ScheduledInstancesMonitoring:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether monitoring is enabled.
description: Describes whether monitoring is enabled for a Scheduled Instance.
ScheduledInstancesNetworkInterfaceSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesNetworkInterface'
- xml:
name: NetworkInterface
ScheduledInstancesPlacement:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The Availability Zone.
GroupName:
allOf:
- $ref: '#/components/schemas/PlacementGroupName'
- description: The name of the placement group.
description: Describes the placement for a Scheduled Instance.
ScheduledInstancesSecurityGroupIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: SecurityGroupId
SearchLocalGatewayRoutesResult:
type: object
properties:
Routes:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteList'
- xml:
name: routeSet
description: Information about the routes.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SearchTransitGatewayMulticastGroupsResult:
type: object
properties:
MulticastGroups:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastGroupList'
- xml:
name: multicastGroups
description: Information about the transit gateway multicast group.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to use to retrieve the next page of results. This value is null when there are no more results to return.
SearchTransitGatewayRoutesResult:
type: object
properties:
Routes:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteList'
- xml:
name: routeSet
description: Information about the routes.
AdditionalRoutesAvailable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: additionalRoutesAvailable
description: Indicates whether there are additional routes available.
StartInstancesResult:
type: object
example:
StartingInstances:
- CurrentState:
Code: 0
Name: pending
InstanceId: i-1234567890abcdef0
PreviousState:
Code: 80
Name: stopped
properties:
StartingInstances:
allOf:
- $ref: '#/components/schemas/InstanceStateChangeList'
- xml:
name: instancesSet
description: Information about the started instances.
StartNetworkInsightsAccessScopeAnalysisResult:
type: object
properties:
NetworkInsightsAccessScopeAnalysis:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis'
- xml:
name: networkInsightsAccessScopeAnalysis
description: The Network Access Scope analysis.
StartNetworkInsightsAnalysisResult:
type: object
properties:
NetworkInsightsAnalysis:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysis'
- xml:
name: networkInsightsAnalysis
description: Information about the network insights analysis.
ResourceArn:
type: string
minLength: 1
maxLength: 1283
StartVpcEndpointServicePrivateDnsVerificationResult:
type: object
properties:
ReturnValue:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, it returns an error.'
StopInstancesResult:
type: object
example:
StoppingInstances:
- CurrentState:
Code: 64
Name: stopping
InstanceId: i-1234567890abcdef0
PreviousState:
Code: 16
Name: running
properties:
StoppingInstances:
allOf:
- $ref: '#/components/schemas/InstanceStateChangeList'
- xml:
name: instancesSet
description: Information about the stopped instances.
TerminateClientVpnConnectionsResult:
type: object
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientVpnEndpointId
description: The ID of the Client VPN endpoint.
Username:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: username
description: The user who established the terminated client connections.
ConnectionStatuses:
allOf:
- $ref: '#/components/schemas/TerminateConnectionStatusSet'
- xml:
name: connectionStatuses
description: The current state of the client connections.
TerminateInstancesResult:
type: object
example:
TerminatingInstances:
- CurrentState:
Code: 32
Name: shutting-down
InstanceId: i-1234567890abcdef0
PreviousState:
Code: 16
Name: running
properties:
TerminatingInstances:
allOf:
- $ref: '#/components/schemas/InstanceStateChangeList'
- xml:
name: instancesSet
description: Information about the terminated instances.
UnassignIpv6AddressesResult:
type: object
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
UnassignedIpv6Addresses:
allOf:
- $ref: '#/components/schemas/Ipv6AddressList'
- xml:
name: unassignedIpv6Addresses
description: The IPv6 addresses that have been unassigned from the network interface.
UnassignedIpv6Prefixes:
allOf:
- $ref: '#/components/schemas/IpPrefixList'
- xml:
name: unassignedIpv6PrefixSet
description: The IPv4 prefixes that have been unassigned from the network interface.
UnassignPrivateNatGatewayAddressResult:
type: object
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- xml:
name: natGatewayId
description: The ID of the NAT gateway.
NatGatewayAddresses:
allOf:
- $ref: '#/components/schemas/NatGatewayAddressList'
- xml:
name: natGatewayAddressSet
description: Information about the NAT gateway IP addresses.
UnmonitorInstancesResult:
type: object
properties:
InstanceMonitorings:
allOf:
- $ref: '#/components/schemas/InstanceMonitoringList'
- xml:
name: instancesSet
description: The monitoring information.
UpdateSecurityGroupRuleDescriptionsEgressResult:
type: object
example: {}
properties:
Return:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: return
description: 'Returns true if the request succeeds; otherwise, returns an error.'
SecurityGroupRuleDescription:
type: object
properties:
SecurityGroupRuleId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the security group rule.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the security group rule.
description: Describes the description of a security group rule.
You can use this when you want to update the security group rule description for either an inbound or outbound rule.
UpdateSecurityGroupRuleDescriptionsIngressResult: type: object example: {} properties: Return: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: return description: 'Returnstrue if the request succeeds; otherwise, returns an error.'
WithdrawByoipCidrResult:
type: object
properties:
ByoipCidr:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- xml:
name: byoipCidr
description: Information about the address pool.
AcceleratorCount:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: min
description: 'The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: max
description: 'The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.'
description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.'
AcceleratorManufacturer:
type: string
enum:
- nvidia
- amd
- amazon-web-services
- xilinx
AcceleratorName:
type: string
enum:
- a100
- v100
- k80
- t4
- m60
- radeon-pro-v520
- vu9p
- inferentia
- k520
AcceleratorTotalMemoryMiB:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: min
description: 'The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: max
description: 'The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.'
description: 'The minimum and maximum amount of total accelerator memory, in MiB.'
AcceleratorType:
type: string
enum:
- gpu
- fpga
- inference
AcceptAddressTransferRequest:
type: object
required:
- Address
title: AcceptAddressTransferRequest
properties:
Address:
allOf:
- $ref: '#/components/schemas/String'
- description: The Elastic IP address you are accepting for transfer.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: ' 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.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
AddressTransfer:
type: object
properties:
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The Elastic IP address being transferred.
AllocationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: allocationId
description: The allocation ID of an Elastic IP address.
TransferAccountId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transferAccountId
description: The ID of the account that you want to transfer the Elastic IP address to.
TransferOfferExpirationTimestamp:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: transferOfferExpirationTimestamp
description: '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.'
TransferOfferAcceptedTimestamp:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: transferOfferAcceptedTimestamp
description: The timestamp when the Elastic IP address transfer was accepted.
AddressTransferStatus:
allOf:
- $ref: '#/components/schemas/AddressTransferStatus'
- xml:
name: addressTransferStatus
description: The Elastic IP address transfer status.
description: 'Details on the Elastic IP address transfer. For more information, see Transfer Elastic IP addresses in the Amazon Virtual Private Cloud User Guide.'
ReservedInstanceIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservationId'
- xml:
name: ReservedInstanceId
TargetConfigurationRequestSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TargetConfigurationRequest'
- xml:
name: TargetConfigurationRequest
AcceptReservedInstancesExchangeQuoteRequest:
type: object
required:
- ReservedInstanceIds
title: AcceptReservedInstancesExchangeQuoteRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReservedInstanceIds:
allOf:
- $ref: '#/components/schemas/ReservedInstanceIdSet'
- xml:
name: ReservedInstanceId
description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
TargetConfigurations:
allOf:
- $ref: '#/components/schemas/TargetConfigurationRequestSet'
- xml:
name: TargetConfiguration
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
description: Contains the parameters for accepting the quote.
AcceptTransitGatewayMulticastDomainAssociationsRequest:
type: object
title: AcceptTransitGatewayMulticastDomainAssociationsRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway attachment.
SubnetIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The IDs of the subnets to associate with the transit gateway multicast domain.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastDomainAssociations:
type: object
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayMulticastDomainId
description: The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the transit gateway attachment.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: 'The type of resource, for example a VPC attachment.'
ResourceOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceOwnerId
description: ' The ID of the Amazon Web Services account that owns the resource.'
Subnets:
allOf:
- $ref: '#/components/schemas/SubnetAssociationList'
- xml:
name: subnets
description: The subnets associated with the multicast domain.
description: Describes the multicast domain associations.
AcceptTransitGatewayPeeringAttachmentRequest:
type: object
required:
- TransitGatewayAttachmentId
title: AcceptTransitGatewayPeeringAttachmentRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPeeringAttachment:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the transit gateway peering attachment.
AccepterTransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: accepterTransitGatewayAttachmentId
description: The ID of the accepter transit gateway attachment.
RequesterTgwInfo:
allOf:
- $ref: '#/components/schemas/PeeringTgwInfo'
- xml:
name: requesterTgwInfo
description: Information about the requester transit gateway.
AccepterTgwInfo:
allOf:
- $ref: '#/components/schemas/PeeringTgwInfo'
- xml:
name: accepterTgwInfo
description: Information about the accepter transit gateway.
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayPeeringAttachmentOptions'
- xml:
name: options
description: Details about the transit gateway peering attachment.
Status:
allOf:
- $ref: '#/components/schemas/PeeringAttachmentStatus'
- xml:
name: status
description: The status of the transit gateway peering attachment.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentState'
- xml:
name: state
description: The state of the transit gateway peering attachment. Note that the initiating state has been deprecated.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The time the transit gateway peering attachment was created.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the transit gateway peering attachment.
description: Describes the transit gateway peering attachment.
AcceptTransitGatewayVpcAttachmentRequest:
type: object
required:
- TransitGatewayAttachmentId
title: AcceptTransitGatewayVpcAttachmentRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayVpcAttachment:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
VpcOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcOwnerId
description: The ID of the Amazon Web Services account that owns the VPC.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentState'
- xml:
name: state
description: The state of the VPC attachment. Note that the initiating state has been deprecated.
SubnetIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: subnetIds
description: The IDs of the subnets.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The creation time.
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachmentOptions'
- xml:
name: options
description: The VPC attachment options.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the VPC attachment.
description: Describes a VPC attachment.
VpcEndpointIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- xml:
name: item
AcceptVpcEndpointConnectionsRequest:
type: object
required:
- ServiceId
- VpcEndpointIds
title: AcceptVpcEndpointConnectionsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the VPC endpoint service.
VpcEndpointIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointIdList'
- xml:
name: VpcEndpointId
description: The IDs of the interface VPC endpoints.
UnsuccessfulItemSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItem'
- xml:
name: item
VpcPeeringConnectionIdWithResolver:
type: string
AcceptVpcPeeringConnectionRequest:
type: object
required:
- VpcPeeringConnectionId
title: AcceptVpcPeeringConnectionRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionIdWithResolver'
- xml:
name: vpcPeeringConnectionId
description: The ID of the VPC peering connection. You must specify this parameter in the request.
VpcPeeringConnection:
type: object
properties:
AccepterVpcInfo:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
- xml:
name: accepterVpcInfo
description: Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.
ExpirationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: expirationTime
description: The time that an unaccepted VPC peering connection will expire.
RequesterVpcInfo:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
- xml:
name: requesterVpcInfo
description: Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.
Status:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionStateReason'
- xml:
name: status
description: The status of the VPC peering connection.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the resource.
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcPeeringConnectionId
description: The ID of the VPC peering connection.
description: Describes a VPC peering connection.
PathComponentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PathComponent'
- xml:
name: item
AccessScopeAnalysisFinding:
type: object
properties:
NetworkInsightsAccessScopeAnalysisId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- xml:
name: networkInsightsAccessScopeAnalysisId
description: The ID of the Network Access Scope analysis.
NetworkInsightsAccessScopeId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- xml:
name: networkInsightsAccessScopeId
description: The ID of the Network Access Scope.
FindingId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: findingId
description: The ID of the finding.
FindingComponents:
allOf:
- $ref: '#/components/schemas/PathComponentList'
- xml:
name: findingComponentSet
description: The finding components.
description: Describes a finding for a Network Access Scope.
AccessScopeAnalysisFindingList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AccessScopeAnalysisFinding'
- xml:
name: item
PathStatement:
type: object
properties:
PacketHeaderStatement:
allOf:
- $ref: '#/components/schemas/PacketHeaderStatement'
- xml:
name: packetHeaderStatement
description: The packet header statement.
ResourceStatement:
allOf:
- $ref: '#/components/schemas/ResourceStatement'
- xml:
name: resourceStatement
description: The resource statement.
description: Describes a path statement.
ThroughResourcesStatementList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ThroughResourcesStatement'
- xml:
name: item
AccessScopePath:
type: object
properties:
Source:
allOf:
- $ref: '#/components/schemas/PathStatement'
- xml:
name: source
description: The source.
Destination:
allOf:
- $ref: '#/components/schemas/PathStatement'
- xml:
name: destination
description: The destination.
ThroughResources:
allOf:
- $ref: '#/components/schemas/ThroughResourcesStatementList'
- xml:
name: throughResourceSet
description: The through resources.
description: Describes a path.
AccessScopePathList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AccessScopePath'
- xml:
name: item
AccessScopePathListRequest:
type: array
items:
allOf:
- $ref: '#/components/schemas/AccessScopePathRequest'
- xml:
name: item
PathStatementRequest:
type: object
properties:
PacketHeaderStatement:
allOf:
- $ref: '#/components/schemas/PacketHeaderStatementRequest'
- description: The packet header statement.
ResourceStatement:
allOf:
- $ref: '#/components/schemas/ResourceStatementRequest'
- description: The resource statement.
description: Describes a path statement.
ThroughResourcesStatementRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ThroughResourcesStatementRequest'
- xml:
name: item
AccountAttributeValueList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AccountAttributeValue'
- xml:
name: item
AccountAttribute:
type: object
properties:
AttributeName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: attributeName
description: The name of the account attribute.
AttributeValues:
allOf:
- $ref: '#/components/schemas/AccountAttributeValueList'
- xml:
name: attributeValueSet
description: The values for the account attribute.
description: Describes an account attribute.
AccountAttributeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AccountAttribute'
- xml:
name: item
AccountAttributeNameStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AccountAttributeName'
- xml:
name: attributeName
AccountAttributeValue:
type: object
properties:
AttributeValue:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: attributeValue
description: The value of the attribute.
description: Describes a value of an account attribute.
InstanceHealthStatus:
type: string
enum:
- healthy
- unhealthy
ActiveInstance:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: The instance type.
SpotInstanceRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotInstanceRequestId
description: The ID of the Spot Instance request.
InstanceHealth:
allOf:
- $ref: '#/components/schemas/InstanceHealthStatus'
- xml:
name: instanceHealth
description: '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.'
description: Describes a running instance in a Spot Fleet.
ActiveInstanceSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ActiveInstance'
- xml:
name: item
ActivityStatus:
type: string
enum:
- error
- pending_fulfillment
- pending_termination
- fulfilled
AddIpamOperatingRegionSet:
type: array
items:
$ref: '#/components/schemas/AddIpamOperatingRegion'
minItems: 0
maxItems: 50
AddPrefixListEntries:
type: array
items:
$ref: '#/components/schemas/AddPrefixListEntry'
minItems: 0
maxItems: 100
PrincipalType:
type: string
enum:
- All
- Service
- OrganizationUnit
- Account
- User
- Role
AddedPrincipal:
type: object
properties:
PrincipalType:
allOf:
- $ref: '#/components/schemas/PrincipalType'
- xml:
name: principalType
description: The type of principal.
Principal:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: principal
description: The Amazon Resource Name (ARN) of the principal.
ServicePermissionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: servicePermissionId
description: The ID of the service permission.
ServiceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceId
description: The ID of the service.
description: Describes a principal.
AddedPrincipalSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AddedPrincipal'
- xml:
name: item
AnalysisComponent:
type: object
properties:
Id:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: id
description: The ID of the component.
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) of the component.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the analysis component.
description: Describes a path component.
RuleOptionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RuleOption'
- xml:
name: item
RuleGroupTypePairList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RuleGroupTypePair'
- xml:
name: item
RuleGroupRuleOptionsPairList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RuleGroupRuleOptionsPair'
- xml:
name: item
AnalysisComponentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: item
AdditionalDetail:
type: object
properties:
AdditionalDetailType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: additionalDetailType
description: The additional detail code.
Component:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: component
description: The path component.
VpcEndpointService:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: vpcEndpointService
description: The VPC endpoint service.
RuleOptions:
allOf:
- $ref: '#/components/schemas/RuleOptionList'
- xml:
name: ruleOptionSet
description: The rule options.
RuleGroupTypePairs:
allOf:
- $ref: '#/components/schemas/RuleGroupTypePairList'
- xml:
name: ruleGroupTypePairSet
description: The rule group type.
RuleGroupRuleOptionsPairs:
allOf:
- $ref: '#/components/schemas/RuleGroupRuleOptionsPairList'
- xml:
name: ruleGroupRuleOptionsPairSet
description: The rule options.
ServiceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceName
description: The name of the VPC endpoint service.
LoadBalancers:
allOf:
- $ref: '#/components/schemas/AnalysisComponentList'
- xml:
name: loadBalancerSet
description: The load balancers.
description: 'Describes an additional detail for a path analysis. For more information, see Reachability Analyzer additional detail codes.'
AdditionalDetailList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AdditionalDetail'
- xml:
name: item
DomainType:
type: string
enum:
- vpc
- standard
Address:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance that the address is associated with (if any).
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The Elastic IP address.
AllocationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: allocationId
description: The ID representing the allocation of the address.
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The ID representing the association of the address with an instance.
Domain:
allOf:
- $ref: '#/components/schemas/DomainType'
- xml:
name: domain
description: The network (vpc).
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
NetworkInterfaceOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceOwnerId
description: The ID of the Amazon Web Services account that owns the network interface.
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateIpAddress
description: The private IP address associated with the Elastic IP address.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the Elastic IP address.
PublicIpv4Pool:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIpv4Pool
description: The ID of an address pool.
NetworkBorderGroup:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkBorderGroup
description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.'
CustomerOwnedIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: customerOwnedIp
description: The customer-owned IP address.
CustomerOwnedIpv4Pool:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: customerOwnedIpv4Pool
description: The ID of the customer-owned address pool.
CarrierIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: carrierIp
description: '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). '
description: 'Describes an Elastic IP address, or a carrier IP address.'
PublicIpAddress:
type: string
PtrUpdateStatus:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The value for the PTR record update.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: The status of the PTR record update.
Reason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reason
description: The reason for the PTR record update.
description: The status of an updated pointer (PTR) record for an Elastic IP address.
AddressAttribute:
type: object
properties:
PublicIp:
allOf:
- $ref: '#/components/schemas/PublicIpAddress'
- xml:
name: publicIp
description: The public IP address.
AllocationId:
allOf:
- $ref: '#/components/schemas/AllocationId'
- xml:
name: allocationId
description: '[EC2-VPC] The allocation ID.'
PtrRecord:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ptrRecord
description: The pointer (PTR) record for the IP address.
PtrRecordUpdate:
allOf:
- $ref: '#/components/schemas/PtrUpdateStatus'
- xml:
name: ptrRecordUpdate
description: The updated PTR record for the IP address.
description: The attributes associated with an Elastic IP address.
AddressAttributeName:
type: string
enum:
- domain-name
AddressFamily:
type: string
enum:
- ipv4
- ipv6
AddressList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Address'
- xml:
name: item
AddressMaxResults:
type: integer
minimum: 1
maximum: 1000
AddressSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AddressAttribute'
- xml:
name: item
MillisecondDateTime:
type: string
format: date-time
AddressTransferStatus:
type: string
enum:
- pending
- disabled
- accepted
AddressTransferList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AddressTransfer'
- xml:
name: item
AdvertiseByoipCidrRequest:
type: object
required:
- Cidr
title: AdvertiseByoipCidrRequest
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: '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.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ByoipCidr:
type: object
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidr
description: 'The address range, in CIDR notation.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the address range.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: 'Upon success, contains the ID of the address pool. Otherwise, contains an error message.'
State:
allOf:
- $ref: '#/components/schemas/ByoipCidrState'
- xml:
name: state
description: The state of the address pool.
description: Information about an address range that is provisioned for use with your Amazon Web Services resources through bring your own IP addresses (BYOIP).
Affinity:
type: string
enum:
- default
- host
AllocateAddressRequest:
type: object
title: AllocateAddressRequest
properties:
Domain:
allOf:
- $ref: '#/components/schemas/DomainType'
- description: The network (vpc).
Address:
allOf:
- $ref: '#/components/schemas/PublicIpAddress'
- description: The Elastic IP address to recover or an IPv4 address from an address pool.
PublicIpv4Pool:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- description: '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.'
NetworkBorderGroup:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups.
Use DescribeAvailabilityZones to view the network border groups.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the Elastic IP address.
AutoPlacement:
type: string
enum:
- 'on'
- 'off'
HostRecovery:
type: string
enum:
- 'on'
- 'off'
HostMaintenance:
type: string
enum:
- 'on'
- 'off'
AssetIdList:
type: array
items:
$ref: '#/components/schemas/AssetId'
AllocateHostsRequest:
type: object
required:
- AvailabilityZone
title: AllocateHostsRequest
properties:
AutoPlacement:
allOf:
- $ref: '#/components/schemas/AutoPlacement'
- xml:
name: autoPlacement
description: 'Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see Understanding auto-placement and affinity in the Amazon EC2 User Guide.
Default: on
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.
' InstanceFamily: allOf: - $ref: '#/components/schemas/String' - description: '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: allOf: - $ref: '#/components/schemas/Integer' - xml: name: quantity description: '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.' TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: The tags to apply to the Dedicated Host during creation. HostRecovery: allOf: - $ref: '#/components/schemas/HostRecovery' - description: '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: allOf: - $ref: '#/components/schemas/HostMaintenance' - description: '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: allOf: - $ref: '#/components/schemas/AssetIdList' - xml: name: AssetId description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool from which you would like to allocate a CIDR.
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: '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: allOf: - $ref: '#/components/schemas/Integer' - description: '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: allOf: - $ref: '#/components/schemas/String' - description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.' Description: allOf: - $ref: '#/components/schemas/String' - description: A description for the allocation. PreviewNextCidr: allOf: - $ref: '#/components/schemas/Boolean' - description: A preview of the next available CIDR in a pool. DisallowedCidrs: allOf: - $ref: '#/components/schemas/IpamPoolAllocationDisallowedCidrs' - xml: name: DisallowedCidr description: Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation. IpamPoolAllocation: type: object properties: Cidr: allOf: - $ref: '#/components/schemas/String' - xml: name: cidr description: 'The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.'
IpamPoolAllocationId:
allOf:
- $ref: '#/components/schemas/IpamPoolAllocationId'
- xml:
name: ipamPoolAllocationId
description: The ID of an allocation.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the pool allocation.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/IpamPoolAllocationResourceType'
- xml:
name: resourceType
description: The type of the resource.
ResourceRegion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceRegion
description: The Amazon Web Services Region of the resource.
ResourceOwner:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceOwner
description: The owner of the resource.
description: 'In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.'
AllocationIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AllocationId'
- xml:
name: AllocationId
AllocationIds:
type: array
items:
allOf:
- $ref: '#/components/schemas/AllocationId'
- xml:
name: item
AllocationState:
type: string
enum:
- available
- under-assessment
- permanent-failure
- released
- released-permanent-failure
- pending
AllocationType:
type: string
enum:
- used
AllowedInstanceType:
type: string
pattern: '[a-zA-Z0-9\.\*\-]+'
minLength: 1
maxLength: 30
AllowedPrincipal:
type: object
properties:
PrincipalType:
allOf:
- $ref: '#/components/schemas/PrincipalType'
- xml:
name: principalType
description: The type of principal.
Principal:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: principal
description: The Amazon Resource Name (ARN) of the principal.
ServicePermissionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: servicePermissionId
description: The ID of the service permission.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags.
ServiceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceId
description: The ID of the service.
description: Describes a principal.
AllowedPrincipalSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AllowedPrincipal'
- xml:
name: item
AllowsMultipleInstanceTypes:
type: string
enum:
- 'on'
- 'off'
AlternatePathHint:
type: object
properties:
ComponentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: componentId
description: The ID of the component.
ComponentArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: componentArn
description: The Amazon Resource Name (ARN) of the component.
description: Describes an potential intermediate component of a feasible path.
AlternatePathHintList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AlternatePathHint'
- xml:
name: item
PortRange:
type: object
properties:
From:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: from
description: The first port in the range.
To:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: to
description: The last port in the range.
description: Describes a range of ports.
AnalysisAclRule:
type: object
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidr
description: 'The IPv4 address range, in CIDR notation.'
Egress:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: egress
description: Indicates whether the rule is an outbound rule.
PortRange:
allOf:
- $ref: '#/components/schemas/PortRange'
- xml:
name: portRange
description: The range of ports.
Protocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: protocol
description: The protocol.
RuleAction:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ruleAction
description: Indicates whether to allow or deny traffic that matches the rule.
RuleNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ruleNumber
description: The rule number.
description: Describes a network access control (ACL) rule.
Port:
type: integer
minimum: 0
maximum: 65535
AnalysisLoadBalancerListener:
type: object
properties:
LoadBalancerPort:
allOf:
- $ref: '#/components/schemas/Port'
- xml:
name: loadBalancerPort
description: The port on which the load balancer is listening.
InstancePort:
allOf:
- $ref: '#/components/schemas/Port'
- xml:
name: instancePort
description: '[Classic Load Balancers] The back-end port for the listener.'
description: Describes a load balancer listener.
AnalysisLoadBalancerTarget:
type: object
properties:
Address:
allOf:
- $ref: '#/components/schemas/IpAddress'
- xml:
name: address
description: The IP address.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
Instance:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: instance
description: Information about the instance.
Port:
allOf:
- $ref: '#/components/schemas/Port'
- xml:
name: port
description: The port on which the target is listening.
description: Describes a load balancer target.
IpAddressList:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpAddress'
- xml:
name: item
PortRangeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PortRange'
- xml:
name: item
AnalysisPacketHeader:
type: object
properties:
DestinationAddresses:
allOf:
- $ref: '#/components/schemas/IpAddressList'
- xml:
name: destinationAddressSet
description: The destination addresses.
DestinationPortRanges:
allOf:
- $ref: '#/components/schemas/PortRangeList'
- xml:
name: destinationPortRangeSet
description: The destination port ranges.
Protocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: protocol
description: The protocol.
SourceAddresses:
allOf:
- $ref: '#/components/schemas/IpAddressList'
- xml:
name: sourceAddressSet
description: The source addresses.
SourcePortRanges:
allOf:
- $ref: '#/components/schemas/PortRangeList'
- xml:
name: sourcePortRangeSet
description: The source port ranges.
description: 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: object
properties:
DestinationCidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidr
description: 'The destination IPv4 address, in CIDR notation.'
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationPrefixListId
description: The prefix of the Amazon Web Service.
EgressOnlyInternetGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: egressOnlyInternetGatewayId
description: The ID of an egress-only internet gateway.
GatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: gatewayId
description: 'The ID of the gateway, such as an internet gateway or virtual private gateway.'
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: 'The ID of the instance, such as a NAT instance.'
NatGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: natGatewayId
description: The ID of a NAT gateway.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of a network interface.
Origin:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: origin
description: '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 state. The following are the possible values:
active
blackhole
The direction. The following are the possible values:
egress
ingress
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ArchitectureTypeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ArchitectureType'
- xml:
name: item
ArnList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: item
Ipv6AddressList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
IpPrefixList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
AssignIpv6AddressesRequest:
type: object
required:
- NetworkInterfaceId
title: AssignIpv6AddressesRequest
properties:
Ipv6AddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ipv6AddressCount
description: 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.
Ipv6Addresses:
allOf:
- $ref: '#/components/schemas/Ipv6AddressList'
- xml:
name: ipv6Addresses
description: 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.
Ipv6PrefixCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 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.
Ipv6Prefixes:
allOf:
- $ref: '#/components/schemas/IpPrefixList'
- xml:
name: Ipv6Prefix
description: One or more IPv6 prefixes assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
PrivateIpAddressStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: PrivateIpAddress
AssignPrivateIpAddressesRequest:
type: object
required:
- NetworkInterfaceId
title: AssignPrivateIpAddressesRequest
properties:
AllowReassignment:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowReassignment
description: 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.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
PrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/PrivateIpAddressStringList'
- xml:
name: privateIpAddress
description: '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.
' SecondaryPrivateIpAddressCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: secondaryPrivateIpAddressCount description: The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. Ipv4Prefixes: allOf: - $ref: '#/components/schemas/IpPrefixList' - xml: name: Ipv4Prefix description: One or more IPv4 prefixes assigned to the network interface. You cannot use this option if you use theIpv4PrefixCount option.
Ipv4PrefixCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 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.
description: Contains the parameters for AssignPrivateIpAddresses.
AssignedPrivateIpAddressList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AssignedPrivateIpAddress'
- xml:
name: item
Ipv4PrefixesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv4PrefixSpecification'
- xml:
name: item
IpList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
PrivateIpAddressCount:
type: integer
minimum: 1
maximum: 31
AssignPrivateNatGatewayAddressRequest:
type: object
required:
- NatGatewayId
title: AssignPrivateNatGatewayAddressRequest
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- description: The ID of the NAT gateway.
PrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/IpList'
- xml:
name: PrivateIpAddress
description: The private IPv4 addresses you want to assign to the private NAT gateway.
PrivateIpAddressCount:
allOf:
- $ref: '#/components/schemas/PrivateIpAddressCount'
- description: 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:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NatGatewayAddressList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NatGatewayAddress'
- xml:
name: item
AssignedPrivateIpAddress:
type: object
properties:
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateIpAddress
description: The private IP address assigned to the network interface.
description: Describes the private IP addresses assigned to a network interface.
EipAllocationPublicIp:
type: string
AssociateAddressRequest:
type: object
title: AssociateAddressRequest
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/AllocationId'
- description: The allocation ID. This is required.
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: '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:
allOf:
- $ref: '#/components/schemas/EipAllocationPublicIp'
- description: Deprecated.
AllowReassociation:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowReassociation
description: 'Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: '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.
' PrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIpAddress description: '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.' AssociateClientVpnTargetNetworkRequest: type: object required: - ClientVpnEndpointId - SubnetId title: AssociateClientVpnTargetNetworkRequest properties: ClientVpnEndpointId: allOf: - $ref: '#/components/schemas/ClientVpnEndpointId' - description: The ID of the Client VPN endpoint. SubnetId: allOf: - $ref: '#/components/schemas/SubnetId' - description: The ID of the subnet to associate with the Client VPN endpoint. ClientToken: allOf: - $ref: '#/components/schemas/String' - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
AssociationStatus:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/AssociationStatusCode'
- xml:
name: code
description: The state of the target network association.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: 'A message about the status of the target network association, if applicable.'
description: Describes the state of a target network association.
DefaultingDhcpOptionsId:
type: string
AssociateDhcpOptionsRequest:
type: object
required:
- DhcpOptionsId
- VpcId
title: AssociateDhcpOptionsRequest
properties:
DhcpOptionsId:
allOf:
- $ref: '#/components/schemas/DefaultingDhcpOptionsId'
- description: 'The ID of the DHCP options set, or default to associate no DHCP options with the VPC.'
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CertificateId:
type: string
RoleId:
type: string
AssociateEnclaveCertificateIamRoleRequest:
type: object
required:
- CertificateArn
- RoleArn
title: AssociateEnclaveCertificateIamRoleRequest
properties:
CertificateArn:
allOf:
- $ref: '#/components/schemas/CertificateId'
- description: The ARN of the ACM certificate with which to associate the IAM role.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleId'
- description: 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:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
AssociateIamInstanceProfileRequest:
type: object
required:
- IamInstanceProfile
- InstanceId
title: AssociateIamInstanceProfileRequest
properties:
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileSpecification'
- description: The IAM instance profile.
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
IamInstanceProfileAssociation:
type: object
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The ID of the association.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfile'
- xml:
name: iamInstanceProfile
description: The IAM instance profile.
State:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociationState'
- xml:
name: state
description: The state of the association.
Timestamp:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: timestamp
description: The time the IAM instance profile was associated with the instance.
description: Describes an association between an IAM instance profile and an instance.
InstanceEventWindowAssociationRequest:
type: object
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdList'
- xml:
name: InstanceId
description: 'The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can''t specify the Instance ID parameter; you must use the Dedicated Host ID parameter.'
InstanceTags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: InstanceTag
description: The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.
DedicatedHostIds:
allOf:
- $ref: '#/components/schemas/DedicatedHostIdList'
- xml:
name: DedicatedHostId
description: The IDs of the Dedicated Hosts to associate with the event window.
description: 'One or more targets associated with the specified event window. Only one type of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.'
AssociateInstanceEventWindowRequest:
type: object
required:
- InstanceEventWindowId
- AssociationTarget
title: AssociateInstanceEventWindowRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceEventWindowId:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- description: The ID of the event window.
AssociationTarget:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowAssociationRequest'
- description: One or more targets associated with the specified event window.
InstanceEventWindow:
type: object
properties:
InstanceEventWindowId:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- xml:
name: instanceEventWindowId
description: The ID of the event window.
TimeRanges:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowTimeRangeList'
- xml:
name: timeRangeSet
description: One or more time ranges defined for the event window.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the event window.
CronExpression:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowCronExpression'
- xml:
name: cronExpression
description: The cron expression defined for the event window.
AssociationTarget:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowAssociationTarget'
- xml:
name: associationTarget
description: One or more targets associated with the event window.
State:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowState'
- xml:
name: state
description: The current state of the event window.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The instance tags associated with the event window.
description: The event window.
IpamId:
type: string
IpamResourceDiscoveryId:
type: string
AssociateIpamResourceDiscoveryRequest:
type: object
required:
- IpamId
- IpamResourceDiscoveryId
title: AssociateIpamResourceDiscoveryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamId:
allOf:
- $ref: '#/components/schemas/IpamId'
- description: An IPAM ID.
IpamResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- description: A resource discovery ID.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: Tag specifications.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A client token.
IpamResourceDiscoveryAssociation:
type: object
properties:
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The Amazon Web Services account ID of the resource discovery owner.
IpamResourceDiscoveryAssociationId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryAssociationId'
- xml:
name: ipamResourceDiscoveryAssociationId
description: The resource discovery association ID.
IpamResourceDiscoveryAssociationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipamResourceDiscoveryAssociationArn
description: The resource discovery association Amazon Resource Name (ARN).
IpamResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- xml:
name: ipamResourceDiscoveryId
description: The resource discovery ID.
IpamId:
allOf:
- $ref: '#/components/schemas/IpamId'
- xml:
name: ipamId
description: The IPAM ID.
IpamArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ipamArn
description: The IPAM ARN.
IpamRegion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipamRegion
description: The IPAM home Region.
IsDefault:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isDefault
description: 'Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it''s associated with your IPAM.'
ResourceDiscoveryStatus:
allOf:
- $ref: '#/components/schemas/IpamAssociatedResourceDiscoveryStatus'
- xml:
name: resourceDiscoveryStatus
description: The resource discovery status.
active - Connection or permissions required to read the results of the resource discovery are intact.
not-found - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the Amazon Web Services RAM resource share is still intact.
The lifecycle state of the association when you associate or disassociate a resource discovery.
associate-in-progress - Resource discovery is being associated.
associate-complete - Resource discovery association is complete.
associate-failed - Resource discovery association has failed.
disassociate-in-progress - Resource discovery is being disassociated.
disassociate-complete - Resource discovery disassociation is complete.
disassociate-failed - Resource discovery disassociation has failed.
isolate-in-progress - Amazon Web Services account that created the resource discovery association has been removed and the resource discovery associatation is being isolated.
isolate-complete - Resource discovery isolation is complete..
restore-in-progress - Resource discovery is being restored.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RouteGatewayId:
type: string
AssociateRouteTableRequest:
type: object
required:
- RouteTableId
title: AssociateRouteTableRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RouteTableId:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: routeTableId
description: The ID of the route table.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: subnetId
description: The ID of the subnet.
GatewayId:
allOf:
- $ref: '#/components/schemas/RouteGatewayId'
- description: The ID of the internet gateway or virtual private gateway.
RouteTableAssociationState:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/RouteTableAssociationStateCode'
- xml:
name: state
description: The state of the association.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: 'The status message, if applicable.'
description: Describes the state of an association between a route table and a subnet or gateway.
AssociateSubnetCidrBlockRequest:
type: object
required:
- Ipv6CidrBlock
- SubnetId
title: AssociateSubnetCidrBlockRequest
properties:
Ipv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6CidrBlock
description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: subnetId
description: The ID of your subnet.
SubnetIpv6CidrBlockAssociation:
type: object
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/SubnetCidrAssociationId'
- xml:
name: associationId
description: The ID of the association.
Ipv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6CidrBlock
description: The IPv6 CIDR block.
Ipv6CidrBlockState:
allOf:
- $ref: '#/components/schemas/SubnetCidrBlockState'
- xml:
name: ipv6CidrBlockState
description: The state of the CIDR block.
description: Describes an association between a subnet and an IPv6 CIDR block.
TransitGatewaySubnetIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
AssociateTransitGatewayMulticastDomainRequest:
type: object
required:
- TransitGatewayMulticastDomainId
- TransitGatewayAttachmentId
- SubnetIds
title: AssociateTransitGatewayMulticastDomainRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway attachment to associate with the transit gateway multicast domain.
SubnetIds:
allOf:
- $ref: '#/components/schemas/TransitGatewaySubnetIdList'
- description: The IDs of the subnets to associate with the transit gateway multicast domain.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
AssociateTransitGatewayPolicyTableRequest:
type: object
required:
- TransitGatewayPolicyTableId
- TransitGatewayAttachmentId
title: AssociateTransitGatewayPolicyTableRequest
properties:
TransitGatewayPolicyTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- description: The ID of the transit gateway policy table to associate with the transit gateway attachment.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway attachment to associate with the policy table.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPolicyTableAssociation:
type: object
properties:
TransitGatewayPolicyTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- xml:
name: transitGatewayPolicyTableId
description: The ID of the transit gateway policy table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: transitGatewayAttachmentId
description: The ID of the transit gateway attachment.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The resource ID of the transit gateway attachment.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: The resource type for the transit gateway policy table association.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociationState'
- xml:
name: state
description: The state of the transit gateway policy table association.
description: Describes a transit gateway policy table association.
AssociateTransitGatewayRouteTableRequest:
type: object
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
title: AssociateTransitGatewayRouteTableRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayAssociation:
type: object
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- xml:
name: transitGatewayRouteTableId
description: The ID of the transit gateway route table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: The resource type. Note that the tgw-peering resource type has been deprecated.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociationState'
- xml:
name: state
description: The state of the association.
description: Describes an association between a resource attachment and a transit gateway route table.
AssociateTrunkInterfaceRequest:
type: object
required:
- BranchInterfaceId
- TrunkInterfaceId
title: AssociateTrunkInterfaceRequest
properties:
BranchInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the branch network interface.
TrunkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the trunk network interface.
VlanId:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The ID of the VLAN. This applies to the VLAN protocol.
GreKey:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The application key. This applies to the GRE protocol.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TrunkInterfaceAssociation:
type: object
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/TrunkInterfaceAssociationId'
- xml:
name: associationId
description: The ID of the association.
BranchInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: branchInterfaceId
description: The ID of the branch network interface.
TrunkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trunkInterfaceId
description: The ID of the trunk network interface.
InterfaceProtocol:
allOf:
- $ref: '#/components/schemas/InterfaceProtocolType'
- xml:
name: interfaceProtocol
description: The interface protocol. Valid values are VLAN and GRE.
VlanId:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: vlanId
description: The ID of the VLAN when you use the VLAN protocol.
GreKey:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: greKey
description: The application key when you use the GRE protocol.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the trunk interface association.
description: 'Currently available in limited preview only. If you are interested in using this feature, contact your account manager.
Information about an association between a branch network interface with a trunk network interface.
' NetmaskLength: type: integer AssociateVpcCidrBlockRequest: type: object required: - VpcId title: AssociateVpcCidrBlockRequest properties: AmazonProvidedIpv6CidrBlock: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: amazonProvidedIpv6CidrBlock description: '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.' CidrBlock: allOf: - $ref: '#/components/schemas/String' - description: An IPv4 CIDR block to associate with the VPC. VpcId: allOf: - $ref: '#/components/schemas/VpcId' - xml: name: vpcId description: The ID of the VPC. Ipv6CidrBlockNetworkBorderGroup: allOf: - $ref: '#/components/schemas/String' - description: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: allOf: - $ref: '#/components/schemas/Ipv6PoolEc2Id' - description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. Ipv6CidrBlock: allOf: - $ref: '#/components/schemas/String' - description: '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: allOf: - $ref: '#/components/schemas/IpamPoolId' - description: '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: allOf: - $ref: '#/components/schemas/NetmaskLength' - description: '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: allOf: - $ref: '#/components/schemas/IpamPoolId' - description: '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: allOf: - $ref: '#/components/schemas/NetmaskLength' - description: '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. ' VpcIpv6CidrBlockAssociation: type: object properties: AssociationId: allOf: - $ref: '#/components/schemas/String' - xml: name: associationId description: The association ID for the IPv6 CIDR block. Ipv6CidrBlock: allOf: - $ref: '#/components/schemas/String' - xml: name: ipv6CidrBlock description: The IPv6 CIDR block. Ipv6CidrBlockState: allOf: - $ref: '#/components/schemas/VpcCidrBlockState' - xml: name: ipv6CidrBlockState description: Information about the state of the CIDR block. NetworkBorderGroup: allOf: - $ref: '#/components/schemas/String' - xml: name: networkBorderGroup description: 'The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses, for example,us-east-1-wl1-bos-wlz-1.'
Ipv6Pool:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6Pool
description: The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
description: Describes an IPv6 CIDR block associated with a VPC.
VpcCidrBlockAssociation:
type: object
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The association ID for the IPv4 CIDR block.
CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrBlock
description: The IPv4 CIDR block.
CidrBlockState:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockState'
- xml:
name: cidrBlockState
description: Information about the state of the CIDR block.
description: Describes an IPv4 CIDR block associated with a VPC.
AssociatedNetworkType:
type: string
enum:
- vpc
AssociatedRole:
type: object
properties:
AssociatedRoleArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: associatedRoleArn
description: The ARN of the associated IAM role.
CertificateS3BucketName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: certificateS3BucketName
description: The name of the Amazon S3 bucket in which the Amazon S3 object is stored.
CertificateS3ObjectKey:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: certificateS3ObjectKey
description: 'The key of the Amazon S3 object ey where the certificate, certificate chain, and encrypted private key bundle is stored. The object key is formated as follows: role_arn/certificate_arn. '
EncryptionKmsKeyId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: encryptionKmsKeyId
description: The ID of the KMS customer master key (CMK) used to encrypt the private key.
description: Information about the associated IAM roles.
AssociatedRolesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AssociatedRole'
- xml:
name: item
AssociatedTargetNetwork:
type: object
properties:
NetworkId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkId
description: The ID of the subnet.
NetworkType:
allOf:
- $ref: '#/components/schemas/AssociatedNetworkType'
- xml:
name: networkType
description: The target network type.
description: Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.
AssociatedTargetNetworkSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AssociatedTargetNetwork'
- xml:
name: item
AssociationIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociationId'
- xml:
name: AssociationId
AssociationStatusCode:
type: string
enum:
- associating
- associated
- association-failed
- disassociating
- disassociated
PartitionLoadFrequency:
type: string
enum:
- none
- daily
- weekly
- monthly
AthenaIntegration:
type: object
required:
- IntegrationResultS3DestinationArn
- PartitionLoadFrequency
properties:
IntegrationResultS3DestinationArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The location in Amazon S3 to store the generated CloudFormation template.
PartitionLoadFrequency:
allOf:
- $ref: '#/components/schemas/PartitionLoadFrequency'
- description: The schedule for adding new partitions to the table.
PartitionStartDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: The start date for the partition.
PartitionEndDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: The end date for the partition.
description: Describes integration options for Amazon Athena.
GroupIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: groupId
AttachClassicLinkVpcRequest:
type: object
required:
- Groups
- InstanceId
- VpcId
title: AttachClassicLinkVpcRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Groups:
allOf:
- $ref: '#/components/schemas/GroupIdStringList'
- xml:
name: SecurityGroupId
description: The IDs of the security groups. You cannot specify security groups from a different VPC.
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of the EC2-Classic instance.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the ClassicLink-enabled VPC.
AttachInternetGatewayRequest:
type: object
required:
- InternetGatewayId
- VpcId
title: AttachInternetGatewayRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InternetGatewayId:
allOf:
- $ref: '#/components/schemas/InternetGatewayId'
- xml:
name: internetGatewayId
description: The ID of the internet gateway.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC.
EnaSrdSpecification:
type: object
properties:
EnaSrdEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether ENA Express is enabled for the network interface.
EnaSrdUdpSpecification:
allOf:
- $ref: '#/components/schemas/EnaSrdUdpSpecification'
- description: Configures ENA Express for UDP network traffic.
description: '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.
' AttachNetworkInterfaceRequest: type: object required: - DeviceIndex - InstanceId - NetworkInterfaceId title: AttachNetworkInterfaceRequest properties: DeviceIndex: allOf: - $ref: '#/components/schemas/Integer' - xml: name: deviceIndex description: The index of the device for the network interface attachment. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of the instance.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
NetworkCardIndex:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 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:
allOf:
- $ref: '#/components/schemas/EnaSrdSpecification'
- description: Configures ENA Express for the network interface that this action attaches to the instance.
description: Contains the parameters for AttachNetworkInterface.
AttachVerifiedAccessTrustProviderRequest:
type: object
required:
- VerifiedAccessInstanceId
- VerifiedAccessTrustProviderId
title: AttachVerifiedAccessTrustProviderRequest
properties:
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- description: The ID of the Verified Access instance.
VerifiedAccessTrustProviderId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderId'
- description: The ID of the Verified Access trust provider.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessTrustProvider:
type: object
properties:
VerifiedAccessTrustProviderId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessTrustProviderId
description: The ID of the Amazon Web Services Verified Access trust provider.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description for the Amazon Web Services Verified Access trust provider.
TrustProviderType:
allOf:
- $ref: '#/components/schemas/TrustProviderType'
- xml:
name: trustProviderType
description: The type of Verified Access trust provider.
UserTrustProviderType:
allOf:
- $ref: '#/components/schemas/UserTrustProviderType'
- xml:
name: userTrustProviderType
description: The type of user-based trust provider.
DeviceTrustProviderType:
allOf:
- $ref: '#/components/schemas/DeviceTrustProviderType'
- xml:
name: deviceTrustProviderType
description: The type of device-based trust provider.
OidcOptions:
allOf:
- $ref: '#/components/schemas/OidcOptions'
- xml:
name: oidcOptions
description: The options for an OpenID Connect-compatible user-identity trust provider.
DeviceOptions:
allOf:
- $ref: '#/components/schemas/DeviceOptions'
- xml:
name: deviceOptions
description: The options for device-identity trust provider.
PolicyReferenceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: policyReferenceName
description: The identifier to be used when working with policy rules.
CreationTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: creationTime
description: The creation time.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: lastUpdatedTime
description: The last updated time.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags.
description: Describes a Verified Access trust provider.
VerifiedAccessInstance:
type: object
properties:
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessInstanceId
description: The ID of the Amazon Web Services Verified Access instance.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description for the Amazon Web Services Verified Access instance.
VerifiedAccessTrustProviders:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderCondensedList'
- xml:
name: verifiedAccessTrustProviderSet
description: The IDs of the Amazon Web Services Verified Access trust providers.
CreationTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: creationTime
description: The creation time.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: lastUpdatedTime
description: The last updated time.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags.
description: Describes a Verified Access instance.
AttachVolumeRequest:
type: object
required:
- Device
- InstanceId
- VolumeId
title: AttachVolumeRequest
properties:
Device:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The device name (for example, /dev/sdh or xvdh).'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeId'
- description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
AttachVpnGatewayRequest:
type: object
required:
- VpcId
- VpnGatewayId
title: AttachVpnGatewayRequest
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- description: The ID of the virtual private gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for AttachVpnGateway.
VpcAttachment:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/AttachmentStatus'
- xml:
name: state
description: The current state of the attachment.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
description: Describes an attachment between a virtual private gateway and a VPC.
AttachmentEnaSrdUdpSpecification:
type: object
properties:
EnaSrdUdpEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enaSrdUdpEnabled
description: 'Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.'
description: Describes the ENA Express configuration for UDP traffic on the network interface that's attached to the instance.
AttachmentEnaSrdSpecification:
type: object
properties:
EnaSrdEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enaSrdEnabled
description: Indicates whether ENA Express is enabled for the network interface that's attached to the instance.
EnaSrdUdpSpecification:
allOf:
- $ref: '#/components/schemas/AttachmentEnaSrdUdpSpecification'
- xml:
name: enaSrdUdpSpecification
description: ENA Express configuration for UDP network traffic.
description: Describes the ENA Express configuration for the network interface that's attached to the instance.
AttachmentStatus:
type: string
enum:
- attaching
- attached
- detaching
- detached
AttributeBooleanValue:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: value
description: The attribute value. The valid values are true or false.
description: Describes a value for a resource attribute that is a Boolean value.
AttributeValue:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The attribute value. The value is case-sensitive.
description: Describes a value for a resource attribute that is a String.
ClientVpnAuthorizationRuleStatus:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatusCode'
- xml:
name: code
description: The state of the authorization rule.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: 'A message about the status of the authorization rule, if applicable.'
description: Describes the state of an authorization rule.
AuthorizationRule:
type: object
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientVpnEndpointId
description: The ID of the Client VPN endpoint with which the authorization rule is associated.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A brief description of the authorization rule.
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the Active Directory group to which the authorization rule grants access.
AccessAll:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: accessAll
description: Indicates whether the authorization rule grants access to all clients.
DestinationCidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidr
description: 'The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.'
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- xml:
name: status
description: The current state of the authorization rule.
description: Information about an authorization rule.
AuthorizationRuleSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/AuthorizationRule'
- xml:
name: item
AuthorizeClientVpnIngressRequest:
type: object
required:
- ClientVpnEndpointId
- TargetNetworkCidr
title: AuthorizeClientVpnIngressRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint.
TargetNetworkCidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 address range, in CIDR notation, of the network for which access is being authorized.'
AccessGroupId:
allOf:
- $ref: '#/components/schemas/String'
- description: '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.'
AuthorizeAllGroups:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 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.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A brief description of the authorization rule.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
IpPermissionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpPermission'
- xml:
name: item
AuthorizeSecurityGroupEgressRequest:
type: object
required:
- GroupId
title: AuthorizeSecurityGroupEgressRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: groupId
description: The ID of the security group.
IpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- xml:
name: ipPermissions
description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags applied to the security group rule.
CidrIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrIp
description: Not supported. Use a set of IP permissions to specify the CIDR.
FromPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: fromPort
description: Not supported. Use a set of IP permissions to specify the port.
IpProtocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipProtocol
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
ToPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: toPort
description: Not supported. Use a set of IP permissions to specify the port.
SourceSecurityGroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourceSecurityGroupName
description: Not supported. Use a set of IP permissions to specify a destination security group.
SourceSecurityGroupOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourceSecurityGroupOwnerId
description: Not supported. Use a set of IP permissions to specify a destination security group.
SecurityGroupRuleList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupRule'
- xml:
name: item
AuthorizeSecurityGroupIngressRequest:
type: object
title: AuthorizeSecurityGroupIngressRequest
properties:
CidrIp:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 address range, in CIDR format. You can''t specify this parameter when specifying a source security group. To specify an IPv6 address range, use a set of IP permissions.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' FromPort: allOf: - $ref: '#/components/schemas/Integer' - description: 'If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types. If you specify all ICMP types, you must specify all ICMP codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' GroupId: allOf: - $ref: '#/components/schemas/SecurityGroupId' - description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' GroupName: allOf: - $ref: '#/components/schemas/SecurityGroupName' - description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.' IpPermissions: allOf: - $ref: '#/components/schemas/IpPermissionList' - description: The sets of IP permissions. IpProtocol: allOf: - $ref: '#/components/schemas/String' - description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' SourceSecurityGroupName: allOf: - $ref: '#/components/schemas/String' - description: '[Default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. The source security group must be in the same VPC.' SourceSecurityGroupOwnerId: allOf: - $ref: '#/components/schemas/String' - description: '[Nondefault VPC] The Amazon Web Services account ID for the source security group, if the source security group is in a different account. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead.' ToPort: allOf: - $ref: '#/components/schemas/Integer' - description: 'If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes. If you specify all ICMP types, you must specify all ICMP codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: '[VPC Only] The tags applied to the security group rule.'
AutoRecoveryFlag:
type: boolean
AvailabilityZoneState:
type: string
enum:
- available
- information
- impaired
- unavailable
AvailabilityZoneOptInStatus:
type: string
enum:
- opt-in-not-required
- opted-in
- not-opted-in
AvailabilityZoneMessageList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneMessage'
- xml:
name: item
AvailabilityZone:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneState'
- xml:
name: zoneState
description: 'The state of the Availability Zone, Local Zone, or Wavelength Zone. This value is always available.'
OptInStatus:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneOptInStatus'
- xml:
name: optInStatus
description: '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.
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.
availability-zone, local-zone, and wavelength-zone.'
ParentZoneName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: parentZoneName
description: 'The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
ParentZoneId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: parentZoneId
description: 'The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.'
description: 'Describes Availability Zones, Local Zones, and Wavelength Zones.'
AvailabilityZoneId:
type: string
AvailabilityZoneList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AvailabilityZone'
- xml:
name: item
AvailabilityZoneMessage:
type: object
properties:
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: 'The message about the Availability Zone, Local Zone, or Wavelength Zone.'
description: 'Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.'
AvailabilityZoneName:
type: string
AvailabilityZoneStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: AvailabilityZone
AvailableInstanceCapacityList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceCapacity'
- xml:
name: item
AvailableCapacity:
type: object
properties:
AvailableInstanceCapacity:
allOf:
- $ref: '#/components/schemas/AvailableInstanceCapacityList'
- xml:
name: availableInstanceCapacity
description: '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.'
AvailableVCpus:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: availableVCpus
description: The number of vCPUs available for launching instances onto the Dedicated Host.
description: 'The capacity information for instances that can be launched onto the Dedicated Host. '
InstanceCapacity:
type: object
properties:
AvailableCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: availableCapacity
description: The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: The instance type supported by the Dedicated Host.
TotalCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalCapacity
description: The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.
description: Information about the number of instances that can be launched onto the Dedicated Host.
BareMetalFlag:
type: boolean
BaselineBandwidthInGbps:
type: number
format: double
BaselineBandwidthInMbps:
type: integer
BaselineEbsBandwidthMbps:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: min
description: 'The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: max
description: 'The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.'
description: '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: number
format: double
BatchState:
type: string
enum:
- submitted
- active
- cancelled
- failed
- cancelled_running
- cancelled_terminating
- modifying
BgpStatus:
type: string
enum:
- up
- down
BillingProductList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
BlobAttributeValue:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/Blob'
- xml:
name: value
EbsBlockDevice:
type: object
properties:
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: 'Indicates whether the EBS volume is deleted on instance termination. For more information, see Preserving Amazon EBS volumes on instance termination in the Amazon EC2 User Guide.'
Iops:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: iops
description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3:1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
io1 or io2, you must specify the IOPS that the volume supports.'
KmsKeyId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kmsKeyId
description: 'Identifier (key ID, key alias, ID ARN, or alias ARN) for a customer managed CMK under which the EBS volume is encrypted.
This parameter is only supported on BlockDeviceMapping objects called by RunInstances, RequestSpotFleet, and RequestSpotInstances.
The throughput that the volume supports, in MiB/s.
This parameter is valid only for gp3 volumes.
Valid Range: Minimum value of 125. Maximum value of 1000.
' OutpostArn: allOf: - $ref: '#/components/schemas/String' - xml: name: outpostArn description: 'The ARN of the Outpost on which the snapshot is stored.
This parameter is not supported when using CreateImage.
' Encrypted: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: encrypted description: 'Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.
In no case can you remove encryption from an encrypted volume.
Encrypted volumes can only be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
This parameter is not returned by DescribeImageAttribute.
For CreateImage and RegisterImage, whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.
If you are creating a block device mapping for a new (empty) volume, you can include this parameter, and specify either true for an encrypted volume, or false for an unencrypted volume. If you omit this parameter, it defaults to false (unencrypted).
If you are creating a block device mapping from an existing encrypted or unencrypted snapshot, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
If you are creating a block device mapping from an existing unencrypted volume, you can include this parameter, but you must specify false. If you specify true, the request will fail. In this case, we recommend that you omit the parameter.
If you are creating a block device mapping from an existing encrypted volume, you can include this parameter, and specify either true or false. However, if you specify false, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
' Storage: allOf: - $ref: '#/components/schemas/Storage' - description: '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: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for BundleInstance.
BundleTask:
type: object
properties:
BundleId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: bundleId
description: The ID of the bundle task.
BundleTaskError:
allOf:
- $ref: '#/components/schemas/BundleTaskError'
- xml:
name: error
description: 'If the task fails, a description of the error.'
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance associated with this bundle task.
Progress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: progress
description: 'The level of task completion, as a percent (for example, 20%).'
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: startTime
description: The time this task started.
State:
allOf:
- $ref: '#/components/schemas/BundleTaskState'
- xml:
name: state
description: The state of the task.
Storage:
allOf:
- $ref: '#/components/schemas/Storage'
- xml:
name: storage
description: The Amazon S3 storage locations.
UpdateTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: updateTime
description: The time of the most recent update for the task.
description: Describes a bundle task.
BundleTaskError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The error message.
description: Describes an error for BundleInstance.
BundleTaskState:
type: string
enum:
- pending
- waiting-for-shutdown
- bundling
- storing
- cancelling
- complete
- failed
BundleTaskList:
type: array
items:
allOf:
- $ref: '#/components/schemas/BundleTask'
- xml:
name: item
BurstablePerformanceFlag:
type: boolean
ByoipCidrState:
type: string
enum:
- advertised
- deprovisioned
- failed-deprovision
- failed-provision
- pending-deprovision
- pending-provision
- provisioned
- provisioned-not-publicly-advertisable
ByoipCidrSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- xml:
name: item
CancelBatchErrorCode:
type: string
enum:
- fleetRequestIdDoesNotExist
- fleetRequestIdMalformed
- fleetRequestNotInCancellableState
- unexpectedError
CancelBundleTaskRequest:
type: object
required:
- BundleId
title: CancelBundleTaskRequest
properties:
BundleId:
allOf:
- $ref: '#/components/schemas/BundleId'
- description: The ID of the bundle task.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for CancelBundleTask.
CancelCapacityReservationFleetErrorCode:
type: string
CancelCapacityReservationFleetErrorMessage:
type: string
CancelCapacityReservationFleetError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/CancelCapacityReservationFleetErrorCode'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/CancelCapacityReservationFleetErrorMessage'
- xml:
name: message
description: The error message.
description: Describes a Capacity Reservation Fleet cancellation error.
CapacityReservationFleetIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetId'
- xml:
name: item
CancelCapacityReservationFleetsRequest:
type: object
required:
- CapacityReservationFleetIds
title: CancelCapacityReservationFleetsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CapacityReservationFleetIds:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetIdSet'
- xml:
name: CapacityReservationFleetId
description: The IDs of the Capacity Reservation Fleets to cancel.
CapacityReservationFleetCancellationStateSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetCancellationState'
- xml:
name: item
FailedCapacityReservationFleetCancellationResultSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/FailedCapacityReservationFleetCancellationResult'
- xml:
name: item
CancelCapacityReservationRequest:
type: object
required:
- CapacityReservationId
title: CancelCapacityReservationRequest
properties:
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/CapacityReservationId'
- description: The ID of the Capacity Reservation to be cancelled.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CancelConversionRequest:
type: object
required:
- ConversionTaskId
title: CancelConversionRequest
properties:
ConversionTaskId:
allOf:
- $ref: '#/components/schemas/ConversionTaskId'
- xml:
name: conversionTaskId
description: The ID of the conversion task.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReasonMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reasonMessage
description: The reason for canceling the conversion task.
ExportVmTaskId:
type: string
CancelExportTaskRequest:
type: object
required:
- ExportTaskId
title: CancelExportTaskRequest
properties:
ExportTaskId:
allOf:
- $ref: '#/components/schemas/ExportVmTaskId'
- xml:
name: exportTaskId
description: The ID of the export task. This is the ID returned by CreateInstanceExportTask.
CancelImageLaunchPermissionRequest:
type: object
required:
- ImageId
title: CancelImageLaunchPermissionRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI that was shared with your Amazon Web Services account.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ImportTaskId:
type: string
CancelImportTaskRequest:
type: object
title: CancelImportTaskRequest
properties:
CancelReason:
allOf:
- $ref: '#/components/schemas/String'
- description: The reason for canceling the task.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ImportTaskId:
allOf:
- $ref: '#/components/schemas/ImportTaskId'
- description: The ID of the import image or import snapshot task to be canceled.
ReservedInstancesListingId:
type: string
CancelReservedInstancesListingRequest:
type: object
required:
- ReservedInstancesListingId
title: CancelReservedInstancesListingRequest
properties:
ReservedInstancesListingId:
allOf:
- $ref: '#/components/schemas/ReservedInstancesListingId'
- xml:
name: reservedInstancesListingId
description: The ID of the Reserved Instance listing.
description: Contains the parameters for CancelReservedInstancesListing.
ReservedInstancesListingList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservedInstancesListing'
- xml:
name: item
CancelSpotFleetRequestsError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/CancelBatchErrorCode'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The description for the error code.
description: Describes a Spot Fleet error.
CancelSpotFleetRequestsErrorItem:
type: object
properties:
Error:
allOf:
- $ref: '#/components/schemas/CancelSpotFleetRequestsError'
- xml:
name: error
description: The error.
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
description: Describes a Spot Fleet request that was not successfully canceled.
CancelSpotFleetRequestsErrorSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CancelSpotFleetRequestsErrorItem'
- xml:
name: item
SpotFleetRequestIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestId'
- xml:
name: item
CancelSpotFleetRequestsRequest:
type: object
required:
- SpotFleetRequestIds
- TerminateInstances
title: CancelSpotFleetRequestsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SpotFleetRequestIds:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestIdList'
- xml:
name: spotFleetRequestId
description: The IDs of the Spot Fleet requests.
TerminateInstances:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: terminateInstances
description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SpotInstanceRequestIds:
allOf:
- $ref: '#/components/schemas/SpotInstanceRequestIdList'
- xml:
name: SpotInstanceRequestId
description: The IDs of the Spot Instance requests.
description: Contains the parameters for CancelSpotInstanceRequests.
CancelledSpotInstanceRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/CancelledSpotInstanceRequest'
- xml:
name: item
CancelledSpotInstanceRequest:
type: object
properties:
SpotInstanceRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotInstanceRequestId
description: The ID of the Spot Instance request.
State:
allOf:
- $ref: '#/components/schemas/CancelSpotInstanceRequestState'
- xml:
name: state
description: The state of the Spot Instance request.
description: Describes a request to cancel a Spot Instance.
CapacityAllocation:
type: object
properties:
AllocationType:
allOf:
- $ref: '#/components/schemas/AllocationType'
- xml:
name: allocationType
description: The usage type. used indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.
Count:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: count
description: 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.
description: Information about instance capacity usage for a Capacity Reservation.
CapacityAllocations:
type: array
items:
allOf:
- $ref: '#/components/schemas/CapacityAllocation'
- xml:
name: 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
CapacityReservationTenancy:
type: string
enum:
- default
- dedicated
CapacityReservationState:
type: string
enum:
- active
- expired
- cancelled
- pending
- failed
EndDateType:
type: string
enum:
- unlimited
- limited
InstanceMatchCriteria:
type: string
enum:
- open
- targeted
OutpostArn:
type: string
pattern: '^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$'
PlacementGroupArn:
type: string
pattern: '^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/^.{1,255}$'
CapacityReservation:
type: object
properties:
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: capacityReservationId
description: The ID of the Capacity Reservation.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the Capacity Reservation.
CapacityReservationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: capacityReservationArn
description: The Amazon Resource Name (ARN) of the Capacity Reservation.
AvailabilityZoneId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZoneId
description: The Availability Zone ID of the Capacity Reservation.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: The type of instance for which the Capacity Reservation reserves capacity.
InstancePlatform:
allOf:
- $ref: '#/components/schemas/CapacityReservationInstancePlatform'
- xml:
name: instancePlatform
description: The type of operating system for which the Capacity Reservation reserves capacity.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone in which the capacity is reserved.
Tenancy:
allOf:
- $ref: '#/components/schemas/CapacityReservationTenancy'
- xml:
name: tenancy
description: '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 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.
expired when it reaches its end date and time.'
EndDateType:
allOf:
- $ref: '#/components/schemas/EndDateType'
- xml:
name: endDateType
description: '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 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 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.
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.
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.
' description: '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.
' CapacityReservationSet: type: array items: allOf: - $ref: '#/components/schemas/CapacityReservation' - xml: name: item CapacityReservationSpecification: type: object properties: CapacityReservationPreference: allOf: - $ref: '#/components/schemas/CapacityReservationPreference' - description: '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.
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.
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.'
CarrierGatewayState:
type: string
enum:
- pending
- available
- deleting
- deleted
CarrierGateway:
type: object
properties:
CarrierGatewayId:
allOf:
- $ref: '#/components/schemas/CarrierGatewayId'
- xml:
name: carrierGatewayId
description: The ID of the carrier gateway.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC associated with the carrier gateway.
State:
allOf:
- $ref: '#/components/schemas/CarrierGatewayState'
- xml:
name: state
description: The state of the carrier gateway.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The Amazon Web Services account ID of the owner of the carrier gateway.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the carrier gateway.
description: Describes a carrier gateway.
CarrierGatewayIdSet:
type: array
items:
$ref: '#/components/schemas/CarrierGatewayId'
CarrierGatewayMaxResults:
type: integer
minimum: 5
maximum: 1000
CarrierGatewaySet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CarrierGateway'
- xml:
name: item
CertificateArn:
type: string
CertificateAuthentication:
type: object
properties:
ClientRootCertificateChain:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientRootCertificateChain
description: 'The ARN of the client certificate. '
description: Information about the client certificate used for authentication.
CertificateAuthenticationRequest:
type: object
properties:
ClientRootCertificateChainArn:
allOf:
- $ref: '#/components/schemas/String'
- description: 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).
description: Information about the client certificate to be used for authentication.
CidrAuthorizationContext:
type: object
required:
- Message
- Signature
properties:
Message:
allOf:
- $ref: '#/components/schemas/String'
- description: The plain-text authorization message for the prefix and account.
Signature:
allOf:
- $ref: '#/components/schemas/String'
- description: The signed authorization message for the prefix and account.
description: 'Provides authorization for Amazon to bring a specific IP address range to a specific Amazon Web Services account using bring your own IP addresses (BYOIP). For more information, see Configuring your BYOIP address range in the Amazon Elastic Compute Cloud User Guide.'
CidrBlock:
type: object
properties:
CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrBlock
description: The IPv4 CIDR block.
description: Describes an IPv4 CIDR block.
CidrBlockSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CidrBlock'
- xml:
name: item
ClassicLinkDnsSupport:
type: object
properties:
ClassicLinkDnsSupported:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: classicLinkDnsSupported
description: Indicates whether ClassicLink DNS support is enabled for the VPC.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
description: Deprecated.
Describes the ClassicLink DNS support status of a VPC.
ClassicLinkDnsSupportList: type: array items: allOf: - $ref: '#/components/schemas/ClassicLinkDnsSupport' - xml: name: item GroupIdentifierList: type: array items: allOf: - $ref: '#/components/schemas/GroupIdentifier' - xml: name: item ClassicLinkInstance: type: object properties: Groups: allOf: - $ref: '#/components/schemas/GroupIdentifierList' - xml: name: groupSet description: The security groups. InstanceId: allOf: - $ref: '#/components/schemas/String' - xml: name: instanceId description: The ID of the instance. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: Any tags assigned to the instance. VpcId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcId description: The ID of the VPC. description:Deprecated.
Describes a linked EC2-Classic instance.
ClassicLinkInstanceList: type: array items: allOf: - $ref: '#/components/schemas/ClassicLinkInstance' - xml: name: item ClassicLoadBalancer: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - xml: name: name description: The name of the load balancer. description: Describes a Classic Load Balancer. ClassicLoadBalancers: type: array items: allOf: - $ref: '#/components/schemas/ClassicLoadBalancer' - xml: name: item minItems: 1 maxItems: 5 ClassicLoadBalancersConfig: type: object properties: ClassicLoadBalancers: allOf: - $ref: '#/components/schemas/ClassicLoadBalancers' - xml: name: classicLoadBalancers description: One or more Classic Load Balancers. description: Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers. ClientCertificateRevocationListStatusCode: type: string enum: - pending - active ClientCertificateRevocationListStatus: type: object properties: Code: allOf: - $ref: '#/components/schemas/ClientCertificateRevocationListStatusCode' - xml: name: code description: The state of the client certificate revocation list. Message: allOf: - $ref: '#/components/schemas/String' - xml: name: message description: 'A message about the status of the client certificate revocation list, if applicable.' description: Describes the state of a client certificate revocation list. ClientConnectOptions: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether client connect options are enabled. The default isfalse (not enabled).
LambdaFunctionArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
description: The options for managing connection authorization for new client connections.
ClientVpnEndpointAttributeStatus:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointAttributeStatusCode'
- xml:
name: code
description: The status code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The status message.
description: Describes the status of the Client VPN endpoint attribute.
ClientConnectResponseOptions:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enabled
description: Indicates whether client connect options are enabled.
LambdaFunctionArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: lambdaFunctionArn
description: The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointAttributeStatus'
- xml:
name: status
description: The status of any updates to the client connect options.
description: The options for managing connection authorization for new client connections.
ClientData:
type: object
properties:
Comment:
allOf:
- $ref: '#/components/schemas/String'
- description: A user-defined comment about the disk upload.
UploadEnd:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The time that the disk upload ends.
UploadSize:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The size of the uploaded disk image, in GiB.'
UploadStart:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The time that the disk upload starts.
description: Describes the client-specific data.
ClientLoginBannerOptions:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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
Current state of text banner feature.
Valid values: true | false
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.
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.
' VpnProtocol: allOf: - $ref: '#/components/schemas/VpnProtocol' - xml: name: vpnProtocol description: The protocol used by the VPN session. TransportProtocol: allOf: - $ref: '#/components/schemas/TransportProtocol' - xml: name: transportProtocol description: The transport protocol used by the Client VPN endpoint. VpnPort: allOf: - $ref: '#/components/schemas/Integer' - xml: name: vpnPort description: The port number for the Client VPN endpoint. AssociatedTargetNetworks: allOf: - $ref: '#/components/schemas/AssociatedTargetNetworkSet' - deprecated: true xml: name: associatedTargetNetwork description: 'Information about the associated target networks. A target network is a subnet in a VPC.This property is deprecated. To view the target networks associated with a Client VPN endpoint, call DescribeClientVpnTargetNetworks and inspect the clientVpnTargetNetworks response element.' ServerCertificateArn: allOf: - $ref: '#/components/schemas/String' - xml: name: serverCertificateArn description: The ARN of the server certificate. AuthenticationOptions: allOf: - $ref: '#/components/schemas/ClientVpnAuthenticationList' - xml: name: authenticationOptions description: Information about the authentication method used by the Client VPN endpoint. ConnectionLogOptions: allOf: - $ref: '#/components/schemas/ConnectionLogResponseOptions' - xml: name: connectionLogOptions description: Information about the client connection logging options for the Client VPN endpoint. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: Any tags assigned to the Client VPN endpoint. SecurityGroupIds: allOf: - $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet' - xml: name: securityGroupIdSet description: The IDs of the security groups for the target network. VpcId: allOf: - $ref: '#/components/schemas/VpcId' - xml: name: vpcId description: The ID of the VPC. SelfServicePortalUrl: allOf: - $ref: '#/components/schemas/String' - xml: name: selfServicePortalUrl description: The URL of the self-service portal. ClientConnectOptions: allOf: - $ref: '#/components/schemas/ClientConnectResponseOptions' - xml: name: clientConnectOptions description: The options for managing connection authorization for new client connections. SessionTimeoutHours: allOf: - $ref: '#/components/schemas/Integer' - xml: name: sessionTimeoutHours description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
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.
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnRouteStatus'
- xml:
name: status
description: The current state of the route.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A brief description of the route.
description: Information about a Client VPN endpoint route.
ClientVpnRouteSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClientVpnRoute'
- xml:
name: item
ClientVpnRouteStatusCode:
type: string
enum:
- creating
- active
- failed
- deleting
CloudWatchLogGroupArn:
type: string
CloudWatchLogOptions:
type: object
properties:
LogEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: logEnabled
description: 'Status of VPN tunnel logging feature. Default value is False.
Valid values: True | False
Configured log format. Default format is json.
Valid values: json | text
Enable or disable VPN tunnel logging feature. Default value is False.
Valid values: True | False
Set log format. Default format is json.
Valid values: json | text
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ConnectionLogOptions:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether connection logging is enabled.
CloudwatchLogGroup:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the CloudWatch Logs log group. Required if connection logging is enabled.
CloudwatchLogStream:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the CloudWatch Logs log stream to which the connection data is published.
description: Describes the client connection logging options for the Client VPN endpoint.
ConnectionNotificationType:
type: string
enum:
- Topic
ConnectionNotificationState:
type: string
enum:
- Enabled
- Disabled
ConnectionNotification:
type: object
properties:
ConnectionNotificationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: connectionNotificationId
description: The ID of the notification.
ServiceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceId
description: The ID of the endpoint service.
VpcEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcEndpointId
description: The ID of the VPC endpoint.
ConnectionNotificationType:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationType'
- xml:
name: connectionNotificationType
description: The type of notification.
ConnectionNotificationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: connectionNotificationArn
description: The ARN of the SNS topic for the notification.
ConnectionEvents:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: connectionEvents
description: 'The events for the notification. Valid values are Accept, Connect, Delete, and Reject.'
ConnectionNotificationState:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationState'
- xml:
name: connectionNotificationState
description: The state of the notification.
description: Describes a connection notification for a VPC endpoint or VPC endpoint service.
ConnectionNotificationIdsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationId'
- xml:
name: item
ConnectionNotificationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ConnectionNotification'
- xml:
name: item
ConnectivityType:
type: string
enum:
- private
- public
ConversionIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ConversionTaskId'
- xml:
name: item
ImportInstanceTaskDetails:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the task.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
Platform:
allOf:
- $ref: '#/components/schemas/PlatformValues'
- xml:
name: platform
description: The instance operating system.
Volumes:
allOf:
- $ref: '#/components/schemas/ImportInstanceVolumeDetailSet'
- xml:
name: volumes
description: The volumes.
description: Describes an import instance task.
ImportVolumeTaskDetails:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone where the resulting volume will reside.
BytesConverted:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: bytesConverted
description: The number of bytes converted so far.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description you provided when starting the import volume task.
Image:
allOf:
- $ref: '#/components/schemas/DiskImageDescription'
- xml:
name: image
description: The image.
Volume:
allOf:
- $ref: '#/components/schemas/DiskImageVolumeDescription'
- xml:
name: volume
description: The volume.
description: Describes an import volume task.
ConversionTaskState:
type: string
enum:
- active
- cancelling
- cancelled
- completed
ConversionTask:
type: object
properties:
ConversionTaskId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: conversionTaskId
description: The ID of the conversion task.
ExpirationTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: expirationTime
description: 'The time when the task expires. If the upload isn''t complete before the expiration time, we automatically cancel the task.'
ImportInstance:
allOf:
- $ref: '#/components/schemas/ImportInstanceTaskDetails'
- xml:
name: importInstance
description: 'If the task is for importing an instance, this contains information about the import instance task.'
ImportVolume:
allOf:
- $ref: '#/components/schemas/ImportVolumeTaskDetails'
- xml:
name: importVolume
description: 'If the task is for importing a volume, this contains information about the import volume task.'
State:
allOf:
- $ref: '#/components/schemas/ConversionTaskState'
- xml:
name: state
description: The state of the conversion task.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: The status message related to the conversion task.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the task.
description: Describes a conversion task.
CopyFpgaImageRequest:
type: object
required:
- SourceFpgaImageId
- SourceRegion
title: CopyFpgaImageRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SourceFpgaImageId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the source AFI.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description for the new AFI.
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name for the new AFI. The default is the name of the source AFI.
SourceRegion:
allOf:
- $ref: '#/components/schemas/String'
- description: The Region that contains the source AFI.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
KmsKeyId:
type: string
CopyImageRequest:
type: object
required:
- Name
- SourceImageId
- SourceRegion
title: CopyImageRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: '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:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the new AMI in the destination Region.
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: encrypted
description: 'Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EC2 User Guide.'
KmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- xml:
name: kmsKeyId
description: '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.
' Name: allOf: - $ref: '#/components/schemas/String' - description: The name of the new AMI in the destination Region. SourceImageId: allOf: - $ref: '#/components/schemas/String' - description: The ID of the AMI to copy. SourceRegion: allOf: - $ref: '#/components/schemas/String' - description: The name of the Region that contains the AMI to copy. DestinationOutpostArn: allOf: - $ref: '#/components/schemas/String' - description: '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 EC2 User Guide.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
CopyImageTags:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.
' description: Contains the parameters for CopyImage. CopySnapshotRequestPSU: type: string format: password CopySnapshotRequest: type: object required: - SourceRegion - SourceSnapshotId title: CopySnapshotRequest properties: Description: allOf: - $ref: '#/components/schemas/String' - description: A description for the EBS snapshot. DestinationOutpostArn: allOf: - $ref: '#/components/schemas/String' - description: '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 Elastic Compute Cloud User Guide.
' DestinationRegion: allOf: - $ref: '#/components/schemas/String' - xml: name: destinationRegion description: '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.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' PresignedUrl: allOf: - $ref: '#/components/schemas/CopySnapshotRequestPSU' - xml: name: presignedUrl description: 'When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query requests.
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using Amazon Web Services Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests: Using Query Parameters (Amazon Web Services Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CopyTagsFromSource:
type: string
enum:
- volume
CoreCount:
type: integer
CoreCountList:
type: array
items:
allOf:
- $ref: '#/components/schemas/CoreCount'
- xml:
name: item
CoreNetworkArn:
type: string
CpuManufacturer:
type: string
enum:
- intel
- amd
- amazon-web-services
CpuOptions:
type: object
properties:
CoreCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: coreCount
description: The number of CPU cores for the instance.
ThreadsPerCore:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: threadsPerCore
description: The number of threads per CPU core.
AmdSevSnp:
allOf:
- $ref: '#/components/schemas/AmdSevSnpSpecification'
- xml:
name: amdSevSnp
description: 'Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see AMD SEV-SNP.'
description: The CPU options for the instance.
CpuOptionsRequest:
type: object
properties:
CoreCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of CPU cores for the instance.
ThreadsPerCore:
allOf:
- $ref: '#/components/schemas/Integer'
- description: '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.'
AmdSevSnp:
allOf:
- $ref: '#/components/schemas/AmdSevSnpSpecification'
- description: '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.'
description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
ReservationFleetInstanceSpecificationList:
type: array
items:
$ref: '#/components/schemas/ReservationFleetInstanceSpecification'
CreateCapacityReservationFleetRequest:
type: object
required:
- InstanceTypeSpecifications
- TotalTargetCapacity
title: CreateCapacityReservationFleetRequest
properties:
AllocationStrategy:
allOf:
- $ref: '#/components/schemas/String'
- description: '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
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 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateCapacityReservationRequest:
type: object
required:
- InstanceType
- InstancePlatform
- InstanceCount
title: CreateCapacityReservationRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.'
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The instance type for which to reserve capacity. For more information, see Instance types in the Amazon EC2 User Guide.'
InstancePlatform:
allOf:
- $ref: '#/components/schemas/CapacityReservationInstancePlatform'
- description: The type of operating system for which to reserve capacity.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneName'
- description: The Availability Zone in which to create the Capacity Reservation.
AvailabilityZoneId:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneId'
- description: The ID of the Availability Zone in which to create the Capacity Reservation.
Tenancy:
allOf:
- $ref: '#/components/schemas/CapacityReservationTenancy'
- description: '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: allOf: - $ref: '#/components/schemas/Boolean' - description: 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: allOf: - $ref: '#/components/schemas/Boolean' - description: ' Deprecated. ' EndDate: allOf: - $ref: '#/components/schemas/DateTime' - description: '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
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
OutpostArn:
allOf:
- $ref: '#/components/schemas/OutpostArn'
- description: The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation.
PlacementGroupArn:
allOf:
- $ref: '#/components/schemas/PlacementGroupArn'
- description: '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.'
CreateCarrierGatewayRequest:
type: object
required:
- VpcId
title: CreateCarrierGatewayRequest
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC to associate with the carrier gateway.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to associate with the carrier gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
SelfServicePortal:
type: string
enum:
- enabled
- disabled
CreateClientVpnEndpointRequest:
type: object
required:
- ClientCidrBlock
- ServerCertificateArn
- AuthenticationOptions
- ConnectionLogOptions
title: CreateClientVpnEndpointRequest
properties:
ClientCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: '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:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ARN of the server certificate. For more information, see the Certificate Manager User Guide.'
AuthenticationOptions:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthenticationRequestList'
- xml:
name: Authentication
description: Information about the authentication method to be used to authenticate clients.
ConnectionLogOptions:
allOf:
- $ref: '#/components/schemas/ConnectionLogOptions'
- description: '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
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
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: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the Client VPN endpoint during creation.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet'
- xml:
name: SecurityGroupId
description: 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.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: '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:
allOf:
- $ref: '#/components/schemas/SelfServicePortal'
- description: 'Specify whether to enable the self-service portal for the Client VPN endpoint.
Default Value: enabled
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateCoipCidrRequest:
type: object
required:
- Cidr
- CoipPoolId
title: CreateCoipCidrRequest
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: ' A customer-owned IP address range to create. '
CoipPoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolCoipId'
- description: ' The ID of the address pool. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateCoipPoolRequest:
type: object
required:
- LocalGatewayRouteTableId
title: CreateCoipPoolRequest
properties:
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- description: ' The ID of the local gateway route table. '
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: ' The tags to assign to the CoIP address pool. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GatewayType:
type: string
enum:
- ipsec.1
CreateCustomerGatewayRequest:
type: object
required:
- Type
title: CreateCustomerGatewayRequest
properties:
BgpAsn:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'For devices that support BGP, the customer gateway''s BGP ASN.
Default: 65000
' PublicIp: allOf: - $ref: '#/components/schemas/String' - description: ' This member has been deprecated. The Internet-routable IP address for the customer gateway''s outside interface. The address must be static.' CertificateArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) for the customer gateway certificate. Type: allOf: - $ref: '#/components/schemas/GatewayType' - description: The type of VPN connection that this customer gateway supports (ipsec.1).
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the customer gateway.
DeviceName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A name for the customer gateway device.
Length Constraints: Up to 255 characters.
' IpAddress: allOf: - $ref: '#/components/schemas/String' - description: ' IPv4 address for the customer gateway device''s outside interface. The address must be static. ' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for CreateCustomerGateway.
CustomerGateway:
type: object
properties:
BgpAsn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: bgpAsn
description: The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
CustomerGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: customerGatewayId
description: The ID of the customer gateway.
IpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipAddress
description: The IP address of the customer gateway device's outside interface.
CertificateArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: certificateArn
description: The Amazon Resource Name (ARN) for the customer gateway certificate.
State:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: state
description: The current state of the customer gateway (pending | available | deleting | deleted).
Type:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: type
description: The type of VPN connection the customer gateway supports (ipsec.1).
DeviceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deviceName
description: The name of customer gateway device.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the customer gateway.
description: Describes a customer gateway.
CreateDefaultSubnetRequest:
type: object
required:
- AvailabilityZone
title: CreateDefaultSubnetRequest
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The Availability Zone in which to create the default subnet.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Ipv6Native:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Subnet:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone of the subnet.
AvailabilityZoneId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZoneId
description: The AZ ID of the subnet.
AvailableIpAddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: availableIpAddressCount
description: The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.
CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrBlock
description: The IPv4 CIDR block assigned to the subnet.
DefaultForAz:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: defaultForAz
description: Indicates whether this is the default subnet for the Availability Zone.
EnableLniAtDeviceIndex:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: enableLniAtDeviceIndex
description: ' Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1). '
MapPublicIpOnLaunch:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: mapPublicIpOnLaunch
description: Indicates whether instances launched in this subnet receive a public IPv4 address.
MapCustomerOwnedIpOnLaunch:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: mapCustomerOwnedIpOnLaunch
description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
CustomerOwnedIpv4Pool:
allOf:
- $ref: '#/components/schemas/CoipPoolId'
- xml:
name: customerOwnedIpv4Pool
description: The customer-owned IPv4 address pool associated with the subnet.
State:
allOf:
- $ref: '#/components/schemas/SubnetState'
- xml:
name: state
description: The current state of the subnet.
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetId
description: The ID of the subnet.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC the subnet is in.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the subnet.
AssignIpv6AddressOnCreation:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: assignIpv6AddressOnCreation
description: Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives an IPv6 address.
Ipv6CidrBlockAssociationSet:
allOf:
- $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociationSet'
- xml:
name: ipv6CidrBlockAssociationSet
description: Information about the IPv6 CIDR blocks associated with the subnet.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the subnet.
SubnetArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetArn
description: The Amazon Resource Name (ARN) of the subnet.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: The Amazon Resource Name (ARN) of the Outpost.
EnableDns64:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enableDns64
description: Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
Ipv6Native:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ipv6Native
description: Indicates whether this is an IPv6 only subnet.
PrivateDnsNameOptionsOnLaunch:
allOf:
- $ref: '#/components/schemas/PrivateDnsNameOptionsOnLaunch'
- xml:
name: privateDnsNameOptionsOnLaunch
description: The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.
description: Describes a subnet.
CreateDefaultVpcRequest:
type: object
title: CreateDefaultVpcRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Vpc:
type: object
properties:
CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrBlock
description: The primary IPv4 CIDR block for the VPC.
DhcpOptionsId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: dhcpOptionsId
description: The ID of the set of DHCP options you've associated with the VPC.
State:
allOf:
- $ref: '#/components/schemas/VpcState'
- xml:
name: state
description: The current state of the VPC.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the VPC.
InstanceTenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- xml:
name: instanceTenancy
description: The allowed tenancy of instances launched into the VPC.
Ipv6CidrBlockAssociationSet:
allOf:
- $ref: '#/components/schemas/VpcIpv6CidrBlockAssociationSet'
- xml:
name: ipv6CidrBlockAssociationSet
description: Information about the IPv6 CIDR blocks associated with the VPC.
CidrBlockAssociationSet:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockAssociationSet'
- xml:
name: cidrBlockAssociationSet
description: Information about the IPv4 CIDR blocks associated with the VPC.
IsDefault:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isDefault
description: Indicates whether the VPC is the default VPC.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the VPC.
description: Describes a VPC.
NewDhcpConfigurationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NewDhcpConfiguration'
- xml:
name: item
CreateDhcpOptionsRequest:
type: object
required:
- DhcpConfigurations
title: CreateDhcpOptionsRequest
properties:
DhcpConfigurations:
allOf:
- $ref: '#/components/schemas/NewDhcpConfigurationList'
- xml:
name: dhcpConfiguration
description: A DHCP configuration option.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the DHCP option.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DhcpOptions:
type: object
properties:
DhcpConfigurations:
allOf:
- $ref: '#/components/schemas/DhcpConfigurationList'
- xml:
name: dhcpConfigurationSet
description: The DHCP options in the set.
DhcpOptionsId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: dhcpOptionsId
description: The ID of the set of DHCP options.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the DHCP options set.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the DHCP options set.
description: The set of DHCP options.
CreateEgressOnlyInternetGatewayRequest:
type: object
required:
- VpcId
title: CreateEgressOnlyInternetGatewayRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC for which to create the egress-only internet gateway.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the egress-only internet gateway.
EgressOnlyInternetGateway:
type: object
properties:
Attachments:
allOf:
- $ref: '#/components/schemas/InternetGatewayAttachmentList'
- xml:
name: attachmentSet
description: Information about the attachment of the egress-only internet gateway.
EgressOnlyInternetGatewayId:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- xml:
name: egressOnlyInternetGatewayId
description: The ID of the egress-only internet gateway.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the egress-only internet gateway.
description: Describes an egress-only internet gateway.
LaunchTemplateAndOverridesResponse:
type: object
properties:
LaunchTemplateSpecification:
allOf:
- $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
- xml:
name: launchTemplateSpecification
description: The launch template.
Overrides:
allOf:
- $ref: '#/components/schemas/FleetLaunchTemplateOverrides'
- xml:
name: overrides
description: Any parameters that you specify override the same parameters in the launch template.
description: Describes a launch template and overrides.
InstanceLifecycle:
type: string
enum:
- spot
- on-demand
CreateFleetError:
type: object
properties:
LaunchTemplateAndOverrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- xml:
name: launchTemplateAndOverrides
description: 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.
Lifecycle:
allOf:
- $ref: '#/components/schemas/InstanceLifecycle'
- xml:
name: lifecycle
description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: errorCode
description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.'
ErrorMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: errorMessage
description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.'
description: Describes the instances that could not be launched by the fleet.
CreateFleetErrorsSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CreateFleetError'
- xml:
name: item
InstanceIdsSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: item
PlatformValues:
type: string
enum:
- Windows
CreateFleetInstance:
type: object
properties:
LaunchTemplateAndOverrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- xml:
name: launchTemplateAndOverrides
description: 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.
Lifecycle:
allOf:
- $ref: '#/components/schemas/InstanceLifecycle'
- xml:
name: lifecycle
description: Indicates if the instance that was launched is a Spot Instance or On-Demand Instance.
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdsSet'
- xml:
name: instanceIds
description: The IDs of the instances.
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: The instance type.
Platform:
allOf:
- $ref: '#/components/schemas/PlatformValues'
- xml:
name: platform
description: 'The value is Windows for Windows instances. Otherwise, the value is blank.'
description: Describes the instances that were launched by the fleet.
CreateFleetInstancesSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/CreateFleetInstance'
- xml:
name: item
SpotOptionsRequest:
type: object
properties:
AllocationStrategy:
allOf:
- $ref: '#/components/schemas/SpotAllocationStrategy'
- description: 'The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn''t have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowest-price
The behavior when a Spot Instance is interrupted.
Default: terminate
The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' SingleInstanceType: allOf: - $ref: '#/components/schemas/Boolean' - description:Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
The maximum amount per hour for Spot Instances that you''re willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
DefaultTargetCapacityType.'
OnDemandTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of On-Demand units to request.
SpotTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of Spot units to request.
DefaultTargetCapacityType:
allOf:
- $ref: '#/components/schemas/DefaultTargetCapacityType'
- description: 'The default TotalTargetCapacity, which is either Spot or On-Demand.'
TargetCapacityUnitType:
allOf:
- $ref: '#/components/schemas/TargetCapacityUnitType'
- description: 'The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptionsRequest and SpotOptionsRequest.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.'
SpotOptions:
allOf:
- $ref: '#/components/schemas/SpotOptionsRequest'
- description: Describes the configuration of Spot Instances in an EC2 Fleet.
OnDemandOptions:
allOf:
- $ref: '#/components/schemas/OnDemandOptionsRequest'
- description: Describes the configuration of On-Demand Instances in an EC2 Fleet.
ExcessCapacityTerminationPolicy:
allOf:
- $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy'
- description: 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 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: allOf: - $ref: '#/components/schemas/DateTime' - description: '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: allOf: - $ref: '#/components/schemas/DateTime' - description: '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: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of typemaintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: 'The key-value pair for tagging the EC2 Fleet request on creation. For more information, see Tagging 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.
plain-text.
HiveCompatiblePartitions:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is false.
PerHourPartition:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is false.
description: Describes the destination options for a flow log.
CreateFlowLogsRequest:
type: object
required:
- ResourceIds
- ResourceType
title: CreateFlowLogsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
DeliverLogsPermissionArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the IAM role that allows Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
This parameter is required if the destination type is cloud-watch-logs and unsupported otherwise.
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.
' ResourceType: allOf: - $ref: '#/components/schemas/FlowLogsResourceType' - description: The type of resource to monitor. TrafficType: allOf: - $ref: '#/components/schemas/TrafficType' - description: '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: allOf: - $ref: '#/components/schemas/LogDestinationType' - description: '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. For the CLI, surround this parameter value with single quotes on Linux or double quotes on Windows.
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: allOf: - $ref: '#/components/schemas/DestinationOptionsRequest' - description: The destination options. StorageLocation: type: object properties: Bucket: allOf: - $ref: '#/components/schemas/String' - description: The name of the S3 bucket. Key: allOf: - $ref: '#/components/schemas/String' - description: The key. description: Describes a storage location in Amazon S3. CreateFpgaImageRequest: type: object required: - InputStorageLocation title: CreateFpgaImageRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
InputStorageLocation:
allOf:
- $ref: '#/components/schemas/StorageLocation'
- description: The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball.
LogsStorageLocation:
allOf:
- $ref: '#/components/schemas/StorageLocation'
- description: The location in Amazon S3 for the output logs.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the AFI.
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: A name for the AFI.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the FPGA image during creation.
CreateImageRequest:
type: object
required:
- InstanceId
- Name
title: CreateImageRequest
properties:
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/BlockDeviceMappingRequestList'
- xml:
name: blockDeviceMapping
description: 'The block device mappings. This parameter cannot be used to modify the encryption status of existing volumes or snapshots. To create an AMI with encrypted snapshots, use the CopyImage action.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description for the new image.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of the instance.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: 'A name for the new image.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' NoReboot: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: noReboot description: '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.
' SecurityGroupIdStringListRequest: type: array items: allOf: - $ref: '#/components/schemas/SecurityGroupId' - xml: name: SecurityGroupId minItems: 0 maxItems: 16 CreateInstanceConnectEndpointRequest: type: object required: - SubnetId title: CreateInstanceConnectEndpointRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of the subnet in which to create the EC2 Instance Connect Endpoint.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdStringListRequest'
- xml:
name: SecurityGroupId
description: '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.'
PreserveClientIp:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether your client''s IP address is preserved as the source. The value is true or false.
If true, your client''s IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
Indicates whether your client''s IP address is preserved as the source. The value is true or false.
If true, your client''s IP address is used when you connect to a resource.
If false, the elastic network interface IP address is used when you connect to a resource.
Default: true
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the event window.
TimeRanges:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequestSet'
- xml:
name: TimeRange
description: 'The time range for the event window. If you specify a time range, you can''t specify a cron expression.'
CronExpression:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowCronExpression'
- description: '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: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: The tags to apply to the event window. ExportToS3TaskSpecification: type: object properties: ContainerFormat: allOf: - $ref: '#/components/schemas/ContainerFormat' - xml: name: containerFormat description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.' DiskImageFormat: allOf: - $ref: '#/components/schemas/DiskImageFormat' - xml: name: diskImageFormat description: The format for the exported image. S3Bucket: allOf: - $ref: '#/components/schemas/String' - xml: name: s3Bucket description: 'The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for theGrantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.'
S3Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: s3Prefix
description: The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
description: Describes an export instance task.
ExportEnvironment:
type: string
enum:
- citrix
- vmware
- microsoft
CreateInstanceExportTaskRequest:
type: object
required:
- ExportToS3Task
- InstanceId
- TargetEnvironment
title: CreateInstanceExportTaskRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description for the conversion task or the resource being exported. The maximum length is 255 characters.
ExportToS3Task:
allOf:
- $ref: '#/components/schemas/ExportToS3TaskSpecification'
- xml:
name: exportToS3
description: The format and location for an export instance task.
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of the instance.
TargetEnvironment:
allOf:
- $ref: '#/components/schemas/ExportEnvironment'
- xml:
name: targetEnvironment
description: The target virtualization environment.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the export instance task during creation.
ExportTask:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the resource being exported.
ExportTaskId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: exportTaskId
description: The ID of the export task.
ExportToS3Task:
allOf:
- $ref: '#/components/schemas/ExportToS3Task'
- xml:
name: exportToS3
description: Information about the export task.
InstanceExportDetails:
allOf:
- $ref: '#/components/schemas/InstanceExportDetails'
- xml:
name: instanceExport
description: Information about the instance to export.
State:
allOf:
- $ref: '#/components/schemas/ExportTaskState'
- xml:
name: state
description: The state of the export task.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: The status message related to the export task.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the export task.
description: Describes an export instance task.
CreateInternetGatewayRequest:
type: object
title: CreateInternetGatewayRequest
properties:
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the internet gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InternetGateway:
type: object
properties:
Attachments:
allOf:
- $ref: '#/components/schemas/InternetGatewayAttachmentList'
- xml:
name: attachmentSet
description: Any VPCs attached to the internet gateway.
InternetGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: internetGatewayId
description: The ID of the internet gateway.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the internet gateway.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the internet gateway.
description: Describes an internet gateway.
IpamScopeId:
type: string
IpamNetmaskLength:
type: integer
minimum: 0
maximum: 128
RequestIpamResourceTagList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RequestIpamResourceTag'
- xml:
name: item
IpamPoolAwsService:
type: string
enum:
- ec2
IpamPoolPublicIpSource:
type: string
enum:
- amazon
- byoip
CreateIpamPoolRequest:
type: object
required:
- IpamScopeId
- AddressFamily
title: CreateIpamPoolRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- description: The ID of the scope in which you would like to create the IPAM pool.
Locale:
allOf:
- $ref: '#/components/schemas/String'
- description: 'In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you do not choose a locale, resources in Regions others than the IPAM''s home region cannot use CIDRs from this pool.
Possible values: Any Amazon Web Services Region, such as us-east-1.
' SourceIpamPoolId: allOf: - $ref: '#/components/schemas/IpamPoolId' - description: 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: allOf: - $ref: '#/components/schemas/String' - description: A description for the IPAM pool. AddressFamily: allOf: - $ref: '#/components/schemas/AddressFamily' - description: The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool. AutoImport: allOf: - $ref: '#/components/schemas/Boolean' - description: '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: allOf: - $ref: '#/components/schemas/Boolean' - description: Determines if the pool is publicly advertisable. This option is not available for pools with AddressFamily set toipv4.
AllocationMinNetmaskLength:
allOf:
- $ref: '#/components/schemas/IpamNetmaskLength'
- description: 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:
allOf:
- $ref: '#/components/schemas/IpamNetmaskLength'
- description: 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:
allOf:
- $ref: '#/components/schemas/IpamNetmaskLength'
- description: '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:
allOf:
- $ref: '#/components/schemas/RequestIpamResourceTagList'
- xml:
name: AllocationResourceTag
description: '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.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: '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.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
AwsService:
allOf:
- $ref: '#/components/schemas/IpamPoolAwsService'
- description: '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:
allOf:
- $ref: '#/components/schemas/IpamPoolPublicIpSource'
- description: '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.'
IpamPool:
type: object
properties:
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The Amazon Web Services account ID of the owner of the IPAM pool.
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- xml:
name: ipamPoolId
description: The ID of the IPAM pool.
SourceIpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- xml:
name: sourceIpamPoolId
description: The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.
IpamPoolArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ipamPoolArn
description: The Amazon Resource Name (ARN) of the IPAM pool.
IpamScopeArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ipamScopeArn
description: The ARN of the scope of the IPAM pool.
IpamScopeType:
allOf:
- $ref: '#/components/schemas/IpamScopeType'
- xml:
name: ipamScopeType
description: '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.'
IpamArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ipamArn
description: The ARN of the IPAM.
IpamRegion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipamRegion
description: The Amazon Web Services Region of the IPAM pool.
Locale:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: locale
description: 'The locale of the IPAM pool. In IPAM, the locale is the Amazon Web Services Region where you want to make an IPAM pool available for allocations. Only resources in the same Region as the locale of the pool can get IP address allocations from the pool. You can only allocate a CIDR for a VPC, for example, from an IPAM pool that shares a locale with the VPC’s Region. Note that once you choose a Locale for a pool, you cannot modify it. If you choose an Amazon Web Services Region for locale that has not been configured as an operating Region for the IPAM, you''ll get an error.'
PoolDepth:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: poolDepth
description: 'The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see Quotas in IPAM in the Amazon VPC IPAM User Guide. '
State:
allOf:
- $ref: '#/components/schemas/IpamPoolState'
- xml:
name: state
description: The state of the IPAM pool.
StateMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: stateMessage
description: A message related to the failed creation of an IPAM pool.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the IPAM pool.
AutoImport:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: autoImport
description: '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: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: publiclyAdvertisable description: Determines if a pool is publicly advertisable. This option is not available for pools with AddressFamily set toipv4.
AddressFamily:
allOf:
- $ref: '#/components/schemas/AddressFamily'
- xml:
name: addressFamily
description: The address family of the pool.
AllocationMinNetmaskLength:
allOf:
- $ref: '#/components/schemas/IpamNetmaskLength'
- xml:
name: allocationMinNetmaskLength
description: 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:
allOf:
- $ref: '#/components/schemas/IpamNetmaskLength'
- xml:
name: allocationMaxNetmaskLength
description: 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:
allOf:
- $ref: '#/components/schemas/IpamNetmaskLength'
- xml:
name: allocationDefaultNetmaskLength
description: '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:
allOf:
- $ref: '#/components/schemas/IpamResourceTagList'
- xml:
name: allocationResourceTagSet
description: '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.'
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: '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.'
AwsService:
allOf:
- $ref: '#/components/schemas/IpamPoolAwsService'
- xml:
name: awsService
description: '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:
allOf:
- $ref: '#/components/schemas/IpamPoolPublicIpSource'
- xml:
name: publicIpSource
description: 'The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is BYOIP. For more information, see Create IPv6 pools in the Amazon VPC IPAM User Guide. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool. For information on increasing the default limit, see Quotas for your IPAM in the Amazon VPC IPAM User Guide.'
description: '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.'
CreateIpamRequest:
type: object
title: CreateIpamRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the IPAM.
OperatingRegions:
allOf:
- $ref: '#/components/schemas/AddIpamOperatingRegionSet'
- xml:
name: OperatingRegion
description: '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.
' TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: '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 keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
CreateIpamResourceDiscoveryRequest:
type: object
title: CreateIpamResourceDiscoveryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the IPAM resource discovery.
OperatingRegions:
allOf:
- $ref: '#/components/schemas/AddIpamOperatingRegionSet'
- xml:
name: OperatingRegion
description: 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.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: Tag specifications for the IPAM resource discovery.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A client token for the IPAM resource discovery.
IpamResourceDiscovery:
type: object
properties:
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the owner.
IpamResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- xml:
name: ipamResourceDiscoveryId
description: The resource discovery ID.
IpamResourceDiscoveryArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipamResourceDiscoveryArn
description: The resource discovery Amazon Resource Name (ARN).
IpamResourceDiscoveryRegion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipamResourceDiscoveryRegion
description: The resource discovery Region.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The resource discovery description.
OperatingRegions:
allOf:
- $ref: '#/components/schemas/IpamOperatingRegionSet'
- xml:
name: operatingRegionSet
description: The operating Regions for the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
IsDefault:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isDefault
description: Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.
State:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryState'
- xml:
name: state
description: The lifecycle state of the resource discovery.
create-in-progress - Resource discovery is being created.
create-complete - Resource discovery creation is complete.
create-failed - Resource discovery creation has failed.
modify-in-progress - Resource discovery is being modified.
modify-complete - Resource discovery modification is complete.
modify-failed - Resource discovery modification has failed.
delete-in-progress - Resource discovery is being deleted.
delete-complete - Resource discovery deletion is complete.
delete-failed - Resource discovery deletion has failed.
isolate-in-progress - Amazon Web Services account that created the resource discovery has been removed and the resource discovery is being isolated.
isolate-complete - Resource discovery isolation is complete.
restore-in-progress - Amazon Web Services account that created the resource discovery and was isolated has been restored.
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' State: allOf: - $ref: '#/components/schemas/IpamState' - xml: name: state description: The state of the IPAM. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: '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 keyOwner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
DefaultResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- xml:
name: defaultResourceDiscoveryId
description: The IPAM's default resource discovery ID.
DefaultResourceDiscoveryAssociationId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryAssociationId'
- xml:
name: defaultResourceDiscoveryAssociationId
description: The IPAM's default resource discovery association ID.
ResourceDiscoveryAssociationCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: resourceDiscoveryAssociationCount
description: The IPAM's resource discovery association count.
description: '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.'
CreateIpamScopeRequest:
type: object
required:
- IpamId
title: CreateIpamScopeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamId:
allOf:
- $ref: '#/components/schemas/IpamId'
- description: The ID of the IPAM for which you're creating this scope.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the scope you're creating.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: '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.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
IpamScope:
type: object
properties:
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The Amazon Web Services account ID of the owner of the scope.
IpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- xml:
name: ipamScopeId
description: The ID of the scope.
IpamScopeArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ipamScopeArn
description: The Amazon Resource Name (ARN) of the scope.
IpamArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ipamArn
description: The ARN of the IPAM.
IpamRegion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipamRegion
description: The Amazon Web Services Region of the IPAM scope.
IpamScopeType:
allOf:
- $ref: '#/components/schemas/IpamScopeType'
- xml:
name: ipamScopeType
description: The type of the scope.
IsDefault:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isDefault
description: Defines if the scope is the default scope or not.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the scope.
PoolCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: poolCount
description: The number of pools in the scope.
State:
allOf:
- $ref: '#/components/schemas/IpamScopeState'
- xml:
name: state
description: The state of the IPAM scope.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: '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.'
description: 'In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict.
For more information, see How IPAM works in the Amazon VPC IPAM User Guide.
' KeyType: type: string enum: - rsa - ed25519 KeyFormat: type: string enum: - pem - ppk CreateKeyPairRequest: type: object required: - KeyName title: CreateKeyPairRequest properties: KeyName: allOf: - $ref: '#/components/schemas/String' - description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
KeyType:
allOf:
- $ref: '#/components/schemas/KeyType'
- description: 'The type of key pair. Note that ED25519 keys are not supported for Windows instances.
Default: rsa
The format of the key pair.
Default: pem
The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
The ID of the AMI. Alternatively, you can specify a Systems Manager parameter, which will resolve to an AMI ID on launch.
Valid formats:
ami-17characters00000
resolve:ssm:parameter-name
resolve:ssm:parameter-name:version-number
resolve:ssm:parameter-name:label
resolve:ssm:public-parameter
Currently, EC2 Fleet and Spot Fleet do not support specifying a Systems Manager parameter. If the launch template will be used by an EC2 Fleet or Spot Fleet, you must specify the AMI ID.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
' InstanceType: allOf: - $ref: '#/components/schemas/InstanceType' - description: 'The instance type. For more information, see Instance types in the Amazon Elastic Compute Cloud User Guide.
If you specify InstanceType, you can''t specify InstanceRequirements.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The ID of the RAM disk.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see User provided kernels in the Amazon Elastic Compute Cloud User Guide.
true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.'
InstanceInitiatedShutdownBehavior:
allOf:
- $ref: '#/components/schemas/ShutdownBehavior'
- description: 'Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see Run commands on your Linux instance at launch (Linux) or Work with instance user data (Windows) in the Amazon Elastic Compute Cloud User Guide.
If you are creating the launch template for use with Batch, the user data must be provided in the MIME multi-part archive format. For more information, see Amazon EC2 user data in launch templates in the Batch User Guide.
' TagSpecifications: allOf: - $ref: '#/components/schemas/LaunchTemplateTagSpecificationRequestList' - xml: name: TagSpecification description: 'The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
To tag the launch template itself, you must use the TagSpecification parameter.
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
LicenseSpecifications:
allOf:
- $ref: '#/components/schemas/LaunchTemplateLicenseSpecificationListRequest'
- xml:
name: LicenseSpecification
description: The license configurations.
HibernationOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateHibernationOptionsRequest'
- description: 'Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.'
MetadataOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptionsRequest'
- description: 'The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.'
EnclaveOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateEnclaveOptionsRequest'
- description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
' InstanceRequirements: allOf: - $ref: '#/components/schemas/InstanceRequirementsRequest' - description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard, or with the RunInstances API or AWS::EC2::Instance Amazon Web Services CloudFormation resource, you can''t specify InstanceRequirements.
For more information, see Attribute-based instance type selection for EC2 Fleet, Attribute-based instance type selection for Spot Fleet, and Spot placement score in the Amazon EC2 User Guide.
' PrivateDnsNameOptions: allOf: - $ref: '#/components/schemas/LaunchTemplatePrivateDnsNameOptionsRequest' - description: The options for the instance hostname. The default values are inherited from the subnet. MaintenanceOptions: allOf: - $ref: '#/components/schemas/LaunchTemplateInstanceMaintenanceOptionsRequest' - description: The maintenance options for the instance. DisableApiStop: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether to enable the instance for stop protection. For more information, see Stop protection in the Amazon Elastic Compute Cloud User Guide.' description:The information to include in the launch template.
You must specify at least one parameter for the launch template data.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: '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: allOf: - $ref: '#/components/schemas/LaunchTemplateName' - description: A name for the launch template. VersionDescription: allOf: - $ref: '#/components/schemas/VersionDescription' - description: A description for the first version of the launch template. LaunchTemplateData: allOf: - $ref: '#/components/schemas/RequestLaunchTemplateData' - description: The information for the launch template. TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: '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: allOf: - $ref: '#/components/schemas/LaunchTemplateId' - description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
LaunchTemplateData. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included.'
VersionDescription:
allOf:
- $ref: '#/components/schemas/VersionDescription'
- description: A description for the version of the launch template.
LaunchTemplateData:
allOf:
- $ref: '#/components/schemas/RequestLaunchTemplateData'
- description: The information for the launch template.
ResolveAlias:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID is displayed in the response for imageID. For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the network interface.
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: ' The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request. '
LocalGatewayRoute:
type: object
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: The CIDR block used for destination matches.
LocalGatewayVirtualInterfaceGroupId:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- xml:
name: localGatewayVirtualInterfaceGroupId
description: The ID of the virtual interface group.
Type:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteType'
- xml:
name: type
description: The route type.
State:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteState'
- xml:
name: state
description: The state of the route.
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- xml:
name: localGatewayRouteTableId
description: The ID of the local gateway route table.
LocalGatewayRouteTableArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: localGatewayRouteTableArn
description: The Amazon Resource Name (ARN) of the local gateway route table.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the local gateway route.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: subnetId
description: The ID of the subnet.
CoipPoolId:
allOf:
- $ref: '#/components/schemas/CoipPoolId'
- xml:
name: coipPoolId
description: The ID of the customer-owned address pool.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- xml:
name: destinationPrefixListId
description: ' The ID of the prefix list. '
description: Describes a route for a local gateway route table.
LocalGatewayRouteTableMode:
type: string
enum:
- direct-vpc-routing
- coip
CreateLocalGatewayRouteTableRequest:
type: object
required:
- LocalGatewayId
title: CreateLocalGatewayRouteTableRequest
properties:
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- description: ' The ID of the local gateway. '
Mode:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableMode'
- description: ' The mode of the local gateway route table. '
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: ' The tags assigned to the local gateway route table. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayRouteTable:
type: object
properties:
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localGatewayRouteTableId
description: The ID of the local gateway route table.
LocalGatewayRouteTableArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: localGatewayRouteTableArn
description: The Amazon Resource Name (ARN) of the local gateway route table.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- xml:
name: localGatewayId
description: The ID of the local gateway.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: The Amazon Resource Name (ARN) of the Outpost.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the local gateway route table.
State:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: state
description: The state of the local gateway route table.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the local gateway route table.
Mode:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableMode'
- xml:
name: mode
description: The mode of the local gateway route table.
StateReason:
allOf:
- $ref: '#/components/schemas/StateReason'
- xml:
name: stateReason
description: Information about the state change.
description: Describes a local gateway route table.
CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest:
type: object
required:
- LocalGatewayRouteTableId
- LocalGatewayVirtualInterfaceGroupId
title: CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest
properties:
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- description: ' The ID of the local gateway route table. '
LocalGatewayVirtualInterfaceGroupId:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- description: ' The ID of the local gateway route table virtual interface group association. '
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: ' The tags assigned to the local gateway route table virtual interface group association. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayRouteTableVirtualInterfaceGroupAssociation:
type: object
properties:
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
- xml:
name: localGatewayRouteTableVirtualInterfaceGroupAssociationId
description: The ID of the association.
LocalGatewayVirtualInterfaceGroupId:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- xml:
name: localGatewayVirtualInterfaceGroupId
description: The ID of the virtual interface group.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localGatewayId
description: The ID of the local gateway.
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- xml:
name: localGatewayRouteTableId
description: The ID of the local gateway route table.
LocalGatewayRouteTableArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: localGatewayRouteTableArn
description: The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
State:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: state
description: The state of the association.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the association.
description: Describes an association between a local gateway route table and a virtual interface group.
CreateLocalGatewayRouteTableVpcAssociationRequest:
type: object
required:
- LocalGatewayRouteTableId
- VpcId
title: CreateLocalGatewayRouteTableVpcAssociationRequest
properties:
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- description: The ID of the local gateway route table.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the local gateway route table VPC association.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayRouteTableVpcAssociation:
type: object
properties:
LocalGatewayRouteTableVpcAssociationId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
- xml:
name: localGatewayRouteTableVpcAssociationId
description: The ID of the association.
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localGatewayRouteTableId
description: The ID of the local gateway route table.
LocalGatewayRouteTableArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: localGatewayRouteTableArn
description: The Amazon Resource Name (ARN) of the local gateway route table for the association.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localGatewayId
description: The ID of the local gateway.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the local gateway route table for the association.
State:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: state
description: The state of the association.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the association.
description: Describes an association between a local gateway route table and a VPC.
CreateManagedPrefixListRequest:
type: object
required:
- PrefixListName
- MaxEntries
- AddressFamily
title: CreateManagedPrefixListRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PrefixListName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A name for the prefix list.
Constraints: Up to 255 characters in length. The name cannot start with com.amazonaws.
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.
' ManagedPrefixList: type: object properties: PrefixListId: allOf: - $ref: '#/components/schemas/PrefixListResourceId' - xml: name: prefixListId description: The ID of the prefix list. AddressFamily: allOf: - $ref: '#/components/schemas/String' - xml: name: addressFamily description: The IP address version. State: allOf: - $ref: '#/components/schemas/PrefixListState' - xml: name: state description: The current state of the prefix list. StateMessage: allOf: - $ref: '#/components/schemas/String' - xml: name: stateMessage description: The state message. PrefixListArn: allOf: - $ref: '#/components/schemas/ResourceArn' - xml: name: prefixListArn description: The Amazon Resource Name (ARN) for the prefix list. PrefixListName: allOf: - $ref: '#/components/schemas/String' - xml: name: prefixListName description: The name of the prefix list. MaxEntries: allOf: - $ref: '#/components/schemas/Integer' - xml: name: maxEntries description: The maximum number of entries for the prefix list. Version: allOf: - $ref: '#/components/schemas/Long' - xml: name: version description: The version of the prefix list. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: The tags for the prefix list. OwnerId: allOf: - $ref: '#/components/schemas/String' - xml: name: ownerId description: The ID of the owner of the prefix list. description: Describes a managed prefix list. CreateNatGatewayRequest: type: object required: - SubnetId title: CreateNatGatewayRequest properties: AllocationId: allOf: - $ref: '#/components/schemas/AllocationId' - description: '[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: allOf: - $ref: '#/components/schemas/String' - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
Constraint: Maximum 64 ASCII characters.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of the subnet in which to create the NAT gateway.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the NAT gateway.
ConnectivityType:
allOf:
- $ref: '#/components/schemas/ConnectivityType'
- description: Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity.
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: '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:
allOf:
- $ref: '#/components/schemas/AllocationIdList'
- xml:
name: SecondaryAllocationId
description: 'Secondary EIP allocation IDs. For more information, see Create a NAT gateway in the Amazon VPC User Guide.'
SecondaryPrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/IpList'
- xml:
name: SecondaryPrivateIpAddress
description: 'Secondary private IPv4 addresses. For more information about secondary addresses, see Create a NAT gateway in the Amazon VPC User Guide.'
SecondaryPrivateIpAddressCount:
allOf:
- $ref: '#/components/schemas/PrivateIpAddressCount'
- description: '[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.'
NatGateway:
type: object
properties:
CreateTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: createTime
description: The date and time the NAT gateway was created.
DeleteTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: deleteTime
description: 'The date and time the NAT gateway was deleted, if applicable.'
FailureCode:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: failureCode
description: 'If the NAT gateway could not be created, specifies the error code for the failure. (InsufficientFreeAddressesInSubnet | Gateway.NotAttached | InvalidAllocationID.NotFound | Resource.AlreadyAssociated | InternalError | InvalidSubnetID.NotFound)'
FailureMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: failureMessage
description: 'If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.
For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
The state of the NAT gateway.
pending: The NAT gateway is being created and is not ready to process traffic.
failed: The NAT gateway could not be created. Check the failureCode and failureMessage fields for the reason.
available: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
deleting: The NAT gateway is in the process of being terminated and may still be processing traffic.
deleted: The NAT gateway has been terminated and is no longer processing traffic.
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.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Egress:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: egress
description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
IcmpTypeCode:
allOf:
- $ref: '#/components/schemas/IcmpTypeCode'
- xml:
name: Icmp
description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.'
Ipv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6CidrBlock
description: 'The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).'
NetworkAclId:
allOf:
- $ref: '#/components/schemas/NetworkAclId'
- xml:
name: networkAclId
description: The ID of the network ACL.
PortRange:
allOf:
- $ref: '#/components/schemas/PortRange'
- xml:
name: portRange
description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
Protocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: protocol
description: '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.'
RuleAction:
allOf:
- $ref: '#/components/schemas/RuleAction'
- xml:
name: ruleAction
description: Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ruleNumber
description: '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.
' CreateNetworkAclRequest: type: object required: - VpcId title: CreateNetworkAclRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the network ACL.
NetworkAcl:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/NetworkAclAssociationList'
- xml:
name: associationSet
description: Any associations between the network ACL and one or more subnets
Entries:
allOf:
- $ref: '#/components/schemas/NetworkAclEntryList'
- xml:
name: entrySet
description: The entries (rules) in the network ACL.
IsDefault:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: default
description: Indicates whether this is the default network ACL for the VPC.
NetworkAclId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkAclId
description: The ID of the network ACL.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the network ACL.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC for the network ACL.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the network ACL.
description: Describes a network ACL.
CreateNetworkInsightsAccessScopeRequest:
type: object
required:
- ClientToken
title: CreateNetworkInsightsAccessScopeRequest
properties:
MatchPaths:
allOf:
- $ref: '#/components/schemas/AccessScopePathListRequest'
- xml:
name: MatchPath
description: The paths to match.
ExcludePaths:
allOf:
- $ref: '#/components/schemas/AccessScopePathListRequest'
- xml:
name: ExcludePath
description: The paths to exclude.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInsightsAccessScope:
type: object
properties:
NetworkInsightsAccessScopeId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- xml:
name: networkInsightsAccessScopeId
description: The ID of the Network Access Scope.
NetworkInsightsAccessScopeArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: networkInsightsAccessScopeArn
description: The Amazon Resource Name (ARN) of the Network Access Scope.
CreatedDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: createdDate
description: The creation date.
UpdatedDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: updatedDate
description: The last updated date.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags.
description: Describes a Network Access Scope.
NetworkInsightsAccessScopeContent:
type: object
properties:
NetworkInsightsAccessScopeId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- xml:
name: networkInsightsAccessScopeId
description: The ID of the Network Access Scope.
MatchPaths:
allOf:
- $ref: '#/components/schemas/AccessScopePathList'
- xml:
name: matchPathSet
description: The paths to match.
ExcludePaths:
allOf:
- $ref: '#/components/schemas/AccessScopePathList'
- xml:
name: excludePathSet
description: The paths to exclude.
description: Describes the Network Access Scope content.
NetworkInsightsResourceId:
type: string
Protocol:
type: string
enum:
- tcp
- udp
PathRequestFilter:
type: object
properties:
SourceAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The source IPv4 address.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/RequestFilterPortRange'
- description: The source port range.
DestinationAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The destination IPv4 address.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/RequestFilterPortRange'
- description: The destination port range.
description: Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.
CreateNetworkInsightsPathRequest:
type: object
required:
- Source
- Protocol
- ClientToken
title: CreateNetworkInsightsPathRequest
properties:
SourceIp:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The IP address of the source.
DestinationIp:
allOf:
- $ref: '#/components/schemas/IpAddress'
- description: The IP address of the destination.
Source:
allOf:
- $ref: '#/components/schemas/NetworkInsightsResourceId'
- description: 'The ID or ARN of the source. If the resource is in another account, you must specify an ARN.'
Destination:
allOf:
- $ref: '#/components/schemas/NetworkInsightsResourceId'
- description: 'The ID or ARN of the destination. If the resource is in another account, you must specify an ARN.'
Protocol:
allOf:
- $ref: '#/components/schemas/Protocol'
- description: The protocol.
DestinationPort:
allOf:
- $ref: '#/components/schemas/Port'
- description: The destination port.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to add to the path.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
FilterAtSource:
allOf:
- $ref: '#/components/schemas/PathRequestFilter'
- description: '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:
allOf:
- $ref: '#/components/schemas/PathRequestFilter'
- description: '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.'
NetworkInsightsPath:
type: object
properties:
NetworkInsightsPathId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathId'
- xml:
name: networkInsightsPathId
description: The ID of the path.
NetworkInsightsPathArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: networkInsightsPathArn
description: The Amazon Resource Name (ARN) of the path.
CreatedDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: createdDate
description: The time stamp when the path was created.
Source:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: source
description: The ID of the source.
Destination:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destination
description: The ID of the destination.
SourceArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: sourceArn
description: The Amazon Resource Name (ARN) of the source.
DestinationArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: destinationArn
description: The Amazon Resource Name (ARN) of the destination.
SourceIp:
allOf:
- $ref: '#/components/schemas/IpAddress'
- xml:
name: sourceIp
description: The IP address of the source.
DestinationIp:
allOf:
- $ref: '#/components/schemas/IpAddress'
- xml:
name: destinationIp
description: The IP address of the destination.
Protocol:
allOf:
- $ref: '#/components/schemas/Protocol'
- xml:
name: protocol
description: The protocol.
DestinationPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: destinationPort
description: The destination port.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags associated with the path.
FilterAtSource:
allOf:
- $ref: '#/components/schemas/PathFilter'
- xml:
name: filterAtSource
description: Scopes the analysis to network paths that match specific filters at the source.
FilterAtDestination:
allOf:
- $ref: '#/components/schemas/PathFilter'
- xml:
name: filterAtDestination
description: Scopes the analysis to network paths that match specific filters at the destination.
description: Describes a path.
InterfacePermissionType:
type: string
enum:
- INSTANCE-ATTACH
- EIP-ASSOCIATE
CreateNetworkInterfacePermissionRequest:
type: object
required:
- NetworkInterfaceId
- Permission
title: CreateNetworkInterfacePermissionRequest
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the network interface.
AwsAccountId:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Web Services account ID.
AwsService:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Web Service. Currently not supported.
Permission:
allOf:
- $ref: '#/components/schemas/InterfacePermissionType'
- description: The type of permission to grant.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for CreateNetworkInterfacePermission.
NetworkInterfacePermission:
type: object
properties:
NetworkInterfacePermissionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfacePermissionId
description: The ID of the network interface permission.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
AwsAccountId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: awsAccountId
description: The Amazon Web Services account ID.
AwsService:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: awsService
description: The Amazon Web Service.
Permission:
allOf:
- $ref: '#/components/schemas/InterfacePermissionType'
- xml:
name: permission
description: The type of permission.
PermissionState:
allOf:
- $ref: '#/components/schemas/NetworkInterfacePermissionState'
- xml:
name: permissionState
description: Information about the state of the permission.
description: Describes a permission for a network interface.
InstanceIpv6AddressList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceIpv6Address'
- xml:
name: item
PrivateIpAddressSpecificationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrivateIpAddressSpecification'
- xml:
name: item
Ipv4PrefixList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv4PrefixSpecificationRequest'
- xml:
name: item
Ipv6PrefixList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv6PrefixSpecificationRequest'
- xml:
name: item
NetworkInterfaceCreationType:
type: string
enum:
- efa
- branch
- trunk
CreateNetworkInterfaceRequest:
type: object
required:
- SubnetId
title: CreateNetworkInterfaceRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description for the network interface.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Groups:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdStringList'
- xml:
name: SecurityGroupId
description: The IDs of one or more security groups.
Ipv6AddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ipv6AddressCount
description: '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.
' PrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIpAddress description: '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 inprivateIpAddresses as primary (only one IP address can be designated as primary).'
PrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/PrivateIpAddressSpecificationList'
- xml:
name: privateIpAddresses
description: '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.
' SecondaryPrivateIpAddressCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: secondaryPrivateIpAddressCount description: '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.
' Ipv4Prefixes: allOf: - $ref: '#/components/schemas/Ipv4PrefixList' - xml: name: Ipv4Prefix description: '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.
' Ipv4PrefixCount: allOf: - $ref: '#/components/schemas/Integer' - description: '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: allOf: - $ref: '#/components/schemas/Ipv6PrefixList' - xml: name: Ipv6Prefix description: '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.
' Ipv6PrefixCount: allOf: - $ref: '#/components/schemas/Integer' - description: '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: allOf: - $ref: '#/components/schemas/NetworkInterfaceCreationType' - description: 'The type of network interface. The default is interface.
The only supported values are interface, efa, and trunk.
true, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.'
Ipv6Native:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ipv6Native
description: Indicates whether this is an IPv6 only network interface.
Ipv6Address:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6Address
description: The IPv6 globally unique address associated with the network interface.
description: Describes a network interface.
PlacementStrategy:
type: string
enum:
- cluster
- spread
- partition
SpreadLevel:
type: string
enum:
- host
- rack
CreatePlacementGroupRequest:
type: object
title: CreatePlacementGroupRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupName
description: 'A name for the placement group. Must be unique within the scope of your account for the Region.
Constraints: Up to 255 ASCII characters
' Strategy: allOf: - $ref: '#/components/schemas/PlacementStrategy' - xml: name: strategy description: The placement strategy. PartitionCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of partitions. Valid only when Strategy is set topartition.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the new placement group.
SpreadLevel:
allOf:
- $ref: '#/components/schemas/SpreadLevel'
- description: Determines how placement groups spread instances.
Host – You can use host only with Outpost placement groups.
Rack – No usage restrictions.
partition.
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the placement group.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags applied to the placement group.
GroupArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupArn
description: The Amazon Resource Name (ARN) of the placement group.
SpreadLevel:
allOf:
- $ref: '#/components/schemas/SpreadLevel'
- xml:
name: spreadLevel
description: The spread level for the placement group. Only Outpost placement groups can be spread across hosts.
description: Describes a placement group.
CreatePublicIpv4PoolRequest:
type: object
title: CreatePublicIpv4PoolRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: '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.'
CreateReplaceRootVolumeTaskRequest:
type: object
required:
- InstanceId
title: CreateReplaceRootVolumeTaskRequest
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance for which to replace the root volume.
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: '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: allOf: - $ref: '#/components/schemas/String' - description: '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.' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the root volume replacement task.
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: '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: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specifytrue. 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.'
ReplaceRootVolumeTask:
type: object
properties:
ReplaceRootVolumeTaskId:
allOf:
- $ref: '#/components/schemas/ReplaceRootVolumeTaskId'
- xml:
name: replaceRootVolumeTaskId
description: The ID of the root volume replacement task.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance for which the root volume replacement task was created.
TaskState:
allOf:
- $ref: '#/components/schemas/ReplaceRootVolumeTaskState'
- xml:
name: taskState
description: 'The state of the task. The task can be in one of the following states:
pending - the replacement volume is being created.
in-progress - the original volume is being detached and the replacement volume is being attached.
succeeded - the replacement volume has been successfully attached to the instance and the instance is available.
failing - the replacement task is in the process of failing.
failed - the replacement task has failed but the original root volume is still attached.
failing-detached - the replacement task is in the process of failing. The instance might have no root volume attached.
failed-detached - the replacement task has failed and the instance has no root volume attached.
The 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateRouteRequest:
type: object
required:
- RouteTableId
title: CreateRouteRequest
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: '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.'
DestinationIpv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationIpv6CidrBlock
description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of a prefix list used for the destination match.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcEndpointId:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
EgressOnlyInternetGatewayId:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- xml:
name: egressOnlyInternetGatewayId
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
GatewayId:
allOf:
- $ref: '#/components/schemas/RouteGatewayId'
- xml:
name: gatewayId
description: The ID of an internet gateway or virtual private gateway attached to your VPC.
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: 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.
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- xml:
name: natGatewayId
description: '[IPv4 traffic only] The ID of a NAT gateway.'
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of a transit gateway.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- description: The ID of the local gateway.
CarrierGatewayId:
allOf:
- $ref: '#/components/schemas/CarrierGatewayId'
- description: 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: allOf: - $ref: '#/components/schemas/NetworkInterfaceId' - xml: name: networkInterfaceId description: The ID of a network interface. RouteTableId: allOf: - $ref: '#/components/schemas/RouteTableId' - xml: name: routeTableId description: The ID of the route table for the route. VpcPeeringConnectionId: allOf: - $ref: '#/components/schemas/VpcPeeringConnectionId' - xml: name: vpcPeeringConnectionId description: The ID of a VPC peering connection. CoreNetworkArn: allOf: - $ref: '#/components/schemas/CoreNetworkArn' - description: The Amazon Resource Name (ARN) of the core network. CreateRouteTableRequest: type: object required: - VpcId title: CreateRouteTableRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the route table.
RouteTable:
type: object
properties:
Associations:
allOf:
- $ref: '#/components/schemas/RouteTableAssociationList'
- xml:
name: associationSet
description: The associations between the route table and one or more subnets or a gateway.
PropagatingVgws:
allOf:
- $ref: '#/components/schemas/PropagatingVgwList'
- xml:
name: propagatingVgwSet
description: Any virtual private gateway (VGW) propagating routes.
RouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: routeTableId
description: The ID of the route table.
Routes:
allOf:
- $ref: '#/components/schemas/RouteList'
- xml:
name: routeSet
description: The routes in the route table.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the route table.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the route table.
description: Describes a route table.
CreateSecurityGroupRequest:
type: object
required:
- Description
- GroupName
title: CreateSecurityGroupRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: GroupDescription
description: 'A description for the security group.
Constraints: Up to 255 characters in length
Valid characters: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' GroupName: allOf: - $ref: '#/components/schemas/String' - description: '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: allOf: - $ref: '#/components/schemas/VpcId' - description: The ID of the VPC. Required for a nondefault VPC. TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: The tags to assign to the security group. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateSnapshotRequest:
type: object
required:
- VolumeId
title: CreateSnapshotRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the snapshot.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- description: '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 Elastic Compute Cloud User Guide.
' VolumeId: allOf: - $ref: '#/components/schemas/VolumeId' - description: The ID of the Amazon EBS volume. TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: The tags to apply to the snapshot during creation. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceSpecification:
type: object
required:
- InstanceId
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceIdWithVolumeResolver'
- description: The instance to specify which volumes should be snapshotted.
ExcludeBootVolume:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Excludes the root volume from being snapshotted.
ExcludeDataVolumeIds:
allOf:
- $ref: '#/components/schemas/VolumeIdStringList'
- xml:
name: ExcludeDataVolumeId
description: 'The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. If you specify the ID of the root volume, the request fails. To exclude the root volume, use ExcludeBootVolume.
You can specify up to 40 volume IDs per request.
' description: The instance details to specify which volumes should be snapshotted. CreateSnapshotsRequest: type: object required: - InstanceSpecification title: CreateSnapshotsRequest properties: Description: allOf: - $ref: '#/components/schemas/String' - description: ' A description propagated to every snapshot specified by the instance.' InstanceSpecification: allOf: - $ref: '#/components/schemas/InstanceSpecification' - description: The instance to specify which volumes should be included in the snapshots. OutpostArn: allOf: - $ref: '#/components/schemas/String' - description: '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 Elastic Compute Cloud User Guide.
' TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: Tags to apply to every snapshot specified by the instance. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
CopyTagsFromSource:
allOf:
- $ref: '#/components/schemas/CopyTagsFromSource'
- description: Copies the tags from the specified volume to corresponding snapshot.
SnapshotSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotInfo'
- xml:
name: item
CreateSpotDatafeedSubscriptionRequest:
type: object
required:
- Bucket
title: CreateSpotDatafeedSubscriptionRequest
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: bucket
description: '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.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: prefix
description: The prefix for the data feed file names.
description: Contains the parameters for CreateSpotDatafeedSubscription.
SpotDatafeedSubscription:
type: object
properties:
Bucket:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: bucket
description: The name of the Amazon S3 bucket where the Spot Instance data feed is located.
Fault:
allOf:
- $ref: '#/components/schemas/SpotInstanceStateFault'
- xml:
name: fault
description: 'The fault codes for the Spot Instance request, if any.'
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The Amazon Web Services account ID of the account.
Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: prefix
description: The prefix for the data feed files.
State:
allOf:
- $ref: '#/components/schemas/DatafeedSubscriptionState'
- xml:
name: state
description: The state of the Spot Instance data feed subscription.
description: Describes the data feed for a Spot Instance.
S3ObjectTagList:
type: array
items:
allOf:
- $ref: '#/components/schemas/S3ObjectTag'
- xml:
name: item
CreateStoreImageTaskRequest:
type: object
required:
- ImageId
- Bucket
title: CreateStoreImageTaskRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI.
Bucket:
allOf:
- $ref: '#/components/schemas/String'
- description: '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:
allOf:
- $ref: '#/components/schemas/S3ObjectTagList'
- xml:
name: S3ObjectTag
description: 'The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SubnetCidrReservationType:
type: string
enum:
- prefix
- explicit
CreateSubnetCidrReservationRequest:
type: object
required:
- SubnetId
- Cidr
- ReservationType
title: CreateSubnetCidrReservationRequest
properties:
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of the subnet.
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: The IPv4 or IPV6 CIDR range to reserve.
ReservationType:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservationType'
- description: 'The type of reservation.
The following are valid values:
prefix: The Amazon EC2 Prefix Delegation feature assigns the IP addresses to network interfaces that are associated with an instance. For information about Prefix Delegation, see Prefix Delegation for Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.
explicit: You manually assign the IP addresses to resources that reside in your subnet.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the subnet CIDR reservation.
SubnetCidrReservation:
type: object
properties:
SubnetCidrReservationId:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservationId'
- xml:
name: subnetCidrReservationId
description: The ID of the subnet CIDR reservation.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: subnetId
description: The ID of the subnet.
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidr
description: The CIDR that has been reserved.
ReservationType:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservationType'
- xml:
name: reservationType
description: 'The type of reservation. '
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: 'The ID of the account that owns the subnet CIDR reservation. '
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description assigned to the subnet CIDR reservation.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the subnet CIDR reservation.
description: Describes a subnet CIDR reservation.
CreateSubnetRequest:
type: object
required:
- VpcId
title: CreateSubnetRequest
properties:
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the subnet.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The Availability Zone or Local Zone for the subnet.
Default: Amazon Web Services selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet.
To create a subnet in a Local Zone, set this value to the Local Zone ID, for example us-west-2-lax-1a. For information about the Regions that support Local Zones, see Local Zones locations.
To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN.
' AvailabilityZoneId: allOf: - $ref: '#/components/schemas/String' - description: The AZ ID or the Local Zone ID of the subnet. CidrBlock: allOf: - $ref: '#/components/schemas/String' - description: '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: allOf: - $ref: '#/components/schemas/String' - description: 'The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
This parameter is required for an IPv6 only subnet.
' OutpostArn: allOf: - $ref: '#/components/schemas/String' - description: '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: allOf: - $ref: '#/components/schemas/VpcId' - description: The ID of the VPC. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
Ipv6Native:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to create an IPv6 only subnet.
ResourceIdList:
type: array
items:
$ref: '#/components/schemas/TaggableResourceId'
CreateTagsRequest:
type: object
required:
- Resources
- Tags
title: CreateTagsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Resources:
allOf:
- $ref: '#/components/schemas/ResourceIdList'
- xml:
name: ResourceId
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: Tag description: 'The tags. Thevalue 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.'
CreateTrafficMirrorFilterRequest:
type: object
title: CreateTrafficMirrorFilterRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the Traffic Mirror filter.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to a Traffic Mirror filter.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
TrafficMirrorFilter:
type: object
properties:
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorFilterId
description: The ID of the Traffic Mirror filter.
IngressFilterRules:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterRuleList'
- xml:
name: ingressFilterRuleSet
description: Information about the ingress rules that are associated with the Traffic Mirror filter.
EgressFilterRules:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterRuleList'
- xml:
name: egressFilterRuleSet
description: Information about the egress rules that are associated with the Traffic Mirror filter.
NetworkServices:
allOf:
- $ref: '#/components/schemas/TrafficMirrorNetworkServiceList'
- xml:
name: networkServiceSet
description: The network service traffic that is associated with the Traffic Mirror filter.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the Traffic Mirror filter.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the Traffic Mirror filter.
description: Describes the Traffic Mirror filter.
TrafficDirection:
type: string
enum:
- ingress
- egress
TrafficMirrorRuleAction:
type: string
enum:
- accept
- reject
TrafficMirrorPortRangeRequest:
type: object
properties:
FromPort:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.
description: Information about the Traffic Mirror filter rule port range.
CreateTrafficMirrorFilterRuleRequest:
type: object
required:
- TrafficMirrorFilterId
- TrafficDirection
- RuleNumber
- RuleAction
- DestinationCidrBlock
- SourceCidrBlock
title: CreateTrafficMirrorFilterRuleRequest
properties:
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterId'
- description: The ID of the filter that this rule is associated with.
TrafficDirection:
allOf:
- $ref: '#/components/schemas/TrafficDirection'
- description: The type of traffic.
RuleNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 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:
allOf:
- $ref: '#/components/schemas/TrafficMirrorRuleAction'
- description: The action to take on the filtered traffic.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
- description: The destination port range.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
- description: The source port range.
Protocol:
allOf:
- $ref: '#/components/schemas/Integer'
- description: '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: allOf: - $ref: '#/components/schemas/String' - description: The destination CIDR block to assign to the Traffic Mirror rule. SourceCidrBlock: allOf: - $ref: '#/components/schemas/String' - description: The source CIDR block to assign to the Traffic Mirror rule. Description: allOf: - $ref: '#/components/schemas/String' - description: The description of the Traffic Mirror rule. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
TrafficMirrorFilterRule:
type: object
properties:
TrafficMirrorFilterRuleId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorFilterRuleId
description: The ID of the Traffic Mirror rule.
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorFilterId
description: The ID of the Traffic Mirror filter that the rule is associated with.
TrafficDirection:
allOf:
- $ref: '#/components/schemas/TrafficDirection'
- xml:
name: trafficDirection
description: The traffic direction assigned to the Traffic Mirror rule.
RuleNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ruleNumber
description: The rule number of the Traffic Mirror rule.
RuleAction:
allOf:
- $ref: '#/components/schemas/TrafficMirrorRuleAction'
- xml:
name: ruleAction
description: The action assigned to the Traffic Mirror rule.
Protocol:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: protocol
description: The protocol assigned to the Traffic Mirror rule.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/TrafficMirrorPortRange'
- xml:
name: destinationPortRange
description: The destination port range assigned to the Traffic Mirror rule.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/TrafficMirrorPortRange'
- xml:
name: sourcePortRange
description: The source port range assigned to the Traffic Mirror rule.
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: The destination CIDR block assigned to the Traffic Mirror rule.
SourceCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourceCidrBlock
description: The source CIDR block assigned to the Traffic Mirror rule.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the Traffic Mirror rule.
description: Describes the Traffic Mirror rule.
CreateTrafficMirrorSessionRequest:
type: object
required:
- NetworkInterfaceId
- TrafficMirrorTargetId
- TrafficMirrorFilterId
- SessionNumber
title: CreateTrafficMirrorSessionRequest
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the source network interface.
TrafficMirrorTargetId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetId'
- description: The ID of the Traffic Mirror target.
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterId'
- description: The ID of the Traffic Mirror filter.
PacketLength:
allOf:
- $ref: '#/components/schemas/Integer'
- description: '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.
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: allOf: - $ref: '#/components/schemas/Integer' - description: 'The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see RFC 7348. If you do not specify aVirtualNetworkId, an account-wide unique id is chosen at random.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the Traffic Mirror session.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to a Traffic Mirror session.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
TrafficMirrorSession:
type: object
properties:
TrafficMirrorSessionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorSessionId
description: The ID for the Traffic Mirror session.
TrafficMirrorTargetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorTargetId
description: The ID of the Traffic Mirror target.
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorFilterId
description: The ID of the Traffic Mirror filter.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the Traffic Mirror session's network interface.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the account that owns the Traffic Mirror session.
PacketLength:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: packetLength
description: 'The number of bytes in each packet to mirror. These are the bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet'
SessionNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: sessionNumber
description: 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: allOf: - $ref: '#/components/schemas/Integer' - xml: name: virtualNetworkId description: The virtual network ID associated with the Traffic Mirror session. Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: The description of the Traffic Mirror session. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: The tags assigned to the Traffic Mirror session. description: Describes a Traffic Mirror session. CreateTrafficMirrorTargetRequest: type: object title: CreateTrafficMirrorTargetRequest properties: NetworkInterfaceId: allOf: - $ref: '#/components/schemas/NetworkInterfaceId' - description: The network interface ID that is associated with the target. NetworkLoadBalancerArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. Description: allOf: - $ref: '#/components/schemas/String' - description: The description of the Traffic Mirror target. TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: The tags to assign to the Traffic Mirror target. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
GatewayLoadBalancerEndpointId:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- description: The ID of the Gateway Load Balancer endpoint.
TrafficMirrorTarget:
type: object
properties:
TrafficMirrorTargetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: trafficMirrorTargetId
description: The ID of the Traffic Mirror target.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The network interface ID that is attached to the target.
NetworkLoadBalancerArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkLoadBalancerArn
description: The Amazon Resource Name (ARN) of the Network Load Balancer.
Type:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetType'
- xml:
name: type
description: The type of Traffic Mirror target.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: Information about the Traffic Mirror target.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the account that owns the Traffic Mirror target.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the Traffic Mirror target.
GatewayLoadBalancerEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: gatewayLoadBalancerEndpointId
description: The ID of the Gateway Load Balancer endpoint.
description: Describes a Traffic Mirror target.
TransitGatewayConnectRequestBgpOptions:
type: object
properties:
PeerAsn:
allOf:
- $ref: '#/components/schemas/Long'
- description: The peer Autonomous System Number (ASN).
description: The BGP options for the Connect attachment.
InsideCidrBlocksStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
CreateTransitGatewayConnectPeerRequest:
type: object
required:
- TransitGatewayAttachmentId
- PeerAddress
- InsideCidrBlocks
title: CreateTransitGatewayConnectPeerRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the Connect attachment.
TransitGatewayAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: '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:
allOf:
- $ref: '#/components/schemas/String'
- description: The peer IP address (GRE outer IP address) on the appliance side of the Connect peer.
BgpOptions:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectRequestBgpOptions'
- description: The BGP options for the Connect peer.
InsideCidrBlocks:
allOf:
- $ref: '#/components/schemas/InsideCidrBlocksStringList'
- description: '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.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the Connect peer.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayConnectPeer:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: transitGatewayAttachmentId
description: The ID of the Connect attachment.
TransitGatewayConnectPeerId:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerId'
- xml:
name: transitGatewayConnectPeerId
description: The ID of the Connect peer.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerState'
- xml:
name: state
description: The state of the Connect peer.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The creation time.
ConnectPeerConfiguration:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerConfiguration'
- xml:
name: connectPeerConfiguration
description: The Connect peer details.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the Connect peer.
description: Describes a transit gateway Connect peer.
CreateTransitGatewayConnectRequestOptions:
type: object
required:
- Protocol
properties:
Protocol:
allOf:
- $ref: '#/components/schemas/ProtocolValue'
- description: The tunnel protocol.
description: The options for a Connect attachment.
CreateTransitGatewayConnectRequest:
type: object
required:
- TransportTransitGatewayAttachmentId
- Options
title: CreateTransitGatewayConnectRequest
properties:
TransportTransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway attachment. You can specify a VPC attachment or Amazon Web Services Direct Connect attachment.
Options:
allOf:
- $ref: '#/components/schemas/CreateTransitGatewayConnectRequestOptions'
- description: The Connect attachment options.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the Connect attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayConnect:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: transitGatewayAttachmentId
description: The ID of the Connect attachment.
TransportTransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: transportTransitGatewayAttachmentId
description: The ID of the attachment from which the Connect attachment was created.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentState'
- xml:
name: state
description: The state of the attachment.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The creation time.
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectOptions'
- xml:
name: options
description: The Connect attachment options.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the attachment.
description: Describes a transit gateway Connect attachment.
CreateTransitGatewayMulticastDomainRequestOptions:
type: object
properties:
Igmpv2Support:
allOf:
- $ref: '#/components/schemas/Igmpv2SupportValue'
- description: Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.
StaticSourcesSupport:
allOf:
- $ref: '#/components/schemas/StaticSourcesSupportValue'
- description: Specify whether to enable support for statically configuring multicast group sources for a domain.
AutoAcceptSharedAssociations:
allOf:
- $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue'
- description: Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.
description: The options for the transit gateway multicast domain.
CreateTransitGatewayMulticastDomainRequest:
type: object
required:
- TransitGatewayId
title: CreateTransitGatewayMulticastDomainRequest
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway.
Options:
allOf:
- $ref: '#/components/schemas/CreateTransitGatewayMulticastDomainRequestOptions'
- description: The options for the transit gateway multicast domain.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags for the transit gateway multicast domain.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastDomain:
type: object
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayMulticastDomainId
description: The ID of the transit gateway multicast domain.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
TransitGatewayMulticastDomainArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayMulticastDomainArn
description: The Amazon Resource Name (ARN) of the transit gateway multicast domain.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain.'
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainOptions'
- xml:
name: options
description: The options for the transit gateway multicast domain.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainState'
- xml:
name: state
description: The state of the transit gateway multicast domain.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The time the transit gateway multicast domain was created.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the transit gateway multicast domain.
description: Describes the transit gateway multicast domain.
TransitAssociationGatewayId:
type: string
CreateTransitGatewayPeeringAttachmentRequestOptions:
type: object
properties:
DynamicRouting:
allOf:
- $ref: '#/components/schemas/DynamicRoutingValue'
- description: Indicates whether dynamic routing is enabled or disabled.
description: Describes whether dynamic routing is enabled or disabled for the transit gateway peering request.
CreateTransitGatewayPeeringAttachmentRequest:
type: object
required:
- TransitGatewayId
- PeerTransitGatewayId
- PeerAccountId
- PeerRegion
title: CreateTransitGatewayPeeringAttachmentRequest
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway.
PeerTransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitAssociationGatewayId'
- description: The ID of the peer transit gateway with which to create the peering attachment.
PeerAccountId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the Amazon Web Services account that owns the peer transit gateway.
PeerRegion:
allOf:
- $ref: '#/components/schemas/String'
- description: The Region where the peer transit gateway is located.
Options:
allOf:
- $ref: '#/components/schemas/CreateTransitGatewayPeeringAttachmentRequestOptions'
- description: Requests a transit gateway peering attachment.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the transit gateway peering attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateTransitGatewayPolicyTableRequest:
type: object
required:
- TransitGatewayId
title: CreateTransitGatewayPolicyTableRequest
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway used for the policy table.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- description: The tags specification for the transit gateway policy table created during the request.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPolicyTable:
type: object
properties:
TransitGatewayPolicyTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- xml:
name: transitGatewayPolicyTableId
description: The ID of the transit gateway policy table.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableState'
- xml:
name: state
description: The state of the transit gateway policy table
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The timestamp when the transit gateway policy table was created.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: he key-value pairs associated with the transit gateway policy table.
description: Describes a transit gateway policy table.
CreateTransitGatewayPrefixListReferenceRequest:
type: object
required:
- TransitGatewayRouteTableId
- PrefixListId
title: CreateTransitGatewayPrefixListReferenceRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list that is used for destination matches.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment to which traffic is routed.
Blackhole:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to drop traffic that matches this route.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPrefixListReference:
type: object
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- xml:
name: transitGatewayRouteTableId
description: The ID of the transit gateway route table.
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- xml:
name: prefixListId
description: The ID of the prefix list.
PrefixListOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: prefixListOwnerId
description: The ID of the prefix list owner.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayPrefixListReferenceState'
- xml:
name: state
description: The state of the prefix list reference.
Blackhole:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: blackhole
description: Indicates whether traffic that matches this route is dropped.
TransitGatewayAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayPrefixListAttachment'
- xml:
name: transitGatewayAttachment
description: Information about the transit gateway attachment.
description: Describes a prefix list reference.
TransitGatewayRequestOptions:
type: object
properties:
AmazonSideAsn:
allOf:
- $ref: '#/components/schemas/Long'
- description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is 64512.
AutoAcceptSharedAttachments:
allOf:
- $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue'
- description: Enable or disable automatic acceptance of attachment requests. Disabled by default.
DefaultRouteTableAssociation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTableAssociationValue'
- description: Enable or disable automatic association with the default association route table. Enabled by default.
DefaultRouteTablePropagation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTablePropagationValue'
- description: Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.
VpnEcmpSupport:
allOf:
- $ref: '#/components/schemas/VpnEcmpSupportValue'
- description: Enable or disable Equal Cost Multipath Protocol support. Enabled by default.
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- description: Enable or disable DNS support. Enabled by default.
MulticastSupport:
allOf:
- $ref: '#/components/schemas/MulticastSupportValue'
- description: Indicates whether multicast is enabled on the transit gateway
TransitGatewayCidrBlocks:
allOf:
- $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
- description: 'One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.'
description: Describes the options for a transit gateway.
CreateTransitGatewayRequest:
type: object
title: CreateTransitGatewayRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description of the transit gateway.
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayRequestOptions'
- description: The transit gateway options.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the transit gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGateway:
type: object
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
TransitGatewayArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayArn
description: The Amazon Resource Name (ARN) of the transit gateway.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayState'
- xml:
name: state
description: The state of the transit gateway.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the transit gateway.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the transit gateway.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The creation time.
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayOptions'
- xml:
name: options
description: The transit gateway options.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the transit gateway.
description: Describes a transit gateway.
CreateTransitGatewayRouteRequest:
type: object
required:
- DestinationCidrBlock
- TransitGatewayRouteTableId
title: CreateTransitGatewayRouteRequest
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR range used for destination matches. Routing decisions are based on the most specific match.
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
Blackhole:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to drop traffic that matches this route.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRoute:
type: object
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: The CIDR block used for destination matches.
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- xml:
name: prefixListId
description: The ID of the prefix list used for destination matches.
TransitGatewayRouteTableAnnouncementId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- xml:
name: transitGatewayRouteTableAnnouncementId
description: 'The ID of the transit gateway route table announcement. '
TransitGatewayAttachments:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteAttachmentList'
- xml:
name: transitGatewayAttachments
description: The attachments.
Type:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteType'
- xml:
name: type
description: The route type.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteState'
- xml:
name: state
description: The state of the route.
description: Describes a route for a transit gateway route table.
CreateTransitGatewayRouteTableAnnouncementRequest:
type: object
required:
- TransitGatewayRouteTableId
- PeeringAttachmentId
title: CreateTransitGatewayRouteTableAnnouncementRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
PeeringAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the peering attachment.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags specifications applied to the transit gateway route table announcement.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTableAnnouncement:
type: object
properties:
TransitGatewayRouteTableAnnouncementId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- xml:
name: transitGatewayRouteTableAnnouncementId
description: The ID of the transit gateway route table announcement.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
CoreNetworkId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: coreNetworkId
description: The ID of the core network for the transit gateway route table announcement.
PeerTransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- xml:
name: peerTransitGatewayId
description: The ID of the peer transit gateway.
PeerCoreNetworkId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: peerCoreNetworkId
description: The ID of the core network ID for the peer.
PeeringAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: peeringAttachmentId
description: The ID of the peering attachment.
AnnouncementDirection:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementDirection'
- xml:
name: announcementDirection
description: The direction for the route table announcement.
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- xml:
name: transitGatewayRouteTableId
description: The ID of the transit gateway route table.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementState'
- xml:
name: state
description: The state of the transit gateway announcement.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The timestamp when the transit gateway route table announcement was created.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The key-value pairs associated with the route table announcement.
description: Describes a transit gateway route table announcement.
CreateTransitGatewayRouteTableRequest:
type: object
required:
- TransitGatewayId
title: CreateTransitGatewayRouteTableRequest
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- description: The tags to apply to the transit gateway route table.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTable:
type: object
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayRouteTableId
description: The ID of the transit gateway route table.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableState'
- xml:
name: state
description: The state of the transit gateway route table.
DefaultAssociationRouteTable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: defaultAssociationRouteTable
description: Indicates whether this is the default association route table for the transit gateway.
DefaultPropagationRouteTable:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: defaultPropagationRouteTable
description: Indicates whether this is the default propagation route table for the transit gateway.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The creation time.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the route table.
description: Describes a transit gateway route table.
CreateTransitGatewayVpcAttachmentRequestOptions:
type: object
properties:
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- description: Enable or disable DNS support. The default is enable.
Ipv6Support:
allOf:
- $ref: '#/components/schemas/Ipv6SupportValue'
- description: Enable or disable IPv6 support. The default is disable.
ApplianceModeSupport:
allOf:
- $ref: '#/components/schemas/ApplianceModeSupportValue'
- description: '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.'
description: Describes the options for a VPC attachment.
CreateTransitGatewayVpcAttachmentRequest:
type: object
required:
- TransitGatewayId
- VpcId
- SubnetIds
title: CreateTransitGatewayVpcAttachmentRequest
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
SubnetIds:
allOf:
- $ref: '#/components/schemas/TransitGatewaySubnetIdList'
- description: '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:
allOf:
- $ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentRequestOptions'
- description: The VPC attachment options.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- description: The tags to apply to the VPC attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateVerifiedAccessEndpointEniOptions:
type: object
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the network interface.
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
description: Describes the network interface options when creating an Amazon Web Services Verified Access endpoint using the network-interface type.
CreateVerifiedAccessEndpointLoadBalancerOptions:
type: object
properties:
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
LoadBalancerArn:
allOf:
- $ref: '#/components/schemas/LoadBalancerArn'
- description: The ARN of the load balancer.
SubnetIds:
allOf:
- $ref: '#/components/schemas/CreateVerifiedAccessEndpointSubnetIdList'
- xml:
name: SubnetId
description: The IDs of the subnets.
description: Describes the load balancer options when creating an Amazon Web Services Verified Access endpoint using the load-balancer type.
VerifiedAccessEndpointType:
type: string
enum:
- load-balancer
- network-interface
VerifiedAccessEndpointAttachmentType:
type: string
enum:
- vpc
SecurityGroupIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
CreateVerifiedAccessEndpointRequest:
type: object
required:
- VerifiedAccessGroupId
- EndpointType
- AttachmentType
- DomainCertificateArn
- ApplicationDomain
- EndpointDomainPrefix
title: CreateVerifiedAccessEndpointRequest
properties:
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- description: The ID of the Verified Access group to associate the endpoint with.
EndpointType:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointType'
- description: The type of Verified Access endpoint to create.
AttachmentType:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointAttachmentType'
- description: The type of attachment.
DomainCertificateArn:
allOf:
- $ref: '#/components/schemas/CertificateArn'
- description: 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:
allOf:
- $ref: '#/components/schemas/String'
- description: The DNS name for users to reach your application.
EndpointDomainPrefix:
allOf:
- $ref: '#/components/schemas/String'
- description: A custom identifier that is prepended to the DNS name that is generated for the endpoint.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdList'
- xml:
name: SecurityGroupId
description: The IDs of the security groups to associate with the Verified Access endpoint.
LoadBalancerOptions:
allOf:
- $ref: '#/components/schemas/CreateVerifiedAccessEndpointLoadBalancerOptions'
- description: The load balancer details. This parameter is required if the endpoint type is load-balancer.
NetworkInterfaceOptions:
allOf:
- $ref: '#/components/schemas/CreateVerifiedAccessEndpointEniOptions'
- description: The network interface details. This parameter is required if the endpoint type is network-interface.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access endpoint.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- description: The Verified Access policy document.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the Verified Access endpoint.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessEndpoint:
type: object
properties:
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessInstanceId
description: The ID of the Amazon Web Services Verified Access instance.
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessGroupId
description: The ID of the Amazon Web Services Verified Access group.
VerifiedAccessEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessEndpointId
description: The ID of the Amazon Web Services Verified Access endpoint.
ApplicationDomain:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: applicationDomain
description: The DNS name for users to reach your application.
EndpointType:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointType'
- xml:
name: endpointType
description: 'The type of Amazon Web Services Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.'
AttachmentType:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointAttachmentType'
- xml:
name: attachmentType
description: The type of attachment used to provide connectivity between the Amazon Web Services Verified Access endpoint and the application.
DomainCertificateArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: domainCertificateArn
description: The ARN of a public TLS/SSL certificate imported into or created with ACM.
EndpointDomain:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: endpointDomain
description: A DNS name that is generated for the endpoint.
DeviceValidationDomain:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deviceValidationDomain
description: Returned if endpoint has a device trust provider attached.
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdList'
- xml:
name: securityGroupIdSet
description: The IDs of the security groups for the endpoint.
LoadBalancerOptions:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointLoadBalancerOptions'
- xml:
name: loadBalancerOptions
description: The load balancer details if creating the Amazon Web Services Verified Access endpoint as load-balancertype.
NetworkInterfaceOptions:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointEniOptions'
- xml:
name: networkInterfaceOptions
description: The options for network-interface type endpoint.
Status:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointStatus'
- xml:
name: status
description: The endpoint status.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description for the Amazon Web Services Verified Access endpoint.
CreationTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: creationTime
description: The creation time.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: lastUpdatedTime
description: The last updated time.
DeletionTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deletionTime
description: The deletion time.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags.
description: An Amazon Web Services Verified Access endpoint specifies the application that Amazon Web Services Verified Access provides access to. It must be attached to an Amazon Web Services Verified Access group. An Amazon Web Services Verified Access endpoint must also have an attached access policy before you attached it to a group.
CreateVerifiedAccessGroupRequest:
type: object
required:
- VerifiedAccessInstanceId
title: CreateVerifiedAccessGroupRequest
properties:
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- description: The ID of the Verified Access instance.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access group.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- description: The Verified Access policy document.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the Verified Access group.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessGroup:
type: object
properties:
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessGroupId
description: The ID of the Verified Access group.
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessInstanceId
description: The ID of the Amazon Web Services Verified Access instance.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description for the Amazon Web Services Verified Access group.
Owner:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: owner
description: The Amazon Web Services account number that owns the group.
VerifiedAccessGroupArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessGroupArn
description: The ARN of the Verified Access group.
CreationTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: creationTime
description: The creation time.
LastUpdatedTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: lastUpdatedTime
description: The last updated time.
DeletionTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deletionTime
description: The deletion time.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags.
description: Describes a Verified Access group.
CreateVerifiedAccessInstanceRequest:
type: object
title: CreateVerifiedAccessInstanceRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access instance.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the Verified Access instance.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
CreateVerifiedAccessTrustProviderDeviceOptions:
type: object
properties:
TenantId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the tenant application with the device-identity provider.
description: Describes the options when creating an Amazon Web Services Verified Access trust provider using the device type.
CreateVerifiedAccessTrustProviderOidcOptions:
type: object
properties:
Issuer:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC issuer.
AuthorizationEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC authorization endpoint.
TokenEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC token endpoint.
UserInfoEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC user info endpoint.
ClientId:
allOf:
- $ref: '#/components/schemas/String'
- description: The client identifier.
ClientSecret:
allOf:
- $ref: '#/components/schemas/ClientSecretType'
- description: The client secret.
Scope:
allOf:
- $ref: '#/components/schemas/String'
- description: 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.
description: Describes the options when creating an Amazon Web Services Verified Access trust provider using the user type.
TrustProviderType:
type: string
enum:
- user
- device
UserTrustProviderType:
type: string
enum:
- iam-identity-center
- oidc
DeviceTrustProviderType:
type: string
enum:
- jamf
- crowdstrike
CreateVerifiedAccessTrustProviderRequest:
type: object
required:
- TrustProviderType
- PolicyReferenceName
title: CreateVerifiedAccessTrustProviderRequest
properties:
TrustProviderType:
allOf:
- $ref: '#/components/schemas/TrustProviderType'
- description: The type of trust provider.
UserTrustProviderType:
allOf:
- $ref: '#/components/schemas/UserTrustProviderType'
- description: The type of user-based trust provider. This parameter is required when the provider type is user.
DeviceTrustProviderType:
allOf:
- $ref: '#/components/schemas/DeviceTrustProviderType'
- description: The type of device-based trust provider. This parameter is required when the provider type is device.
OidcOptions:
allOf:
- $ref: '#/components/schemas/CreateVerifiedAccessTrustProviderOidcOptions'
- description: The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is user.
DeviceOptions:
allOf:
- $ref: '#/components/schemas/CreateVerifiedAccessTrustProviderDeviceOptions'
- description: The options for a device-based trust provider. This parameter is required when the provider type is device.
PolicyReferenceName:
allOf:
- $ref: '#/components/schemas/String'
- description: The identifier to be used when working with policy rules.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access trust provider.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to assign to the Verified Access trust provider.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PermissionGroup:
type: string
enum:
- all
CreateVolumePermission:
type: object
properties:
Group:
allOf:
- $ref: '#/components/schemas/PermissionGroup'
- xml:
name: group
description: The group to be added or removed. The possible value is all.
UserId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: userId
description: The ID of the Amazon Web Services account to be added or removed.
description: Describes the user or group to be added or removed from the list of create volume permissions for a volume.
CreateVolumePermissionModifications:
type: object
properties:
Add:
allOf:
- $ref: '#/components/schemas/CreateVolumePermissionList'
- description: Adds the specified Amazon Web Services account ID or group to the list.
Remove:
allOf:
- $ref: '#/components/schemas/CreateVolumePermissionList'
- description: Removes the specified Amazon Web Services account ID or group from the list.
description: Describes modifications to the list of create volume permissions for a volume.
VolumeType:
type: string
enum:
- standard
- io1
- io2
- gp2
- sc1
- st1
- gp3
CreateVolumeRequest:
type: object
required:
- AvailabilityZone
title: CreateVolumeRequest
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneName'
- description: 'The ID of the Availability Zone in which to create the volume. For example, us-east-1a.'
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: encrypted
description: 'Indicates whether the volume should be encrypted. The effect of setting the encryption state to true depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see Encryption by default in the Amazon Elastic Compute Cloud User Guide.
Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see Supported instance types.
' Iops: allOf: - $ref: '#/components/schemas/Integer' - description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
io1 and io2 volumes support up to 64,000 IOPS only on Instances built on the Nitro System. Other instance families support performance up to 32,000 IOPS.
This parameter is required for io1 and io2 volumes. The default for gp3 volumes is 3,000 IOPS. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
' OutpostArn: allOf: - $ref: '#/components/schemas/String' - description: The Amazon Resource Name (ARN) of the Outpost. Size: allOf: - $ref: '#/components/schemas/Integer' - description: 'The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size. You can specify a volume size that is equal to or larger than the snapshot size.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
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 Elastic Compute Cloud User Guide.
Default: gp2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the volume during creation.
MultiAttachEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Instances built on the Nitro System in the same Availability Zone. This parameter is supported with io1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
Throughput:
allOf:
- $ref: '#/components/schemas/Integer'
- description: '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: allOf: - $ref: '#/components/schemas/String' - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency.' CreateVpcEndpointConnectionNotificationRequest: type: object required: - ConnectionNotificationArn - ConnectionEvents title: CreateVpcEndpointConnectionNotificationRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the endpoint service.
VpcEndpointId:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- description: The ID of the endpoint.
ConnectionNotificationArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the SNS topic for the notifications.
ConnectionEvents:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: 'The endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
VpcEndpointType:
type: string
enum:
- Interface
- Gateway
- GatewayLoadBalancer
VpcEndpointRouteTableIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: item
VpcEndpointSubnetIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
VpcEndpointSecurityGroupIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
IpAddressType:
type: string
enum:
- ipv4
- dualstack
- ipv6
DnsOptionsSpecification:
type: object
properties:
DnsRecordIpType:
allOf:
- $ref: '#/components/schemas/DnsRecordIpType'
- description: The DNS records created for the endpoint.
PrivateDnsOnlyForInboundResolverEndpoint:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.
description: Describes the DNS options for an endpoint.
CreateVpcEndpointRequest:
type: object
required:
- VpcId
- ServiceName
title: CreateVpcEndpointRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcEndpointType:
allOf:
- $ref: '#/components/schemas/VpcEndpointType'
- description: 'The type of endpoint.
Default: Gateway
' VpcId: allOf: - $ref: '#/components/schemas/VpcId' - description: The ID of the VPC. ServiceName: allOf: - $ref: '#/components/schemas/String' - description: The name of the endpoint service. PolicyDocument: allOf: - $ref: '#/components/schemas/String' - description: '(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: allOf: - $ref: '#/components/schemas/VpcEndpointRouteTableIdList' - xml: name: RouteTableId description: (Gateway endpoint) The route table IDs. SubnetIds: allOf: - $ref: '#/components/schemas/VpcEndpointSubnetIdList' - xml: name: SubnetId description: '(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create an endpoint network interface. For a Gateway Load Balancer endpoint, you can specify only one subnet.' SecurityGroupIds: allOf: - $ref: '#/components/schemas/VpcEndpointSecurityGroupIdList' - xml: name: SecurityGroupId description: '(Interface endpoint) The IDs of the security groups to associate with the endpoint network interface. If this parameter is not specified, we use the default security group for the VPC.' IpAddressType: allOf: - $ref: '#/components/schemas/IpAddressType' - description: The IP address type for the endpoint. DnsOptions: allOf: - $ref: '#/components/schemas/DnsOptionsSpecification' - description: The DNS options for the endpoint. ClientToken: allOf: - $ref: '#/components/schemas/String' - description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.' PrivateDnsEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: '(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
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
AcceptanceRequired:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually.
PrivateDnsName:
allOf:
- $ref: '#/components/schemas/String'
- description: (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service.
NetworkLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: NetworkLoadBalancerArn
description: The Amazon Resource Names (ARNs) of the Network Load Balancers.
GatewayLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: GatewayLoadBalancerArn
description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers.
SupportedIpAddressTypes:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: SupportedIpAddressType
description: The supported IP address types. The possible values are ipv4 and ipv6.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to associate with the service.
ServiceConfiguration:
type: object
properties:
ServiceType:
allOf:
- $ref: '#/components/schemas/ServiceTypeDetailSet'
- xml:
name: serviceType
description: The type of service.
ServiceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceId
description: The ID of the service.
ServiceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceName
description: The name of the service.
ServiceState:
allOf:
- $ref: '#/components/schemas/ServiceState'
- xml:
name: serviceState
description: The service state.
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: availabilityZoneSet
description: The Availability Zones in which the service is available.
AcceptanceRequired:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: acceptanceRequired
description: Indicates whether requests from other Amazon Web Services accounts to create an endpoint to the service must first be accepted.
ManagesVpcEndpoints:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: managesVpcEndpoints
description: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
NetworkLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: networkLoadBalancerArnSet
description: The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.
GatewayLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: gatewayLoadBalancerArnSet
description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.
SupportedIpAddressTypes:
allOf:
- $ref: '#/components/schemas/SupportedIpAddressTypes'
- xml:
name: supportedIpAddressTypeSet
description: The supported IP address types.
BaseEndpointDnsNames:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: baseEndpointDnsNameSet
description: The DNS names for the service.
PrivateDnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateDnsName
description: The private DNS name for the service.
PrivateDnsNameConfiguration:
allOf:
- $ref: '#/components/schemas/PrivateDnsNameConfiguration'
- xml:
name: privateDnsNameConfiguration
description: Information about the endpoint service private DNS name configuration.
PayerResponsibility:
allOf:
- $ref: '#/components/schemas/PayerResponsibility'
- xml:
name: payerResponsibility
description: The payer responsibility.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the service.
description: Describes a service configuration for a VPC endpoint service.
CreateVpcPeeringConnectionRequest:
type: object
required:
- VpcId
title: CreateVpcPeeringConnectionRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PeerOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: peerOwnerId
description: 'The Amazon Web Services account ID of the owner of the accepter VPC.
Default: Your Amazon Web Services account ID
' PeerVpcId: allOf: - $ref: '#/components/schemas/String' - xml: name: peerVpcId description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. VpcId: allOf: - $ref: '#/components/schemas/VpcId' - xml: name: vpcId description: The ID of the requester VPC. You must specify this parameter in the request. PeerRegion: allOf: - $ref: '#/components/schemas/String' - description: '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: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: The tags to assign to the peering connection. CreateVpcRequest: type: object title: CreateVpcRequest properties: CidrBlock: allOf: - $ref: '#/components/schemas/String' - description: '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.'
AmazonProvidedIpv6CidrBlock:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: amazonProvidedIpv6CidrBlock
description: '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.'
Ipv6Pool:
allOf:
- $ref: '#/components/schemas/Ipv6PoolEc2Id'
- description: The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
Ipv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: '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: allOf: - $ref: '#/components/schemas/IpamPoolId' - description: '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: allOf: - $ref: '#/components/schemas/NetmaskLength' - description: '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: allOf: - $ref: '#/components/schemas/IpamPoolId' - description: '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: allOf: - $ref: '#/components/schemas/NetmaskLength' - description: '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: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceTenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- xml:
name: instanceTenancy
description: '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.
Indicate whether to enable acceleration for the VPN connection.
Default: false
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify true. Use CreateVpnConnectionRoute to create a static route.
Default: false
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.
Default: ipv4
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
The type of IPv4 address assigned to the outside interface of the customer gateway device.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
The transit gateway attachment ID to use for the VPN tunnel.
Required if OutsideIpAddressType is set to PrivateIpv4.
ipsec.1).
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- description: 'The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.'
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: 'The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Options:
allOf:
- $ref: '#/components/schemas/VpnConnectionOptionsSpecification'
- xml:
name: options
description: The options for the VPN connection.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the VPN connection.
description: Contains the parameters for CreateVpnConnection.
VpnConnection:
type: object
properties:
CustomerGatewayConfiguration:
allOf:
- $ref: '#/components/schemas/customerGatewayConfiguration'
- xml:
name: customerGatewayConfiguration
description: 'The configuration information for the VPN connection''s customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it''s present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.'
CustomerGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: customerGatewayId
description: The ID of the customer gateway at your end of the VPN connection.
Category:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: category
description: The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.
State:
allOf:
- $ref: '#/components/schemas/VpnState'
- xml:
name: state
description: The current state of the VPN connection.
Type:
allOf:
- $ref: '#/components/schemas/GatewayType'
- xml:
name: type
description: The type of VPN connection.
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpnConnectionId
description: The ID of the VPN connection.
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpnGatewayId
description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayId
description: The ID of the transit gateway associated with the VPN connection.
CoreNetworkArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: coreNetworkArn
description: The ARN of the core network.
CoreNetworkAttachmentArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: coreNetworkAttachmentArn
description: The ARN of the core network attachment.
GatewayAssociationState:
allOf:
- $ref: '#/components/schemas/GatewayAssociationState'
- xml:
name: gatewayAssociationState
description: The current state of the gateway association.
Options:
allOf:
- $ref: '#/components/schemas/VpnConnectionOptions'
- xml:
name: options
description: The VPN connection options.
Routes:
allOf:
- $ref: '#/components/schemas/VpnStaticRouteList'
- xml:
name: routes
description: The static routes associated with the VPN connection.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the VPN connection.
VgwTelemetry:
allOf:
- $ref: '#/components/schemas/VgwTelemetryList'
- xml:
name: vgwTelemetry
description: Information about the VPN tunnel.
description: Describes a VPN connection.
CreateVpnConnectionRouteRequest:
type: object
required:
- DestinationCidrBlock
- VpnConnectionId
title: CreateVpnConnectionRouteRequest
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR block associated with the local subnet of the customer network.
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: The ID of the VPN connection.
description: Contains the parameters for CreateVpnConnectionRoute.
CreateVpnGatewayRequest:
type: object
required:
- Type
title: CreateVpnGatewayRequest
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The Availability Zone for the virtual private gateway.
Type:
allOf:
- $ref: '#/components/schemas/GatewayType'
- description: The type of VPN connection this virtual private gateway supports.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the virtual private gateway.
AmazonSideAsn:
allOf:
- $ref: '#/components/schemas/Long'
- description: '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: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for CreateVpnGateway.
VpnGateway:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: 'The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.'
State:
allOf:
- $ref: '#/components/schemas/VpnState'
- xml:
name: state
description: The current state of the virtual private gateway.
Type:
allOf:
- $ref: '#/components/schemas/GatewayType'
- xml:
name: type
description: The type of VPN connection the virtual private gateway supports.
VpcAttachments:
allOf:
- $ref: '#/components/schemas/VpcAttachmentList'
- xml:
name: attachments
description: Any VPCs attached to the virtual private gateway.
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpnGatewayId
description: The ID of the virtual private gateway.
AmazonSideAsn:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: amazonSideAsn
description: The private Autonomous System Number (ASN) for the Amazon side of a BGP session.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the virtual private gateway.
description: Describes a virtual private gateway.
CreditSpecification:
type: object
properties:
CpuCredits:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cpuCredits
description: 'The credit option for CPU usage of a T instance.
Valid values: standard | unlimited
DataQuery.
Source:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: source
description: 'The Region or Availability Zone that''s the source for the data query. For example, us-east-1.'
Destination:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destination
description: 'The Region or Availability Zone that''s the destination for the data query. For example, eu-west-1.'
Metric:
allOf:
- $ref: '#/components/schemas/MetricType'
- xml:
name: metric
description: 'The metric used for the network performance request. Only aggregate-latency is supported, which shows network latency during a specified period. '
Statistic:
allOf:
- $ref: '#/components/schemas/StatisticType'
- xml:
name: statistic
description: The statistic used for the network performance request.
Period:
allOf:
- $ref: '#/components/schemas/PeriodType'
- xml:
name: period
description: The period used for the network performance request.
MetricPoints:
allOf:
- $ref: '#/components/schemas/MetricPoints'
- xml:
name: metricPointSet
description: A list of MetricPoint objects.
description: The response to a DataQuery.
DataResponses:
type: array
items:
allOf:
- $ref: '#/components/schemas/DataResponse'
- xml:
name: item
DatafeedSubscriptionState:
type: string
enum:
- Active
- Inactive
DedicatedHostFlag:
type: boolean
DefaultNetworkCardIndex:
type: integer
DeleteCarrierGatewayRequest:
type: object
required:
- CarrierGatewayId
title: DeleteCarrierGatewayRequest
properties:
CarrierGatewayId:
allOf:
- $ref: '#/components/schemas/CarrierGatewayId'
- description: The ID of the carrier gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteClientVpnEndpointRequest:
type: object
required:
- ClientVpnEndpointId
title: DeleteClientVpnEndpointRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN to be deleted.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteClientVpnRouteRequest:
type: object
required:
- ClientVpnEndpointId
- DestinationCidrBlock
title: DeleteClientVpnRouteRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint from which the route is to be deleted.
TargetVpcSubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of the target subnet used by the route.
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 address range, in CIDR notation, of the route to be deleted.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteCoipCidrRequest:
type: object
required:
- Cidr
- CoipPoolId
title: DeleteCoipCidrRequest
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: ' A customer-owned IP address range that you want to delete. '
CoipPoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolCoipId'
- description: ' The ID of the customer-owned address pool. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteCoipPoolRequest:
type: object
required:
- CoipPoolId
title: DeleteCoipPoolRequest
properties:
CoipPoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolCoipId'
- description: 'The ID of the CoIP pool that you want to delete. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteCustomerGatewayRequest:
type: object
required:
- CustomerGatewayId
title: DeleteCustomerGatewayRequest
properties:
CustomerGatewayId:
allOf:
- $ref: '#/components/schemas/CustomerGatewayId'
- description: The ID of the customer gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DeleteCustomerGateway.
DeleteDhcpOptionsRequest:
type: object
required:
- DhcpOptionsId
title: DeleteDhcpOptionsRequest
properties:
DhcpOptionsId:
allOf:
- $ref: '#/components/schemas/DhcpOptionsId'
- description: The ID of the DHCP options set.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteEgressOnlyInternetGatewayRequest:
type: object
required:
- EgressOnlyInternetGatewayId
title: DeleteEgressOnlyInternetGatewayRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EgressOnlyInternetGatewayId:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- description: The ID of the egress-only internet gateway.
DeleteFleetErrorCode:
type: string
enum:
- fleetIdDoesNotExist
- fleetIdMalformed
- fleetNotInDeletableState
- unexpectedError
DeleteFleetError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/DeleteFleetErrorCode'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The description for the error code.
description: Describes an EC2 Fleet error.
DeleteFleetErrorItem:
type: object
properties:
Error:
allOf:
- $ref: '#/components/schemas/DeleteFleetError'
- xml:
name: error
description: The error.
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- xml:
name: fleetId
description: The ID of the EC2 Fleet.
description: Describes an EC2 Fleet that was not successfully deleted.
DeleteFleetErrorSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DeleteFleetErrorItem'
- xml:
name: item
FleetStateCode:
type: string
enum:
- submitted
- active
- deleted
- failed
- deleted_running
- deleted_terminating
- modifying
DeleteFleetSuccessItem:
type: object
properties:
CurrentFleetState:
allOf:
- $ref: '#/components/schemas/FleetStateCode'
- xml:
name: currentFleetState
description: The current state of the EC2 Fleet.
PreviousFleetState:
allOf:
- $ref: '#/components/schemas/FleetStateCode'
- xml:
name: previousFleetState
description: The previous state of the EC2 Fleet.
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- xml:
name: fleetId
description: The ID of the EC2 Fleet.
description: Describes an EC2 Fleet that was successfully deleted.
DeleteFleetSuccessSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DeleteFleetSuccessItem'
- xml:
name: item
FleetIdSet:
type: array
items:
$ref: '#/components/schemas/FleetId'
DeleteFleetsRequest:
type: object
required:
- FleetIds
- TerminateInstances
title: DeleteFleetsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FleetIds:
allOf:
- $ref: '#/components/schemas/FleetIdSet'
- xml:
name: FleetId
description: The IDs of the EC2 Fleets.
TerminateInstances:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FlowLogIds:
allOf:
- $ref: '#/components/schemas/FlowLogIdList'
- xml:
name: FlowLogId
description: 'One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' DeleteFpgaImageRequest: type: object required: - FpgaImageId title: DeleteFpgaImageRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
FpgaImageId:
allOf:
- $ref: '#/components/schemas/FpgaImageId'
- description: The ID of the AFI.
InstanceConnectEndpointId:
type: string
DeleteInstanceConnectEndpointRequest:
type: object
required:
- InstanceConnectEndpointId
title: DeleteInstanceConnectEndpointRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceConnectEndpointId:
allOf:
- $ref: '#/components/schemas/InstanceConnectEndpointId'
- description: The ID of the EC2 Instance Connect Endpoint to delete.
DeleteInstanceEventWindowRequest:
type: object
required:
- InstanceEventWindowId
title: DeleteInstanceEventWindowRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ForceDelete:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Specify true to force delete the event window. Use the force delete parameter if the event window is currently associated with targets.
InstanceEventWindowId:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- description: The ID of the event window.
InstanceEventWindowStateChange:
type: object
properties:
InstanceEventWindowId:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- xml:
name: instanceEventWindowId
description: The ID of the event window.
State:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowState'
- xml:
name: state
description: The current state of the event window.
description: The state of the event window.
DeleteInternetGatewayRequest:
type: object
required:
- InternetGatewayId
title: DeleteInternetGatewayRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InternetGatewayId:
allOf:
- $ref: '#/components/schemas/InternetGatewayId'
- xml:
name: internetGatewayId
description: The ID of the internet gateway.
DeleteIpamPoolRequest:
type: object
required:
- IpamPoolId
title: DeleteIpamPoolRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the pool to delete.
DeleteIpamRequest:
type: object
required:
- IpamId
title: DeleteIpamRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamId:
allOf:
- $ref: '#/components/schemas/IpamId'
- description: The ID of the IPAM to delete.
Cascade:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
IpamResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- description: The IPAM resource discovery ID.
DeleteIpamScopeRequest:
type: object
required:
- IpamScopeId
title: DeleteIpamScopeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- description: The ID of the scope to delete.
DeleteKeyPairRequest:
type: object
title: DeleteKeyPairRequest
properties:
KeyName:
allOf:
- $ref: '#/components/schemas/KeyPairName'
- description: The name of the key pair.
KeyPairId:
allOf:
- $ref: '#/components/schemas/KeyPairId'
- description: The ID of the key pair.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteLaunchTemplateRequest:
type: object
title: DeleteLaunchTemplateRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: ' Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request. '
DeleteLocalGatewayRouteTableRequest:
type: object
required:
- LocalGatewayRouteTableId
title: DeleteLocalGatewayRouteTableRequest
properties:
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- description: ' The ID of the local gateway route table. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest:
type: object
required:
- LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
title: DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociationRequest
properties:
LocalGatewayRouteTableVirtualInterfaceGroupAssociationId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
- description: ' The ID of the local gateway route table virtual interface group association. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteLocalGatewayRouteTableVpcAssociationRequest:
type: object
required:
- LocalGatewayRouteTableVpcAssociationId
title: DeleteLocalGatewayRouteTableVpcAssociationRequest
properties:
LocalGatewayRouteTableVpcAssociationId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
- description: The ID of the association.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteManagedPrefixListRequest:
type: object
required:
- PrefixListId
title: DeleteManagedPrefixListRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list.
DeleteNatGatewayRequest:
type: object
required:
- NatGatewayId
title: DeleteNatGatewayRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- description: The ID of the NAT gateway.
DeleteNetworkAclEntryRequest:
type: object
required:
- Egress
- NetworkAclId
- RuleNumber
title: DeleteNetworkAclEntryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Egress:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: egress
description: Indicates whether the rule is an egress rule.
NetworkAclId:
allOf:
- $ref: '#/components/schemas/NetworkAclId'
- xml:
name: networkAclId
description: The ID of the network ACL.
RuleNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ruleNumber
description: The rule number of the entry to delete.
DeleteNetworkAclRequest:
type: object
required:
- NetworkAclId
title: DeleteNetworkAclRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkAclId:
allOf:
- $ref: '#/components/schemas/NetworkAclId'
- xml:
name: networkAclId
description: The ID of the network ACL.
DeleteNetworkInsightsAccessScopeAnalysisRequest:
type: object
required:
- NetworkInsightsAccessScopeAnalysisId
title: DeleteNetworkInsightsAccessScopeAnalysisRequest
properties:
NetworkInsightsAccessScopeAnalysisId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- description: The ID of the Network Access Scope analysis.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteNetworkInsightsAccessScopeRequest:
type: object
required:
- NetworkInsightsAccessScopeId
title: DeleteNetworkInsightsAccessScopeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInsightsAccessScopeId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- description: The ID of the Network Access Scope.
DeleteNetworkInsightsAnalysisRequest:
type: object
required:
- NetworkInsightsAnalysisId
title: DeleteNetworkInsightsAnalysisRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInsightsAnalysisId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- description: The ID of the network insights analysis.
DeleteNetworkInsightsPathRequest:
type: object
required:
- NetworkInsightsPathId
title: DeleteNetworkInsightsPathRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInsightsPathId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathId'
- description: The ID of the path.
DeleteNetworkInterfacePermissionRequest:
type: object
required:
- NetworkInterfacePermissionId
title: DeleteNetworkInterfacePermissionRequest
properties:
NetworkInterfacePermissionId:
allOf:
- $ref: '#/components/schemas/NetworkInterfacePermissionId'
- description: The ID of the network interface permission.
Force:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Specify true to remove the permission even if the network interface is attached to an instance.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DeleteNetworkInterfacePermission.
DeleteNetworkInterfaceRequest:
type: object
required:
- NetworkInterfaceId
title: DeleteNetworkInterfaceRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
description: Contains the parameters for DeleteNetworkInterface.
DeletePlacementGroupRequest:
type: object
required:
- GroupName
title: DeletePlacementGroupRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupName:
allOf:
- $ref: '#/components/schemas/PlacementGroupName'
- xml:
name: groupName
description: The name of the placement group.
DeletePublicIpv4PoolRequest:
type: object
required:
- PoolId
title: DeletePublicIpv4PoolRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- description: The ID of the public IPv4 pool you want to delete.
DeleteQueuedReservedInstancesErrorCode:
type: string
enum:
- reserved-instances-id-invalid
- reserved-instances-not-in-queued-state
- unexpected-error
DeleteQueuedReservedInstancesError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/DeleteQueuedReservedInstancesErrorCode'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The error message.
description: Describes the error for a Reserved Instance whose queued purchase could not be deleted.
DeleteQueuedReservedInstancesIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservationId'
- xml:
name: item
minItems: 1
maxItems: 100
DeleteQueuedReservedInstancesRequest:
type: object
required:
- ReservedInstancesIds
title: DeleteQueuedReservedInstancesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReservedInstancesIds:
allOf:
- $ref: '#/components/schemas/DeleteQueuedReservedInstancesIdList'
- xml:
name: ReservedInstancesId
description: The IDs of the Reserved Instances.
SuccessfulQueuedPurchaseDeletionSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SuccessfulQueuedPurchaseDeletion'
- xml:
name: item
FailedQueuedPurchaseDeletionSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/FailedQueuedPurchaseDeletion'
- xml:
name: item
DeleteRouteRequest:
type: object
required:
- RouteTableId
title: DeleteRouteRequest
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
DestinationIpv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationIpv6CidrBlock
description: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list for the route.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RouteTableId:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: routeTableId
description: The ID of the route table.
DeleteRouteTableRequest:
type: object
required:
- RouteTableId
title: DeleteRouteTableRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RouteTableId:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: routeTableId
description: The ID of the route table.
DeleteSecurityGroupRequest:
type: object
title: DeleteSecurityGroupRequest
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- description: The ID of the security group.
GroupName:
allOf:
- $ref: '#/components/schemas/SecurityGroupName'
- description: '[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:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteSnapshotRequest:
type: object
required:
- SnapshotId
title: DeleteSnapshotRequest
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: The ID of the EBS snapshot.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteSpotDatafeedSubscriptionRequest:
type: object
title: DeleteSpotDatafeedSubscriptionRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DeleteSpotDatafeedSubscription.
SubnetCidrReservationId:
type: string
DeleteSubnetCidrReservationRequest:
type: object
required:
- SubnetCidrReservationId
title: DeleteSubnetCidrReservationRequest
properties:
SubnetCidrReservationId:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservationId'
- description: The ID of the subnet CIDR reservation.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteSubnetRequest:
type: object
required:
- SubnetId
title: DeleteSubnetRequest
properties:
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of the subnet.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTagsRequest:
type: object
required:
- Resources
title: DeleteTagsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Resources:
allOf:
- $ref: '#/components/schemas/ResourceIdList'
- xml:
name: resourceId
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tag description: '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.
' DeleteTrafficMirrorFilterRequest: type: object required: - TrafficMirrorFilterId title: DeleteTrafficMirrorFilterRequest properties: TrafficMirrorFilterId: allOf: - $ref: '#/components/schemas/TrafficMirrorFilterId' - description: The ID of the Traffic Mirror filter. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
TrafficMirrorFilterRuleIdWithResolver:
type: string
DeleteTrafficMirrorFilterRuleRequest:
type: object
required:
- TrafficMirrorFilterRuleId
title: DeleteTrafficMirrorFilterRuleRequest
properties:
TrafficMirrorFilterRuleId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterRuleIdWithResolver'
- description: The ID of the Traffic Mirror rule.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTrafficMirrorSessionRequest:
type: object
required:
- TrafficMirrorSessionId
title: DeleteTrafficMirrorSessionRequest
properties:
TrafficMirrorSessionId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSessionId'
- description: The ID of the Traffic Mirror session.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTrafficMirrorTargetRequest:
type: object
required:
- TrafficMirrorTargetId
title: DeleteTrafficMirrorTargetRequest
properties:
TrafficMirrorTargetId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetId'
- description: The ID of the Traffic Mirror target.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayConnectPeerRequest:
type: object
required:
- TransitGatewayConnectPeerId
title: DeleteTransitGatewayConnectPeerRequest
properties:
TransitGatewayConnectPeerId:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerId'
- description: The ID of the Connect peer.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayConnectRequest:
type: object
required:
- TransitGatewayAttachmentId
title: DeleteTransitGatewayConnectRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the Connect attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayMulticastDomainRequest:
type: object
required:
- TransitGatewayMulticastDomainId
title: DeleteTransitGatewayMulticastDomainRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayPeeringAttachmentRequest:
type: object
required:
- TransitGatewayAttachmentId
title: DeleteTransitGatewayPeeringAttachmentRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway peering attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayPolicyTableRequest:
type: object
required:
- TransitGatewayPolicyTableId
title: DeleteTransitGatewayPolicyTableRequest
properties:
TransitGatewayPolicyTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- description: The transit gateway policy table to delete.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayPrefixListReferenceRequest:
type: object
required:
- TransitGatewayRouteTableId
- PrefixListId
title: DeleteTransitGatewayPrefixListReferenceRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the route table.
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayRequest:
type: object
required:
- TransitGatewayId
title: DeleteTransitGatewayRequest
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayRouteRequest:
type: object
required:
- TransitGatewayRouteTableId
- DestinationCidrBlock
title: DeleteTransitGatewayRouteRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR range for the route. This must match the CIDR for the route exactly.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayRouteTableAnnouncementRequest:
type: object
required:
- TransitGatewayRouteTableAnnouncementId
title: DeleteTransitGatewayRouteTableAnnouncementRequest
properties:
TransitGatewayRouteTableAnnouncementId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- description: 'The transit gateway route table ID that''s being deleted. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayRouteTableRequest:
type: object
required:
- TransitGatewayRouteTableId
title: DeleteTransitGatewayRouteTableRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteTransitGatewayVpcAttachmentRequest:
type: object
required:
- TransitGatewayAttachmentId
title: DeleteTransitGatewayVpcAttachmentRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteVerifiedAccessEndpointRequest:
type: object
required:
- VerifiedAccessEndpointId
title: DeleteVerifiedAccessEndpointRequest
properties:
VerifiedAccessEndpointId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointId'
- description: The ID of the Verified Access endpoint.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteVerifiedAccessGroupRequest:
type: object
required:
- VerifiedAccessGroupId
title: DeleteVerifiedAccessGroupRequest
properties:
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- description: The ID of the Verified Access group.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteVerifiedAccessInstanceRequest:
type: object
required:
- VerifiedAccessInstanceId
title: DeleteVerifiedAccessInstanceRequest
properties:
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- description: The ID of the Verified Access instance.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DeleteVerifiedAccessTrustProviderRequest:
type: object
required:
- VerifiedAccessTrustProviderId
title: DeleteVerifiedAccessTrustProviderRequest
properties:
VerifiedAccessTrustProviderId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderId'
- description: The ID of the Verified Access trust provider.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DeleteVolumeRequest:
type: object
required:
- VolumeId
title: DeleteVolumeRequest
properties:
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeId'
- description: The ID of the volume.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteVpcEndpointConnectionNotificationsRequest:
type: object
required:
- ConnectionNotificationIds
title: DeleteVpcEndpointConnectionNotificationsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ConnectionNotificationIds:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationIdsList'
- xml:
name: ConnectionNotificationId
description: The IDs of the notifications.
VpcEndpointServiceIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- xml:
name: item
DeleteVpcEndpointServiceConfigurationsRequest:
type: object
required:
- ServiceIds
title: DeleteVpcEndpointServiceConfigurationsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceIdList'
- xml:
name: ServiceId
description: The IDs of the services.
DeleteVpcEndpointsRequest:
type: object
required:
- VpcEndpointIds
title: DeleteVpcEndpointsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcEndpointIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointIdList'
- xml:
name: VpcEndpointId
description: The IDs of the VPC endpoints.
DeleteVpcPeeringConnectionRequest:
type: object
required:
- VpcPeeringConnectionId
title: DeleteVpcPeeringConnectionRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionId'
- xml:
name: vpcPeeringConnectionId
description: The ID of the VPC peering connection.
DeleteVpcRequest:
type: object
required:
- VpcId
title: DeleteVpcRequest
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeleteVpnConnectionRequest:
type: object
required:
- VpnConnectionId
title: DeleteVpnConnectionRequest
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: The ID of the VPN connection.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DeleteVpnConnection.
DeleteVpnConnectionRouteRequest:
type: object
required:
- DestinationCidrBlock
- VpnConnectionId
title: DeleteVpnConnectionRouteRequest
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR block associated with the local subnet of the customer network.
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: The ID of the VPN connection.
description: Contains the parameters for DeleteVpnConnectionRoute.
DeleteVpnGatewayRequest:
type: object
required:
- VpnGatewayId
title: DeleteVpnGatewayRequest
properties:
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- description: The ID of the virtual private gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DeleteVpnGateway.
DeprovisionByoipCidrRequest:
type: object
required:
- Cidr
title: DeprovisionByoipCidrRequest
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DeprovisionIpamPoolCidrRequest:
type: object
required:
- IpamPoolId
title: DeprovisionIpamPoolCidrRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the pool that has the CIDR you want to deprovision.
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR which you want to deprovision from the pool.
IpamPoolCidr:
type: object
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidr
description: 'The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.'
State:
allOf:
- $ref: '#/components/schemas/IpamPoolCidrState'
- xml:
name: state
description: The state of the CIDR.
FailureReason:
allOf:
- $ref: '#/components/schemas/IpamPoolCidrFailureReason'
- xml:
name: failureReason
description: Details related to why an IPAM pool CIDR failed to be provisioned.
IpamPoolCidrId:
allOf:
- $ref: '#/components/schemas/IpamPoolCidrId'
- xml:
name: ipamPoolCidrId
description: The IPAM pool CIDR ID.
NetmaskLength:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: netmaskLength
description: The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. "NetmaskLength" or "Cidr" is required.
description: A CIDR provisioned to an IPAM pool.
DeprovisionPublicIpv4PoolCidrRequest:
type: object
required:
- PoolId
- Cidr
title: DeprovisionPublicIpv4PoolCidrRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- description: The ID of the pool that you want to deprovision the CIDR from.
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The CIDR you want to deprovision from the pool. Enter the CIDR you want to deprovision with a netmask of /32. You must rerun this command for each IP address in the CIDR range. If your CIDR is a /24, you will have to run this command to deprovision each of the 256 IP addresses in the /24 CIDR.'
DeprovisionedAddressSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
DeregisterImageRequest:
type: object
required:
- ImageId
title: DeregisterImageRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DeregisterImage.
DeregisterInstanceTagAttributeRequest:
type: object
properties:
IncludeAllTagsOfInstance:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to deregister all tag keys in the current Region. Specify false to deregister all tag keys.
InstanceTagKeys:
allOf:
- $ref: '#/components/schemas/InstanceTagKeySet'
- xml:
name: InstanceTagKey
description: Information about the tag keys to deregister.
description: Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
DeregisterInstanceEventNotificationAttributesRequest:
type: object
required:
- InstanceTagAttribute
title: DeregisterInstanceEventNotificationAttributesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceTagAttribute:
allOf:
- $ref: '#/components/schemas/DeregisterInstanceTagAttributeRequest'
- description: Information about the tag keys to deregister.
InstanceTagNotificationAttribute:
type: object
properties:
InstanceTagKeys:
allOf:
- $ref: '#/components/schemas/InstanceTagKeySet'
- xml:
name: instanceTagKeySet
description: The registered tag keys.
IncludeAllTagsOfInstance:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: includeAllTagsOfInstance
description: Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. true indicates that all tag keys in the current Region are registered.
description: Describes the registered tag keys for the current Region.
TransitGatewayNetworkInterfaceIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: item
DeregisterTransitGatewayMulticastGroupMembersRequest:
type: object
title: DeregisterTransitGatewayMulticastGroupMembersRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayNetworkInterfaceIdList'
- description: The IDs of the group members' network interfaces.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastDeregisteredGroupMembers:
type: object
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayMulticastDomainId
description: The ID of the transit gateway multicast domain.
DeregisteredNetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: deregisteredNetworkInterfaceIds
description: The network interface IDs of the deregistered members.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupIpAddress
description: The IP address assigned to the transit gateway multicast group.
description: Describes the deregistered transit gateway multicast group members.
DeregisterTransitGatewayMulticastGroupSourcesRequest:
type: object
title: DeregisterTransitGatewayMulticastGroupSourcesRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayNetworkInterfaceIdList'
- description: The IDs of the group sources' network interfaces.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastDeregisteredGroupSources:
type: object
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayMulticastDomainId
description: The ID of the transit gateway multicast domain.
DeregisteredNetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: deregisteredNetworkInterfaceIds
description: The network interface IDs of the non-registered members.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupIpAddress
description: The IP address assigned to the transit gateway multicast group.
description: Describes the deregistered transit gateway multicast group sources.
DescribeAccountAttributesRequest:
type: object
title: DescribeAccountAttributesRequest
properties:
AttributeNames:
allOf:
- $ref: '#/components/schemas/AccountAttributeNameStringList'
- xml:
name: attributeName
description: The account attribute names.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeAddressTransfersMaxResults:
type: integer
minimum: 5
maximum: 1000
DescribeAddressTransfersRequest:
type: object
title: DescribeAddressTransfersRequest
properties:
AllocationIds:
allOf:
- $ref: '#/components/schemas/AllocationIdList'
- xml:
name: AllocationId
description: The allocation IDs of Elastic IP addresses.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeAddressTransfersMaxResults'
- description: The maximum number of address transfers to return in one page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
type: string
DescribeAddressesAttributeRequest:
type: object
title: DescribeAddressesAttributeRequest
properties:
AllocationIds:
allOf:
- $ref: '#/components/schemas/AllocationIds'
- xml:
name: AllocationId
description: '[EC2-VPC] The allocation IDs.'
Attribute:
allOf:
- $ref: '#/components/schemas/AddressAttributeName'
- description: The attribute of the IP address.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/AddressMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FilterList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Filter'
- xml:
name: Filter
PublicIpStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: PublicIp
DescribeAddressesRequest:
type: object
title: DescribeAddressesRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. Filter names and values are case-sensitive.
allocation-id - The allocation ID for the address.
association-id - The association ID for the address.
instance-id - The ID of the instance the address is associated with, if any.
network-border-group - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where Amazon Web Services advertises IP addresses.
network-interface-id - The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The Amazon Web Services account ID of the owner.
private-ip-address - The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address, or the carrier IP address.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more Elastic IP addresses.
Default: Describes all your Elastic IP addresses.
' AllocationIds: allOf: - $ref: '#/components/schemas/AllocationIdList' - xml: name: AllocationId description: Information about the allocation IDs. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeAggregateIdFormatRequest:
type: object
title: DescribeAggregateIdFormatRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
IdFormatList:
type: array
items:
allOf:
- $ref: '#/components/schemas/IdFormat'
- xml:
name: item
ZoneNameStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ZoneName
ZoneIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ZoneId
DescribeAvailabilityZonesRequest:
type: object
title: DescribeAvailabilityZonesRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
group-name - For Availability Zones, use the Region name. For Local Zones, use the name of the group associated with the Local Zone (for example, us-west-2-lax-1) For Wavelength Zones, use the name of the group associated with the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
message - The Zone message.
opt-in-status - The opt-in status (opted-in | not-opted-in | opt-in-not-required).
parent-zoneID - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
parent-zoneName - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls.
region-name - The name of the Region for the Zone (for example, us-east-1).
state - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (available).
zone-id - The ID of the Availability Zone (for example, use1-az1), the Local Zone (for example, usw2-lax1-az1), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-name - The name of the Availability Zone (for example, us-east-1a), the Local Zone (for example, us-west-2-lax-1a), or the Wavelength Zone (for example, us-east-1-wl1-bos-wlz-1).
zone-type - The type of zone (availability-zone | local-zone | wavelength-zone).
Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status.
If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResultsParam:
type: integer
minimum: 0
maximum: 100
DescribeAwsNetworkPerformanceMetricSubscriptionsRequest:
type: object
title: DescribeAwsNetworkPerformanceMetricSubscriptionsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResultsParam'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SubscriptionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Subscription'
- xml:
name: item
DescribeBundleTasksRequest:
type: object
title: DescribeBundleTasksRequest
properties:
BundleIds:
allOf:
- $ref: '#/components/schemas/BundleIdStringList'
- xml:
name: BundleId
description: 'The bundle task IDs.
Default: Describes all your bundle tasks.
' Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: 'The filters.
bundle-id - The ID of the bundle task.
error-code - If the task failed, the error code returned.
error-message - If the task failed, the error message returned.
instance-id - The ID of the instance.
progress - The level of task completion, as a percentage (for example, 20%).
s3-bucket - The Amazon S3 bucket to store the AMI.
s3-prefix - The beginning of the AMI name.
start-time - The time the task started (for example, 2013-09-15T17:15:20.000Z).
state - The state of the task (pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed).
update-time - The time of the most recent update for the task.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeByoipCidrsMaxResults:
type: integer
minimum: 1
maximum: 100
DescribeByoipCidrsRequest:
type: object
required:
- MaxResults
title: DescribeByoipCidrsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeByoipCidrsMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
DescribeCapacityReservationFleetsMaxResults:
type: integer
minimum: 1
maximum: 100
DescribeCapacityReservationFleetsRequest:
type: object
title: DescribeCapacityReservationFleetsRequest
properties:
CapacityReservationFleetIds:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetIdSet'
- xml:
name: CapacityReservationFleetId
description: The IDs of the Capacity Reservation Fleets to describe.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to use to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeCapacityReservationFleetsMaxResults'
- description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
state - The state of the Fleet (submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed).
instance-match-criteria - The instance matching criteria for the Fleet. Only open is supported.
tenancy - The tenancy of the Fleet (default | dedicated).
allocation-strategy - The allocation strategy used by the Fleet. Only prioritized is supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeCapacityReservationsMaxResults:
type: integer
minimum: 1
maximum: 1000
DescribeCapacityReservationsRequest:
type: object
title: DescribeCapacityReservationsRequest
properties:
CapacityReservationIds:
allOf:
- $ref: '#/components/schemas/CapacityReservationIdSet'
- xml:
name: CapacityReservationId
description: The ID of the Capacity Reservation.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to use to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeCapacityReservationsMaxResults'
- description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
instance-type - The type of instance for which the Capacity Reservation reserves capacity.
owner-id - The ID of the Amazon Web Services account that owns the Capacity Reservation.
instance-platform - The type of operating system for which the Capacity Reservation reserves capacity.
availability-zone - The Availability Zone of the Capacity Reservation.
tenancy - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other Amazon Web Services accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single Amazon Web Services account.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.
state - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states:
active- The Capacity Reservation is active and the capacity is available for your use.
expired - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use.
cancelled - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use.
pending - The Capacity Reservation request was successful but the capacity provisioning is still pending.
failed - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes.
start-date - The date and time at which the Capacity Reservation was started.
end-date - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
end-date-type - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it.
limited - The Capacity Reservation expires automatically at a specified date and time.
instance-match-criteria - Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
placement-group-arn - The ARN of the cluster placement group in which the Capacity Reservation was created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeCarrierGatewaysRequest:
type: object
title: DescribeCarrierGatewaysRequest
properties:
CarrierGatewayIds:
allOf:
- $ref: '#/components/schemas/CarrierGatewayIdSet'
- xml:
name: CarrierGatewayId
description: One or more carrier gateway IDs.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
carrier-gateway-id - The ID of the carrier gateway.
state - The state of the carrier gateway (pending | failed | available | deleting | deleted).
owner-id - The Amazon Web Services account ID of the owner of the carrier gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC associated with the carrier gateway.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeClassicLinkInstancesMaxResults:
type: integer
minimum: 5
maximum: 1000
InstanceIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: InstanceId
DescribeClassicLinkInstancesRequest:
type: object
title: DescribeClassicLinkInstancesRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
group-id - The ID of a VPC security group that''s associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdStringList'
- xml:
name: InstanceId
description: The instance IDs. Must be instances linked to a VPC through ClassicLink.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeClassicLinkInstancesMaxResults'
- xml:
name: maxResults
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
Constraint: If the value is greater than 1000, we return only 1000 items.
' NextToken: allOf: - $ref: '#/components/schemas/String' - xml: name: nextToken description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. DescribeClientVpnAuthorizationRulesMaxResults: type: integer minimum: 5 maximum: 1000 DescribeClientVpnAuthorizationRulesRequest: type: object required: - ClientVpnEndpointId title: DescribeClientVpnAuthorizationRulesRequest properties: ClientVpnEndpointId: allOf: - $ref: '#/components/schemas/ClientVpnEndpointId' - description: The ID of the Client VPN endpoint. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to retrieve the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
description - The description of the authorization rule.
destination-cidr - The CIDR of the network to which the authorization rule applies.
group-id - The ID of the Active Directory group to which the authorization rule grants access.
One or more filters. Filter names and values are case-sensitive.
connection-id - The ID of the connection.
username - For Active Directory client authentication, the user name of the client who established the client connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeClientVpnEndpointMaxResults:
type: integer
minimum: 5
maximum: 1000
DescribeClientVpnEndpointsRequest:
type: object
title: DescribeClientVpnEndpointsRequest
properties:
ClientVpnEndpointIds:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointIdList'
- xml:
name: ClientVpnEndpointId
description: The ID of the Client VPN endpoint.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeClientVpnEndpointMaxResults'
- description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to retrieve the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
endpoint-id - The ID of the Client VPN endpoint.
transport-protocol - The transport protocol (tcp | udp).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EndpointSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpoint'
- xml:
name: item
DescribeClientVpnRoutesMaxResults:
type: integer
minimum: 5
maximum: 1000
DescribeClientVpnRoutesRequest:
type: object
required:
- ClientVpnEndpointId
title: DescribeClientVpnRoutesRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
destination-cidr - The CIDR of the route destination.
origin - How the route was associated with the Client VPN endpoint (associate | add-route).
target-subnet - The ID of the subnet through which traffic is routed.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeClientVpnTargetNetworksMaxResults:
type: integer
minimum: 5
maximum: 1000
DescribeClientVpnTargetNetworksRequest:
type: object
required:
- ClientVpnEndpointId
title: DescribeClientVpnTargetNetworksRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint.
AssociationIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The IDs of the target network associations.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeClientVpnTargetNetworksMaxResults'
- description: The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token to retrieve the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
association-id - The ID of the association.
target-network-id - The ID of the subnet specified as the target network.
vpc-id - The ID of the VPC in which the target network is located.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TargetNetworkSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TargetNetwork'
- xml:
name: item
DescribeCoipPoolsRequest:
type: object
title: DescribeCoipPoolsRequest
properties:
PoolIds:
allOf:
- $ref: '#/components/schemas/CoipPoolIdSet'
- xml:
name: PoolId
description: The IDs of the address pools.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
coip-pool.local-gateway-route-table-id - The ID of the local gateway route table.
coip-pool.pool-id - The ID of the address pool.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeConversionTaskList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ConversionTask'
- xml:
name: item
DescribeConversionTasksRequest:
type: object
title: DescribeConversionTasksRequest
properties:
ConversionTaskIds:
allOf:
- $ref: '#/components/schemas/ConversionIdStringList'
- xml:
name: conversionTaskId
description: The conversion task IDs.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeCustomerGatewaysRequest:
type: object
title: DescribeCustomerGatewaysRequest
properties:
CustomerGatewayIds:
allOf:
- $ref: '#/components/schemas/CustomerGatewayIdStringList'
- xml:
name: CustomerGatewayId
description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: 'One or more filters.
bgp-asn - The customer gateway''s Border Gateway Protocol (BGP) Autonomous System Number (ASN).
customer-gateway-id - The ID of the customer gateway.
ip-address - The IP address of the customer gateway device''s external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DescribeCustomerGateways.
DescribeDhcpOptionsMaxResults:
type: integer
minimum: 5
maximum: 1000
DhcpOptionsIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/DhcpOptionsId'
- xml:
name: DhcpOptionsId
DescribeDhcpOptionsRequest:
type: object
title: DescribeDhcpOptionsRequest
properties:
DhcpOptionsIds:
allOf:
- $ref: '#/components/schemas/DhcpOptionsIdStringList'
- xml:
name: DhcpOptionsId
description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: 'The filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the Amazon Web Services account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeDhcpOptionsMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
DhcpOptionsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/DhcpOptions'
- xml:
name: item
DescribeEgressOnlyInternetGatewaysMaxResults:
type: integer
minimum: 5
maximum: 255
EgressOnlyInternetGatewayIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- xml:
name: item
DescribeEgressOnlyInternetGatewaysRequest:
type: object
title: DescribeEgressOnlyInternetGatewaysRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EgressOnlyInternetGatewayIds:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayIdList'
- xml:
name: EgressOnlyInternetGatewayId
description: The IDs of the egress-only internet gateways.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
availability-zone - The Availability Zone in which the Elastic Graphics accelerator resides.
elastic-gpu-health - The status of the Elastic Graphics accelerator (OK | IMPAIRED).
elastic-gpu-state - The state of the Elastic Graphics accelerator (ATTACHED).
elastic-gpu-type - The type of Elastic Graphics accelerator; for example, eg1.medium.
instance-id - The ID of the instance to which the Elastic Graphics accelerator is associated.
NextToken value. This value can be between 5 and 1000.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to request the next page of results.
ElasticGpuSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticGpus'
- xml:
name: item
DescribeExportImageTasksMaxResults:
type: integer
minimum: 1
maximum: 500
ExportImageTaskIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ExportImageTaskId'
- xml:
name: ExportImageTaskId
DescribeExportImageTasksRequest:
type: object
title: DescribeExportImageTasksRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
ExportImageTaskIds:
allOf:
- $ref: '#/components/schemas/ExportImageTaskIdList'
- xml:
name: ExportImageTaskId
description: The IDs of the export image tasks.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeExportImageTasksMaxResults'
- description: The maximum number of results to return in a single call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: A token that indicates the next page of results.
ExportImageTaskList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ExportImageTask'
- xml:
name: item
ExportTaskIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ExportTaskId'
- xml:
name: ExportTaskId
DescribeExportTasksRequest:
type: object
title: DescribeExportTasksRequest
properties:
ExportTaskIds:
allOf:
- $ref: '#/components/schemas/ExportTaskIdStringList'
- xml:
name: exportTaskId
description: The export task IDs.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: the filters for the export tasks.
ExportTaskList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ExportTask'
- xml:
name: item
FastLaunchImageIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImageId'
- xml:
name: ImageId
DescribeFastLaunchImagesRequestMaxResults:
type: integer
minimum: 0
maximum: 200
DescribeFastLaunchImagesRequest:
type: object
title: DescribeFastLaunchImagesRequest
properties:
ImageIds:
allOf:
- $ref: '#/components/schemas/FastLaunchImageIdList'
- xml:
name: ImageId
description: Details for one or more Windows AMI image IDs.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: Use the following filters to streamline results.
resource-type - The resource type for pre-provisioning.
launch-template - The launch template that is associated with the pre-provisioned Windows AMI.
owner-id - The owner ID for the pre-provisioning resource.
state - The current state of fast launching for the Windows AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeFastLaunchImagesSuccessSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DescribeFastLaunchImagesSuccessItem'
- xml:
name: item
FastLaunchResourceType:
type: string
enum:
- snapshot
FastLaunchSnapshotConfigurationResponse:
type: object
properties:
TargetResourceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: targetResourceCount
description: The number of pre-provisioned snapshots requested to keep on hand for a fast-launch enabled Windows AMI.
description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
FastLaunchLaunchTemplateSpecificationResponse:
type: object
properties:
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- xml:
name: launchTemplateId
description: The ID of the launch template for faster launching of the associated Windows AMI.
LaunchTemplateName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: launchTemplateName
description: The name of the launch template for faster launching of the associated Windows AMI.
Version:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: version
description: The version of the launch template for faster launching of the associated Windows AMI.
description: Identifies the launch template to use for faster launching of the Windows AMI.
FastLaunchStateCode:
type: string
enum:
- enabling
- enabling-failed
- enabled
- enabled-failed
- disabling
- disabling-failed
DescribeFastLaunchImagesSuccessItem:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- xml:
name: imageId
description: The image ID that identifies the fast-launch enabled Windows image.
ResourceType:
allOf:
- $ref: '#/components/schemas/FastLaunchResourceType'
- xml:
name: resourceType
description: 'The resource type that is used for pre-provisioning the Windows AMI. Supported values include: snapshot.'
SnapshotConfiguration:
allOf:
- $ref: '#/components/schemas/FastLaunchSnapshotConfigurationResponse'
- xml:
name: snapshotConfiguration
description: A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationResponse'
- xml:
name: launchTemplate
description: The launch template that the fast-launch enabled Windows AMI uses when it launches Windows instances from pre-provisioned snapshots.
MaxParallelLaunches:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxParallelLaunches
description: The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The owner ID for the fast-launch enabled Windows AMI.
State:
allOf:
- $ref: '#/components/schemas/FastLaunchStateCode'
- xml:
name: state
description: The current state of faster launching for the specified Windows AMI.
StateTransitionReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: stateTransitionReason
description: The reason that faster launching for the Windows AMI changed to the current state.
StateTransitionTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: stateTransitionTime
description: The time that faster launching for the Windows AMI changed to the current state.
description: Describe details about a fast-launch enabled Windows image that meets the requested criteria. Criteria are defined by the DescribeFastLaunchImages action filters.
FastSnapshotRestoreStateCode:
type: string
enum:
- enabling
- optimizing
- enabled
- disabling
- disabled
DescribeFastSnapshotRestoreSuccessItem:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
State:
allOf:
- $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
- xml:
name: state
description: The state of fast snapshot restores.
StateTransitionReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: stateTransitionReason
description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
OptimizingTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: optimizingTime
description: The time at which fast snapshot restores entered the optimizing state.
EnabledTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: enabledTime
description: The time at which fast snapshot restores entered the enabled state.
DisablingTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: disablingTime
description: The time at which fast snapshot restores entered the disabling state.
DisabledTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: disabledTime
description: The time at which fast snapshot restores entered the disabled state.
description: Describes fast snapshot restores for a snapshot.
DescribeFastSnapshotRestoreSuccessSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DescribeFastSnapshotRestoreSuccessItem'
- xml:
name: item
DescribeFastSnapshotRestoresMaxResults:
type: integer
minimum: 0
maximum: 200
DescribeFastSnapshotRestoresRequest:
type: object
title: DescribeFastSnapshotRestoresRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters. The possible values are:
availability-zone: The Availability Zone of the snapshot.
owner-id: The ID of the Amazon Web Services account that enabled fast snapshot restore on the snapshot.
snapshot-id: The ID of the snapshot.
state: The state of fast snapshot restores for the snapshot (enabling | optimizing | enabled | disabling | disabled).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeFleetError:
type: object
properties:
LaunchTemplateAndOverrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- xml:
name: launchTemplateAndOverrides
description: 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.
Lifecycle:
allOf:
- $ref: '#/components/schemas/InstanceLifecycle'
- xml:
name: lifecycle
description: Indicates if the instance that could not be launched was a Spot Instance or On-Demand Instance.
ErrorCode:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: errorCode
description: 'The error code that indicates why the instance could not be launched. For more information about error codes, see Error codes.'
ErrorMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: errorMessage
description: 'The error message that describes why the instance could not be launched. For more information about error messages, see Error codes.'
description: Describes the instances that could not be launched by the fleet.
FleetEventType:
type: string
enum:
- instance-change
- fleet-change
- service-error
DescribeFleetHistoryRequest:
type: object
required:
- FleetId
- StartTime
title: DescribeFleetHistoryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EventType:
allOf:
- $ref: '#/components/schemas/FleetEventType'
- description: 'The type of events to describe. By default, all events are described.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- description: The ID of the EC2 Fleet.
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
HistoryRecordSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/HistoryRecordEntry'
- xml:
name: item
DescribeFleetInstancesRequest:
type: object
required:
- FleetId
title: DescribeFleetInstancesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- description: The ID of the EC2 Fleet.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters.
instance-type - The instance type.
Windows for Windows instances. Otherwise, the value is blank.'
description: Describes the instances that were launched by the fleet.
DescribeFleetsInstancesSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DescribeFleetsInstances'
- xml:
name: item
DescribeFleetsRequest:
type: object
title: DescribeFleetsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
FleetIds:
allOf:
- $ref: '#/components/schemas/FleetIdSet'
- xml:
name: FleetId
description: 'The IDs of the EC2 Fleets.
If a fleet is of type instant, you must specify the fleet ID, otherwise it does not appear in the response.
The filters.
activity-status - The progress of the EC2 Fleet ( error | pending-fulfillment | pending-termination | fulfilled).
excess-capacity-termination-policy - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (true | false).
fleet-state - The state of the EC2 Fleet (submitted | active | deleted | failed | deleted-running | deleted-terminating | modifying).
replace-unhealthy-instances - Indicates whether EC2 Fleet should replace unhealthy instances (true | false).
type - The type of request (instant | request | maintain).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filter:
allOf:
- $ref: '#/components/schemas/FilterList'
- description: 'One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination for the flow log data (cloud-watch-logs | s3 | kinesis-data-firehose).
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
One or more flow log IDs.
Constraint: Maximum of 1000 flow log IDs.
' MaxResults: allOf: - $ref: '#/components/schemas/Integer' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token to request the next page of items. Pagination continues from the end of the items returned by the previous request. FlowLogSet: type: array items: allOf: - $ref: '#/components/schemas/FlowLog' - xml: name: item FpgaImageAttributeName: type: string enum: - description - name - loadPermission - productCodes DescribeFpgaImageAttributeRequest: type: object required: - FpgaImageId - Attribute title: DescribeFpgaImageAttributeRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
FpgaImageId:
allOf:
- $ref: '#/components/schemas/FpgaImageId'
- description: The ID of the AFI.
Attribute:
allOf:
- $ref: '#/components/schemas/FpgaImageAttributeName'
- description: The AFI attribute.
FpgaImageAttribute:
type: object
properties:
FpgaImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: fpgaImageId
description: The ID of the AFI.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the AFI.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the AFI.
LoadPermissions:
allOf:
- $ref: '#/components/schemas/LoadPermissionList'
- xml:
name: loadPermissions
description: The load permissions.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeList'
- xml:
name: productCodes
description: The product codes.
description: Describes an Amazon FPGA image (AFI) attribute.
DescribeFpgaImagesMaxResults:
type: integer
minimum: 5
maximum: 1000
FpgaImageIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/FpgaImageId'
- xml:
name: item
OwnerStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: Owner
DescribeFpgaImagesRequest:
type: object
title: DescribeFpgaImagesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FpgaImageIds:
allOf:
- $ref: '#/components/schemas/FpgaImageIdList'
- xml:
name: FpgaImageId
description: The AFI IDs.
Owners:
allOf:
- $ref: '#/components/schemas/OwnerStringList'
- xml:
name: Owner
description: 'Filters the AFI by owner. Specify an Amazon Web Services account ID, self (owner is the sender of the request), or an Amazon Web Services owner alias (valid values are amazon | aws-marketplace).'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
create-time - The creation time of the AFI.
fpga-image-id - The FPGA image identifier (AFI ID).
fpga-image-global-id - The global FPGA image identifier (AGFI ID).
name - The name of the AFI.
owner-id - The Amazon Web Services account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the Amazon Web Services Shell that was used to create the bitstream.
state - The state of the AFI (pending | failed | available | unavailable).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
The filters.
instance-family - The instance family of the offering (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
MinDuration:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'This is the minimum duration of the reservation you''d like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to use to retrieve the next page of results.
OfferingId:
allOf:
- $ref: '#/components/schemas/OfferingId'
- description: The ID of the reservation offering.
HostOfferingSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/HostOffering'
- xml:
name: item
HostReservationIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/HostReservationId'
- xml:
name: item
DescribeHostReservationsRequest:
type: object
title: DescribeHostReservationsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/FilterList'
- description: 'The filters.
instance-family - The instance family (for example, m4).
payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
state - The state of the reservation (payment-pending | payment-failed | active | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to use to retrieve the next page of results.
HostReservationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/HostReservation'
- xml:
name: item
RequestHostIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/DedicatedHostId'
- xml:
name: item
DescribeHostsRequest:
type: object
title: DescribeHostsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: filter
description: 'The filters.
auto-placement - Whether auto-placement is enabled or disabled (on | off).
availability-zone - The Availability Zone of the host.
client-token - The idempotency token that you provided when you allocated the host.
host-reservation-id - The ID of the reservation assigned to this host.
instance-type - The instance type size that the Dedicated Host is configured to support.
state - The allocation state of the Dedicated Host (available | under-assessment | permanent-failure | released | released-permanent-failure).
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
You cannot specify this parameter and the host IDs parameter in the same request.
' NextToken: allOf: - $ref: '#/components/schemas/String' - xml: name: nextToken description: The token to use to retrieve the next page of results. HostList: type: array items: allOf: - $ref: '#/components/schemas/Host' - xml: name: item DescribeIamInstanceProfileAssociationsMaxResults: type: integer minimum: 5 maximum: 1000 DescribeIamInstanceProfileAssociationsRequest: type: object title: DescribeIamInstanceProfileAssociationsRequest properties: AssociationIds: allOf: - $ref: '#/components/schemas/AssociationIdList' - xml: name: AssociationId description: The IAM instance profile associations. Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description:The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating).
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 '
DescribeIdentityIdFormatRequest:
type: object
required:
- PrincipalArn
title: DescribeIdentityIdFormatRequest
properties:
PrincipalArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: principalArn
description: 'The ARN of the principal, which can be an IAM role, IAM user, or the root user.'
Resource:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resource
description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
ImageAttributeName:
type: string
enum:
- description
- kernel
- ramdisk
- launchPermission
- productCodes
- blockDeviceMapping
- sriovNetSupport
- bootMode
- tpmSupport
- uefiData
- lastLaunchedTime
- imdsSupport
DescribeImageAttributeRequest:
type: object
required:
- Attribute
- ImageId
title: DescribeImageAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/ImageAttributeName'
- description: 'The AMI attribute.
Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DescribeImageAttribute.
ExecutableByStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ExecutableBy
ImageIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImageId'
- xml:
name: ImageId
DescribeImagesRequest:
type: object
title: DescribeImagesRequest
properties:
ExecutableUsers:
allOf:
- $ref: '#/components/schemas/ExecutableByStringList'
- xml:
name: ExecutableBy
description: 'Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
If you specify all, all public AMIs are returned.
The filters.
architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - The owner alias (amazon | aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the Amazon Web Services account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
platform - The platform. The only supported value is windows.
product-code - The product code.
product-code.type - The type of the product code (marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' Owners: allOf: - $ref: '#/components/schemas/OwnerStringList' - xml: name: Owner description: 'Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services account IDs,self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.'
IncludeDeprecated:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Specifies whether to include deprecated AMIs.
Default: No deprecated AMIs are included in the response.
If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
ImageList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Image'
- xml:
name: item
ImportTaskIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportImageTaskId'
- xml:
name: ImportTaskId
DescribeImportImageTasksRequest:
type: object
title: DescribeImportImageTasksRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, or deleted.'
ImportTaskIds:
allOf:
- $ref: '#/components/schemas/ImportTaskIdList'
- xml:
name: ImportTaskId
description: The IDs of the import image tasks.
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The maximum number of results to return in a single call.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A token that indicates the next page of results.
ImportImageTaskList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportImageTask'
- xml:
name: item
ImportSnapshotTaskIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportSnapshotTaskId'
- xml:
name: ImportTaskId
DescribeImportSnapshotTasksRequest:
type: object
title: DescribeImportSnapshotTasksRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- description: The filters.
ImportTaskIds:
allOf:
- $ref: '#/components/schemas/ImportSnapshotTaskIdList'
- xml:
name: ImportTaskId
description: A list of import snapshot task IDs.
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A token that indicates the next page of results.
ImportSnapshotTaskList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportSnapshotTask'
- xml:
name: item
InstanceAttributeName:
type: string
enum:
- instanceType
- kernel
- ramdisk
- userData
- disableApiTermination
- instanceInitiatedShutdownBehavior
- rootDeviceName
- blockDeviceMapping
- productCodes
- sourceDestCheck
- groupSet
- ebsOptimized
- sriovNetSupport
- enaSupport
- enclaveOptions
- disableApiStop
DescribeInstanceAttributeRequest:
type: object
required:
- Attribute
- InstanceId
title: DescribeInstanceAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/InstanceAttributeName'
- xml:
name: attribute
description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of the instance.
InstanceConnectEndpointMaxResults:
type: integer
minimum: 1
maximum: 50
DescribeInstanceConnectEndpointsRequest:
type: object
title: DescribeInstanceConnectEndpointsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/InstanceConnectEndpointMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
instance-connect-endpoint-id - The ID of the EC2 Instance Connect Endpoint.
state - The state of the EC2 Instance Connect Endpoint (create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed).
subnet-id - The ID of the subnet in which the EC2 Instance Connect Endpoint was created.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key.
vpc-id - The ID of the VPC in which the EC2 Instance Connect Endpoint was created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters.
instance-id - The ID of the instance.
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 1000 explicitly specified instance IDs.
' MaxResults: allOf: - $ref: '#/components/schemas/DescribeInstanceCreditSpecificationsMaxResults' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same call.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. InstanceCreditSpecificationList: type: array items: allOf: - $ref: '#/components/schemas/InstanceCreditSpecification' - xml: name: item DescribeInstanceEventNotificationAttributesRequest: type: object title: DescribeInstanceEventNotificationAttributesRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceEventWindowIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- xml:
name: InstanceEventWindowId
ResultRange:
type: integer
minimum: 20
maximum: 500
DescribeInstanceEventWindowsRequest:
type: object
title: DescribeInstanceEventWindowsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceEventWindowIds:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowIdSet'
- xml:
name: InstanceEventWindowId
description: The IDs of the event windows.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
dedicated-host-id - The event windows associated with the specified Dedicated Host ID.
event-window-name - The event windows associated with the specified names.
instance-id - The event windows associated with the specified instance ID.
instance-tag - The event windows associated with the specified tag and value.
instance-tag-key - The event windows associated with the specified tag key, regardless of the value.
instance-tag-value - The event windows associated with the specified tag value, regardless of the key.
tag:<key> - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value CMX, specify tag:Owner for the filter name and CMX for the filter value.
tag-key - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value.
tag-value - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key.
NextToken value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to request the next page of results.
description: The filters.
availability-zone - The Availability Zone of the instance.
event.code - The code for the scheduled event (instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop).
event.description - A description of the event.
event.instance-event-id - The ID of the event whose date and time you are modifying.
event.not-after - The latest end time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before - The earliest start time for the scheduled event (for example, 2014-09-15T17:15:20.000Z).
event.not-before-deadline - The deadline for starting the event (for example, 2014-09-15T17:15:20.000Z).
instance-state-code - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-status.reachability - Filters on instance status where the name is reachability (passed | failed | initializing | insufficient-data).
instance-status.status - The status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
system-status.reachability - Filters on system status where the name is reachability (passed | failed | initializing | insufficient-data).
system-status.status - The system status of the instance (ok | impaired | initializing | insufficient-data | not-applicable).
The instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
' MaxResults: allOf: - $ref: '#/components/schemas/Integer' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
IncludeAllInstances:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: includeAllInstances
description: 'When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocationType:
allOf:
- $ref: '#/components/schemas/LocationType'
- description: The location type.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. Filter names and values are case-sensitive.
location - This depends on the location type. For example, if the location type is region (default), the location is the Region code (for example, us-east-2.)
instance-type - The instance type. For example, c5.2xlarge.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceTypes:
allOf:
- $ref: '#/components/schemas/RequestInstanceTypeList'
- xml:
name: InstanceType
description: 'The instance types. For more information, see Instance types in the Amazon EC2 User Guide.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. Filter names and values are case-sensitive.
auto-recovery-supported - Indicates whether Amazon CloudWatch action based recovery is supported (true | false).
bare-metal - Indicates whether it is a bare metal instance type (true | false).
burstable-performance-supported - Indicates whether the instance type is a burstable performance T instance type (true | false).
current-generation - Indicates whether this instance type is the latest generation instance type of an instance family (true | false).
ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.baseline-iops - The baseline input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.baseline-throughput-in-mbps - The baseline throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.
ebs-info.ebs-optimized-info.maximum-iops - The maximum input/output storage operations per second for an EBS-optimized instance type.
ebs-info.ebs-optimized-info.maximum-throughput-in-mbps - The maximum throughput performance for an EBS-optimized instance type, in MB/s.
ebs-info.ebs-optimized-support - Indicates whether the instance type is EBS-optimized (supported | unsupported | default).
ebs-info.encryption-support - Indicates whether EBS encryption is supported (supported | unsupported).
ebs-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (required | supported | unsupported).
free-tier-eligible - Indicates whether the instance type is eligible to use in the free tier (true | false).
hibernation-supported - Indicates whether On-Demand hibernation is supported (true | false).
hypervisor - The hypervisor (nitro | xen).
instance-storage-info.disk.count - The number of local disks.
instance-storage-info.disk.size-in-gb - The storage size of each instance storage disk, in GB.
instance-storage-info.disk.type - The storage technology for the local instance storage disks (hdd | ssd).
instance-storage-info.encryption-support - Indicates whether data is encrypted at rest (required | supported | unsupported).
instance-storage-info.nvme-support - Indicates whether non-volatile memory express (NVMe) is supported for instance store (required | supported | unsupported).
instance-storage-info.total-size-in-gb - The total amount of storage available from all local instance storage, in GB.
instance-storage-supported - Indicates whether the instance type has local instance storage (true | false).
instance-type - The instance type (for example c5.2xlarge or c5*).
memory-info.size-in-mib - The memory size.
network-info.efa-info.maximum-efa-interfaces - The maximum number of Elastic Fabric Adapters (EFAs) per instance.
network-info.efa-supported - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (true | false).
network-info.ena-support - Indicates whether Elastic Network Adapter (ENA) is supported or required (required | supported | unsupported).
network-info.encryption-in-transit-supported - Indicates whether the instance type automatically encrypts in-transit traffic between instances (true | false).
network-info.ipv4-addresses-per-interface - The maximum number of private IPv4 addresses per network interface.
network-info.ipv6-addresses-per-interface - The maximum number of private IPv6 addresses per network interface.
network-info.ipv6-supported - Indicates whether the instance type supports IPv6 (true | false).
network-info.maximum-network-cards - The maximum number of network cards per instance.
network-info.maximum-network-interfaces - The maximum number of network interfaces per instance.
network-info.network-performance - The network performance (for example, "25 Gigabit").
nitro-enclaves-support - Indicates whether Nitro Enclaves is supported (supported | unsupported).
nitro-tpm-support - Indicates whether NitroTPM is supported (supported | unsupported).
nitro-tpm-info.supported-versions - The supported NitroTPM version (2.0).
processor-info.supported-architecture - The CPU architecture (arm64 | i386 | x86_64).
processor-info.sustained-clock-speed-in-ghz - The CPU clock speed, in GHz.
processor-info.supported-features - The supported CPU features (amd-sev-snp).
supported-boot-mode - The boot mode (legacy-bios | uefi).
supported-root-device-type - The root device type (ebs | instance-store).
supported-usage-class - The usage class (on-demand | spot).
supported-virtualization-type - The virtualization type (hvm | paravirtual).
vcpu-info.default-cores - The default number of cores for the instance type.
vcpu-info.default-threads-per-core - The default number of threads per core for the instance type.
vcpu-info.default-vcpus - The default number of vCPUs for the instance type.
vcpu-info.valid-cores - The number of cores that can be configured for the instance type.
vcpu-info.valid-threads-per-core - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2".
The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64 | arm64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
capacity-reservation-id - The ID of the Capacity Reservation into which the instance was launched.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen). The value xen is used for both Xen and Nitro hypervisors.
iam-instance-profile.arn - The instance profile associated with the instance. Specified as an ARN.
image-id - The ID of the image used to launch the instance.
instance-id - The ID of the instance.
instance-lifecycle - Indicates whether this is a Spot Instance or a Scheduled Instance (spot | scheduled).
instance-state-code - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped).
instance-state-name - The state of the instance (pending | running | shutting-down | terminated | stopping | stopped).
instance-type - The type of instance (for example, t2.micro).
instance.group-id - The ID of the security group for the instance.
instance.group-name - The name of the security group for the instance.
ip-address - The public IPv4 address of the instance.
kernel-id - The kernel ID.
key-name - The name of the key pair used when the instance was launched.
launch-index - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on).
launch-time - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
metadata-options.http-tokens - The metadata request authorization state (optional | required)
metadata-options.http-put-response-hop-limit - The HTTP metadata request put response hop limit (integer, possible values 1 to 64)
metadata-options.http-endpoint - The status of access to the HTTP metadata endpoint on your instance (enabled | disabled)
metadata-options.instance-metadata-tags - The status of access to instance tags from the instance metadata (enabled | disabled)
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by Amazon Web Services.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The Amazon Web Services account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance''s reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxResults
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the instance IDs parameter in the same request.
' NextToken: allOf: - $ref: '#/components/schemas/String' - xml: name: nextToken description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. ReservationList: type: array items: allOf: - $ref: '#/components/schemas/Reservation' - xml: name: item DescribeInternetGatewaysMaxResults: type: integer minimum: 5 maximum: 1000 InternetGatewayIdList: type: array items: allOf: - $ref: '#/components/schemas/InternetGatewayId' - xml: name: item DescribeInternetGatewaysRequest: type: object title: DescribeInternetGatewaysRequest properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: 'The filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the Amazon Web Services account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InternetGatewayIds:
allOf:
- $ref: '#/components/schemas/InternetGatewayIdList'
- xml:
name: internetGatewayId
description: 'The IDs of the internet gateways.
Default: Describes all your internet gateways.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. MaxResults: allOf: - $ref: '#/components/schemas/DescribeInternetGatewaysMaxResults' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' InternetGatewayList: type: array items: allOf: - $ref: '#/components/schemas/InternetGateway' - xml: name: item IpamMaxResults: type: integer minimum: 5 maximum: 1000 DescribeIpamPoolsRequest: type: object title: DescribeIpamPoolsRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of results to return in the request.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
IpamPoolIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: IpamPoolId
description: The IDs of the IPAM pools you would like information on.
IpamPoolSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamPool'
- xml:
name: item
DescribeIpamResourceDiscoveriesRequest:
type: object
title: DescribeIpamResourceDiscoveriesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamResourceDiscoveryIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: IpamResourceDiscoveryId
description: The IPAM resource discovery IDs.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of resource discoveries to return in one page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The resource discovery filters.
IpamResourceDiscoverySet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscovery'
- xml:
name: item
DescribeIpamResourceDiscoveryAssociationsRequest:
type: object
title: DescribeIpamResourceDiscoveryAssociationsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamResourceDiscoveryAssociationIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: IpamResourceDiscoveryAssociationId
description: The resource discovery association IDs.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of resource discovery associations to return in one page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The resource discovery association filters.
IpamResourceDiscoveryAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryAssociation'
- xml:
name: item
DescribeIpamScopesRequest:
type: object
title: DescribeIpamScopesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of results to return in the request.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
IpamScopeIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: IpamScopeId
description: The IDs of the scopes you want information on.
IpamScopeSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamScope'
- xml:
name: item
DescribeIpamsRequest:
type: object
title: DescribeIpamsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of results to return in the request.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
IpamIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: IpamId
description: The IDs of the IPAMs you want information on.
IpamSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipam'
- xml:
name: item
Ipv6PoolIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv6PoolEc2Id'
- xml:
name: item
Ipv6PoolMaxResults:
type: integer
minimum: 1
maximum: 1000
DescribeIpv6PoolsRequest:
type: object
title: DescribeIpv6PoolsRequest
properties:
PoolIds:
allOf:
- $ref: '#/components/schemas/Ipv6PoolIdList'
- xml:
name: PoolId
description: The IDs of the IPv6 address pools.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/Ipv6PoolMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
key-pair-id - The ID of the key pair.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
The key pair names.
Default: Describes all of your key pairs.
' KeyPairIds: allOf: - $ref: '#/components/schemas/KeyPairIdStringList' - xml: name: KeyPairId description: The IDs of the key pairs. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
IncludePublicKey:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, the public key material is included in the response.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: 'The ID of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
' LaunchTemplateName: allOf: - $ref: '#/components/schemas/LaunchTemplateName' - description: 'The name of the launch template.
To describe one or more versions of a specified launch template, you must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
To describe all the latest or default launch template versions in your account, you must omit this parameter.
' Versions: allOf: - $ref: '#/components/schemas/VersionStringList' - xml: name: LaunchTemplateVersion description: 'One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account.
To describe one or more versions of a specified launch template, valid values are $Latest, $Default, and numbers.
To describe all launch templates in your account that are defined as the latest version, the valid value is $Latest. To describe all launch templates in your account that are defined as the default version, the valid value is $Default. You can specify $Latest and $Default in the same request. You cannot specify numbers.
NextToken value. This value can be between 1 and 200.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
create-time - The time the launch template version was created.
ebs-optimized - A boolean that indicates whether the instance is optimized for Amazon EBS I/O.
http-endpoint - Indicates whether the HTTP metadata endpoint on your instances is enabled (enabled | disabled).
http-protocol-ipv4 - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (enabled | disabled).
host-resource-group-arn - The ARN of the host resource group in which to launch the instances.
http-tokens - The state of token usage for your instance metadata requests (optional | required).
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
license-configuration-arn - The ARN of the license configuration.
network-card-index - The index of the network card.
ram-disk-id - The RAM disk ID.
If true, and if a Systems Manager parameter is specified for ImageId, the AMI ID is displayed in the response for imageId.
If false, and if a Systems Manager parameter is specified for ImageId, the parameter is displayed in the response for imageId.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LaunchTemplateIds:
allOf:
- $ref: '#/components/schemas/LaunchTemplateIdStringList'
- xml:
name: LaunchTemplateId
description: One or more launch template IDs.
LaunchTemplateNames:
allOf:
- $ref: '#/components/schemas/LaunchTemplateNameStringList'
- xml:
name: LaunchTemplateName
description: One or more launch template names.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
create-time - The time the launch template was created.
launch-template-name - The name of the launch template.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 1 and 200.'
LaunchTemplateSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplate'
- xml:
name: item
LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationId'
- xml:
name: item
LocalGatewayMaxResults:
type: integer
minimum: 5
maximum: 1000
DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest:
type: object
title: DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociationsRequest
properties:
LocalGatewayRouteTableVirtualInterfaceGroupAssociationIds:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociationIdSet'
- xml:
name: LocalGatewayRouteTableVirtualInterfaceGroupAssociationId
description: The IDs of the associations.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-virtual-interface-group-association-id - The ID of the association.
local-gateway-route-table-virtual-interface-group-id - The ID of the virtual interface group.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group association.
state - The state of the association.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayRouteTableVirtualInterfaceGroupAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVirtualInterfaceGroupAssociation'
- xml:
name: item
LocalGatewayRouteTableVpcAssociationIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationId'
- xml:
name: item
DescribeLocalGatewayRouteTableVpcAssociationsRequest:
type: object
title: DescribeLocalGatewayRouteTableVpcAssociationsRequest
properties:
LocalGatewayRouteTableVpcAssociationIds:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociationIdSet'
- xml:
name: LocalGatewayRouteTableVpcAssociationId
description: The IDs of the associations.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table for the association.
local-gateway-route-table-id - The ID of the local gateway route table.
local-gateway-route-table-vpc-association-id - The ID of the association.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table for the association.
state - The state of the association.
vpc-id - The ID of the VPC.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayRouteTableVpcAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableVpcAssociation'
- xml:
name: item
LocalGatewayRouteTableIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- xml:
name: item
DescribeLocalGatewayRouteTablesRequest:
type: object
title: DescribeLocalGatewayRouteTablesRequest
properties:
LocalGatewayRouteTableIds:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTableIdSet'
- xml:
name: LocalGatewayRouteTableId
description: The IDs of the local gateway route tables.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-route-table-arn - The Amazon Resource Name (ARN) of the local gateway route table.
local-gateway-route-table-id - The ID of a local gateway route table.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway route table.
state - The state of the local gateway route table.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayRouteTableSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRouteTable'
- xml:
name: item
LocalGatewayVirtualInterfaceGroupIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- xml:
name: item
DescribeLocalGatewayVirtualInterfaceGroupsRequest:
type: object
title: DescribeLocalGatewayVirtualInterfaceGroupsRequest
properties:
LocalGatewayVirtualInterfaceGroupIds:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupIdSet'
- xml:
name: LocalGatewayVirtualInterfaceGroupId
description: The IDs of the virtual interface groups.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
local-gateway-id - The ID of a local gateway.
local-gateway-virtual-interface-group-id - The ID of the virtual interface group.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayVirtualInterfaceGroupSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroup'
- xml:
name: item
LocalGatewayVirtualInterfaceIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
- xml:
name: item
DescribeLocalGatewayVirtualInterfacesRequest:
type: object
title: DescribeLocalGatewayVirtualInterfacesRequest
properties:
LocalGatewayVirtualInterfaceIds:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet'
- xml:
name: LocalGatewayVirtualInterfaceId
description: The IDs of the virtual interfaces.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
local-address - The local address.
local-bgp-asn - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
local-gateway-id - The ID of the local gateway.
local-gateway-virtual-interface-id - The ID of the virtual interface.
owner-id - The ID of the Amazon Web Services account that owns the local gateway virtual interface.
peer-address - The peer address.
peer-bgp-asn - The peer BGP ASN.
vlan - The ID of the VLAN.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewayVirtualInterfaceSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterface'
- xml:
name: item
LocalGatewayIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- xml:
name: item
DescribeLocalGatewaysRequest:
type: object
title: DescribeLocalGatewaysRequest
properties:
LocalGatewayIds:
allOf:
- $ref: '#/components/schemas/LocalGatewayIdSet'
- xml:
name: LocalGatewayId
description: The IDs of the local gateways.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
local-gateway-id - The ID of a local gateway.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the local gateway.
state - The state of the association.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LocalGatewaySet:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGateway'
- xml:
name: item
PrefixListMaxResults:
type: integer
minimum: 1
maximum: 100
DescribeManagedPrefixListsRequest:
type: object
title: DescribeManagedPrefixListsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
owner-id - The ID of the prefix list owner.
prefix-list-id - The ID of the prefix list.
prefix-list-name - The name of the prefix list.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
PrefixListIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: PrefixListId
description: One or more prefix list IDs.
ManagedPrefixListSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ManagedPrefixList'
- xml:
name: item
DescribeMovingAddressesMaxResults:
type: integer
minimum: 5
maximum: 1000
DescribeMovingAddressesRequest:
type: object
title: DescribeMovingAddressesRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: filter
description: One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeMovingAddressesMaxResults'
- xml:
name: maxResults
description: 'The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value outside of this range, an error is returned.
Default: If no value is provided, the default is 1000.
' NextToken: allOf: - $ref: '#/components/schemas/String' - xml: name: nextToken description: The token for the next page of results. PublicIps: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: publicIp description: One or more Elastic IP addresses. MovingAddressStatusSet: type: array items: allOf: - $ref: '#/components/schemas/MovingAddressStatus' - xml: name: item DescribeNatGatewaysMaxResults: type: integer minimum: 5 maximum: 1000 NatGatewayIdStringList: type: array items: allOf: - $ref: '#/components/schemas/NatGatewayId' - xml: name: item DescribeNatGatewaysRequest: type: object title: DescribeNatGatewaysRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filter:
allOf:
- $ref: '#/components/schemas/FilterList'
- description: 'The filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
The filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.egress - A Boolean that indicates the type of rule. Specify true for egress rules, or false for ingress rules.
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the Amazon Web Services account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkAclIds:
allOf:
- $ref: '#/components/schemas/NetworkAclIdStringList'
- xml:
name: NetworkAclId
description: 'The IDs of the network ACLs.
Default: Describes all your network ACLs.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. MaxResults: allOf: - $ref: '#/components/schemas/DescribeNetworkAclsMaxResults' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' NetworkAclList: type: array items: allOf: - $ref: '#/components/schemas/NetworkAcl' - xml: name: item NetworkInsightsAccessScopeAnalysisIdList: type: array items: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - xml: name: item NetworkInsightsMaxResults: type: integer minimum: 1 maximum: 100 DescribeNetworkInsightsAccessScopeAnalysesRequest: type: object title: DescribeNetworkInsightsAccessScopeAnalysesRequest properties: NetworkInsightsAccessScopeAnalysisIds: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisIdList' - xml: name: NetworkInsightsAccessScopeAnalysisId description: The IDs of the Network Access Scope analyses. NetworkInsightsAccessScopeId: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - description: The ID of the Network Access Scope. AnalysisStartTimeBegin: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - description: Filters the results based on the start time. The analysis must have started on or after this time. AnalysisStartTimeEnd: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - description: Filters the results based on the start time. The analysis must have started on or before this time. Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: There are no supported filters. MaxResults: allOf: - $ref: '#/components/schemas/NetworkInsightsMaxResults' - description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
NetworkInsightsAccessScopeAnalysisList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysis'
- xml:
name: item
NetworkInsightsAccessScopeIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- xml:
name: item
DescribeNetworkInsightsAccessScopesRequest:
type: object
title: DescribeNetworkInsightsAccessScopesRequest
properties:
NetworkInsightsAccessScopeIds:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeIdList'
- xml:
name: NetworkInsightsAccessScopeId
description: The IDs of the Network Access Scopes.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: There are no supported filters.
MaxResults:
allOf:
- $ref: '#/components/schemas/NetworkInsightsMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
NetworkInsightsAccessScopeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScope'
- xml:
name: item
NetworkInsightsAnalysisIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysisId'
- xml:
name: item
DescribeNetworkInsightsAnalysesRequest:
type: object
title: DescribeNetworkInsightsAnalysesRequest
properties:
NetworkInsightsAnalysisIds:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysisIdList'
- xml:
name: NetworkInsightsAnalysisId
description: The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
NetworkInsightsPathId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathId'
- description: The ID of the path. You must specify either a path ID or analysis IDs.
AnalysisStartTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: The time when the network insights analyses started.
AnalysisEndTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: The time when the network insights analyses ended.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters. The following are the possible values:
path-found - A Boolean value that indicates whether a feasible path is found.
status - The status of the analysis (running | succeeded | failed).
nextToken value.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
NetworkInsightsAnalysisList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAnalysis'
- xml:
name: item
NetworkInsightsPathIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathId'
- xml:
name: item
DescribeNetworkInsightsPathsRequest:
type: object
title: DescribeNetworkInsightsPathsRequest
properties:
NetworkInsightsPathIds:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathIdList'
- xml:
name: NetworkInsightsPathId
description: The IDs of the paths.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters. The following are the possible values:
destination - The ID of the resource.
filter-at-source.source-address - The source IPv4 address at the source.
filter-at-source.source-port-range - The source port range at the source.
filter-at-source.destination-address - The destination IPv4 address at the source.
filter-at-source.destination-port-range - The destination port range at the source.
filter-at-destination.source-address - The source IPv4 address at the destination.
filter-at-destination.source-port-range - The source port range at the destination.
filter-at-destination.destination-address - The destination IPv4 address at the destination.
filter-at-destination.destination-port-range - The destination port range at the destination.
protocol - The protocol.
source - The ID of the resource.
nextToken value.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
NetworkInsightsPathList:
type: array
items:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPath'
- xml:
name: item
NetworkInterfaceAttribute:
type: string
enum:
- description
- groupSet
- sourceDestCheck
- attachment
DescribeNetworkInterfaceAttributeRequest:
type: object
required:
- NetworkInterfaceId
title: DescribeNetworkInterfaceAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttribute'
- xml:
name: attribute
description: The attribute of the network interface. This parameter is required.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
description: Contains the parameters for DescribeNetworkInterfaceAttribute.
NetworkInterfaceAttachment:
type: object
properties:
AttachTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: attachTime
description: The timestamp indicating when the attachment initiated.
AttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: attachmentId
description: The ID of the network interface attachment.
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: Indicates whether the network interface is deleted when the instance is terminated.
DeviceIndex:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: deviceIndex
description: The device index of the network interface attachment on the instance.
NetworkCardIndex:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: networkCardIndex
description: The index of the network card.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
InstanceOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceOwnerId
description: The Amazon Web Services account ID of the owner of the instance.
Status:
allOf:
- $ref: '#/components/schemas/AttachmentStatus'
- xml:
name: status
description: The attachment state.
EnaSrdSpecification:
allOf:
- $ref: '#/components/schemas/AttachmentEnaSrdSpecification'
- xml:
name: enaSrdSpecification
description: Configures ENA Express for the network interface that this action attaches to the instance.
description: Describes a network interface attachment.
DescribeNetworkInterfacePermissionsMaxResults:
type: integer
minimum: 5
maximum: 255
NetworkInterfacePermissionIdList:
type: array
items:
$ref: '#/components/schemas/NetworkInterfacePermissionId'
DescribeNetworkInterfacePermissionsRequest:
type: object
title: DescribeNetworkInterfacePermissionsRequest
properties:
NetworkInterfacePermissionIds:
allOf:
- $ref: '#/components/schemas/NetworkInterfacePermissionIdList'
- xml:
name: NetworkInterfacePermissionId
description: The network interface permission IDs.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
network-interface-permission.network-interface-permission-id - The ID of the permission.
network-interface-permission.network-interface-id - The ID of the network interface.
network-interface-permission.aws-account-id - The Amazon Web Services account ID.
network-interface-permission.aws-service - The Amazon Web Service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
One or more filters.
addresses.private-ip-address - The private IPv4 addresses associated with the network interface.
addresses.primary - Whether the private IPv4 address is the primary IP address associated with the network interface.
addresses.association.public-ip - The association ID returned when the network interface was associated with the Elastic IP address (IPv4).
addresses.association.owner-id - The owner ID of the addresses associated with the network interface.
association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
association.public-dns-name - The public DNS name for the network interface (IPv4).
attachment.attachment-id - The ID of the interface attachment.
attachment.attach-time - The time that the network interface was attached to an instance.
attachment.delete-on-termination - Indicates whether the attachment is deleted when an instance is terminated.
attachment.device-index - The device index to which the network interface is attached.
attachment.instance-id - The ID of the instance to which the network interface is attached.
attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
interface-type - The type of network interface (api_gateway_managed | aws_codestar_connections_managed | branch | efa | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint).
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The Amazon Web Services account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The alias or Amazon Web Services account ID of the principal or service that created the network interface.
requester-managed - Indicates whether the network interface is being managed by an Amazon Web Service (for example, Amazon Web Services Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceIdList'
- xml:
name: NetworkInterfaceId
description: 'The network interface IDs.
Default: Describes all your network interfaces.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. MaxResults: allOf: - $ref: '#/components/schemas/DescribeNetworkInterfacesMaxResults' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see Pagination.' description: Contains the parameters for DescribeNetworkInterfaces. NetworkInterfaceList: type: array items: allOf: - $ref: '#/components/schemas/NetworkInterface' - xml: name: item PlacementGroupStringList: type: array items: $ref: '#/components/schemas/PlacementGroupName' PlacementGroupIdStringList: type: array items: allOf: - $ref: '#/components/schemas/PlacementGroupId' - xml: name: GroupId DescribePlacementGroupsRequest: type: object title: DescribePlacementGroupsRequest properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: 'The filters.
group-name - The name of the placement group.
group-arn - The Amazon Resource Name (ARN) of the placement group.
spread-level - The spread level for the placement group (host | rack).
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupNames:
allOf:
- $ref: '#/components/schemas/PlacementGroupStringList'
- xml:
name: groupName
description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' GroupIds: allOf: - $ref: '#/components/schemas/PlacementGroupIdStringList' - xml: name: GroupId description: The IDs of the placement groups. PlacementGroupList: type: array items: allOf: - $ref: '#/components/schemas/PlacementGroup' - xml: name: item PrefixListResourceIdStringList: type: array items: allOf: - $ref: '#/components/schemas/PrefixListResourceId' - xml: name: item DescribePrefixListsRequest: type: object title: DescribePrefixListsRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
prefix-list-id: The ID of a prefix list.
prefix-list-name: The name of a prefix list.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
PrefixListIds:
allOf:
- $ref: '#/components/schemas/PrefixListResourceIdStringList'
- xml:
name: PrefixListId
description: One or more prefix list IDs.
PrefixListSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrefixList'
- xml:
name: item
DescribePrincipalIdFormatMaxResults:
type: integer
minimum: 1
maximum: 1000
ResourceList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
DescribePrincipalIdFormatRequest:
type: object
title: DescribePrincipalIdFormatRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Resources:
allOf:
- $ref: '#/components/schemas/ResourceList'
- xml:
name: Resource
description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | instance | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | reservation | route-table | route-table-association | security-group | snapshot | subnet | subnet-cidr-block-association | volume | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway '
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribePrincipalIdFormatMaxResults'
- description: 'The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. '
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to request the next page of results.
PrincipalIdFormatList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrincipalIdFormat'
- xml:
name: item
PublicIpv4PoolIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- xml:
name: item
PoolMaxResults:
type: integer
minimum: 1
maximum: 10
DescribePublicIpv4PoolsRequest:
type: object
title: DescribePublicIpv4PoolsRequest
properties:
PoolIds:
allOf:
- $ref: '#/components/schemas/PublicIpv4PoolIdStringList'
- xml:
name: PoolId
description: The IDs of the address pools.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/PoolMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
opt-in-status - The opt-in status of the Region (opt-in-not-required | opted-in | not-opted-in).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
AllRegions:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether to display all Regions, including Regions that are disabled for your account.'
RegionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Region'
- xml:
name: item
DescribeReplaceRootVolumeTasksMaxResults:
type: integer
minimum: 1
maximum: 50
ReplaceRootVolumeTaskIds:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReplaceRootVolumeTaskId'
- xml:
name: ReplaceRootVolumeTaskId
DescribeReplaceRootVolumeTasksRequest:
type: object
title: DescribeReplaceRootVolumeTasksRequest
properties:
ReplaceRootVolumeTaskIds:
allOf:
- $ref: '#/components/schemas/ReplaceRootVolumeTaskIds'
- xml:
name: ReplaceRootVolumeTaskId
description: The ID of the root volume replacement task to view.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'Filter to use:
instance-id - The ID of the instance for which the root volume replacement task was created.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReplaceRootVolumeTasks:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReplaceRootVolumeTask'
- xml:
name: item
DescribeReservedInstancesListingsRequest:
type: object
title: DescribeReservedInstancesListingsRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
reserved-instances-id - The ID of the Reserved Instances.
reserved-instances-listing-id - The ID of the Reserved Instances listing.
status - The status of the Reserved Instance listing (pending | active | cancelled | closed).
status-message - The reason for the status.
One or more filters.
client-token - The idempotency token for the modification request.
create-date - The time when the modification request was created.
effective-date - The time when the modification becomes effective.
modification-result.reserved-instances-id - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is fulfilled.
modification-result.target-configuration.availability-zone - The Availability Zone for the new Reserved Instances.
modification-result.target-configuration.instance-count - The number of new Reserved Instances.
modification-result.target-configuration.instance-type - The instance type of the new Reserved Instances.
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000 | 94608000).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
marketplace - Set to true to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
m1.small). For more information, see Instance types in the Amazon EC2 User Guide.'
MaxDuration:
allOf:
- $ref: '#/components/schemas/Long'
- description: 'The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
' MaxInstanceCount: allOf: - $ref: '#/components/schemas/Integer' - description: 'The maximum number of instances to filter when searching for offerings.
Default: 20
' MinDuration: allOf: - $ref: '#/components/schemas/Long' - description: 'The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
' OfferingClass: allOf: - $ref: '#/components/schemas/OfferingClassType' - description: The offering class of the Reserved Instance. Can bestandard or convertible.
ProductDescription:
allOf:
- $ref: '#/components/schemas/RIProductDescription'
- description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
ReservedInstancesOfferingIds:
allOf:
- $ref: '#/components/schemas/ReservedInstancesOfferingIdStringList'
- xml:
name: ReservedInstancesOfferingId
description: One or more Reserved Instances offering IDs.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceTenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- xml:
name: instanceTenancy
description: 'The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of dedicated is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host value cannot be used with this parameter. Use the default or dedicated values only.
Default: default
The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. The maximum is 100.
Default: 100
' NextToken: allOf: - $ref: '#/components/schemas/String' - xml: name: nextToken description: The token to retrieve the next page of results. OfferingType: allOf: - $ref: '#/components/schemas/OfferingTypeValues' - xml: name: offeringType description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to theMedium Utilization Reserved Instance offering type. '
description: Contains the parameters for DescribeReservedInstancesOfferings.
ReservedInstancesOfferingList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservedInstancesOffering'
- xml:
name: item
ReservedInstancesIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservationId'
- xml:
name: ReservedInstancesId
DescribeReservedInstancesRequest:
type: object
title: DescribeReservedInstancesRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
availability-zone - The Availability Zone where the Reserved Instance can be used.
duration - The duration of the Reserved Instance (one year or three years), in seconds (31536000 | 94608000).
end - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z).
fixed-price - The purchase price of the Reserved Instance (for example, 9800.0).
instance-type - The instance type that is covered by the reservation.
scope - The scope of the Reserved Instance (Region or Availability Zone).
product-description - The Reserved Instance product platform description (Linux/UNIX | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | SUSE Linux | Red Hat Enterprise Linux | Red Hat Enterprise Linux with HA | Windows | Windows with SQL Server Standard | Windows with SQL Server Web | Windows with SQL Server Enterprise).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
OfferingType:
allOf:
- $ref: '#/components/schemas/OfferingTypeValues'
- xml:
name: offeringType
description: 'The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the Medium Utilization Reserved Instance offering type.'
description: Contains the parameters for DescribeReservedInstances.
ReservedInstancesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservedInstances'
- xml:
name: item
DescribeRouteTablesMaxResults:
type: integer
minimum: 5
maximum: 100
RouteTableIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: item
DescribeRouteTablesRequest:
type: object
title: DescribeRouteTablesRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the Amazon Web Services account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the Amazon Web Service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RouteTableIds:
allOf:
- $ref: '#/components/schemas/RouteTableIdStringList'
- xml:
name: RouteTableId
description: 'The IDs of the route tables.
Default: Describes all your route tables.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. MaxResults: allOf: - $ref: '#/components/schemas/DescribeRouteTablesMaxResults' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' RouteTableList: type: array items: allOf: - $ref: '#/components/schemas/RouteTable' - xml: name: item DescribeScheduledInstanceAvailabilityMaxResults: type: integer minimum: 5 maximum: 300 SlotDateTimeRangeRequest: type: object required: - EarliestTime - LatestTime properties: EarliestTime: allOf: - $ref: '#/components/schemas/DateTime' - description: 'The earliest date and time, in UTC, for the Scheduled Instance to start.' LatestTime: allOf: - $ref: '#/components/schemas/DateTime' - description: 'The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.' description: Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day. ScheduledInstanceRecurrenceRequest: type: object properties: Frequency: allOf: - $ref: '#/components/schemas/String' - description: 'The frequency (Daily, Weekly, or Monthly).'
Interval:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.'
OccurrenceDays:
allOf:
- $ref: '#/components/schemas/OccurrenceDayRequestSet'
- xml:
name: OccurrenceDay
description: 'The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can''t specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.'
OccurrenceRelativeToEnd:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.
OccurrenceUnit:
allOf:
- $ref: '#/components/schemas/String'
- description: The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.
description: Describes the recurring schedule for a Scheduled Instance.
DescribeScheduledInstanceAvailabilityRequest:
type: object
required:
- FirstSlotStartTimeRange
- Recurrence
title: DescribeScheduledInstanceAvailabilityRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
MaxSlotDurationInHours:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.'
MinSlotDurationInHours:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next set of results.
Recurrence:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceRecurrenceRequest'
- description: The schedule recurrence.
description: Contains the parameters for DescribeScheduledInstanceAvailability.
ScheduledInstanceAvailabilitySet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceAvailability'
- xml:
name: item
ScheduledInstanceIdRequestSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceId'
- xml:
name: ScheduledInstanceId
SlotStartTimeRangeRequest:
type: object
properties:
EarliestTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The earliest date and time, in UTC, for the Scheduled Instance to start.'
LatestTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The latest date and time, in UTC, for the Scheduled Instance to start.'
description: Describes the time period for a Scheduled Instance to start its first schedule.
DescribeScheduledInstancesRequest:
type: object
title: DescribeScheduledInstancesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
platform - The platform (Linux/UNIX or Windows).
NextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next set of results.
ScheduledInstanceIds:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceIdRequestSet'
- xml:
name: ScheduledInstanceId
description: The Scheduled Instance IDs.
SlotStartTimeRange:
allOf:
- $ref: '#/components/schemas/SlotStartTimeRangeRequest'
- description: The time period for the first schedule to start.
description: Contains the parameters for DescribeScheduledInstances.
ScheduledInstanceSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstance'
- xml:
name: item
GroupIds:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
DescribeSecurityGroupReferencesRequest:
type: object
required:
- GroupId
title: DescribeSecurityGroupReferencesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupId:
allOf:
- $ref: '#/components/schemas/GroupIds'
- description: The IDs of the security groups in your account.
SecurityGroupReferences:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupReference'
- xml:
name: item
DescribeSecurityGroupRulesMaxResults:
type: integer
minimum: 5
maximum: 1000
SecurityGroupRuleIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
DescribeSecurityGroupRulesRequest:
type: object
title: DescribeSecurityGroupRulesRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
group-id - The ID of the security group.
security-group-rule-id - The ID of the security group rule.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeSecurityGroupRulesMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.'
DescribeSecurityGroupsMaxResults:
type: integer
minimum: 5
maximum: 1000
GroupNameStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupName'
- xml:
name: GroupName
DescribeSecurityGroupsRequest:
type: object
title: DescribeSecurityGroupsRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters.
description - The description of the security group.
egress.ip-permission.cidr - An IPv4 CIDR block for an outbound security group rule.
egress.ip-permission.from-port - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
egress.ip-permission.group-id - The ID of a security group that has been referenced in an outbound security group rule.
egress.ip-permission.group-name - The name of a security group that is referenced in an outbound security group rule.
egress.ip-permission.ipv6-cidr - An IPv6 CIDR block for an outbound security group rule.
egress.ip-permission.prefix-list-id - The ID of a prefix list to which a security group rule allows outbound access.
egress.ip-permission.protocol - The IP protocol for an outbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that is referenced in an inbound security group rule.
ip-permission.ipv6-cidr - An IPv6 CIDR block for an inbound security group rule.
ip-permission.prefix-list-id - The ID of a prefix list from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp, a protocol number, or -1 for all protocols).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an Amazon Web Services account that has been referenced in an inbound security group rule.
owner-id - The Amazon Web Services account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all of your security groups.
' GroupNames: allOf: - $ref: '#/components/schemas/GroupNameStringList' - xml: name: GroupName description: '[Default VPC] The names of the security groups. You can specify either the security group name or the security group ID.
Default: Describes all of your security groups.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeSecurityGroupsMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see Pagination.'
SecurityGroupList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroup'
- xml:
name: item
SnapshotAttributeName:
type: string
enum:
- productCodes
- createVolumePermission
DescribeSnapshotAttributeRequest:
type: object
required:
- Attribute
- SnapshotId
title: DescribeSnapshotAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/SnapshotAttributeName'
- description: The snapshot attribute you would like to view.
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: The ID of the EBS snapshot.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ProductCodeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ProductCode'
- xml:
name: item
DescribeSnapshotTierStatusMaxResults:
type: integer
DescribeSnapshotTierStatusRequest:
type: object
title: DescribeSnapshotTierStatusRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters.
snapshot-id - The snapshot ID.
volume-id - The ID of the volume the snapshot is for.
last-tiering-operation - The state of the last archive or restore action. (archival-in-progress | archival-completed | archival-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeSnapshotTierStatusMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
snapshotTierStatusSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotTierStatus'
- xml:
name: item
RestorableByStringList:
type: array
items:
$ref: '#/components/schemas/String'
SnapshotIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- xml:
name: SnapshotId
DescribeSnapshotsRequest:
type: object
title: DescribeSnapshotsRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.
owner-id - The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
storage-tier - The storage tier of the snapshot (archive | standard).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
self, and amazon.'
RestorableByUserIds:
allOf:
- $ref: '#/components/schemas/RestorableByStringList'
- xml:
name: RestorableBy
description: The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
SnapshotIds:
allOf:
- $ref: '#/components/schemas/SnapshotIdStringList'
- xml:
name: SnapshotId
description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
SnapshotList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Snapshot'
- xml:
name: item
DescribeSpotDatafeedSubscriptionRequest:
type: object
title: DescribeSpotDatafeedSubscriptionRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DescribeSpotDatafeedSubscription.
DescribeSpotFleetInstancesMaxResults:
type: integer
minimum: 1
maximum: 1000
DescribeSpotFleetInstancesRequest:
type: object
required:
- SpotFleetRequestId
title: DescribeSpotFleetInstancesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetInstancesMaxResults'
- xml:
name: maxResults
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestId'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
description: Contains the parameters for DescribeSpotFleetInstances.
DescribeSpotFleetRequestHistoryMaxResults:
type: integer
minimum: 1
maximum: 1000
EventType:
type: string
enum:
- instanceChange
- fleetRequestChange
- error
- information
DescribeSpotFleetRequestHistoryRequest:
type: object
required:
- SpotFleetRequestId
- StartTime
title: DescribeSpotFleetRequestHistoryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EventType:
allOf:
- $ref: '#/components/schemas/EventType'
- xml:
name: eventType
description: 'The type of events to describe. By default, all events are described.'
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryMaxResults'
- xml:
name: maxResults
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestId'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: startTime
description: 'The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
description: Contains the parameters for DescribeSpotFleetRequestHistory.
HistoryRecords:
type: array
items:
allOf:
- $ref: '#/components/schemas/HistoryRecord'
- xml:
name: item
DescribeSpotFleetRequestsRequest:
type: object
title: DescribeSpotFleetRequestsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxResults
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token to include in another request to get the next page of items. This value is null when there are no more items to return.
SpotFleetRequestIds:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestIdList'
- xml:
name: spotFleetRequestId
description: The IDs of the Spot Fleet requests.
description: Contains the parameters for DescribeSpotFleetRequests.
SpotFleetRequestConfigSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestConfig'
- xml:
name: item
DescribeSpotInstanceRequestsRequest:
type: object
title: DescribeSpotInstanceRequestsRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
launch.group-id - The ID of the security group for the instance.
launch.group-name - The name of the security group for the instance.
launch.image-id - The ID of the AMI.
launch.instance-type - The type of instance (for example, m3.medium).
launch.kernel-id - The kernel ID.
launch.key-name - The name of the key pair the instance launched with.
launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot Instance.
launch.ramdisk-id - The RAM disk ID.
launched-availability-zone - The Availability Zone in which the request is launched.
network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
network-interface.description - A description of the network interface.
network-interface.device-index - The index of the device for the network interface attachment on the instance.
network-interface.group-id - The ID of the security group associated with the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.private-ip-address - The primary private IP address of the network interface.
network-interface.subnet-id - The ID of the subnet for the instance.
product-description - The product description associated with the instance (Linux/UNIX | Windows).
spot-instance-request-id - The Spot Instance request ID.
spot-price - The maximum hourly price for any Spot Instance launched to fulfill the request.
state - The state of the Spot Instance request (open | active | closed | cancelled | failed). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see Spot request status in the Amazon EC2 User Guide for Linux Instances.
status-code - The short code describing the most recent evaluation of your Spot Instance request.
status-message - The message explaining the status of the Spot Instance request.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of Spot Instance request (one-time | persistent).
valid-from - The start date of the request.
valid-until - The end date of the request.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SpotInstanceRequestIds:
allOf:
- $ref: '#/components/schemas/SpotInstanceRequestIdList'
- xml:
name: SpotInstanceRequestId
description: The IDs of the Spot Instance requests.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
description: Contains the parameters for DescribeSpotInstanceRequests.
SpotInstanceRequestList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotInstanceRequest'
- xml:
name: item
InstanceTypeList:
type: array
items:
$ref: '#/components/schemas/InstanceType'
ProductDescriptionList:
type: array
items:
$ref: '#/components/schemas/String'
DescribeSpotPriceHistoryRequest:
type: object
title: DescribeSpotPriceHistoryRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)).
spot-price - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).
timestamp - The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EndTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: endTime
description: 'The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
InstanceTypes:
allOf:
- $ref: '#/components/schemas/InstanceTypeList'
- xml:
name: InstanceType
description: Filters the results by the specified instance types.
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxResults
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
ProductDescriptions:
allOf:
- $ref: '#/components/schemas/ProductDescriptionList'
- xml:
name: ProductDescription
description: Filters the results by the specified basic product descriptions.
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: startTime
description: 'The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
description: Contains the parameters for DescribeSpotPriceHistory.
SpotPriceHistoryList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotPrice'
- xml:
name: item
DescribeStaleSecurityGroupsMaxResults:
type: integer
minimum: 5
maximum: 255
DescribeStaleSecurityGroupsNextToken:
type: string
minLength: 1
maxLength: 1024
DescribeStaleSecurityGroupsRequest:
type: object
required:
- VpcId
title: DescribeStaleSecurityGroupsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeStaleSecurityGroupsMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/DescribeStaleSecurityGroupsNextToken'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
StaleSecurityGroupSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/StaleSecurityGroup'
- xml:
name: item
ImageIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImageId'
- xml:
name: item
DescribeStoreImageTasksRequestMaxResults:
type: integer
minimum: 1
maximum: 200
DescribeStoreImageTasksRequest:
type: object
title: DescribeStoreImageTasksRequest
properties:
ImageIds:
allOf:
- $ref: '#/components/schemas/ImageIdList'
- xml:
name: ImageId
description: The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
task-state - Returns tasks in a certain state (InProgress | Completed | Failed)
bucket - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name.
The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
You cannot specify this parameter and the ImageIDs parameter in the same call.
The filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet''s CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
customer-owned-ipv4-pool - The customer-owned IPv4 address pool associated with the subnet.
default-for-az - Indicates whether this is the default subnet for the Availability Zone (true | false). You can also use defaultForAz as the filter name.
enable-dns64 - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations.
enable-lni-at-device-index - Indicates the device position for local network interfaces in this subnet. For example, 1 indicates local network interfaces in this subnet are the secondary network interface (eth1).
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
ipv6-native - Indicates whether this is an IPv6 only subnet (true | false).
map-customer-owned-ip-on-launch - Indicates whether a network interface created in this subnet (including a network interface created by RunInstances) receives a customer-owned IPv4 address.
map-public-ip-on-launch - Indicates whether instances launched in this subnet receive a public IPv4 address.
outpost-arn - The Amazon Resource Name (ARN) of the Outpost.
owner-id - The ID of the Amazon Web Services account that owns the subnet.
private-dns-name-options-on-launch.hostname-type - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name).
private-dns-name-options-on-launch.enable-resource-name-dns-a-record - Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
The IDs of the subnets.
Default: Describes all your subnets.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeSubnetsMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
SubnetList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Subnet'
- xml:
name: item
DescribeTagsRequest:
type: object
title: DescribeTagsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
key - The tag key.
resource-id - The ID of the resource.
resource-type - The resource type (customer-gateway | dedicated-host | dhcp-options | elastic-ip | fleet | fpga-image | host-reservation | image | instance | internet-gateway | key-pair | launch-template | natgateway | network-acl | network-interface | placement-group | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpc-endpoint | vpc-endpoint-service | vpc-peering-connection | vpn-connection | vpn-gateway).
tag:<key> - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA".
value - The tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
description: The Traffic Mirror filter description.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
TrafficMirrorFilterSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilter'
- xml:
name: item
TrafficMirrorSessionIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSessionId'
- xml:
name: item
DescribeTrafficMirrorSessionsRequest:
type: object
title: DescribeTrafficMirrorSessionsRequest
properties:
TrafficMirrorSessionIds:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSessionIdList'
- xml:
name: TrafficMirrorSessionId
description: The ID of the Traffic Mirror session.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
description: The Traffic Mirror session description.
network-interface-id: The ID of the Traffic Mirror session network interface.
owner-id: The ID of the account that owns the Traffic Mirror session.
packet-length: The assigned number of packets to mirror.
session-number: The assigned session number.
traffic-mirror-filter-id: The ID of the Traffic Mirror filter.
traffic-mirror-session-id: The ID of the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
virtual-network-id: The virtual network ID of the Traffic Mirror session.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
TrafficMirrorSessionSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSession'
- xml:
name: item
TrafficMirrorTargetIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetId'
- xml:
name: item
DescribeTrafficMirrorTargetsRequest:
type: object
title: DescribeTrafficMirrorTargetsRequest
properties:
TrafficMirrorTargetIds:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetIdList'
- xml:
name: TrafficMirrorTargetId
description: The ID of the Traffic Mirror targets.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
description: The Traffic Mirror target description.
network-interface-id: The ID of the Traffic Mirror session network interface.
network-load-balancer-arn: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session.
owner-id: The ID of the account that owns the Traffic Mirror session.
traffic-mirror-target-id: The ID of the Traffic Mirror target.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
TrafficMirrorTargetSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTarget'
- xml:
name: item
TransitGatewayAttachmentIdStringList:
type: array
items:
$ref: '#/components/schemas/TransitGatewayAttachmentId'
TransitGatewayMaxResults:
type: integer
minimum: 5
maximum: 1000
DescribeTransitGatewayAttachmentsRequest:
type: object
title: DescribeTransitGatewayAttachmentsRequest
properties:
TransitGatewayAttachmentIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- description: The IDs of the attachments.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
association.state - The state of the association (associating | associated | disassociating).
association.transit-gateway-route-table-id - The ID of the route table for the transit gateway.
resource-id - The ID of the resource.
resource-owner-id - The ID of the Amazon Web Services account that owns the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayAttachmentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachment'
- xml:
name: item
TransitGatewayConnectPeerIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerId'
- xml:
name: item
DescribeTransitGatewayConnectPeersRequest:
type: object
title: DescribeTransitGatewayConnectPeersRequest
properties:
TransitGatewayConnectPeerIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeerIdStringList'
- description: The IDs of the Connect peers.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
state - The state of the Connect peer (pending | available | deleting | deleted).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-connect-peer-id - The ID of the Connect peer.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayConnectPeerList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnectPeer'
- xml:
name: item
DescribeTransitGatewayConnectsRequest:
type: object
title: DescribeTransitGatewayConnectsRequest
properties:
TransitGatewayAttachmentIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- description: The IDs of the attachments.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
options.protocol - The tunnel protocol (gre).
state - The state of the attachment (initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing).
transit-gateway-attachment-id - The ID of the Connect attachment.
transit-gateway-id - The ID of the transit gateway.
transport-transit-gateway-attachment-id - The ID of the transit gateway attachment from which the Connect attachment was created.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayConnectList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayConnect'
- xml:
name: item
TransitGatewayMulticastDomainIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- xml:
name: item
DescribeTransitGatewayMulticastDomainsRequest:
type: object
title: DescribeTransitGatewayMulticastDomainsRequest
properties:
TransitGatewayMulticastDomainIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainIdStringList'
- description: The ID of the transit gateway multicast domain.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
state - The state of the transit gateway multicast domain. Valid values are pending | available | deleting | deleted.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-multicast-domain-id - The ID of the transit gateway multicast domain.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastDomainList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomain'
- xml:
name: item
DescribeTransitGatewayPeeringAttachmentsRequest:
type: object
title: DescribeTransitGatewayPeeringAttachmentsRequest
properties:
TransitGatewayAttachmentIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- description: One or more IDs of the transit gateway peering attachments.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
transit-gateway-attachment-id - The ID of the transit gateway attachment.
local-owner-id - The ID of your Amazon Web Services account.
remote-owner-id - The ID of the Amazon Web Services account in the remote Region that owns the transit gateway.
state - The state of the peering attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPeeringAttachmentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayPeeringAttachment'
- xml:
name: item
TransitGatewayPolicyTableIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- xml:
name: item
DescribeTransitGatewayPolicyTablesRequest:
type: object
title: DescribeTransitGatewayPolicyTablesRequest
properties:
TransitGatewayPolicyTableIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableIdStringList'
- description: The IDs of the transit gateway policy tables.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters associated with the transit gateway policy table.
MaxResults:
allOf:
- $ref: '#/components/schemas/TransitGatewayMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPolicyTableList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTable'
- xml:
name: item
TransitGatewayRouteTableAnnouncementIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- xml:
name: item
DescribeTransitGatewayRouteTableAnnouncementsRequest:
type: object
title: DescribeTransitGatewayRouteTableAnnouncementsRequest
properties:
TransitGatewayRouteTableAnnouncementIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementIdStringList'
- description: The IDs of the transit gateway route tables that are being advertised.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters associated with the transit gateway policy table.
MaxResults:
allOf:
- $ref: '#/components/schemas/TransitGatewayMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTableAnnouncementList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncement'
- xml:
name: item
TransitGatewayRouteTableIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- xml:
name: item
DescribeTransitGatewayRouteTablesRequest:
type: object
title: DescribeTransitGatewayRouteTablesRequest
properties:
TransitGatewayRouteTableIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableIdStringList'
- description: The IDs of the transit gateway route tables.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
default-association-route-table - Indicates whether this is the default association route table for the transit gateway (true | false).
default-propagation-route-table - Indicates whether this is the default propagation route table for the transit gateway (true | false).
state - The state of the route table (available | deleting | deleted | pending).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTableList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTable'
- xml:
name: item
DescribeTransitGatewayVpcAttachmentsRequest:
type: object
title: DescribeTransitGatewayVpcAttachmentsRequest
properties:
TransitGatewayAttachmentIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentIdStringList'
- description: The IDs of the attachments.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
state - The state of the attachment. Valid values are available | deleted | deleting | failed | failing | initiatingRequest | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting.
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
vpc-id - The ID of the VPC.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayVpcAttachmentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- xml:
name: item
TransitGatewayIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- xml:
name: item
DescribeTransitGatewaysRequest:
type: object
title: DescribeTransitGatewaysRequest
properties:
TransitGatewayIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayIdStringList'
- description: The IDs of the transit gateways.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
options.propagation-default-route-table-id - The ID of the default propagation route table.
options.amazon-side-asn - The private ASN for the Amazon side of a BGP session.
options.association-default-route-table-id - The ID of the default association route table.
options.auto-accept-shared-attachments - Indicates whether there is automatic acceptance of attachment requests (enable | disable).
options.default-route-table-association - Indicates whether resource attachments are automatically associated with the default association route table (enable | disable).
options.default-route-table-propagation - Indicates whether resource attachments automatically propagate routes to the default propagation route table (enable | disable).
options.dns-support - Indicates whether DNS support is enabled (enable | disable).
options.vpn-ecmp-support - Indicates whether Equal Cost Multipath Protocol support is enabled (enable | disable).
owner-id - The ID of the Amazon Web Services account that owns the transit gateway.
state - The state of the transit gateway (available | deleted | deleting | modifying | pending).
transit-gateway-id - The ID of the transit gateway.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGateway'
- xml:
name: item
DescribeTrunkInterfaceAssociationsMaxResults:
type: integer
minimum: 5
maximum: 255
TrunkInterfaceAssociationIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrunkInterfaceAssociationId'
- xml:
name: item
DescribeTrunkInterfaceAssociationsRequest:
type: object
title: DescribeTrunkInterfaceAssociationsRequest
properties:
AssociationIds:
allOf:
- $ref: '#/components/schemas/TrunkInterfaceAssociationIdList'
- xml:
name: AssociationId
description: The IDs of the associations.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
gre-key - The ID of a trunk interface association.
interface-protocol - The interface protocol. Valid values are VLAN and GRE.
nextToken value.'
TrunkInterfaceAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrunkInterfaceAssociation'
- xml:
name: item
DescribeVerifiedAccessEndpointsMaxResults:
type: integer
minimum: 5
maximum: 1000
VerifiedAccessEndpointIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointId'
- xml:
name: item
DescribeVerifiedAccessEndpointsRequest:
type: object
title: DescribeVerifiedAccessEndpointsRequest
properties:
VerifiedAccessEndpointIds:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointIdList'
- xml:
name: VerifiedAccessEndpointId
description: The ID of the Verified Access endpoint.
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- description: The ID of the Verified Access instance.
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- description: The ID of the Verified Access group.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeVerifiedAccessEndpointsMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessEndpointList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpoint'
- xml:
name: item
DescribeVerifiedAccessGroupMaxResults:
type: integer
minimum: 5
maximum: 1000
VerifiedAccessGroupIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- xml:
name: item
DescribeVerifiedAccessGroupsRequest:
type: object
title: DescribeVerifiedAccessGroupsRequest
properties:
VerifiedAccessGroupIds:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupIdList'
- xml:
name: VerifiedAccessGroupId
description: The ID of the Verified Access groups.
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- description: The ID of the Verified Access instance.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeVerifiedAccessGroupMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessGroupList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroup'
- xml:
name: item
DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults:
type: integer
minimum: 1
maximum: 10
VerifiedAccessInstanceIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- xml:
name: item
DescribeVerifiedAccessInstanceLoggingConfigurationsRequest:
type: object
title: DescribeVerifiedAccessInstanceLoggingConfigurationsRequest
properties:
VerifiedAccessInstanceIds:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceIdList'
- xml:
name: VerifiedAccessInstanceId
description: The IDs of the Verified Access instances.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeVerifiedAccessInstanceLoggingConfigurationsMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessInstanceLoggingConfigurationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceLoggingConfiguration'
- xml:
name: item
DescribeVerifiedAccessInstancesMaxResults:
type: integer
minimum: 5
maximum: 200
DescribeVerifiedAccessInstancesRequest:
type: object
title: DescribeVerifiedAccessInstancesRequest
properties:
VerifiedAccessInstanceIds:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceIdList'
- xml:
name: VerifiedAccessInstanceId
description: The IDs of the Verified Access instances.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeVerifiedAccessInstancesMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessInstanceList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstance'
- xml:
name: item
DescribeVerifiedAccessTrustProvidersMaxResults:
type: integer
minimum: 5
maximum: 200
VerifiedAccessTrustProviderIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderId'
- xml:
name: item
DescribeVerifiedAccessTrustProvidersRequest:
type: object
title: DescribeVerifiedAccessTrustProvidersRequest
properties:
VerifiedAccessTrustProviderIds:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderIdList'
- xml:
name: VerifiedAccessTrustProviderId
description: The IDs of the Verified Access trust providers.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeVerifiedAccessTrustProvidersMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters. Filter names and values are case-sensitive.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessTrustProviderList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProvider'
- xml:
name: item
VolumeAttributeName:
type: string
enum:
- autoEnableIO
- productCodes
DescribeVolumeAttributeRequest:
type: object
required:
- Attribute
- VolumeId
title: DescribeVolumeAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/VolumeAttributeName'
- description: The attribute of the volume. This parameter is required.
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeId'
- description: The ID of the volume.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeVolumeStatusRequest:
type: object
title: DescribeVolumeStatusRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
action.code - The action code for the event (for example, enable-volume-io).
action.description - A description of the action.
action.event-id - The event ID associated with the action.
availability-zone - The Availability Zone of the instance.
event.description - A description of the event.
event.event-id - The event ID.
event.event-type - The event type (for io-enabled: passed | failed; for io-performance: io-performance:degraded | io-performance:severely-degraded | io-performance:stalled).
event.not-after - The latest end time for the event.
event.not-before - The earliest start time for the event.
volume-status.details-name - The cause for volume-status.status (io-enabled | io-performance).
volume-status.details-status - The status of volume-status.details-name (for io-enabled: passed | failed; for io-performance: normal | degraded | severely-degraded | stalled).
volume-status.status - The status of the volume (ok | impaired | warning | insufficient-data).
The IDs of the volumes.
Default: Describes all your volumes.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
VolumeStatusList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeStatusItem'
- xml:
name: item
DescribeVolumesModificationsRequest:
type: object
title: DescribeVolumesModificationsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VolumeIds:
allOf:
- $ref: '#/components/schemas/VolumeIdStringList'
- xml:
name: VolumeId
description: The IDs of the volumes.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
modification-state - The current modification state (modifying | optimizing | completed | failed).
original-iops - The original IOPS rate of the volume.
original-size - The original size of the volume, in GiB.
original-volume-type - The original volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
originalMultiAttachEnabled - Indicates whether Multi-Attach support was enabled (true | false).
start-time - The modification start time.
target-iops - The target IOPS rate of the volume.
target-size - The target size of the volume, in GiB.
target-volume-type - The target volume type of the volume (standard | io1 | io2 | gp2 | sc1 | st1).
targetMultiAttachEnabled - Indicates whether Multi-Attach support is to be enabled (true | false).
volume-id - The ID of the volume.
The filters.
attachment.attach-time - The time stamp when the attachment initiated.
attachment.delete-on-termination - Whether the volume is deleted on instance termination.
attachment.device - The device name specified in the block device mapping (for example, /dev/sda1).
attachment.instance-id - The ID of the instance the volume is attached to.
attachment.status - The attachment state (attaching | attached | detaching).
availability-zone - The Availability Zone in which the volume was created.
create-time - The time stamp when the volume was created.
encrypted - Indicates whether the volume is encrypted (true | false)
multi-attach-enabled - Indicates whether the volume is enabled for Multi-Attach (true | false)
fast-restored - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (true | false).
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The state of the volume (creating | available | in-use | deleting | deleted | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The volume ID.
volume-type - The Amazon EBS volume type (gp2 | gp3 | io1 | io2 | st1 | sc1| standard)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxResults
description: 'The maximum number of volumes to return for this request. This value can be between 5 and 500; if you specify a value larger than 500, only 500 items are returned. If this parameter is not used, then all items are returned. You cannot specify this parameter and the volume IDs parameter in the same request. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: nextToken
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned from the previous request.
VolumeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Volume'
- xml:
name: item
VpcAttributeName:
type: string
enum:
- enableDnsSupport
- enableDnsHostnames
- enableNetworkAddressUsageMetrics
DescribeVpcAttributeRequest:
type: object
required:
- Attribute
- VpcId
title: DescribeVpcAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/VpcAttributeName'
- description: The VPC attribute.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DescribeVpcClassicLinkDnsSupportMaxResults:
type: integer
minimum: 5
maximum: 255
DescribeVpcClassicLinkDnsSupportNextToken:
type: string
minLength: 1
maxLength: 1024
VpcClassicLinkIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: VpcId
DescribeVpcClassicLinkDnsSupportRequest:
type: object
title: DescribeVpcClassicLinkDnsSupportRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportMaxResults'
- xml:
name: maxResults
description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportNextToken'
- xml:
name: nextToken
description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
VpcIds:
allOf:
- $ref: '#/components/schemas/VpcClassicLinkIdList'
- description: The IDs of the VPCs.
DescribeVpcClassicLinkRequest:
type: object
title: DescribeVpcClassicLinkRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcIds:
allOf:
- $ref: '#/components/schemas/VpcClassicLinkIdList'
- xml:
name: VpcId
description: The VPCs for which you want to describe the ClassicLink status.
VpcClassicLinkList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcClassicLink'
- xml:
name: item
DescribeVpcEndpointConnectionNotificationsRequest:
type: object
title: DescribeVpcEndpointConnectionNotificationsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ConnectionNotificationId:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationId'
- description: The ID of the notification.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters.
connection-notification-arn - The ARN of the SNS topic for the notification.
connection-notification-id - The ID of the notification.
connection-notification-state - The state of the notification (Enabled | Disabled).
connection-notification-type - The type of notification (Topic).
service-id - The ID of the endpoint service.
vpc-endpoint-id - The ID of the VPC endpoint.
NextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to request the next page of results.
DescribeVpcEndpointConnectionsRequest:
type: object
title: DescribeVpcEndpointConnectionsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-id - The ID of the service.
vpc-endpoint-owner - The ID of the Amazon Web Services account ID that owns the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to retrieve the next page of results.
VpcEndpointConnectionSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcEndpointConnection'
- xml:
name: item
DescribeVpcEndpointServiceConfigurationsRequest:
type: object
title: DescribeVpcEndpointServiceConfigurationsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceIdList'
- xml:
name: ServiceId
description: The IDs of the endpoint services.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to retrieve the next page of results.
ServiceConfigurationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ServiceConfiguration'
- xml:
name: item
DescribeVpcEndpointServicePermissionsRequest:
type: object
required:
- ServiceId
title: DescribeVpcEndpointServicePermissionsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the service.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters.
principal - The ARN of the principal.
principal-type - The principal type (All | Service | OrganizationUnit | Account | User | Role).
NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to retrieve the next page of results.
DescribeVpcEndpointServicesRequest:
type: object
title: DescribeVpcEndpointServicesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceNames:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: ServiceName
description: The service names.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
owner - The ID or alias of the Amazon Web Services account that owns the service.
service-name - The name of the service.
service-type - The type of service (Interface | Gateway | GatewayLoadBalancer).
supported-ip-address-types - The IP address type (ipv4 | ipv6).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token for the next set of items to return. (You received this token from a prior call.) ServiceDetailSet: type: array items: allOf: - $ref: '#/components/schemas/ServiceDetail' - xml: name: item DescribeVpcEndpointsRequest: type: object title: DescribeVpcEndpointsRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcEndpointIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointIdList'
- xml:
name: VpcEndpointId
description: The IDs of the VPC endpoints.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'The filters.
ip-address-type - The IP address type (ipv4 | ipv6).
service-name - The name of the service.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the endpoint resides.
vpc-endpoint-id - The ID of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-type - The type of VPC endpoint (Interface | Gateway | GatewayLoadBalancer).
The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results.
Constraint: If the value is greater than 1,000, we return only 1,000 items.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token for the next set of items to return. (You received this token from a prior call.) VpcEndpointSet: type: array items: allOf: - $ref: '#/components/schemas/VpcEndpoint' - xml: name: item DescribeVpcPeeringConnectionsMaxResults: type: integer minimum: 5 maximum: 1000 VpcPeeringConnectionIdList: type: array items: allOf: - $ref: '#/components/schemas/VpcPeeringConnectionId' - xml: name: item DescribeVpcPeeringConnectionsRequest: type: object title: DescribeVpcPeeringConnectionsRequest properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: 'The filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester''s VPC.
requester-vpc-info.owner-id - The ID of the Amazon Web Services account that owns the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcPeeringConnectionIds:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionIdList'
- xml:
name: VpcPeeringConnectionId
description: 'The IDs of the VPC peering connections.
Default: Describes all your VPC peering connections.
' NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. MaxResults: allOf: - $ref: '#/components/schemas/DescribeVpcPeeringConnectionsMaxResults' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' VpcPeeringConnectionList: type: array items: allOf: - $ref: '#/components/schemas/VpcPeeringConnection' - xml: name: item DescribeVpcsMaxResults: type: integer minimum: 5 maximum: 1000 VpcIdStringList: type: array items: allOf: - $ref: '#/components/schemas/VpcId' - xml: name: VpcId DescribeVpcsRequest: type: object title: DescribeVpcsRequest properties: Filters: allOf: - $ref: '#/components/schemas/FilterList' - xml: name: Filter description: 'The filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC''s CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.ipv6-pool - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
is-default - Indicates whether the VPC is the default VPC.
owner-id - The ID of the Amazon Web Services account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
The IDs of the VPCs.
Default: Describes all your VPCs.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
MaxResults:
allOf:
- $ref: '#/components/schemas/DescribeVpcsMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
VpcList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Vpc'
- xml:
name: item
VpnConnectionIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- xml:
name: VpnConnectionId
DescribeVpnConnectionsRequest:
type: object
title: DescribeVpnConnectionsRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
customer-gateway-configuration - The configuration information for the customer gateway.
customer-gateway-id - The ID of a customer gateway associated with the VPN connection.
state - The state of the VPN connection (pending | available | deleting | deleted).
option.static-routes-only - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
route.destination-cidr-block - The destination CIDR block. This corresponds to the subnet used in a customer data center.
bgp-asn - The BGP Autonomous System Number (ASN) associated with a BGP device.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of VPN connection. Currently the only supported type is ipsec.1.
vpn-connection-id - The ID of the VPN connection.
vpn-gateway-id - The ID of a virtual private gateway associated with the VPN connection.
transit-gateway-id - The ID of a transit gateway associated with the VPN connection.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DescribeVpnConnections.
VpnConnectionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- xml:
name: item
VpnGatewayIdStringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- xml:
name: VpnGatewayId
DescribeVpnGatewaysRequest:
type: object
title: DescribeVpnGatewaysRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
amazon-side-asn - The Autonomous System Number (ASN) for the Amazon side of the gateway.
attachment.state - The current state of the attachment between the gateway and the VPC (attaching | attached | detaching | detached).
attachment.vpc-id - The ID of an attached VPC.
availability-zone - The Availability Zone for the virtual private gateway (if applicable).
state - The state of the virtual private gateway (pending | available | deleting | deleted).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
type - The type of virtual private gateway. Currently the only supported type is ipsec.1.
vpn-gateway-id - The ID of the virtual private gateway.
One or more virtual private gateway IDs.
Default: Describes all your virtual private gateways.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DescribeVpnGateways.
VpnGatewayList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpnGateway'
- xml:
name: item
DestinationOptionsResponse:
type: object
properties:
FileFormat:
allOf:
- $ref: '#/components/schemas/DestinationFileFormat'
- xml:
name: fileFormat
description: The format for the flow log.
HiveCompatiblePartitions:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: hiveCompatiblePartitions
description: Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.
PerHourPartition:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: perHourPartition
description: Indicates whether to partition the flow log per hour.
description: Describes the destination options for a flow log.
DetachClassicLinkVpcRequest:
type: object
required:
- InstanceId
- VpcId
title: DetachClassicLinkVpcRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of the instance to unlink from the VPC.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC to which the instance is linked.
DetachInternetGatewayRequest:
type: object
required:
- InternetGatewayId
- VpcId
title: DetachInternetGatewayRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InternetGatewayId:
allOf:
- $ref: '#/components/schemas/InternetGatewayId'
- xml:
name: internetGatewayId
description: The ID of the internet gateway.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC.
DetachNetworkInterfaceRequest:
type: object
required:
- AttachmentId
title: DetachNetworkInterfaceRequest
properties:
AttachmentId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttachmentId'
- xml:
name: attachmentId
description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Force:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: force
description: 'Specifies whether to force a detachment.
Use the Force parameter only as a last resort to detach a network interface from a failed instance.
If you use the Force parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance.
If you force the detachment of a network interface, the instance metadata might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceIdForResolver:
type: string
VolumeIdWithResolver:
type: string
DetachVolumeRequest:
type: object
required:
- VolumeId
title: DetachVolumeRequest
properties:
Device:
allOf:
- $ref: '#/components/schemas/String'
- description: The device name.
Force:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won''t have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceIdForResolver'
- description: 'The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID.'
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeIdWithResolver'
- description: The ID of the volume.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DetachVpnGatewayRequest:
type: object
required:
- VpcId
- VpnGatewayId
title: DetachVpnGatewayRequest
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- description: The ID of the virtual private gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DetachVpnGateway.
DeviceOptions:
type: object
properties:
TenantId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: tenantId
description: The ID of the tenant application with the device-identity provider.
description: Describes the options for an Amazon Web Services Verified Access device-identity based trust provider.
DeviceType:
type: string
enum:
- ebs
- instance-store
DhcpConfigurationValueList:
type: array
items:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: item
DhcpConfiguration:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: key
description: The name of a DHCP option.
Values:
allOf:
- $ref: '#/components/schemas/DhcpConfigurationValueList'
- xml:
name: valueSet
description: The values for the DHCP option.
description: Describes a DHCP configuration option.
DhcpConfigurationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/DhcpConfiguration'
- xml:
name: item
DisableAddressTransferRequest:
type: object
required:
- AllocationId
title: DisableAddressTransferRequest
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/AllocationId'
- description: The allocation ID of an Elastic IP address.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisableAwsNetworkPerformanceMetricSubscriptionRequest:
type: object
title: DisableAwsNetworkPerformanceMetricSubscriptionRequest
properties:
Source:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The source Region or Availability Zone that the metric subscription is disabled for. For example, us-east-1.'
Destination:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The target Region or Availability Zone that the metric subscription is disabled for. For example, eu-north-1.'
Metric:
allOf:
- $ref: '#/components/schemas/MetricType'
- description: The metric used for the disabled subscription.
Statistic:
allOf:
- $ref: '#/components/schemas/StatisticType'
- description: 'The statistic used for the disabled subscription. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisableEbsEncryptionByDefaultRequest:
type: object
title: DisableEbsEncryptionByDefaultRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisableFastLaunchRequest:
type: object
required:
- ImageId
title: DisableFastLaunchRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: 'The ID of the image for which you’re turning off faster launching, and removing pre-provisioned snapshots.'
Force:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Forces the image settings to turn off faster launching for your Windows AMI. This parameter overrides any errors that are encountered while cleaning up resources in your account.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisableFastSnapshotRestoreStateErrorSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorItem'
- xml:
name: item
DisableFastSnapshotRestoreErrorItem:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
FastSnapshotRestoreStateErrors:
allOf:
- $ref: '#/components/schemas/DisableFastSnapshotRestoreStateErrorSet'
- xml:
name: fastSnapshotRestoreStateErrorSet
description: The errors.
description: Contains information about the errors that occurred when disabling fast snapshot restores.
DisableFastSnapshotRestoreErrorSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DisableFastSnapshotRestoreErrorItem'
- xml:
name: item
DisableFastSnapshotRestoreStateError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The error message.
description: Describes an error that occurred when disabling fast snapshot restores.
DisableFastSnapshotRestoreStateErrorItem:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
Error:
allOf:
- $ref: '#/components/schemas/DisableFastSnapshotRestoreStateError'
- xml:
name: error
description: The error.
description: Contains information about an error that occurred when disabling fast snapshot restores.
DisableFastSnapshotRestoreSuccessItem:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
State:
allOf:
- $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
- xml:
name: state
description: The state of fast snapshot restores for the snapshot.
StateTransitionReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: stateTransitionReason
description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
OptimizingTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: optimizingTime
description: The time at which fast snapshot restores entered the optimizing state.
EnabledTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: enabledTime
description: The time at which fast snapshot restores entered the enabled state.
DisablingTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: disablingTime
description: The time at which fast snapshot restores entered the disabling state.
DisabledTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: disabledTime
description: The time at which fast snapshot restores entered the disabled state.
description: Describes fast snapshot restores that were successfully disabled.
DisableFastSnapshotRestoreSuccessSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DisableFastSnapshotRestoreSuccessItem'
- xml:
name: item
DisableFastSnapshotRestoresRequest:
type: object
required:
- AvailabilityZones
- SourceSnapshotIds
title: DisableFastSnapshotRestoresRequest
properties:
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneStringList'
- xml:
name: AvailabilityZone
description: 'One or more Availability Zones. For example, us-east-2a.'
SourceSnapshotIds:
allOf:
- $ref: '#/components/schemas/SnapshotIdStringList'
- xml:
name: SourceSnapshotId
description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisableImageDeprecationRequest:
type: object
required:
- ImageId
title: DisableImageDeprecationRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisableIpamOrganizationAdminAccountRequest:
type: object
required:
- DelegatedAdminAccountId
title: DisableIpamOrganizationAdminAccountRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
DelegatedAdminAccountId:
allOf:
- $ref: '#/components/schemas/String'
- description: The Organizations member account ID that you want to disable as IPAM account.
DisableSerialConsoleAccessRequest:
type: object
title: DisableSerialConsoleAccessRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisableTransitGatewayRouteTablePropagationRequest:
type: object
required:
- TransitGatewayRouteTableId
title: DisableTransitGatewayRouteTablePropagationRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the propagation route table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTableAnnouncementId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- description: The ID of the route table announcement.
TransitGatewayPropagation:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: The resource type. Note that the tgw-peering resource type has been deprecated.
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayRouteTableId
description: The ID of the transit gateway route table.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayPropagationState'
- xml:
name: state
description: The state.
TransitGatewayRouteTableAnnouncementId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- xml:
name: transitGatewayRouteTableAnnouncementId
description: The ID of the transit gateway route table announcement.
description: Describes route propagation.
DisableVgwRoutePropagationRequest:
type: object
required:
- GatewayId
- RouteTableId
title: DisableVgwRoutePropagationRequest
properties:
GatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- description: The ID of the virtual private gateway.
RouteTableId:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- description: The ID of the route table.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for DisableVgwRoutePropagation.
DisableVpcClassicLinkDnsSupportRequest:
type: object
title: DisableVpcClassicLinkDnsSupportRequest
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
DisableVpcClassicLinkRequest:
type: object
required:
- VpcId
title: DisableVpcClassicLinkRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC.
DisassociateAddressRequest:
type: object
title: DisassociateAddressRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/ElasticIpAssociationId'
- description: The association ID. This parameter is required.
PublicIp:
allOf:
- $ref: '#/components/schemas/EipAllocationPublicIp'
- description: Deprecated.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisassociateClientVpnTargetNetworkRequest:
type: object
required:
- ClientVpnEndpointId
- AssociationId
title: DisassociateClientVpnTargetNetworkRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint from which to disassociate the target network.
AssociationId:
allOf:
- $ref: '#/components/schemas/ClientVpnAssociationId'
- description: The ID of the target network association.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisassociateEnclaveCertificateIamRoleRequest:
type: object
required:
- CertificateArn
- RoleArn
title: DisassociateEnclaveCertificateIamRoleRequest
properties:
CertificateArn:
allOf:
- $ref: '#/components/schemas/CertificateId'
- description: The ARN of the ACM certificate from which to disassociate the IAM role.
RoleArn:
allOf:
- $ref: '#/components/schemas/RoleId'
- description: The ARN of the IAM role to disassociate.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisassociateIamInstanceProfileRequest:
type: object
required:
- AssociationId
title: DisassociateIamInstanceProfileRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociationId'
- description: The ID of the IAM instance profile association.
InstanceEventWindowDisassociationRequest:
type: object
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdList'
- xml:
name: InstanceId
description: The IDs of the instances to disassociate from the event window.
InstanceTags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: InstanceTag
description: The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.
DedicatedHostIds:
allOf:
- $ref: '#/components/schemas/DedicatedHostIdList'
- xml:
name: DedicatedHostId
description: The IDs of the Dedicated Hosts to disassociate from the event window.
description: The targets to disassociate from the specified event window.
DisassociateInstanceEventWindowRequest:
type: object
required:
- InstanceEventWindowId
- AssociationTarget
title: DisassociateInstanceEventWindowRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceEventWindowId:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- description: The ID of the event window.
AssociationTarget:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowDisassociationRequest'
- description: One or more targets to disassociate from the specified event window.
IpamResourceDiscoveryAssociationId:
type: string
DisassociateIpamResourceDiscoveryRequest:
type: object
required:
- IpamResourceDiscoveryAssociationId
title: DisassociateIpamResourceDiscoveryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamResourceDiscoveryAssociationId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryAssociationId'
- description: A resource discovery association ID.
EipAssociationIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticIpAssociationId'
- xml:
name: item
DrainSeconds:
type: integer
minimum: 1
maximum: 4000
DisassociateNatGatewayAddressRequest:
type: object
required:
- NatGatewayId
- AssociationIds
title: DisassociateNatGatewayAddressRequest
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- description: The ID of the NAT gateway.
AssociationIds:
allOf:
- $ref: '#/components/schemas/EipAssociationIdList'
- xml:
name: AssociationId
description: The association IDs of EIPs that have been associated with the NAT gateway.
MaxDrainDurationSeconds:
allOf:
- $ref: '#/components/schemas/DrainSeconds'
- description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RouteTableAssociationId:
type: string
DisassociateRouteTableRequest:
type: object
required:
- AssociationId
title: DisassociateRouteTableRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/RouteTableAssociationId'
- xml:
name: associationId
description: The association ID representing the current association between the route table and subnet or gateway.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SubnetCidrAssociationId:
type: string
DisassociateSubnetCidrBlockRequest:
type: object
required:
- AssociationId
title: DisassociateSubnetCidrBlockRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/SubnetCidrAssociationId'
- xml:
name: associationId
description: The association ID for the CIDR block.
DisassociateTransitGatewayMulticastDomainRequest:
type: object
required:
- TransitGatewayMulticastDomainId
- TransitGatewayAttachmentId
- SubnetIds
title: DisassociateTransitGatewayMulticastDomainRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
SubnetIds:
allOf:
- $ref: '#/components/schemas/TransitGatewaySubnetIdList'
- description: The IDs of the subnets;
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisassociateTransitGatewayPolicyTableRequest:
type: object
required:
- TransitGatewayPolicyTableId
- TransitGatewayAttachmentId
title: DisassociateTransitGatewayPolicyTableRequest
properties:
TransitGatewayPolicyTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- description: The ID of the disassociated policy table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway attachment to disassociate from the policy table.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisassociateTransitGatewayRouteTableRequest:
type: object
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
title: DisassociateTransitGatewayRouteTableRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DisassociateTrunkInterfaceRequest:
type: object
required:
- AssociationId
title: DisassociateTrunkInterfaceRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/TrunkInterfaceAssociationId'
- description: The ID of the association
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcCidrAssociationId:
type: string
DisassociateVpcCidrBlockRequest:
type: object
required:
- AssociationId
title: DisassociateVpcCidrBlockRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/VpcCidrAssociationId'
- xml:
name: associationId
description: The association ID for the CIDR block.
DiskCount:
type: integer
DiskImageDetail:
type: object
required:
- Bytes
- Format
- ImportManifestUrl
properties:
Bytes:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: bytes
description: 'The size of the disk image, in GiB.'
Format:
allOf:
- $ref: '#/components/schemas/DiskImageFormat'
- xml:
name: format
description: The disk image format.
ImportManifestUrl:
allOf:
- $ref: '#/components/schemas/ImportManifestUrl'
- xml:
name: importManifestUrl
description: 'A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' description: Describes a disk image. VolumeDetail: type: object required: - Size properties: Size: allOf: - $ref: '#/components/schemas/Long' - xml: name: size description: 'The size of the volume, in GiB.' description: Describes an EBS volume. DiskImageDescription: type: object properties: Checksum: allOf: - $ref: '#/components/schemas/String' - xml: name: checksum description: The checksum computed for the disk image. Format: allOf: - $ref: '#/components/schemas/DiskImageFormat' - xml: name: format description: The disk image format. ImportManifestUrl: allOf: - $ref: '#/components/schemas/ImportManifestUrl' - xml: name: importManifestUrl description: 'A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the Authenticating REST Requests topic in the Amazon Simple Storage Service Developer Guide.
For information about the import manifest referenced by this API action, see VM Import Manifest.
' Size: allOf: - $ref: '#/components/schemas/Long' - xml: name: size description: 'The size of the disk image, in GiB.' description: Describes a disk image. DiskImageList: type: array items: $ref: '#/components/schemas/DiskImage' DiskImageVolumeDescription: type: object properties: Id: allOf: - $ref: '#/components/schemas/String' - xml: name: id description: The volume identifier. Size: allOf: - $ref: '#/components/schemas/Long' - xml: name: size description: 'The size of the volume, in GiB.' description: Describes a disk image volume. DiskSize: type: integer DiskType: type: string enum: - hdd - ssd DiskInfo: type: object properties: SizeInGB: allOf: - $ref: '#/components/schemas/DiskSize' - xml: name: sizeInGB description: The size of the disk in GB. Count: allOf: - $ref: '#/components/schemas/DiskCount' - xml: name: count description: The number of disks with this configuration. Type: allOf: - $ref: '#/components/schemas/DiskType' - xml: name: type description: The type of disk. description: Describes a disk. DiskInfoList: type: array items: allOf: - $ref: '#/components/schemas/DiskInfo' - xml: name: item DnsEntry: type: object properties: DnsName: allOf: - $ref: '#/components/schemas/String' - xml: name: dnsName description: The DNS name. HostedZoneId: allOf: - $ref: '#/components/schemas/String' - xml: name: hostedZoneId description: The ID of the private hosted zone. description: Describes a DNS entry. DnsEntrySet: type: array items: allOf: - $ref: '#/components/schemas/DnsEntry' - xml: name: item DnsNameState: type: string enum: - pendingVerification - verified - failed DnsOptions: type: object properties: DnsRecordIpType: allOf: - $ref: '#/components/schemas/DnsRecordIpType' - xml: name: dnsRecordIpType description: The DNS records created for the endpoint. PrivateDnsOnlyForInboundResolverEndpoint: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: privateDnsOnlyForInboundResolverEndpoint description: Indicates whether to enable private DNS only for inbound endpoints. description: Describes the DNS options for an endpoint. DnsServersOptionsModifyStructure: type: object properties: CustomDnsServers: allOf: - $ref: '#/components/schemas/ValueStringList' - description: 'The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.' Enabled: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether DNS servers should be used. SpecifyFalse to delete the existing DNS servers.
description: Information about the DNS server to be used.
DoubleWithConstraints:
type: number
format: double
minimum: 0.001
maximum: 99.999
EbsEncryptionSupport:
type: string
enum:
- unsupported
- supported
EbsOptimizedSupport:
type: string
enum:
- unsupported
- supported
- default
EbsOptimizedInfo:
type: object
properties:
BaselineBandwidthInMbps:
allOf:
- $ref: '#/components/schemas/BaselineBandwidthInMbps'
- xml:
name: baselineBandwidthInMbps
description: 'The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.'
BaselineThroughputInMBps:
allOf:
- $ref: '#/components/schemas/BaselineThroughputInMBps'
- xml:
name: baselineThroughputInMBps
description: 'The baseline throughput performance for an EBS-optimized instance type, in MB/s.'
BaselineIops:
allOf:
- $ref: '#/components/schemas/BaselineIops'
- xml:
name: baselineIops
description: The baseline input/output storage operations per seconds for an EBS-optimized instance type.
MaximumBandwidthInMbps:
allOf:
- $ref: '#/components/schemas/MaximumBandwidthInMbps'
- xml:
name: maximumBandwidthInMbps
description: 'The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.'
MaximumThroughputInMBps:
allOf:
- $ref: '#/components/schemas/MaximumThroughputInMBps'
- xml:
name: maximumThroughputInMBps
description: 'The maximum throughput performance for an EBS-optimized instance type, in MB/s.'
MaximumIops:
allOf:
- $ref: '#/components/schemas/MaximumIops'
- xml:
name: maximumIops
description: The maximum input/output storage operations per second for an EBS-optimized instance type.
description: Describes the optimized EBS performance for supported instance types.
EbsNvmeSupport:
type: string
enum:
- unsupported
- supported
- required
EbsInfo:
type: object
properties:
EbsOptimizedSupport:
allOf:
- $ref: '#/components/schemas/EbsOptimizedSupport'
- xml:
name: ebsOptimizedSupport
description: 'Indicates whether the instance type is Amazon EBS-optimized. For more information, see Amazon EBS-optimized instances in Amazon EC2 User Guide.'
EncryptionSupport:
allOf:
- $ref: '#/components/schemas/EbsEncryptionSupport'
- xml:
name: encryptionSupport
description: Indicates whether Amazon EBS encryption is supported.
EbsOptimizedInfo:
allOf:
- $ref: '#/components/schemas/EbsOptimizedInfo'
- xml:
name: ebsOptimizedInfo
description: Describes the optimized EBS performance for the instance type.
NvmeSupport:
allOf:
- $ref: '#/components/schemas/EbsNvmeSupport'
- xml:
name: nvmeSupport
description: Indicates whether non-volatile memory express (NVMe) is supported.
description: Describes the Amazon EBS features supported by the instance type.
EbsInstanceBlockDevice:
type: object
properties:
AttachTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: attachTime
description: The time stamp when the attachment initiated.
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: Indicates whether the volume is deleted on instance termination.
Status:
allOf:
- $ref: '#/components/schemas/AttachmentStatus'
- xml:
name: status
description: The attachment state.
VolumeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeId
description: The ID of the EBS volume.
description: Describes a parameter used to set up an EBS volume in a block device mapping.
EbsInstanceBlockDeviceSpecification:
type: object
properties:
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: Indicates whether the volume is deleted on instance termination.
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeId'
- xml:
name: volumeId
description: The ID of the EBS volume.
description: Describes information used to set up an EBS volume specified in a block device mapping.
MaximumBandwidthInMbps:
type: integer
MaximumThroughputInMBps:
type: number
format: double
MaximumIops:
type: integer
Ec2InstanceConnectEndpointState:
type: string
enum:
- create-in-progress
- create-complete
- create-failed
- delete-in-progress
- delete-complete
- delete-failed
NetworkInterfaceIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
SecurityGroupIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: item
MaximumEfaInterfaces:
type: integer
EfaInfo:
type: object
properties:
MaximumEfaInterfaces:
allOf:
- $ref: '#/components/schemas/MaximumEfaInterfaces'
- xml:
name: maximumEfaInterfaces
description: The maximum number of Elastic Fabric Adapters for the instance type.
description: Describes the Elastic Fabric Adapters for the instance type.
EfaSupportedFlag:
type: boolean
InternetGatewayAttachmentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InternetGatewayAttachment'
- xml:
name: item
ElasticGpuAssociation:
type: object
properties:
ElasticGpuId:
allOf:
- $ref: '#/components/schemas/ElasticGpuId'
- xml:
name: elasticGpuId
description: The ID of the Elastic Graphics accelerator.
ElasticGpuAssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticGpuAssociationId
description: The ID of the association.
ElasticGpuAssociationState:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticGpuAssociationState
description: The state of the association between the instance and the Elastic Graphics accelerator.
ElasticGpuAssociationTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticGpuAssociationTime
description: The time the Elastic Graphics accelerator was associated with the instance.
description: Describes the association between an instance and an Elastic Graphics accelerator.
ElasticGpuAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticGpuAssociation'
- xml:
name: item
ElasticGpuStatus:
type: string
enum:
- OK
- IMPAIRED
ElasticGpuHealth:
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ElasticGpuStatus'
- xml:
name: status
description: The health status.
description: Describes the status of an Elastic Graphics accelerator.
ElasticGpus:
type: object
properties:
ElasticGpuId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticGpuId
description: The ID of the Elastic Graphics accelerator.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone in the which the Elastic Graphics accelerator resides.
ElasticGpuType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticGpuType
description: The type of Elastic Graphics accelerator.
ElasticGpuHealth:
allOf:
- $ref: '#/components/schemas/ElasticGpuHealth'
- xml:
name: elasticGpuHealth
description: The status of the Elastic Graphics accelerator.
ElasticGpuState:
allOf:
- $ref: '#/components/schemas/ElasticGpuState'
- xml:
name: elasticGpuState
description: The state of the Elastic Graphics accelerator.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance to which the Elastic Graphics accelerator is attached.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the Elastic Graphics accelerator.
description: Describes an Elastic Graphics accelerator.
ElasticGpuSpecificationResponse:
type: object
properties:
Type:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: type
description: The elastic GPU type.
description: Describes an elastic GPU.
ElasticGpuSpecificationResponseList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticGpuSpecificationResponse'
- xml:
name: item
ElasticGpuSpecifications:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticGpuSpecification'
- xml:
name: item
ElasticGpuState:
type: string
enum:
- ATTACHED
ElasticInferenceAcceleratorCount:
type: integer
minimum: 1
ElasticInferenceAcceleratorAssociation:
type: object
properties:
ElasticInferenceAcceleratorArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticInferenceAcceleratorArn
description: ' The Amazon Resource Name (ARN) of the elastic inference accelerator. '
ElasticInferenceAcceleratorAssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticInferenceAcceleratorAssociationId
description: ' The ID of the association. '
ElasticInferenceAcceleratorAssociationState:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: elasticInferenceAcceleratorAssociationState
description: ' The state of the elastic inference accelerator. '
ElasticInferenceAcceleratorAssociationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: elasticInferenceAcceleratorAssociationTime
description: ' The time at which the elastic inference accelerator is associated with an instance. '
description: ' Describes the association between an instance and an elastic inference accelerator. '
ElasticInferenceAcceleratorAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociation'
- xml:
name: item
ElasticInferenceAccelerators:
type: array
items:
allOf:
- $ref: '#/components/schemas/ElasticInferenceAccelerator'
- xml:
name: item
EnaSrdSupported:
type: boolean
EnaSupport:
type: string
enum:
- unsupported
- supported
- required
EnableAddressTransferRequest:
type: object
required:
- AllocationId
- TransferAccountId
title: EnableAddressTransferRequest
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/AllocationId'
- description: The allocation ID of an Elastic IP address.
TransferAccountId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the account that you want to transfer the Elastic IP address to.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnableAwsNetworkPerformanceMetricSubscriptionRequest:
type: object
title: EnableAwsNetworkPerformanceMetricSubscriptionRequest
properties:
Source:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The source Region or Availability Zone that the metric subscription is enabled for. For example, us-east-1.'
Destination:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The target Region or Availability Zone that the metric subscription is enabled for. For example, eu-west-1.'
Metric:
allOf:
- $ref: '#/components/schemas/MetricType'
- description: The metric used for the enabled subscription.
Statistic:
allOf:
- $ref: '#/components/schemas/StatisticType'
- description: The statistic used for the enabled subscription.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnableEbsEncryptionByDefaultRequest:
type: object
title: EnableEbsEncryptionByDefaultRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FastLaunchSnapshotConfigurationRequest:
type: object
properties:
TargetResourceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of pre-provisioned snapshots to keep on hand for a fast-launch enabled Windows AMI.
description: Configuration settings for creating and managing pre-provisioned snapshots for a fast-launch enabled Windows AMI.
FastLaunchLaunchTemplateSpecificationRequest:
type: object
required:
- Version
properties:
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: The ID of the launch template to use for faster launching for a Windows AMI.
LaunchTemplateName:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the launch template to use for faster launching for a Windows AMI.
Version:
allOf:
- $ref: '#/components/schemas/String'
- description: The version of the launch template to use for faster launching for a Windows AMI.
description: 'Request to create a launch template for a fast-launch enabled Windows AMI.
Note - You can specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
snapshot, which is the default value.'
SnapshotConfiguration:
allOf:
- $ref: '#/components/schemas/FastLaunchSnapshotConfigurationRequest'
- description: Configuration settings for creating and managing the snapshots that are used for pre-provisioning the Windows AMI for faster launching. The associated ResourceType must be snapshot.
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/FastLaunchLaunchTemplateSpecificationRequest'
- description: 'The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both.'
MaxParallelLaunches:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows faster launching. Value must be 6 or greater.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnableFastSnapshotRestoreStateErrorSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorItem'
- xml:
name: item
EnableFastSnapshotRestoreErrorItem:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
FastSnapshotRestoreStateErrors:
allOf:
- $ref: '#/components/schemas/EnableFastSnapshotRestoreStateErrorSet'
- xml:
name: fastSnapshotRestoreStateErrorSet
description: The errors.
description: Contains information about the errors that occurred when enabling fast snapshot restores.
EnableFastSnapshotRestoreErrorSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/EnableFastSnapshotRestoreErrorItem'
- xml:
name: item
EnableFastSnapshotRestoreStateError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The error message.
description: Describes an error that occurred when enabling fast snapshot restores.
EnableFastSnapshotRestoreStateErrorItem:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
Error:
allOf:
- $ref: '#/components/schemas/EnableFastSnapshotRestoreStateError'
- xml:
name: error
description: The error.
description: Contains information about an error that occurred when enabling fast snapshot restores.
EnableFastSnapshotRestoreSuccessItem:
type: object
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: snapshotId
description: The ID of the snapshot.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
State:
allOf:
- $ref: '#/components/schemas/FastSnapshotRestoreStateCode'
- xml:
name: state
description: The state of fast snapshot restores.
StateTransitionReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: stateTransitionReason
description: 'The reason for the state transition. The possible values are as follows:
Client.UserInitiated - The state successfully transitioned to enabling or disabling.
Client.UserInitiated - Lifecycle state transition - The state successfully transitioned to optimizing, enabled, or disabled.
enabling state.
OptimizingTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: optimizingTime
description: The time at which fast snapshot restores entered the optimizing state.
EnabledTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: enabledTime
description: The time at which fast snapshot restores entered the enabled state.
DisablingTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: disablingTime
description: The time at which fast snapshot restores entered the disabling state.
DisabledTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: disabledTime
description: The time at which fast snapshot restores entered the disabled state.
description: Describes fast snapshot restores that were successfully enabled.
EnableFastSnapshotRestoreSuccessSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/EnableFastSnapshotRestoreSuccessItem'
- xml:
name: item
EnableFastSnapshotRestoresRequest:
type: object
required:
- AvailabilityZones
- SourceSnapshotIds
title: EnableFastSnapshotRestoresRequest
properties:
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/AvailabilityZoneStringList'
- xml:
name: AvailabilityZone
description: 'One or more Availability Zones. For example, us-east-2a.'
SourceSnapshotIds:
allOf:
- $ref: '#/components/schemas/SnapshotIdStringList'
- xml:
name: SourceSnapshotId
description: 'The IDs of one or more snapshots. For example, snap-1234567890abcdef0. You can specify a snapshot that was shared with you from another Amazon Web Services account.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnableImageDeprecationRequest:
type: object
required:
- ImageId
- DeprecateAt
title: EnableImageDeprecationRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI.
DeprecateAt:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.
You can’t specify a date in the past. The upper limit for DeprecateAt is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnableIpamOrganizationAdminAccountRequest:
type: object
required:
- DelegatedAdminAccountId
title: EnableIpamOrganizationAdminAccountRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
DelegatedAdminAccountId:
allOf:
- $ref: '#/components/schemas/String'
- description: The Organizations member account ID that you want to enable as the IPAM account.
EnableReachabilityAnalyzerOrganizationSharingRequest:
type: object
title: EnableReachabilityAnalyzerOrganizationSharingRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnableSerialConsoleAccessRequest:
type: object
title: EnableSerialConsoleAccessRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnableTransitGatewayRouteTablePropagationRequest:
type: object
required:
- TransitGatewayRouteTableId
title: EnableTransitGatewayRouteTablePropagationRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the propagation route table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTableAnnouncementId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- description: The ID of the transit gateway route table announcement.
EnableVgwRoutePropagationRequest:
type: object
required:
- GatewayId
- RouteTableId
title: EnableVgwRoutePropagationRequest
properties:
GatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- description: 'The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. '
RouteTableId:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- description: 'The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for EnableVgwRoutePropagation.
EnableVolumeIORequest:
type: object
required:
- VolumeId
title: EnableVolumeIORequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeId'
- xml:
name: volumeId
description: The ID of the volume.
EnableVpcClassicLinkDnsSupportRequest:
type: object
title: EnableVpcClassicLinkDnsSupportRequest
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
EnableVpcClassicLinkRequest:
type: object
required:
- VpcId
title: EnableVpcClassicLinkRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- xml:
name: vpcId
description: The ID of the VPC.
EnclaveOptions:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enabled
description: 'If this parameter is set to true, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.'
description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
EnclaveOptionsRequest:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'To enable the instance for Amazon Web Services Nitro Enclaves, set this parameter to true.'
description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.'
EncryptionInTransitSupported:
type: boolean
EphemeralNvmeSupport:
type: string
enum:
- unsupported
- supported
- required
ValidationError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: 'The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see Error codes.'
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: 'The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see Error codes.'
description: The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.
ErrorSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ValidationError'
- xml:
name: item
EventCode:
type: string
enum:
- instance-reboot
- system-reboot
- system-maintenance
- instance-retirement
- instance-stop
EventInformation:
type: object
properties:
EventDescription:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventDescription
description: The description of the event.
EventSubType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventSubType
description: 'The event.
error events:
iamFleetRoleInvalid - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
allLaunchSpecsTemporarilyBlacklisted - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
spotInstanceCountLimitExceeded - You''ve reached the limit on the number of Spot Instances that you can launch.
spotFleetRequestConfigurationInvalid - The configuration is not valid. For more information, see the description of the event.
fleetRequestChange events:
active - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
deleted (EC2 Fleet) / cancelled (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
deleted_running (EC2 Fleet) / cancelled_running (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
deleted_terminating (EC2 Fleet) / cancelled_terminating (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
expired - The EC2 Fleet or Spot Fleet request has expired. If the request was created with TerminateInstancesWithExpiration set, a subsequent terminated event indicates that the instances are terminated.
modify_in_progress - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
modify_succeeded - The EC2 Fleet or Spot Fleet request was modified.
submitted - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
progress - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
instanceChange events:
launched - A new instance was launched.
terminated - An instance was terminated by the user.
termination_notified - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
Information events:
fleetProgressHalted - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced launchSpecUnusable events). A launch specification might become valid if the Spot price changes.
launchSpecTemporarilyBlacklisted - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
launchSpecUnusable - The price in a launch specification is not valid because it is below the Spot price.
registerWithLoadBalancersFailed - An attempt to register instances with load balancers failed. For more information, see the description of the event.
instanceChange events.
description: Describes an EC2 Fleet or Spot Fleet event.
ExcludedInstanceType:
type: string
pattern: '[a-zA-Z0-9\.\*\-]+'
minLength: 1
maxLength: 30
StringList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
TransitGatewayRouteTableRoute:
type: object
properties:
DestinationCidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidr
description: The CIDR block used for destination matches.
State:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: state
description: The state of the route.
RouteOrigin:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: routeOrigin
description: 'The route origin. The following are the possible values:
static
propagated
pass, drop, and forward_to_site.'
Priority:
allOf:
- $ref: '#/components/schemas/Priority'
- xml:
name: priority
description: The rule priority.
description: Describes a stateless rule.
FirewallStatefulRule:
type: object
properties:
RuleGroupArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ruleGroupArn
description: The ARN of the stateful rule group.
Sources:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: sourceSet
description: 'The source IP addresses, in CIDR notation.'
Destinations:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: destinationSet
description: 'The destination IP addresses, in CIDR notation.'
SourcePorts:
allOf:
- $ref: '#/components/schemas/PortRangeList'
- xml:
name: sourcePortSet
description: The source ports.
DestinationPorts:
allOf:
- $ref: '#/components/schemas/PortRangeList'
- xml:
name: destinationPortSet
description: The destination ports.
Protocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: protocol
description: The protocol.
RuleAction:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ruleAction
description: 'The rule action. The possible values are pass, drop, and alert.'
Direction:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: direction
description: The direction. The possible values are FORWARD and ANY.
description: Describes a stateful rule.
Explanation:
type: object
properties:
Acl:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: acl
description: The network ACL.
AclRule:
allOf:
- $ref: '#/components/schemas/AnalysisAclRule'
- xml:
name: aclRule
description: The network ACL rule.
Address:
allOf:
- $ref: '#/components/schemas/IpAddress'
- xml:
name: address
description: 'The IPv4 address, in CIDR notation.'
Addresses:
allOf:
- $ref: '#/components/schemas/IpAddressList'
- xml:
name: addressSet
description: 'The IPv4 addresses, in CIDR notation.'
AttachedTo:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: attachedTo
description: The resource to which the component is attached.
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: availabilityZoneSet
description: The Availability Zones.
Cidrs:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: cidrSet
description: The CIDR ranges.
Component:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: component
description: The component.
CustomerGateway:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: customerGateway
description: The customer gateway.
Destination:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: destination
description: The destination.
DestinationVpc:
allOf:
- $ref: '#/components/schemas/AnalysisComponent'
- xml:
name: destinationVpc
description: The destination VPC.
Direction:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: direction
description: 'The direction. The following are the possible values:
egress
ingress
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ExportClientVpnClientConfigurationRequest:
type: object
required:
- ClientVpnEndpointId
title: ExportClientVpnClientConfigurationRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ExportTaskS3LocationRequest:
type: object
required:
- S3Bucket
properties:
S3Bucket:
allOf:
- $ref: '#/components/schemas/String'
- description: The destination Amazon S3 bucket.
S3Prefix:
allOf:
- $ref: '#/components/schemas/String'
- description: The prefix (logical hierarchy) in the bucket.
description: Describes the destination for an export image task.
ExportImageRequest:
type: object
required:
- DiskImageFormat
- ImageId
- S3ExportLocation
title: ExportImageRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: Token to enable idempotency for export image requests.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description of the image being exported. The maximum length is 255 characters.
DiskImageFormat:
allOf:
- $ref: '#/components/schemas/DiskImageFormat'
- description: The disk image format.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the image.
S3ExportLocation:
allOf:
- $ref: '#/components/schemas/ExportTaskS3LocationRequest'
- description: The Amazon S3 bucket for the destination image. The destination bucket must exist.
RoleName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named ''vmimport''.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the export image task during creation.
ExportTaskS3Location:
type: object
properties:
S3Bucket:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: s3Bucket
description: The destination Amazon S3 bucket.
S3Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: s3Prefix
description: The prefix (logical hierarchy) in the bucket.
description: Describes the destination for an export image task.
ExportImageTask:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the image being exported.
ExportImageTaskId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: exportImageTaskId
description: The ID of the export image task.
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The ID of the image.
Progress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: progress
description: The percent complete of the export image task.
S3ExportLocation:
allOf:
- $ref: '#/components/schemas/ExportTaskS3Location'
- xml:
name: s3ExportLocation
description: Information about the destination Amazon S3 bucket.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: 'The status of the export image task. The possible values are active, completed, deleting, and deleted.'
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: The status message for the export image task.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the export image task.
description: Describes an export image task.
ExportToS3Task:
type: object
properties:
ContainerFormat:
allOf:
- $ref: '#/components/schemas/ContainerFormat'
- xml:
name: containerFormat
description: 'The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.'
DiskImageFormat:
allOf:
- $ref: '#/components/schemas/DiskImageFormat'
- xml:
name: diskImageFormat
description: The format for the exported image.
S3Bucket:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: s3Bucket
description: 'The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the Grantee. For more information about the ACL to your S3 bucket, see Prerequisites in the VM Import/Export User Guide.'
S3Key:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: s3Key
description: The encryption key for your S3 bucket.
description: Describes the format and location for the export task.
InstanceExportDetails:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the resource being exported.
TargetEnvironment:
allOf:
- $ref: '#/components/schemas/ExportEnvironment'
- xml:
name: targetEnvironment
description: The target virtualization environment.
description: Describes an instance to export.
ExportTaskState:
type: string
enum:
- active
- cancelling
- cancelled
- completed
ExportTransitGatewayRoutesRequest:
type: object
required:
- TransitGatewayRouteTableId
- S3Bucket
title: ExportTransitGatewayRoutesRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the route table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id - The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FailedCapacityReservationFleetCancellationResult:
type: object
properties:
CapacityReservationFleetId:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetId'
- xml:
name: capacityReservationFleetId
description: The ID of the Capacity Reservation Fleet that could not be cancelled.
CancelCapacityReservationFleetError:
allOf:
- $ref: '#/components/schemas/CancelCapacityReservationFleetError'
- xml:
name: cancelCapacityReservationFleetError
description: Information about the Capacity Reservation Fleet cancellation error.
description: Describes a Capacity Reservation Fleet that could not be cancelled.
FailedQueuedPurchaseDeletion:
type: object
properties:
Error:
allOf:
- $ref: '#/components/schemas/DeleteQueuedReservedInstancesError'
- xml:
name: error
description: The error.
ReservedInstancesId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesId
description: The ID of the Reserved Instance.
description: Describes a Reserved Instance whose queued purchase was not deleted.
FilterPortRange:
type: object
properties:
FromPort:
allOf:
- $ref: '#/components/schemas/Port'
- xml:
name: fromPort
description: The first port in the range.
ToPort:
allOf:
- $ref: '#/components/schemas/Port'
- xml:
name: toPort
description: The last port in the range.
description: Describes a port range.
FindingsFound:
type: string
enum:
- 'true'
- 'false'
- unknown
ProtocolIntList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ProtocolInt'
- xml:
name: item
Priority:
type: integer
minimum: -1
maximum: 65535
FleetActivityStatus:
type: string
enum:
- error
- pending_fulfillment
- pending_termination
- fulfilled
IntegerWithConstraints:
type: integer
minimum: 0
FleetCapacityReservation:
type: object
properties:
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/CapacityReservationId'
- xml:
name: capacityReservationId
description: The ID of the Capacity Reservation.
AvailabilityZoneId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZoneId
description: The ID of the Availability Zone in which the Capacity Reservation reserves capacity.
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: The instance type for which the Capacity Reservation reserves capacity.
InstancePlatform:
allOf:
- $ref: '#/components/schemas/CapacityReservationInstancePlatform'
- xml:
name: instancePlatform
description: The type of operating system for which the Capacity Reservation reserves capacity.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone in which the Capacity Reservation reserves capacity.
TotalInstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalInstanceCount
description: The total number of instances for which the Capacity Reservation reserves capacity.
FulfilledCapacity:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: fulfilledCapacity
description: 'The number of capacity units fulfilled by the Capacity Reservation. For more information, see Total target capacity in the Amazon EC2 User Guide.'
EbsOptimized:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ebsOptimized
description: Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.
CreateDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: createDate
description: The date and time at which the Capacity Reservation was created.
Weight:
allOf:
- $ref: '#/components/schemas/DoubleWithConstraints'
- xml:
name: weight
description: 'The weight of the instance type in the Capacity Reservation Fleet. For more information, see Instance type weight in the Amazon EC2 User Guide.'
Priority:
allOf:
- $ref: '#/components/schemas/IntegerWithConstraints'
- xml:
name: priority
description: 'The priority of the instance type in the Capacity Reservation Fleet. For more information, see Instance type priority in the Amazon EC2 User Guide.'
description: Information about a Capacity Reservation in a Capacity Reservation Fleet.
FleetLaunchTemplateConfigList:
type: array
items:
allOf:
- $ref: '#/components/schemas/FleetLaunchTemplateConfig'
- xml:
name: item
TargetCapacitySpecification:
type: object
properties:
TotalTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalTargetCapacity
description: 'The number of units to request, filled using DefaultTargetCapacityType.'
OnDemandTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: onDemandTargetCapacity
description: 'The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.'
SpotTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: spotTargetCapacity
description: 'The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.'
DefaultTargetCapacityType:
allOf:
- $ref: '#/components/schemas/DefaultTargetCapacityType'
- xml:
name: defaultTargetCapacityType
description: 'The default TotalTargetCapacity, which is either Spot or On-Demand.'
TargetCapacityUnitType:
allOf:
- $ref: '#/components/schemas/TargetCapacityUnitType'
- xml:
name: targetCapacityUnitType
description: 'The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
You can use the On-Demand Instance MaxTotalPrice parameter, the Spot Instance MaxTotalPrice, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The MaxTotalPrice parameters are located in OnDemandOptions and SpotOptions.
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacity-optimized-prioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacity-optimized-prioritized is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand AllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn''t have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowest-price
The behavior when a Spot Instance is interrupted.
Default: terminate
The number of Spot pools across which to allocate your target Spot capacity. Supported only when AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' SingleInstanceType: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: singleInstanceType description:Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
The maximum amount per hour for Spot Instances that you''re willing to pay. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.
lowest-price - EC2 Fleet uses price to determine the order, launching the lowest price first.
prioritized - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.
Default: lowest-price
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.
Supported only for fleets of type instant.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
Supported only for fleets of type instant.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
Supported only for fleets of type instant.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
Supported only for fleets of type instant.
At least one of the following must be specified: SingleAvailabilityZone | SingleInstanceType
error. After all requests are placed, the status is pending_fulfillment. If the size of the EC2 Fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the EC2 Fleet is decreased, the status is pending_termination while instances are terminating.'
CreateTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: createTime
description: The creation date and time of the EC2 Fleet.
FleetId:
allOf:
- $ref: '#/components/schemas/FleetId'
- xml:
name: fleetId
description: The ID of the EC2 Fleet.
FleetState:
allOf:
- $ref: '#/components/schemas/FleetStateCode'
- xml:
name: fleetState
description: The state of the EC2 Fleet.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring idempotency.
Constraints: Maximum 64 ASCII characters
' ExcessCapacityTerminationPolicy: allOf: - $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy' - xml: name: excessCapacityTerminationPolicy description:Indicates whether running instances should be terminated if the target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet.
Supported only for fleets of type maintain.
maintain, you can specify a target capacity of 0 and add capacity later.'
TerminateInstancesWithExpiration:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: terminateInstancesWithExpiration
description: 'Indicates whether running instances should be terminated when the EC2 Fleet expires. '
Type:
allOf:
- $ref: '#/components/schemas/FleetType'
- xml:
name: type
description: 'The type of request. Indicates whether the EC2 Fleet only requests the target capacity, or also attempts to maintain it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: maintain.'
ValidFrom:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: validFrom
description: '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:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: validUntil
description: 'The end date and time of the request, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). At this point, no new instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date. '
ReplaceUnhealthyInstances:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: replaceUnhealthyInstances
description: 'Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type maintain. For more information, see EC2 Fleet health checks in the Amazon EC2 User Guide.'
SpotOptions:
allOf:
- $ref: '#/components/schemas/SpotOptions'
- xml:
name: spotOptions
description: The configuration of Spot Instances in an EC2 Fleet.
OnDemandOptions:
allOf:
- $ref: '#/components/schemas/OnDemandOptions'
- xml:
name: onDemandOptions
description: The allocation strategy of On-Demand Instances in an EC2 Fleet.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for an EC2 Fleet resource.
Errors:
allOf:
- $ref: '#/components/schemas/DescribeFleetsErrorSet'
- xml:
name: errorSet
description: Information about the instances that could not be launched by the fleet. Valid only when Type is set to instant.
Instances:
allOf:
- $ref: '#/components/schemas/DescribeFleetsInstancesSet'
- xml:
name: fleetInstanceSet
description: Information about the instances that were launched by the fleet. Valid only when Type is set to instant.
Context:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: context
description: Reserved.
description: Describes an EC2 Fleet.
FleetLaunchTemplateSpecification:
type: object
properties:
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: launchTemplateId
description: 'The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The Amazon EC2 launch template that can be used by a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.
For information about launch templates, see Launch an instance from a launch template in the Amazon EC2 User Guide.
' FleetLaunchTemplateOverridesList: type: array items: allOf: - $ref: '#/components/schemas/FleetLaunchTemplateOverrides' - xml: name: item FleetLaunchTemplateConfig: type: object properties: LaunchTemplateSpecification: allOf: - $ref: '#/components/schemas/FleetLaunchTemplateSpecification' - xml: name: launchTemplateSpecification description: The launch template. Overrides: allOf: - $ref: '#/components/schemas/FleetLaunchTemplateOverridesList' - xml: name: overrides description: Any parameters that you specify override the same parameters in the launch template. description: Describes a launch template and overrides. FleetLaunchTemplateSpecificationRequest: type: object properties: LaunchTemplateId: allOf: - $ref: '#/components/schemas/LaunchTemplateId' - description: 'The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The launch template version number, $Latest, or $Default. You must specify a value, otherwise the request fails.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
The Amazon EC2 launch template that can be used by an EC2 Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.
For information about launch templates, see Launch an instance from a launch template in the Amazon EC2 User Guide.
' FleetLaunchTemplateOverridesListRequest: type: array items: allOf: - $ref: '#/components/schemas/FleetLaunchTemplateOverridesRequest' - xml: name: item PlacementResponse: type: object properties: GroupName: allOf: - $ref: '#/components/schemas/PlacementGroupName' - xml: name: groupName description: The name of the placement group that the instance is in. description: Describes the placement of an instance. InstanceRequirements: type: object properties: VCpuCount: allOf: - $ref: '#/components/schemas/VCpuCountRange' - xml: name: vCpuCount description: The minimum and maximum number of vCPUs. MemoryMiB: allOf: - $ref: '#/components/schemas/MemoryMiB' - xml: name: memoryMiB description: 'The minimum and maximum amount of memory, in MiB.' CpuManufacturers: allOf: - $ref: '#/components/schemas/CpuManufacturerSet' - xml: name: cpuManufacturerSet description: 'The CPU manufacturers to include.
For instance types with Intel CPUs, specify intel.
For instance types with AMD CPUs, specify amd.
For instance types with Amazon Web Services CPUs, specify amazon-web-services.
Don''t confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer
' MemoryGiBPerVCpu: allOf: - $ref: '#/components/schemas/MemoryGiBPerVCpu' - xml: name: memoryGiBPerVCpu description: 'The minimum and maximum amount of memory per vCPU, in GiB.
Default: No minimum or maximum limits
' ExcludedInstanceTypes: allOf: - $ref: '#/components/schemas/ExcludedInstanceTypeSet' - xml: name: excludedInstanceTypeSet description: 'The instance types to exclude.
You can use strings with one or more wild cards, represented by an asterisk (*), to exclude an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.
If you specify ExcludedInstanceTypes, you can''t specify AllowedInstanceTypes.
Default: No excluded instance types
' InstanceGenerations: allOf: - $ref: '#/components/schemas/InstanceGenerationSet' - xml: name: instanceGenerationSet description: 'Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see Instance types in the Amazon EC2 User Guide.
For current generation instance types, specify current.
For previous generation instance types, specify previous.
Default: Current and previous generation instance types
' SpotMaxPricePercentageOverLowestPrice: allOf: - $ref: '#/components/schemas/Integer' - xml: name: spotMaxPricePercentageOverLowestPrice description: 'The price protection threshold for Spot Instances. This is the maximum you’ll pay for a Spot Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 100
The price protection threshold for On-Demand Instances. This is the maximum you’ll pay for an On-Demand Instance, expressed as a percentage above the least expensive current generation M, C, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it excludes instance types priced above your threshold.
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.
To turn off price protection, specify a high value, such as 999999.
This parameter is not supported for GetSpotPlacementScores and GetInstanceTypesFromInstanceRequirements.
If you set TargetCapacityUnitType to vcpu or memory-mib, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: 20
Indicates whether bare metal instance types must be included, excluded, or required.
To include bare metal instance types, specify included.
To require only bare metal instance types, specify required.
To exclude bare metal instance types, specify excluded.
Default: excluded
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see Burstable performance instances.
To include burstable performance instance types, specify included.
To require only burstable performance instance types, specify required.
To exclude burstable performance instance types, specify excluded.
Default: excluded
Indicates whether instance types must support hibernation for On-Demand Instances.
This parameter is not supported for GetSpotPlacementScores.
Default: false
The minimum and maximum number of network interfaces.
Default: No minimum or maximum limits
' LocalStorage: allOf: - $ref: '#/components/schemas/LocalStorage' - xml: name: localStorage description: 'Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, Amazon EC2 instance store in the Amazon EC2 User Guide.
To include instance types with instance store volumes, specify included.
To require only instance types with instance store volumes, specify required.
To exclude instance types with instance store volumes, specify excluded.
Default: included
The type of local storage that is required.
For instance types with hard disk drive (HDD) storage, specify hdd.
For instance types with solid state drive (SSD) storage, specify ssd.
Default: hdd and ssd
The minimum and maximum amount of total local storage, in GB.
Default: No minimum or maximum limits
' BaselineEbsBandwidthMbps: allOf: - $ref: '#/components/schemas/BaselineEbsBandwidthMbps' - xml: name: baselineEbsBandwidthMbps description: 'The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see Amazon EBS–optimized instances in the Amazon EC2 User Guide.
Default: No minimum or maximum limits
' AcceleratorTypes: allOf: - $ref: '#/components/schemas/AcceleratorTypeSet' - xml: name: acceleratorTypeSet description: 'The accelerator types that must be on the instance type.
For instance types with GPU accelerators, specify gpu.
For instance types with FPGA accelerators, specify fpga.
For instance types with inference accelerators, specify inference.
Default: Any accelerator type
' AcceleratorCount: allOf: - $ref: '#/components/schemas/AcceleratorCount' - xml: name: acceleratorCount description: 'The minimum and maximum number of accelerators (GPUs, FPGAs, or Amazon Web Services Inferentia chips) on an instance.
To exclude accelerator-enabled instance types, set Max to 0.
Default: No minimum or maximum limits
' AcceleratorManufacturers: allOf: - $ref: '#/components/schemas/AcceleratorManufacturerSet' - xml: name: acceleratorManufacturerSet description: 'Indicates whether instance types must have accelerators by specific manufacturers.
For instance types with NVIDIA devices, specify nvidia.
For instance types with AMD devices, specify amd.
For instance types with Amazon Web Services devices, specify amazon-web-services.
For instance types with Xilinx devices, specify xilinx.
Default: Any manufacturer
' AcceleratorNames: allOf: - $ref: '#/components/schemas/AcceleratorNameSet' - xml: name: acceleratorNameSet description: 'The accelerators that must be on the instance type.
For instance types with NVIDIA A100 GPUs, specify a100.
For instance types with NVIDIA V100 GPUs, specify v100.
For instance types with NVIDIA K80 GPUs, specify k80.
For instance types with NVIDIA T4 GPUs, specify t4.
For instance types with NVIDIA M60 GPUs, specify m60.
For instance types with AMD Radeon Pro V520 GPUs, specify radeon-pro-v520.
For instance types with Xilinx VU9P FPGAs, specify vu9p.
For instance types with Amazon Web Services Inferentia chips, specify inferentia.
For instance types with NVIDIA GRID K520 GPUs, specify k520.
Default: Any accelerator
' AcceleratorTotalMemoryMiB: allOf: - $ref: '#/components/schemas/AcceleratorTotalMemoryMiB' - xml: name: acceleratorTotalMemoryMiB description: 'The minimum and maximum amount of total accelerator memory, in MiB.
Default: No minimum or maximum limits
' NetworkBandwidthGbps: allOf: - $ref: '#/components/schemas/NetworkBandwidthGbps' - xml: name: networkBandwidthGbps description: 'The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Default: No minimum or maximum limits
' AllowedInstanceTypes: allOf: - $ref: '#/components/schemas/AllowedInstanceTypeSet' - xml: name: allowedInstanceTypeSet description: 'The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.
You can use strings with one or more wild cards, represented by an asterisk (*), to allow an instance type, size, or generation. The following are examples: m5.8xlarge, c5*.*, m5a.*, r*, *3*.
For example, if you specify c5*,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify m5a.*, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.
If you specify AllowedInstanceTypes, you can''t specify ExcludedInstanceTypes.
Default: All instance types
' description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
You must specify VCpuCount and MemoryMiB. All other attributes are optional. Any unspecified optional attribute is set to its default.
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
AllowedInstanceTypes - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
ExcludedInstanceTypes - The instance types to exclude from the list, even if they match your specified attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the launch instance wizard or with the RunInstances API, you can''t specify InstanceRequirements.
For more information, see 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.
' FleetLaunchTemplateOverrides: type: object properties: InstanceType: allOf: - $ref: '#/components/schemas/InstanceType' - xml: name: instanceType description: 'The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can''t specify InstanceRequirements.
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
instant. For fleets of type maintain and request, you must specify the AMI ID in the launch template.'
description: Describes overrides for a launch template.
FleetLaunchTemplateOverridesRequest:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: 'The instance type.
mac1.metal is not supported as a launch template override.
If you specify InstanceType, you can''t specify InstanceRequirements.
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
subnet-1234abcdeexample1, subnet-0987cdef6example2). A request of type instant can have only one subnet ID.'
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- description: The Availability Zone in which to launch the instances.
WeightedCapacity:
allOf:
- $ref: '#/components/schemas/Double'
- description: The number of units provided by the specified instance type.
Priority:
allOf:
- $ref: '#/components/schemas/Double'
- description: 'The priority for the launch template override. The highest priority is launched first.
If the On-Demand AllocationStrategy is set to prioritized, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacity-optimized-prioritized, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
instant. For fleets of type maintain and request, you must specify the AMI ID in the launch template.'
description: Describes overrides for a launch template.
FleetReplacementStrategy:
type: string
enum:
- launch
- launch-before-terminate
FleetSpotCapacityRebalance:
type: object
properties:
ReplacementStrategy:
allOf:
- $ref: '#/components/schemas/FleetReplacementStrategy'
- xml:
name: replacementStrategy
description: 'The replacement strategy to use. Only available for fleets of type maintain.
launch - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
The replacement strategy to use. Only available for fleets of type maintain.
launch - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Rate limited indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you''ve reached the limit on the number of log groups that you can create. Access error indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. Unknown error indicates an internal error.'
DeliverLogsPermissionArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deliverLogsPermissionArn
description: The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.
DeliverCrossAccountRole:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deliverCrossAccountRole
description: The ARN of the IAM role that allows the service to publish flow logs across accounts.
DeliverLogsStatus:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deliverLogsStatus
description: The status of the logs delivery (SUCCESS | FAILED).
FlowLogId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: flowLogId
description: The ID of the flow log.
FlowLogStatus:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: flowLogStatus
description: The status of the flow log (ACTIVE).
LogGroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: logGroupName
description: The name of the flow log group.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource being monitored.
TrafficType:
allOf:
- $ref: '#/components/schemas/TrafficType'
- xml:
name: trafficType
description: The type of traffic captured for the flow log.
LogDestinationType:
allOf:
- $ref: '#/components/schemas/LogDestinationType'
- xml:
name: logDestinationType
description: The type of destination for the flow log data.
LogDestination:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: logDestination
description: The Amazon Resource Name (ARN) of the destination for the flow log data.
LogFormat:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: logFormat
description: The format of the flow log record.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the flow log.
MaxAggregationInterval:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxAggregationInterval
description: 'The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.
When a network interface is attached to a Nitro-based instance, the aggregation interval is always 60 seconds (1 minute) or less, regardless of the specified value.
Valid Values: 60 | 600
The state. The following are the possible values:
pending - AFI bitstream generation is in progress.
available - The AFI is available for use.
failed - AFI bitstream generation failed.
unavailable - The AFI is no longer available for use.
failed, this is the error message.'
description: Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).
InstanceTypesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
FpgaImage:
type: object
properties:
FpgaImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: fpgaImageId
description: The FPGA image identifier (AFI ID).
FpgaImageGlobalId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: fpgaImageGlobalId
description: The global FPGA image identifier (AGFI ID).
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the AFI.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the AFI.
ShellVersion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: shellVersion
description: The version of the Amazon Web Services Shell that was used to create the bitstream.
PciId:
allOf:
- $ref: '#/components/schemas/PciId'
- xml:
name: pciId
description: Information about the PCI bus.
State:
allOf:
- $ref: '#/components/schemas/FpgaImageState'
- xml:
name: state
description: Information about the state of the AFI.
CreateTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: createTime
description: The date and time the AFI was created.
UpdateTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: updateTime
description: The time of the most recent update to the AFI.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the AFI.
OwnerAlias:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerAlias
description: 'The alias of the AFI owner. Possible values include self, amazon, and aws-marketplace.'
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeList'
- xml:
name: productCodes
description: The product codes for the AFI.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tags
description: Any tags assigned to the AFI.
Public:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: public
description: Indicates whether the AFI is public.
DataRetentionSupport:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dataRetentionSupport
description: Indicates whether data retention support is enabled for the AFI.
InstanceTypes:
allOf:
- $ref: '#/components/schemas/InstanceTypesList'
- xml:
name: instanceTypes
description: The instance types supported by the AFI.
description: Describes an Amazon FPGA image (AFI).
LoadPermissionList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LoadPermission'
- xml:
name: item
FpgaImageStateCode:
type: string
enum:
- pending
- failed
- available
- unavailable
totalFpgaMemory:
type: integer
FpgaInfo:
type: object
properties:
Fpgas:
allOf:
- $ref: '#/components/schemas/FpgaDeviceInfoList'
- xml:
name: fpgas
description: Describes the FPGAs for the instance type.
TotalFpgaMemoryInMiB:
allOf:
- $ref: '#/components/schemas/totalFpgaMemory'
- xml:
name: totalFpgaMemoryInMiB
description: The total memory of all FPGA accelerators for the instance type.
description: Describes the FPGAs for the instance type.
FreeTierEligibleFlag:
type: boolean
GVCDMaxResults:
type: integer
minimum: 200
maximum: 1000
GatewayAssociationState:
type: string
enum:
- associated
- not-associated
- associating
- disassociating
GetAssociatedEnclaveCertificateIamRolesRequest:
type: object
required:
- CertificateArn
title: GetAssociatedEnclaveCertificateIamRolesRequest
properties:
CertificateArn:
allOf:
- $ref: '#/components/schemas/CertificateId'
- description: 'The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetAssociatedIpv6PoolCidrsRequest:
type: object
required:
- PoolId
title: GetAssociatedIpv6PoolCidrsRequest
properties:
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv6PoolEc2Id'
- description: The ID of the IPv6 address pool.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/Ipv6PoolMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Ipv6CidrAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv6CidrAssociation'
- xml:
name: item
GetAwsNetworkPerformanceDataRequest:
type: object
title: GetAwsNetworkPerformanceDataRequest
properties:
DataQueries:
allOf:
- $ref: '#/components/schemas/DataQueries'
- xml:
name: DataQuery
description: A list of network performance data queries.
StartTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: 'The starting time for the performance data request. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.'
EndTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: 'The ending time for the performance data request. The end time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.'
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetCapacityReservationUsageRequestMaxResults:
type: integer
minimum: 1
maximum: 1000
GetCapacityReservationUsageRequest:
type: object
required:
- CapacityReservationId
title: GetCapacityReservationUsageRequest
properties:
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/CapacityReservationId'
- description: The ID of the Capacity Reservation.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to use to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/GetCapacityReservationUsageRequestMaxResults'
- description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.
Valid range: Minimum value of 1. Maximum value of 1000.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceUsageSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceUsage'
- xml:
name: item
GetCoipPoolUsageRequest:
type: object
required:
- PoolId
title: GetCoipPoolUsageRequest
properties:
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolCoipId'
- description: The ID of the address pool.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: One or more filters.
coip-address-usage.allocation-id - The allocation ID of the address.
coip-address-usage.aws-account-id - The ID of the Amazon Web Services account that is using the customer-owned IP address.
coip-address-usage.aws-service - The Amazon Web Services service that is using the customer-owned IP address.
coip-address-usage.co-ip - The customer-owned IP address.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetConsoleOutputRequest:
type: object
required:
- InstanceId
title: GetConsoleOutputRequest
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Latest:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
WakeUp:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'When set to true, acts as keystroke input and wakes up an instance that''s in standby or "sleep" mode.'
UnlimitedSupportedInstanceFamily:
type: string
enum:
- t2
- t3
- t3a
- t4g
GetDefaultCreditSpecificationRequest:
type: object
required:
- InstanceFamily
title: GetDefaultCreditSpecificationRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceFamily:
allOf:
- $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily'
- description: The instance family.
InstanceFamilyCreditSpecification:
type: object
properties:
InstanceFamily:
allOf:
- $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily'
- xml:
name: instanceFamily
description: The instance family.
CpuCredits:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cpuCredits
description: The default credit option for CPU usage of the instance family. Valid values are standard and unlimited.
description: Describes the default credit option for CPU usage of a burstable performance instance family.
GetEbsDefaultKmsKeyIdRequest:
type: object
title: GetEbsDefaultKmsKeyIdRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetEbsEncryptionByDefaultRequest:
type: object
title: GetEbsEncryptionByDefaultRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SSEType:
type: string
enum:
- sse-ebs
- sse-kms
- none
IntegrateServices:
type: object
properties:
AthenaIntegrations:
allOf:
- $ref: '#/components/schemas/AthenaIntegrationsSet'
- xml:
name: AthenaIntegration
description: Information about the integration with Amazon Athena.
description: Describes service integrations with VPC Flow logs.
GetFlowLogsIntegrationTemplateRequest:
type: object
required:
- FlowLogId
- ConfigDeliveryS3DestinationArn
- IntegrateServices
title: GetFlowLogsIntegrationTemplateRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FlowLogId:
allOf:
- $ref: '#/components/schemas/VpcFlowLogId'
- description: The ID of the flow log.
ConfigDeliveryS3DestinationArn:
allOf:
- $ref: '#/components/schemas/String'
- description: 'To store the CloudFormation template in Amazon S3, specify the location in Amazon S3.'
IntegrateServices:
allOf:
- $ref: '#/components/schemas/IntegrateServices'
- xml:
name: IntegrateService
description: Information about the service integration.
GetGroupsForCapacityReservationRequestMaxResults:
type: integer
minimum: 1
maximum: 1000
GetGroupsForCapacityReservationRequest:
type: object
required:
- CapacityReservationId
title: GetGroupsForCapacityReservationRequest
properties:
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/CapacityReservationId'
- description: 'The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token to use to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/GetGroupsForCapacityReservationRequestMaxResults'
- description: 'The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned nextToken value. This value can be between 5 and 500. If maxResults is given a larger value than 500, you receive an error.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RequestHostIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/DedicatedHostId'
- xml:
name: item
GetHostReservationPurchasePreviewRequest:
type: object
required:
- HostIdSet
- OfferingId
title: GetHostReservationPurchasePreviewRequest
properties:
HostIdSet:
allOf:
- $ref: '#/components/schemas/RequestHostIdSet'
- description: The IDs of the Dedicated Hosts with which the reservation is associated.
OfferingId:
allOf:
- $ref: '#/components/schemas/OfferingId'
- description: The offering ID of the reservation.
PurchaseSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/Purchase'
- xml:
name: item
GetInstanceTypesFromInstanceRequirementsRequest:
type: object
required:
- ArchitectureTypes
- VirtualizationTypes
- InstanceRequirements
title: GetInstanceTypesFromInstanceRequirementsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ArchitectureTypes:
allOf:
- $ref: '#/components/schemas/ArchitectureTypeSet'
- xml:
name: ArchitectureType
description: The processor architecture type.
VirtualizationTypes:
allOf:
- $ref: '#/components/schemas/VirtualizationTypeSet'
- xml:
name: VirtualizationType
description: The virtualization type.
InstanceRequirements:
allOf:
- $ref: '#/components/schemas/InstanceRequirementsRequest'
- description: The attributes required for the instance types.
MaxResults:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
InstanceTypeInfoFromInstanceRequirementsSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceTypeInfoFromInstanceRequirements'
- xml:
name: item
GetInstanceUefiDataRequest:
type: object
required:
- InstanceId
title: GetInstanceUefiDataRequest
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance from which to retrieve the UEFI data.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
IpamAddressHistoryMaxResults:
type: integer
minimum: 1
maximum: 1000
GetIpamAddressHistoryRequest:
type: object
required:
- Cidr
- IpamScopeId
title: GetIpamAddressHistoryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR.'
IpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- description: The ID of the IPAM scope that the CIDR is in.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the VPC you want your history records filtered by.
StartTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: 'The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime.'
EndTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: 'The end of the time period for which you are looking for history. If you omit this option, it will default to the current time.'
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamAddressHistoryMaxResults'
- description: The maximum number of historical results you would like returned per page. Defaults to 100.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
IpamAddressHistoryRecordSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamAddressHistoryRecord'
- xml:
name: item
GetIpamDiscoveredAccountsRequest:
type: object
required:
- IpamResourceDiscoveryId
- DiscoveryRegion
title: GetIpamDiscoveredAccountsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- description: A resource discovery ID.
DiscoveryRegion:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Web Services Region that the account information is returned from.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: Discovered account filters.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of discovered accounts to return in one page of results.
IpamDiscoveredAccountSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamDiscoveredAccount'
- xml:
name: item
GetIpamDiscoveredResourceCidrsRequest:
type: object
required:
- IpamResourceDiscoveryId
- ResourceRegion
title: GetIpamDiscoveredResourceCidrsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- description: A resource discovery ID.
ResourceRegion:
allOf:
- $ref: '#/components/schemas/String'
- description: A resource Region.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: Filters.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: Specify the pagination token from a previous request to retrieve the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of discovered resource CIDRs to return in one page of results.
IpamDiscoveredResourceCidrSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamDiscoveredResourceCidr'
- xml:
name: item
GetIpamPoolAllocationsMaxResults:
type: integer
minimum: 1000
maximum: 100000
IpamPoolAllocationId:
type: string
GetIpamPoolAllocationsRequest:
type: object
required:
- IpamPoolId
title: GetIpamPoolAllocationsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool you want to see the allocations for.
IpamPoolAllocationId:
allOf:
- $ref: '#/components/schemas/IpamPoolAllocationId'
- description: The ID of the allocation.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
MaxResults:
allOf:
- $ref: '#/components/schemas/GetIpamPoolAllocationsMaxResults'
- description: The maximum number of results you would like returned per page.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
IpamPoolAllocationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamPoolAllocation'
- xml:
name: item
GetIpamPoolCidrsRequest:
type: object
required:
- IpamPoolId
title: GetIpamPoolCidrsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool you want the CIDR for.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of results to return in the request.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
IpamPoolCidrSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamPoolCidr'
- xml:
name: item
IpamResourceType:
type: string
enum:
- vpc
- subnet
- eip
- public-ipv4-pool
- ipv6-pool
GetIpamResourceCidrsRequest:
type: object
required:
- IpamScopeId
title: GetIpamResourceCidrsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters for the request. For more information about filtering, see Filtering CLI output.'
MaxResults:
allOf:
- $ref: '#/components/schemas/IpamMaxResults'
- description: The maximum number of results to return in the request.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
IpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- description: The ID of the scope that the resource is in.
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool that the resource is in.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/IpamResourceType'
- description: The resource type.
ResourceTag:
allOf:
- $ref: '#/components/schemas/RequestIpamResourceTag'
- description: The resource tag.
ResourceOwner:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the Amazon Web Services account that owns the resource.
IpamResourceCidrSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpamResourceCidr'
- xml:
name: item
GetLaunchTemplateDataRequest:
type: object
required:
- InstanceId
title: GetLaunchTemplateDataRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
ResponseLaunchTemplateData:
type: object
properties:
KernelId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kernelId
description: 'The ID of the kernel, if applicable.'
EbsOptimized:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ebsOptimized
description: 'Indicates whether the instance is optimized for Amazon EBS I/O. '
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecification'
- xml:
name: iamInstanceProfile
description: The IAM instance profile.
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingList'
- xml:
name: blockDeviceMappingSet
description: The block device mappings.
NetworkInterfaces:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationList'
- xml:
name: networkInterfaceSet
description: The network interfaces.
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: 'The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.
The value depends on what you specified in the request. The possible values are:
If an AMI ID was specified in the request, then this is the AMI ID.
If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as true, then this is the AMI ID that the parameter is mapped to in the Parameter Store.
If a Systems Manager parameter was specified in the request, and ResolveAlias was configured as false, then this is the parameter value.
For more information, see Use a Systems Manager parameter instead of an AMI ID in the Amazon Elastic Compute Cloud User Guide.
' InstanceType: allOf: - $ref: '#/components/schemas/InstanceType' - xml: name: instanceType description: The instance type. KeyName: allOf: - $ref: '#/components/schemas/String' - xml: name: keyName description: The name of the key pair. Monitoring: allOf: - $ref: '#/components/schemas/LaunchTemplatesMonitoring' - xml: name: monitoring description: The monitoring for the instance. Placement: allOf: - $ref: '#/components/schemas/LaunchTemplatePlacement' - xml: name: placement description: The placement of the instance. RamDiskId: allOf: - $ref: '#/components/schemas/String' - xml: name: ramDiskId description: 'The ID of the RAM disk, if applicable.' DisableApiTermination: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: disableApiTermination description: 'If set totrue, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.'
InstanceInitiatedShutdownBehavior:
allOf:
- $ref: '#/components/schemas/ShutdownBehavior'
- xml:
name: instanceInitiatedShutdownBehavior
description: Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
UserData:
allOf:
- $ref: '#/components/schemas/SensitiveUserData'
- xml:
name: userData
description: 'The user data for the instance. '
TagSpecifications:
allOf:
- $ref: '#/components/schemas/LaunchTemplateTagSpecificationList'
- xml:
name: tagSpecificationSet
description: The tags that are applied to the resources that are created during instance launch.
ElasticGpuSpecifications:
allOf:
- $ref: '#/components/schemas/ElasticGpuSpecificationResponseList'
- xml:
name: elasticGpuSpecificationSet
description: The elastic GPU specification.
ElasticInferenceAccelerators:
allOf:
- $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponseList'
- xml:
name: elasticInferenceAcceleratorSet
description: ' The elastic inference accelerator for the instance. '
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: securityGroupIdSet
description: The security group IDs.
SecurityGroups:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: securityGroupSet
description: The security group names.
InstanceMarketOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMarketOptions'
- xml:
name: instanceMarketOptions
description: The market (purchasing) option for the instances.
CreditSpecification:
allOf:
- $ref: '#/components/schemas/CreditSpecification'
- xml:
name: creditSpecification
description: The credit option for CPU usage of the instance.
CpuOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateCpuOptions'
- xml:
name: cpuOptions
description: 'The CPU options for the instance. For more information, see Optimizing CPU options in the Amazon Elastic Compute Cloud User Guide.'
CapacityReservationSpecification:
allOf:
- $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationResponse'
- xml:
name: capacityReservationSpecification
description: Information about the Capacity Reservation targeting option.
LicenseSpecifications:
allOf:
- $ref: '#/components/schemas/LaunchTemplateLicenseList'
- xml:
name: licenseSet
description: The license configurations.
HibernationOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateHibernationOptions'
- xml:
name: hibernationOptions
description: 'Indicates whether an instance is configured for hibernation. For more information, see Hibernate your instance in the Amazon Elastic Compute Cloud User Guide.'
MetadataOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptions'
- xml:
name: metadataOptions
description: 'The metadata options for the instance. For more information, see Instance metadata and user data in the Amazon Elastic Compute Cloud User Guide.'
EnclaveOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateEnclaveOptions'
- xml:
name: enclaveOptions
description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
InstanceRequirements:
allOf:
- $ref: '#/components/schemas/InstanceRequirements'
- xml:
name: instanceRequirements
description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.
If you specify InstanceRequirements, you can''t specify InstanceTypes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list.
MaxResults:
allOf:
- $ref: '#/components/schemas/GetManagedPrefixListAssociationsMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
PrefixListAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrefixListAssociation'
- xml:
name: item
GetManagedPrefixListEntriesRequest:
type: object
required:
- PrefixListId
title: GetManagedPrefixListEntriesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list.
TargetVersion:
allOf:
- $ref: '#/components/schemas/Long'
- description: The version of the prefix list for which to return the entries. The default is the current version.
MaxResults:
allOf:
- $ref: '#/components/schemas/PrefixListMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
PrefixListEntrySet:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrefixListEntry'
- xml:
name: item
GetNetworkInsightsAccessScopeAnalysisFindingsRequest:
type: object
required:
- NetworkInsightsAccessScopeAnalysisId
title: GetNetworkInsightsAccessScopeAnalysisFindingsRequest
properties:
NetworkInsightsAccessScopeAnalysisId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId'
- description: The ID of the Network Access Scope analysis.
MaxResults:
allOf:
- $ref: '#/components/schemas/NetworkInsightsMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetNetworkInsightsAccessScopeContentRequest:
type: object
required:
- NetworkInsightsAccessScopeId
title: GetNetworkInsightsAccessScopeContentRequest
properties:
NetworkInsightsAccessScopeId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- description: The ID of the Network Access Scope.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetPasswordDataRequest:
type: object
required:
- InstanceId
title: GetPasswordDataRequest
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the Windows instance.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetReservedInstancesExchangeQuoteRequest:
type: object
required:
- ReservedInstanceIds
title: GetReservedInstancesExchangeQuoteRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReservedInstanceIds:
allOf:
- $ref: '#/components/schemas/ReservedInstanceIdSet'
- xml:
name: ReservedInstanceId
description: The IDs of the Convertible Reserved Instances to exchange.
TargetConfigurations:
allOf:
- $ref: '#/components/schemas/TargetConfigurationRequestSet'
- xml:
name: TargetConfiguration
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
description: Contains the parameters for GetReservedInstanceExchangeQuote.
ReservationValue:
type: object
properties:
HourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hourlyPrice
description: The hourly rate of the reservation.
RemainingTotalValue:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: remainingTotalValue
description: The balance of the total value (the sum of remainingUpfrontValue + hourlyPrice * number of hours remaining).
RemainingUpfrontValue:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: remainingUpfrontValue
description: The remaining upfront cost of the reservation.
description: The cost associated with the Reserved Instance.
ReservedInstanceReservationValueSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservedInstanceReservationValue'
- xml:
name: item
TargetReservationValueSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TargetReservationValue'
- xml:
name: item
GetSerialConsoleAccessStatusRequest:
type: object
title: GetSerialConsoleAccessStatusRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceTypes:
type: array
items:
$ref: '#/components/schemas/String'
minItems: 0
maxItems: 1000
SpotPlacementScoresTargetCapacity:
type: integer
minimum: 1
maximum: 2000000000
RegionNames:
type: array
items:
$ref: '#/components/schemas/String'
minItems: 0
maxItems: 10
InstanceRequirementsWithMetadataRequest:
type: object
properties:
ArchitectureTypes:
allOf:
- $ref: '#/components/schemas/ArchitectureTypeSet'
- xml:
name: ArchitectureType
description: The architecture type.
VirtualizationTypes:
allOf:
- $ref: '#/components/schemas/VirtualizationTypeSet'
- xml:
name: VirtualizationType
description: The virtualization type.
InstanceRequirements:
allOf:
- $ref: '#/components/schemas/InstanceRequirementsRequest'
- description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.'
description: 'The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadataRequest, you can''t specify InstanceTypes.
The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an m3.xlarge with and without instance storage), the returned placement score will always be low.
If you specify InstanceTypes, you can''t specify InstanceRequirementsWithMetadata.
The unit for the target capacity.
Default: units (translates to number of instances)
Specify true so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions.
A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone.
' RegionNames: allOf: - $ref: '#/components/schemas/RegionNames' - xml: name: RegionName description: 'The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,us-east-1.'
InstanceRequirementsWithMetadata:
allOf:
- $ref: '#/components/schemas/InstanceRequirementsWithMetadataRequest'
- description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirementsWithMetadata, you can''t specify InstanceTypes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaxResults:
allOf:
- $ref: '#/components/schemas/SpotPlacementScoresMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
SpotPlacementScores:
type: array
items:
allOf:
- $ref: '#/components/schemas/SpotPlacementScore'
- xml:
name: item
GetSubnetCidrReservationsMaxResults:
type: integer
minimum: 5
maximum: 1000
GetSubnetCidrReservationsRequest:
type: object
required:
- SubnetId
title: GetSubnetCidrReservationsRequest
properties:
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
reservationType - The type of reservation (prefix | explicit).
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
MaxResults:
allOf:
- $ref: '#/components/schemas/GetSubnetCidrReservationsMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
SubnetCidrReservationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetCidrReservation'
- xml:
name: item
GetTransitGatewayAttachmentPropagationsRequest:
type: object
required:
- TransitGatewayAttachmentId
title: GetTransitGatewayAttachmentPropagationsRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayAttachmentPropagationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentPropagation'
- xml:
name: item
GetTransitGatewayMulticastDomainAssociationsRequest:
type: object
required:
- TransitGatewayMulticastDomainId
title: GetTransitGatewayMulticastDomainAssociationsRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The type of resource. The valid value is: vpc.
state - The state of the subnet association. Valid values are associated | associating | disassociated | disassociating.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastDomainAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainAssociation'
- xml:
name: item
GetTransitGatewayPolicyTableAssociationsRequest:
type: object
required:
- TransitGatewayPolicyTableId
title: GetTransitGatewayPolicyTableAssociationsRequest
properties:
TransitGatewayPolicyTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- description: The ID of the transit gateway policy table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters associated with the transit gateway policy table.
MaxResults:
allOf:
- $ref: '#/components/schemas/TransitGatewayMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPolicyTableAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableAssociation'
- xml:
name: item
GetTransitGatewayPolicyTableEntriesRequest:
type: object
required:
- TransitGatewayPolicyTableId
title: GetTransitGatewayPolicyTableEntriesRequest
properties:
TransitGatewayPolicyTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableId'
- description: The ID of the transit gateway policy table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: The filters associated with the transit gateway policy table.
MaxResults:
allOf:
- $ref: '#/components/schemas/TransitGatewayMaxResults'
- description: 'The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPolicyTableEntryList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyTableEntry'
- xml:
name: item
GetTransitGatewayPrefixListReferencesRequest:
type: object
required:
- TransitGatewayRouteTableId
title: GetTransitGatewayPrefixListReferencesRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
attachment.resource-id - The ID of the resource for the attachment.
attachment.resource-type - The type of resource for the attachment. Valid values are vpc | vpn | direct-connect-gateway | peering.
attachment.transit-gateway-attachment-id - The ID of the attachment.
is-blackhole - Whether traffic matching the route is blocked (true | false).
prefix-list-id - The ID of the prefix list.
prefix-list-owner-id - The ID of the owner of the prefix list.
state - The state of the prefix list reference (pending | available | modifying | deleting).
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayPrefixListReferenceSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayPrefixListReference'
- xml:
name: item
GetTransitGatewayRouteTableAssociationsRequest:
type: object
required:
- TransitGatewayRouteTableId
title: GetTransitGatewayRouteTableAssociationsRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTableAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAssociation'
- xml:
name: item
GetTransitGatewayRouteTablePropagationsRequest:
type: object
required:
- TransitGatewayRouteTableId
title: GetTransitGatewayRouteTablePropagationsRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteTablePropagationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTablePropagation'
- xml:
name: item
GetVerifiedAccessEndpointPolicyRequest:
type: object
required:
- VerifiedAccessEndpointId
title: GetVerifiedAccessEndpointPolicyRequest
properties:
VerifiedAccessEndpointId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointId'
- description: The ID of the Verified Access endpoint.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GetVerifiedAccessGroupPolicyRequest:
type: object
required:
- VerifiedAccessGroupId
title: GetVerifiedAccessGroupPolicyRequest
properties:
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- description: The ID of the Verified Access group.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpnConnectionDeviceTypeId:
type: string
GetVpnConnectionDeviceSampleConfigurationRequest:
type: object
required:
- VpnConnectionId
- VpnConnectionDeviceTypeId
title: GetVpnConnectionDeviceSampleConfigurationRequest
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: The VpnConnectionId specifies the Site-to-Site VPN connection used for the sample configuration.
VpnConnectionDeviceTypeId:
allOf:
- $ref: '#/components/schemas/VpnConnectionDeviceTypeId'
- description: Device identifier provided by the GetVpnConnectionDeviceTypes API.
InternetKeyExchangeVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: ikev1 or ikev2.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpnConnectionDeviceSampleConfiguration:
type: string
format: password
GetVpnConnectionDeviceTypesRequest:
type: object
title: GetVpnConnectionDeviceTypesRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/GVCDMaxResults'
- description: 'The maximum number of results returned by GetVpnConnectionDeviceTypes in paginated output. When this parameter is used, GetVpnConnectionDeviceTypes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another GetVpnConnectionDeviceTypes request with the returned NextToken value. This value can be between 200 and 1000. If this parameter is not used, then GetVpnConnectionDeviceTypes returns all results.'
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: 'The NextToken value returned from a previous paginated GetVpnConnectionDeviceTypes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpnConnectionDeviceTypeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpnConnectionDeviceType'
- xml:
name: item
GetVpnTunnelReplacementStatusRequest:
type: object
required:
- VpnConnectionId
- VpnTunnelOutsideIpAddress
title: GetVpnTunnelReplacementStatusRequest
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: 'The ID of the Site-to-Site VPN connection. '
VpnTunnelOutsideIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The external IP address of the VPN tunnel.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MaintenanceDetails:
type: object
properties:
PendingMaintenance:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: pendingMaintenance
description: Verify existence of a pending maintenance.
MaintenanceAutoAppliedAfter:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: maintenanceAutoAppliedAfter
description: The timestamp after which Amazon Web Services will automatically apply maintenance.
LastMaintenanceApplied:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: lastMaintenanceApplied
description: Timestamp of last applied maintenance.
description: Details for Site-to-Site VPN tunnel endpoint maintenance events.
GpuDeviceCount:
type: integer
GpuDeviceName:
type: string
GpuDeviceManufacturerName:
type: string
GpuDeviceMemoryInfo:
type: object
properties:
SizeInMiB:
allOf:
- $ref: '#/components/schemas/GpuDeviceMemorySize'
- xml:
name: sizeInMiB
description: 'The size of the memory available to the GPU accelerator, in MiB.'
description: Describes the memory available to the GPU accelerator.
GpuDeviceInfo:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/GpuDeviceName'
- xml:
name: name
description: The name of the GPU accelerator.
Manufacturer:
allOf:
- $ref: '#/components/schemas/GpuDeviceManufacturerName'
- xml:
name: manufacturer
description: The manufacturer of the GPU accelerator.
Count:
allOf:
- $ref: '#/components/schemas/GpuDeviceCount'
- xml:
name: count
description: The number of GPUs for the instance type.
MemoryInfo:
allOf:
- $ref: '#/components/schemas/GpuDeviceMemoryInfo'
- xml:
name: memoryInfo
description: Describes the memory available to the GPU accelerator.
description: Describes the GPU accelerators for the instance type.
GpuDeviceInfoList:
type: array
items:
allOf:
- $ref: '#/components/schemas/GpuDeviceInfo'
- xml:
name: item
GpuDeviceMemorySize:
type: integer
totalGpuMemory:
type: integer
GpuInfo:
type: object
properties:
Gpus:
allOf:
- $ref: '#/components/schemas/GpuDeviceInfoList'
- xml:
name: gpus
description: Describes the GPU accelerators for the instance type.
TotalGpuMemoryInMiB:
allOf:
- $ref: '#/components/schemas/totalGpuMemory'
- xml:
name: totalGpuMemoryInMiB
description: 'The total size of the memory for the GPU accelerators for the instance type, in MiB.'
description: Describes the GPU accelerators for the instance type.
GroupIdentifier:
type: object
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupName
description: The name of the security group.
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the security group.
description: Describes a security group.
SecurityGroupIdentifier:
type: object
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the security group.
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupName
description: The name of the security group.
description: Describes a security group.
GroupIdentifierSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdentifier'
- xml:
name: item
HibernationFlag:
type: boolean
HibernationOptions:
type: object
properties:
Configured:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: configured
description: 'If true, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.'
description: 'Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.'
HibernationOptionsRequest:
type: object
properties:
Configured:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Set to true to enable your instance for hibernation.
Default: false
The event type.
error - An error with the Spot Fleet request.
fleetRequestChange - A change in the status or configuration of the Spot Fleet request.
instanceChange - An instance was launched or terminated.
Information - An informational event.
m5.large. If the host supports multiple instance types, no instanceType is returned.'
InstanceFamily:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceFamily
description: 'The instance family supported by the Dedicated Host. For example, m5.'
Sockets:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: sockets
description: The number of sockets on the Dedicated Host.
TotalVCpus:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalVCpus
description: The total number of vCPUs on the Dedicated Host.
description: Describes the properties of a Dedicated Host.
HostInstanceList:
type: array
items:
allOf:
- $ref: '#/components/schemas/HostInstance'
- xml:
name: item
Host:
type: object
properties:
AutoPlacement:
allOf:
- $ref: '#/components/schemas/AutoPlacement'
- xml:
name: autoPlacement
description: Whether auto-placement is on or off.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone of the Dedicated Host.
AvailableCapacity:
allOf:
- $ref: '#/components/schemas/AvailableCapacity'
- xml:
name: availableCapacity
description: Information about the instances running on the Dedicated Host.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
HostId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hostId
description: The ID of the Dedicated Host.
HostProperties:
allOf:
- $ref: '#/components/schemas/HostProperties'
- xml:
name: hostProperties
description: The hardware specifications of the Dedicated Host.
HostReservationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hostReservationId
description: The reservation ID of the Dedicated Host. This returns a null response if the Dedicated Host doesn't have an associated reservation.
Instances:
allOf:
- $ref: '#/components/schemas/HostInstanceList'
- xml:
name: instances
description: The IDs and instance type that are currently running on the Dedicated Host.
State:
allOf:
- $ref: '#/components/schemas/AllocationState'
- xml:
name: state
description: The Dedicated Host's state.
AllocationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: allocationTime
description: The time that the Dedicated Host was allocated.
ReleaseTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: releaseTime
description: The time that the Dedicated Host was released.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the Dedicated Host.
HostRecovery:
allOf:
- $ref: '#/components/schemas/HostRecovery'
- xml:
name: hostRecovery
description: Indicates whether host recovery is enabled or disabled for the Dedicated Host.
AllowsMultipleInstanceTypes:
allOf:
- $ref: '#/components/schemas/AllowsMultipleInstanceTypes'
- xml:
name: allowsMultipleInstanceTypes
description: 'Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is on, the Dedicated Host supports multiple instance types in the instance family. If the value is off, the Dedicated Host supports a single instance type only.'
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the Dedicated Host.
AvailabilityZoneId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZoneId
description: The ID of the Availability Zone in which the Dedicated Host is allocated.
MemberOfServiceLinkedResourceGroup:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: memberOfServiceLinkedResourceGroup
description: 'Indicates whether the Dedicated Host is in a host resource group. If memberOfServiceLinkedResourceGroup is true, the host is in a host resource group; otherwise, it is not.'
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: The Amazon Resource Name (ARN) of the Amazon Web Services Outpost on which the Dedicated Host is allocated.
HostMaintenance:
allOf:
- $ref: '#/components/schemas/HostMaintenance'
- xml:
name: hostMaintenance
description: Indicates whether host maintenance is enabled or disabled for the Dedicated Host.
AssetId:
allOf:
- $ref: '#/components/schemas/AssetId'
- xml:
name: assetId
description: The ID of the Outpost hardware asset on which the Dedicated Host is allocated.
description: Describes the properties of the Dedicated Host.
HostInstance:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of instance that is running on the Dedicated Host.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: 'The instance type (for example, m3.medium) of the running instance.'
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the instance.
description: Describes an instance running on a Dedicated Host.
PaymentOption:
type: string
enum:
- AllUpfront
- PartialUpfront
- NoUpfront
HostOffering:
type: object
properties:
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: The currency of the offering.
Duration:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: duration
description: The duration of the offering (in seconds).
HourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hourlyPrice
description: The hourly price of the offering.
InstanceFamily:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceFamily
description: The instance family of the offering.
OfferingId:
allOf:
- $ref: '#/components/schemas/OfferingId'
- xml:
name: offeringId
description: The ID of the offering.
PaymentOption:
allOf:
- $ref: '#/components/schemas/PaymentOption'
- xml:
name: paymentOption
description: The available payment option.
UpfrontPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: upfrontPrice
description: The upfront price of the offering. Does not apply to No Upfront offerings.
description: Details about the Dedicated Host Reservation offering.
ResponseHostIdSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: item
ReservationState:
type: string
enum:
- payment-pending
- payment-failed
- active
- retired
HostReservation:
type: object
properties:
Count:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: count
description: The number of Dedicated Hosts the reservation is associated with.
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency in which the upfrontPrice and hourlyPrice amounts are specified. At this time, the only supported currency is USD.'
Duration:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: duration
description: 'The length of the reservation''s term, specified in seconds. Can be 31536000 (1 year) | 94608000 (3 years).'
End:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: end
description: The date and time that the reservation ends.
HostIdSet:
allOf:
- $ref: '#/components/schemas/ResponseHostIdSet'
- xml:
name: hostIdSet
description: The IDs of the Dedicated Hosts associated with the reservation.
HostReservationId:
allOf:
- $ref: '#/components/schemas/HostReservationId'
- xml:
name: hostReservationId
description: The ID of the reservation that specifies the associated Dedicated Hosts.
HourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hourlyPrice
description: The hourly price of the reservation.
InstanceFamily:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceFamily
description: The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.
OfferingId:
allOf:
- $ref: '#/components/schemas/OfferingId'
- xml:
name: offeringId
description: The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.
PaymentOption:
allOf:
- $ref: '#/components/schemas/PaymentOption'
- xml:
name: paymentOption
description: The payment option selected for this reservation.
Start:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: start
description: The date and time that the reservation started.
State:
allOf:
- $ref: '#/components/schemas/ReservationState'
- xml:
name: state
description: The state of the reservation.
UpfrontPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: upfrontPrice
description: The upfront price of the reservation.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the Dedicated Host Reservation.
description: Details about the Dedicated Host Reservation and associated Dedicated Hosts.
HostTenancy:
type: string
enum:
- dedicated
- host
Hour:
type: integer
minimum: 0
maximum: 23
HypervisorType:
type: string
enum:
- ovm
- xen
IKEVersionsListValue:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The IKE version.
description: The internet key exchange (IKE) version permitted for the VPN tunnel.
IKEVersionsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/IKEVersionsListValue'
- xml:
name: item
IKEVersionsRequestListValue:
type: object
properties:
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The IKE version.
description: The IKE version that is permitted for the VPN tunnel.
IamInstanceProfile:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) of the instance profile.
Id:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: id
description: The ID of the instance profile.
description: Describes an IAM instance profile.
IamInstanceProfileAssociationState:
type: string
enum:
- associating
- associated
- disassociating
- disassociated
IdFormat:
type: object
properties:
Deadline:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: deadline
description: 'The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.'
Resource:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resource
description: The type of resource.
UseLongIds:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: useLongIds
description: Indicates whether longer IDs (17-character IDs) are enabled for the resource.
description: Describes the ID format for a resource.
ImageTypeValues:
type: string
enum:
- machine
- kernel
- ramdisk
ImageState:
type: string
enum:
- pending
- available
- invalid
- deregistered
- transient
- failed
- error
StateReason:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: The reason code for the state change.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: 'The message for the state change.
Server.InsufficientInstanceCapacity: There was insufficient capacity available to satisfy the launch request.
Server.InternalError: An internal error caused the instance to terminate during launch.
Server.ScheduledStop: The instance was stopped due to a scheduled retirement.
Server.SpotInstanceShutdown: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Server.SpotInstanceTermination: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
Client.InstanceInitiatedShutdown: The instance was shut down using the shutdown -h command from the instance.
Client.InstanceTerminated: The instance was terminated or rebooted during AMI creation.
Client.InternalError: A client error caused the instance to terminate during launch.
Client.InvalidSnapshot.NotFound: The specified snapshot was not found.
Client.UserInitiatedHibernate: Hibernation was initiated on the instance.
Client.UserInitiatedShutdown: The instance was shut down using the Amazon EC2 API.
Client.VolumeLimitExceeded: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.
true if this image has public launch permissions or false if it has only implicit and explicit launch permissions.
KernelId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: kernelId
description: 'The kernel associated with the image, if any. Only applicable for machine images.'
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageOwnerId
description: The ID of the Amazon Web Services account that owns the image.
Platform:
allOf:
- $ref: '#/components/schemas/PlatformValues'
- xml:
name: platform
description: 'This value is set to windows for Windows AMIs; otherwise, it is blank.'
PlatformDetails:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: platformDetails
description: 'The platform details associated with the billing code of the AMI. For more information, see Understand AMI billing information in the Amazon EC2 User Guide.'
UsageOperation:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: usageOperation
description: 'The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. usageOperation corresponds to the lineitem/Operation column on your Amazon Web Services Cost and Usage Report and in the Amazon Web Services Price List API. You can view these fields on the Instances or AMIs pages in the Amazon EC2 console, or in the responses that are returned by the DescribeImages command in the Amazon EC2 API, or the describe-images command in the CLI.'
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeList'
- xml:
name: productCodes
description: Any product codes associated with the AMI.
RamdiskId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ramdiskId
description: 'The RAM disk associated with the image, if any. Only applicable for machine images.'
State:
allOf:
- $ref: '#/components/schemas/ImageState'
- xml:
name: imageState
description: 'The current state of the AMI. If the state is available, the image is successfully registered and can be used to launch an instance.'
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/BlockDeviceMappingList'
- xml:
name: blockDeviceMapping
description: Any block device mapping entries.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the AMI that was provided during image creation.
EnaSupport:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enaSupport
description: Specifies whether enhanced networking with ENA is enabled.
Hypervisor:
allOf:
- $ref: '#/components/schemas/HypervisorType'
- xml:
name: hypervisor
description: The hypervisor type of the image.
ImageOwnerAlias:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageOwnerAlias
description: 'The Amazon Web Services account alias (for example, amazon, self) or the Amazon Web Services account ID of the AMI owner.'
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the AMI that was provided during image creation.
RootDeviceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: rootDeviceName
description: 'The device name of the root device volume (for example, /dev/sda1).'
RootDeviceType:
allOf:
- $ref: '#/components/schemas/DeviceType'
- xml:
name: rootDeviceType
description: The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sriovNetSupport
description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason:
allOf:
- $ref: '#/components/schemas/StateReason'
- xml:
name: stateReason
description: The reason for the state change.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the image.
VirtualizationType:
allOf:
- $ref: '#/components/schemas/VirtualizationType'
- xml:
name: virtualizationType
description: The type of virtualization of the AMI.
BootMode:
allOf:
- $ref: '#/components/schemas/BootModeValues'
- xml:
name: bootMode
description: 'The boot mode of the image. For more information, see Boot modes in the Amazon EC2 User Guide.'
TpmSupport:
allOf:
- $ref: '#/components/schemas/TpmSupportValues'
- xml:
name: tpmSupport
description: 'If the image is configured for NitroTPM support, the value is v2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.'
DeprecationTime:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deprecationTime
description: 'The date and time to deprecate the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.'
ImdsSupport:
allOf:
- $ref: '#/components/schemas/ImdsSupportValues'
- xml:
name: imdsSupport
description: 'If v2.0, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.'
description: Describes an image.
ImageDiskContainerList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImageDiskContainer'
- xml:
name: item
ImageRecycleBinInfo:
type: object
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: imageId
description: The ID of the AMI.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the AMI.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the AMI.
RecycleBinEnterTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: recycleBinEnterTime
description: The date and time when the AMI entered the Recycle Bin.
RecycleBinExitTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: recycleBinExitTime
description: The date and time when the AMI is to be permanently deleted from the Recycle Bin.
description: Information about an AMI that is currently in the Recycle Bin.
ImageRecycleBinInfoList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImageRecycleBinInfo'
- xml:
name: item
ImportClientVpnClientCertificateRevocationListRequest:
type: object
required:
- ClientVpnEndpointId
- CertificateRevocationList
title: ImportClientVpnClientCertificateRevocationListRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint to which the client certificate revocation list applies.
CertificateRevocationList:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the Client VPN Administrator Guide.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ImportImageLicenseConfigurationResponse:
type: object
properties:
LicenseConfigurationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: licenseConfigurationArn
description: The ARN of a license configuration.
description: ' The response information for license configurations.'
ImportImageLicenseSpecificationListRequest:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportImageLicenseConfigurationRequest'
- xml:
name: item
ImportImageLicenseSpecificationListResponse:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportImageLicenseConfigurationResponse'
- xml:
name: item
ImportImageRequest:
type: object
title: ImportImageRequest
properties:
Architecture:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The architecture of the virtual machine.
Valid values: i386 | x86_64
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
Hypervisor:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The target hypervisor platform.
Valid values: xen
An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the AMI is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' LicenseType: allOf: - $ref: '#/components/schemas/String' - description: 'The license type to be used for the Amazon Machine Image (AMI) after importing.
Specify AWS to replace the source-system license with an Amazon Web Services license or BYOL to retain the source-system license. Leaving this parameter undefined is the same as choosing AWS when importing a Windows Server operating system, and the same as choosing BYOL when importing a Windows client operating system (such as Windows 10) or a Linux operating system.
To use BYOL, you must have existing licenses with rights to use these licenses in a third party cloud, such as Amazon Web Services. For more information, see Prerequisites in the VM Import/Export User Guide.
The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform.
Valid values: Windows | Linux
The architecture of the virtual machine.
Valid values: i386 | x86_64 | arm64
The target hypervisor for the import task.
Valid values: xen
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LaunchSpecification:
allOf:
- $ref: '#/components/schemas/ImportInstanceLaunchSpecification'
- xml:
name: launchSpecification
description: The launch specification.
Platform:
allOf:
- $ref: '#/components/schemas/PlatformValues'
- xml:
name: platform
description: The instance operating system.
ImportInstanceVolumeDetailSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ImportInstanceVolumeDetailItem'
- xml:
name: item
ImportInstanceVolumeDetailItem:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone where the resulting instance will reside.
BytesConverted:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: bytesConverted
description: The number of bytes converted so far.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the task.
Image:
allOf:
- $ref: '#/components/schemas/DiskImageDescription'
- xml:
name: image
description: The image.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: The status of the import of this particular disk image.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: The status information or errors related to the disk image.
Volume:
allOf:
- $ref: '#/components/schemas/DiskImageVolumeDescription'
- xml:
name: volume
description: The volume.
description: Describes an import volume task.
ImportKeyPairRequest:
type: object
required:
- KeyName
- PublicKeyMaterial
title: ImportKeyPairRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
KeyName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: keyName
description: A unique name for the key pair.
PublicKeyMaterial:
allOf:
- $ref: '#/components/schemas/Blob'
- xml:
name: publicKeyMaterial
description: 'The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the imported key pair.
SnapshotDiskContainer:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the disk image being imported.
Format:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The format of the disk image being imported.
Valid values: VHD | VMDK | RAW
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.'
KmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- description: 'An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The KMS key identifier may be provided in any of the following formats:
Key ID
Key alias
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the key namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, the alias namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
' RoleName: allOf: - $ref: '#/components/schemas/String' - description: 'The name of the role to use when not using the default role, ''vmimport''.' TagSpecifications: allOf: - $ref: '#/components/schemas/TagSpecificationList' - xml: name: TagSpecification description: The tags to apply to the import snapshot task during creation. SnapshotTaskDetail: type: object properties: Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: The description of the snapshot. DiskImageSize: allOf: - $ref: '#/components/schemas/Double' - xml: name: diskImageSize description: 'The size of the disk in the snapshot, in GiB.' Encrypted: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: encrypted description: Indicates whether the snapshot is encrypted. Format: allOf: - $ref: '#/components/schemas/String' - xml: name: format description: The format of the disk image from which the snapshot is created. KmsKeyId: allOf: - $ref: '#/components/schemas/String' - xml: name: kmsKeyId description: The identifier for the KMS key that was used to create the encrypted snapshot. Progress: allOf: - $ref: '#/components/schemas/String' - xml: name: progress description: The percentage of completion for the import snapshot task. SnapshotId: allOf: - $ref: '#/components/schemas/String' - xml: name: snapshotId description: The snapshot ID of the disk being imported. Status: allOf: - $ref: '#/components/schemas/String' - xml: name: status description: A brief status for the import snapshot task. StatusMessage: allOf: - $ref: '#/components/schemas/String' - xml: name: statusMessage description: A detailed status message for the import snapshot task. Url: allOf: - $ref: '#/components/schemas/SensitiveUrl' - xml: name: url description: The URL of the disk image from which the snapshot is created. UserBucket: allOf: - $ref: '#/components/schemas/UserBucketDetails' - xml: name: userBucket description: The Amazon S3 bucket for the disk image. description: Details about the import snapshot task. ImportSnapshotTask: type: object properties: Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: A description of the import snapshot task. ImportTaskId: allOf: - $ref: '#/components/schemas/String' - xml: name: importTaskId description: The ID of the import snapshot task. SnapshotTaskDetail: allOf: - $ref: '#/components/schemas/SnapshotTaskDetail' - xml: name: snapshotTaskDetail description: Describes an import snapshot task. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: The tags for the import snapshot task. description: Describes an import snapshot task. ImportVolumeRequest: type: object required: - AvailabilityZone - Image - Volume title: ImportVolumeRequest properties: AvailabilityZone: allOf: - $ref: '#/components/schemas/String' - xml: name: availabilityZone description: The Availability Zone for the resulting EBS volume. Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: A description of the volume. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
Image:
allOf:
- $ref: '#/components/schemas/DiskImageDetail'
- xml:
name: image
description: The disk image.
Volume:
allOf:
- $ref: '#/components/schemas/VolumeDetail'
- xml:
name: volume
description: The volume size.
InferenceDeviceInfoList:
type: array
items:
$ref: '#/components/schemas/InferenceDeviceInfo'
totalInferenceMemory:
type: integer
InferenceAcceleratorInfo:
type: object
properties:
Accelerators:
allOf:
- $ref: '#/components/schemas/InferenceDeviceInfoList'
- xml:
name: accelerators
description: Describes the Inference accelerators for the instance type.
TotalInferenceMemoryInMiB:
allOf:
- $ref: '#/components/schemas/totalInferenceMemory'
- xml:
name: totalInferenceMemoryInMiB
description: 'The total size of the memory for the inference accelerators for the instance type, in MiB.'
description: Describes the Inference accelerators for the instance type.
InferenceDeviceCount:
type: integer
InferenceDeviceName:
type: string
InferenceDeviceManufacturerName:
type: string
InferenceDeviceMemoryInfo:
type: object
properties:
SizeInMiB:
allOf:
- $ref: '#/components/schemas/InferenceDeviceMemorySize'
- xml:
name: sizeInMiB
description: 'The size of the memory available to the inference accelerator, in MiB.'
description: Describes the memory available to the inference accelerator.
InferenceDeviceInfo:
type: object
properties:
Count:
allOf:
- $ref: '#/components/schemas/InferenceDeviceCount'
- xml:
name: count
description: The number of Inference accelerators for the instance type.
Name:
allOf:
- $ref: '#/components/schemas/InferenceDeviceName'
- xml:
name: name
description: The name of the Inference accelerator.
Manufacturer:
allOf:
- $ref: '#/components/schemas/InferenceDeviceManufacturerName'
- xml:
name: manufacturer
description: The manufacturer of the Inference accelerator.
MemoryInfo:
allOf:
- $ref: '#/components/schemas/InferenceDeviceMemoryInfo'
- xml:
name: memoryInfo
description: Describes the memory available to the inference accelerator.
description: Describes the Inference accelerators for the instance type.
InferenceDeviceMemorySize:
type: integer
Monitoring:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/MonitoringState'
- xml:
name: state
description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.'
description: Describes the monitoring of an instance.
InstanceState:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: code
description: 'The state of the instance as a 16-bit unsigned integer.
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.
The valid values for instance-state-code will all be in the range of the low byte and they are:
0 : pending
16 : running
32 : shutting-down
48 : terminated
64 : stopping
80 : stopped
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.
' Name: allOf: - $ref: '#/components/schemas/InstanceStateName' - xml: name: name description: The current state of the instance. description: Describes the current state of an instance. InstanceBlockDeviceMappingList: type: array items: allOf: - $ref: '#/components/schemas/InstanceBlockDeviceMapping' - xml: name: item InstanceLifecycleType: type: string enum: - spot - scheduled InstanceNetworkInterfaceList: type: array items: allOf: - $ref: '#/components/schemas/InstanceNetworkInterface' - xml: name: item LicenseList: type: array items: allOf: - $ref: '#/components/schemas/LicenseConfiguration' - xml: name: item InstanceMetadataOptionsResponse: type: object properties: State: allOf: - $ref: '#/components/schemas/InstanceMetadataOptionsState' - xml: name: state description:The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
IMDSv2 uses token-backed sessions. Indicates whether the use of HTTP tokens is optional (in other words, indicates whether the use of IMDSv2 is optional) or required (in other words, indicates whether the use of IMDSv2 is required).
optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' HttpEndpoint: allOf: - $ref: '#/components/schemas/InstanceMetadataEndpointState' - xml: name: httpEndpoint description: 'Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.
If the value is disabled, you cannot access your instance metadata.
Windows for Windows instances; otherwise blank.
PrivateDnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateDnsName
description: '[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the running state.
The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you''ve enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.
' PrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIpAddress description: The private IPv4 address assigned to the instance. ProductCodes: allOf: - $ref: '#/components/schemas/ProductCodeList' - xml: name: productCodes description: 'The product codes attached to this instance, if applicable.' PublicDnsName: allOf: - $ref: '#/components/schemas/String' - xml: name: dnsName description: '[IPv4 only] The public DNS name assigned to the instance. This name is not available until the instance enters therunning state. This name is only available if you''ve enabled DNS hostnames for your VPC.'
PublicIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipAddress
description: 'The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.
' RamdiskId: allOf: - $ref: '#/components/schemas/String' - xml: name: ramdiskId description: 'The RAM disk associated with this instance, if applicable.' State: allOf: - $ref: '#/components/schemas/InstanceState' - xml: name: instanceState description: The current state of the instance. StateTransitionReason: allOf: - $ref: '#/components/schemas/String' - xml: name: reason description: The reason for the most recent state transition. This might be an empty string. SubnetId: allOf: - $ref: '#/components/schemas/String' - xml: name: subnetId description: The ID of the subnet in which the instance is running. VpcId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcId description: The ID of the VPC in which the instance is running. Architecture: allOf: - $ref: '#/components/schemas/ArchitectureValues' - xml: name: architecture description: The architecture of the image. BlockDeviceMappings: allOf: - $ref: '#/components/schemas/InstanceBlockDeviceMappingList' - xml: name: blockDeviceMapping description: Any block device mapping entries for the instance. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'The idempotency token you provided when you launched the instance, if applicable.' EbsOptimized: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: ebsOptimized description: Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. EnaSupport: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: enaSupport description: Specifies whether enhanced networking with ENA is enabled. Hypervisor: allOf: - $ref: '#/components/schemas/HypervisorType' - xml: name: hypervisor description: The hypervisor type of the instance. The valuexen is used for both Xen and Nitro hypervisors.
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfile'
- xml:
name: iamInstanceProfile
description: 'The IAM instance profile associated with the instance, if applicable.'
InstanceLifecycle:
allOf:
- $ref: '#/components/schemas/InstanceLifecycleType'
- xml:
name: instanceLifecycle
description: Indicates whether this is a Spot Instance or a Scheduled Instance.
ElasticGpuAssociations:
allOf:
- $ref: '#/components/schemas/ElasticGpuAssociationList'
- xml:
name: elasticGpuAssociationSet
description: The Elastic GPU associated with the instance.
ElasticInferenceAcceleratorAssociations:
allOf:
- $ref: '#/components/schemas/ElasticInferenceAcceleratorAssociationList'
- xml:
name: elasticInferenceAcceleratorAssociationSet
description: The elastic inference accelerator associated with the instance.
NetworkInterfaces:
allOf:
- $ref: '#/components/schemas/InstanceNetworkInterfaceList'
- xml:
name: networkInterfaceSet
description: The network interfaces for the instance.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: The Amazon Resource Name (ARN) of the Outpost.
RootDeviceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: rootDeviceName
description: 'The device name of the root device volume (for example, /dev/sda1).'
RootDeviceType:
allOf:
- $ref: '#/components/schemas/DeviceType'
- xml:
name: rootDeviceType
description: The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.
SecurityGroups:
allOf:
- $ref: '#/components/schemas/GroupIdentifierList'
- xml:
name: groupSet
description: The security groups for the instance.
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: sourceDestCheck
description: Indicates whether source/destination checking is enabled.
SpotInstanceRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotInstanceRequestId
description: 'If the request is a Spot Instance request, the ID of the request.'
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sriovNetSupport
description: Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.
StateReason:
allOf:
- $ref: '#/components/schemas/StateReason'
- xml:
name: stateReason
description: The reason for the most recent state transition.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the instance.
VirtualizationType:
allOf:
- $ref: '#/components/schemas/VirtualizationType'
- xml:
name: virtualizationType
description: The virtualization type of the instance.
CpuOptions:
allOf:
- $ref: '#/components/schemas/CpuOptions'
- xml:
name: cpuOptions
description: The CPU options for the instance.
CapacityReservationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: capacityReservationId
description: The ID of the Capacity Reservation.
CapacityReservationSpecification:
allOf:
- $ref: '#/components/schemas/CapacityReservationSpecificationResponse'
- xml:
name: capacityReservationSpecification
description: Information about the Capacity Reservation targeting option.
HibernationOptions:
allOf:
- $ref: '#/components/schemas/HibernationOptions'
- xml:
name: hibernationOptions
description: Indicates whether the instance is enabled for hibernation.
Licenses:
allOf:
- $ref: '#/components/schemas/LicenseList'
- xml:
name: licenseSet
description: The license configurations for the instance.
MetadataOptions:
allOf:
- $ref: '#/components/schemas/InstanceMetadataOptionsResponse'
- xml:
name: metadataOptions
description: The metadata options for the instance.
EnclaveOptions:
allOf:
- $ref: '#/components/schemas/EnclaveOptions'
- xml:
name: enclaveOptions
description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
BootMode:
allOf:
- $ref: '#/components/schemas/BootModeValues'
- xml:
name: bootMode
description: 'The boot mode that was specified by the AMI. If the value is uefi-preferred, the AMI supports both UEFI and Legacy BIOS. The currentInstanceBootMode parameter is the boot mode that is used to boot the instance at launch or start.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
' PlatformDetails: allOf: - $ref: '#/components/schemas/String' - xml: name: platformDetails description: 'The platform details value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.' UsageOperation: allOf: - $ref: '#/components/schemas/String' - xml: name: usageOperation description: 'The usage operation value for the instance. For more information, see AMI billing information fields in the Amazon EC2 User Guide.' UsageOperationUpdateTime: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - xml: name: usageOperationUpdateTime description: The time that the usage operation was last updated. PrivateDnsNameOptions: allOf: - $ref: '#/components/schemas/PrivateDnsNameOptionsResponse' - xml: name: privateDnsNameOptions description: The options for the instance hostname. Ipv6Address: allOf: - $ref: '#/components/schemas/String' - xml: name: ipv6Address description: The IPv6 address assigned to the instance. TpmSupport: allOf: - $ref: '#/components/schemas/String' - xml: name: tpmSupport description: 'If the instance is configured for NitroTPM support, the value isv2.0. For more information, see NitroTPM in the Amazon EC2 User Guide.'
MaintenanceOptions:
allOf:
- $ref: '#/components/schemas/InstanceMaintenanceOptions'
- xml:
name: maintenanceOptions
description: Provides information on the recovery and maintenance options of your instance.
CurrentInstanceBootMode:
allOf:
- $ref: '#/components/schemas/InstanceBootModeValues'
- xml:
name: currentInstanceBootMode
description: 'The boot mode that is used to boot the instance at launch or start. For more information, see Boot modes in the Amazon EC2 User Guide.'
description: Describes an instance.
InstanceBlockDeviceMapping:
type: object
properties:
DeviceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deviceName
description: 'The device name (for example, /dev/sdh or xvdh).'
Ebs:
allOf:
- $ref: '#/components/schemas/EbsInstanceBlockDevice'
- xml:
name: ebs
description: Parameters used to automatically set up EBS volumes when the instance is launched.
description: Describes a block device mapping.
InstanceBlockDeviceMappingSpecificationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification'
- xml:
name: item
ListingState:
type: string
enum:
- available
- sold
- cancelled
- pending
InstanceCount:
type: object
properties:
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: instanceCount
description: The number of listed Reserved Instances in the state specified by the state.
State:
allOf:
- $ref: '#/components/schemas/ListingState'
- xml:
name: state
description: The states of the listed Reserved Instances.
description: Describes a Reserved Instance listing state.
InstanceCountList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceCount'
- xml:
name: item
InstanceCreditSpecification:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
CpuCredits:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cpuCredits
description: 'The credit option for CPU usage of the instance.
Valid values: standard | unlimited
IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to required).
optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' HttpEndpoint: allOf: - $ref: '#/components/schemas/InstanceMetadataEndpointState' - description: 'Enables or disables the HTTP metadata endpoint on your instances.
If you specify a value of disabled, you cannot access your instance metadata.
Default: enabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The type of network interface.
Valid values: interface | efa | trunk
0, there is no minimum limit.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: max
description: 'The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.'
description: The minimum and maximum number of vCPUs.
MemoryMiB:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: min
description: 'The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.'
Max:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: max
description: 'The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.'
description: 'The minimum and maximum amount of memory, in MiB.'
MemoryGiBPerVCpu:
type: object
properties:
Min:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: min
description: 'The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.'
Max:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: max
description: 'The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.'
description: 'The minimum and maximum amount of memory per vCPU, in GiB.
' NetworkInterfaceCount: type: object properties: Min: allOf: - $ref: '#/components/schemas/Integer' - xml: name: min description: 'The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.' Max: allOf: - $ref: '#/components/schemas/Integer' - xml: name: max description: 'The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.' description: The minimum and maximum number of network interfaces. TotalLocalStorageGB: type: object properties: Min: allOf: - $ref: '#/components/schemas/Double' - xml: name: min description: 'The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.' Max: allOf: - $ref: '#/components/schemas/Double' - xml: name: max description: 'The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.' description: 'The minimum and maximum amount of total local storage, in GB.' NetworkBandwidthGbps: type: object properties: Min: allOf: - $ref: '#/components/schemas/Double' - xml: name: min description: 'The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.' Max: allOf: - $ref: '#/components/schemas/Double' - xml: name: max description: 'The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.' description: 'The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see Available instance bandwidth in the Amazon EC2 User Guide.
running state.
InstanceStatus:
allOf:
- $ref: '#/components/schemas/InstanceStatusSummary'
- xml:
name: instanceStatus
description: 'Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.'
SystemStatus:
allOf:
- $ref: '#/components/schemas/InstanceStatusSummary'
- xml:
name: systemStatus
description: 'Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.'
description: Describes the status of an instance.
StatusName:
type: string
enum:
- reachability
StatusType:
type: string
enum:
- passed
- failed
- insufficient-data
- initializing
InstanceStatusDetails:
type: object
properties:
ImpairedSince:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: impairedSince
description: 'The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.'
Name:
allOf:
- $ref: '#/components/schemas/StatusName'
- xml:
name: name
description: The type of instance status.
Status:
allOf:
- $ref: '#/components/schemas/StatusType'
- xml:
name: status
description: The status.
description: Describes the instance status.
InstanceStatusDetailsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/InstanceStatusDetails'
- xml:
name: item
InstanceStatusEvent:
type: object
properties:
InstanceEventId:
allOf:
- $ref: '#/components/schemas/InstanceEventId'
- xml:
name: instanceEventId
description: The ID of the event.
Code:
allOf:
- $ref: '#/components/schemas/EventCode'
- xml:
name: code
description: The event code.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: 'A description of the event.
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].
' NotAfter: allOf: - $ref: '#/components/schemas/DateTime' - xml: name: notAfter description: The latest scheduled end time for the event. NotBefore: allOf: - $ref: '#/components/schemas/DateTime' - xml: name: notBefore description: The earliest scheduled start time for the event. NotBeforeDeadline: allOf: - $ref: '#/components/schemas/DateTime' - xml: name: notBeforeDeadline description: The deadline for starting the event. description: Describes a scheduled event for an instance. SummaryStatus: type: string enum: - ok - impaired - insufficient-data - not-applicable - initializing InstanceStorageEncryptionSupport: type: string enum: - unsupported - required InstanceStorageFlag: type: boolean InstanceStorageInfo: type: object properties: TotalSizeInGB: allOf: - $ref: '#/components/schemas/DiskSize' - xml: name: totalSizeInGB description: 'The total size of the disks, in GB.' Disks: allOf: - $ref: '#/components/schemas/DiskInfoList' - xml: name: disks description: Describes the disks that are available for the instance type. NvmeSupport: allOf: - $ref: '#/components/schemas/EphemeralNvmeSupport' - xml: name: nvmeSupport description: Indicates whether non-volatile memory express (NVMe) is supported. EncryptionSupport: allOf: - $ref: '#/components/schemas/InstanceStorageEncryptionSupport' - xml: name: encryptionSupport description: Indicates whether data is encrypted at rest. description: Describes the instance store features that are supported by the instance type. InstanceTypeHypervisor: type: string enum: - nitro - xen UsageClassTypeList: type: array items: allOf: - $ref: '#/components/schemas/UsageClassType' - xml: name: item RootDeviceTypeList: type: array items: allOf: - $ref: '#/components/schemas/RootDeviceType' - xml: name: item VirtualizationTypeList: type: array items: allOf: - $ref: '#/components/schemas/VirtualizationType' - xml: name: item ProcessorInfo: type: object properties: SupportedArchitectures: allOf: - $ref: '#/components/schemas/ArchitectureTypeList' - xml: name: supportedArchitectures description: The architectures supported by the instance type. SustainedClockSpeedInGhz: allOf: - $ref: '#/components/schemas/ProcessorSustainedClockSpeed' - xml: name: sustainedClockSpeedInGhz description: 'The speed of the processor, in GHz.' SupportedFeatures: allOf: - $ref: '#/components/schemas/SupportedAdditionalProcessorFeatureList' - xml: name: supportedFeatures description: 'Indicates whether the instance type supports AMD SEV-SNP. If the request returnsamd-sev-snp, AMD SEV-SNP is supported. Otherwise, it is not supported. For more information, see AMD SEV-SNP.'
description: Describes the processor used by the instance type.
VCpuInfo:
type: object
properties:
DefaultVCpus:
allOf:
- $ref: '#/components/schemas/VCpuCount'
- xml:
name: defaultVCpus
description: The default number of vCPUs for the instance type.
DefaultCores:
allOf:
- $ref: '#/components/schemas/CoreCount'
- xml:
name: defaultCores
description: The default number of cores for the instance type.
DefaultThreadsPerCore:
allOf:
- $ref: '#/components/schemas/ThreadsPerCore'
- xml:
name: defaultThreadsPerCore
description: The default number of threads per core for the instance type.
ValidCores:
allOf:
- $ref: '#/components/schemas/CoreCountList'
- xml:
name: validCores
description: The valid number of cores that can be configured for the instance type.
ValidThreadsPerCore:
allOf:
- $ref: '#/components/schemas/ThreadsPerCoreList'
- xml:
name: validThreadsPerCore
description: The valid number of threads per core that can be configured for the instance type.
description: Describes the vCPU configurations for the instance type.
MemoryInfo:
type: object
properties:
SizeInMiB:
allOf:
- $ref: '#/components/schemas/MemorySize'
- xml:
name: sizeInMiB
description: 'The size of the memory, in MiB.'
description: Describes the memory for the instance type.
NetworkInfo:
type: object
properties:
NetworkPerformance:
allOf:
- $ref: '#/components/schemas/NetworkPerformance'
- xml:
name: networkPerformance
description: The network performance.
MaximumNetworkInterfaces:
allOf:
- $ref: '#/components/schemas/MaxNetworkInterfaces'
- xml:
name: maximumNetworkInterfaces
description: The maximum number of network interfaces for the instance type.
MaximumNetworkCards:
allOf:
- $ref: '#/components/schemas/MaximumNetworkCards'
- xml:
name: maximumNetworkCards
description: The maximum number of physical network cards that can be allocated to the instance.
DefaultNetworkCardIndex:
allOf:
- $ref: '#/components/schemas/DefaultNetworkCardIndex'
- xml:
name: defaultNetworkCardIndex
description: 'The index of the default network card, starting at 0.'
NetworkCards:
allOf:
- $ref: '#/components/schemas/NetworkCardInfoList'
- xml:
name: networkCards
description: Describes the network cards for the instance type.
Ipv4AddressesPerInterface:
allOf:
- $ref: '#/components/schemas/MaxIpv4AddrPerInterface'
- xml:
name: ipv4AddressesPerInterface
description: The maximum number of IPv4 addresses per network interface.
Ipv6AddressesPerInterface:
allOf:
- $ref: '#/components/schemas/MaxIpv6AddrPerInterface'
- xml:
name: ipv6AddressesPerInterface
description: The maximum number of IPv6 addresses per network interface.
Ipv6Supported:
allOf:
- $ref: '#/components/schemas/Ipv6Flag'
- xml:
name: ipv6Supported
description: Indicates whether IPv6 is supported.
EnaSupport:
allOf:
- $ref: '#/components/schemas/EnaSupport'
- xml:
name: enaSupport
description: Indicates whether Elastic Network Adapter (ENA) is supported.
EfaSupported:
allOf:
- $ref: '#/components/schemas/EfaSupportedFlag'
- xml:
name: efaSupported
description: Indicates whether Elastic Fabric Adapter (EFA) is supported.
EfaInfo:
allOf:
- $ref: '#/components/schemas/EfaInfo'
- xml:
name: efaInfo
description: Describes the Elastic Fabric Adapters for the instance type.
EncryptionInTransitSupported:
allOf:
- $ref: '#/components/schemas/EncryptionInTransitSupported'
- xml:
name: encryptionInTransitSupported
description: Indicates whether the instance type automatically encrypts in-transit traffic between instances.
EnaSrdSupported:
allOf:
- $ref: '#/components/schemas/EnaSrdSupported'
- xml:
name: enaSrdSupported
description: Indicates whether the instance type supports ENA Express. ENA Express uses Amazon Web Services Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.
description: Describes the networking features of the instance type.
PlacementGroupInfo:
type: object
properties:
SupportedStrategies:
allOf:
- $ref: '#/components/schemas/PlacementGroupStrategyList'
- xml:
name: supportedStrategies
description: The supported placement group types.
description: Describes the placement group support of the instance type.
NitroEnclavesSupport:
type: string
enum:
- unsupported
- supported
NitroTpmSupport:
type: string
enum:
- unsupported
- supported
NitroTpmInfo:
type: object
properties:
SupportedVersions:
allOf:
- $ref: '#/components/schemas/NitroTpmSupportedVersionsList'
- xml:
name: supportedVersions
description: Indicates the supported NitroTPM versions.
description: Describes the supported NitroTPM versions for the instance type.
InstanceTypeInfo:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.'
CurrentGeneration:
allOf:
- $ref: '#/components/schemas/CurrentGenerationFlag'
- xml:
name: currentGeneration
description: Indicates whether the instance type is current generation.
FreeTierEligible:
allOf:
- $ref: '#/components/schemas/FreeTierEligibleFlag'
- xml:
name: freeTierEligible
description: Indicates whether the instance type is eligible for the free tier.
SupportedUsageClasses:
allOf:
- $ref: '#/components/schemas/UsageClassTypeList'
- xml:
name: supportedUsageClasses
description: Indicates whether the instance type is offered for spot or On-Demand.
SupportedRootDeviceTypes:
allOf:
- $ref: '#/components/schemas/RootDeviceTypeList'
- xml:
name: supportedRootDeviceTypes
description: The supported root device types.
SupportedVirtualizationTypes:
allOf:
- $ref: '#/components/schemas/VirtualizationTypeList'
- xml:
name: supportedVirtualizationTypes
description: The supported virtualization types.
BareMetal:
allOf:
- $ref: '#/components/schemas/BareMetalFlag'
- xml:
name: bareMetal
description: Indicates whether the instance is a bare metal instance type.
Hypervisor:
allOf:
- $ref: '#/components/schemas/InstanceTypeHypervisor'
- xml:
name: hypervisor
description: The hypervisor for the instance type.
ProcessorInfo:
allOf:
- $ref: '#/components/schemas/ProcessorInfo'
- xml:
name: processorInfo
description: Describes the processor.
VCpuInfo:
allOf:
- $ref: '#/components/schemas/VCpuInfo'
- xml:
name: vCpuInfo
description: Describes the vCPU configurations for the instance type.
MemoryInfo:
allOf:
- $ref: '#/components/schemas/MemoryInfo'
- xml:
name: memoryInfo
description: Describes the memory for the instance type.
InstanceStorageSupported:
allOf:
- $ref: '#/components/schemas/InstanceStorageFlag'
- xml:
name: instanceStorageSupported
description: Indicates whether instance storage is supported.
InstanceStorageInfo:
allOf:
- $ref: '#/components/schemas/InstanceStorageInfo'
- xml:
name: instanceStorageInfo
description: Describes the instance storage for the instance type.
EbsInfo:
allOf:
- $ref: '#/components/schemas/EbsInfo'
- xml:
name: ebsInfo
description: Describes the Amazon EBS settings for the instance type.
NetworkInfo:
allOf:
- $ref: '#/components/schemas/NetworkInfo'
- xml:
name: networkInfo
description: Describes the network settings for the instance type.
GpuInfo:
allOf:
- $ref: '#/components/schemas/GpuInfo'
- xml:
name: gpuInfo
description: Describes the GPU accelerator settings for the instance type.
FpgaInfo:
allOf:
- $ref: '#/components/schemas/FpgaInfo'
- xml:
name: fpgaInfo
description: Describes the FPGA accelerator settings for the instance type.
PlacementGroupInfo:
allOf:
- $ref: '#/components/schemas/PlacementGroupInfo'
- xml:
name: placementGroupInfo
description: Describes the placement group settings for the instance type.
InferenceAcceleratorInfo:
allOf:
- $ref: '#/components/schemas/InferenceAcceleratorInfo'
- xml:
name: inferenceAcceleratorInfo
description: Describes the Inference accelerator settings for the instance type.
HibernationSupported:
allOf:
- $ref: '#/components/schemas/HibernationFlag'
- xml:
name: hibernationSupported
description: Indicates whether On-Demand hibernation is supported.
BurstablePerformanceSupported:
allOf:
- $ref: '#/components/schemas/BurstablePerformanceFlag'
- xml:
name: burstablePerformanceSupported
description: 'Indicates whether the instance type is a burstable performance T instance type. For more information, see Burstable performance instances.'
DedicatedHostsSupported:
allOf:
- $ref: '#/components/schemas/DedicatedHostFlag'
- xml:
name: dedicatedHostsSupported
description: Indicates whether Dedicated Hosts are supported on the instance type.
AutoRecoverySupported:
allOf:
- $ref: '#/components/schemas/AutoRecoveryFlag'
- xml:
name: autoRecoverySupported
description: Indicates whether Amazon CloudWatch action based recovery is supported.
SupportedBootModes:
allOf:
- $ref: '#/components/schemas/BootModeTypeList'
- xml:
name: supportedBootModes
description: 'The supported boot modes. For more information, see Boot modes in the Amazon EC2 User Guide.'
NitroEnclavesSupport:
allOf:
- $ref: '#/components/schemas/NitroEnclavesSupport'
- xml:
name: nitroEnclavesSupport
description: Indicates whether Nitro Enclaves is supported.
NitroTpmSupport:
allOf:
- $ref: '#/components/schemas/NitroTpmSupport'
- xml:
name: nitroTpmSupport
description: Indicates whether NitroTPM is supported.
NitroTpmInfo:
allOf:
- $ref: '#/components/schemas/NitroTpmInfo'
- xml:
name: nitroTpmInfo
description: Describes the supported NitroTPM versions for the instance type.
description: Describes the instance type.
InstanceTypeInfoFromInstanceRequirements:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: The matching instance type.
description: The list of instance types with the specified instance attributes.
Location:
type: string
InstanceTypeOffering:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.'
LocationType:
allOf:
- $ref: '#/components/schemas/LocationType'
- xml:
name: locationType
description: The location type.
Location:
allOf:
- $ref: '#/components/schemas/Location'
- xml:
name: location
description: 'The identifier for the location. This depends on the location type. For example, if the location type is region, the location is the Region code (for example, us-east-2.)'
description: The instance types offered.
InstanceUsage:
type: object
properties:
AccountId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: accountId
description: The ID of the Amazon Web Services account that is making use of the Capacity Reservation.
UsedInstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: usedInstanceCount
description: The number of instances the Amazon Web Services account currently has in the Capacity Reservation.
description: Information about the Capacity Reservation usage.
InterfaceProtocolType:
type: string
enum:
- VLAN
- GRE
InternetGatewayAttachment:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/AttachmentStatus'
- xml:
name: state
description: 'The current state of the attachment. For an internet gateway, the state is available when attached to a VPC; otherwise, this value is not returned.'
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
description: Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
IpRangeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/IpRange'
- xml:
name: item
Ipv6RangeList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv6Range'
- xml:
name: item
PrefixListIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrefixListId'
- xml:
name: item
UserIdGroupPairList:
type: array
items:
allOf:
- $ref: '#/components/schemas/UserIdGroupPair'
- xml:
name: item
IpRange:
type: object
properties:
CidrIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrIp
description: 'The IPv4 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: 'A description for the security group rule that references this IPv4 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' description: Describes an IPv4 range. IpRanges: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item IpamOperatingRegionSet: type: array items: allOf: - $ref: '#/components/schemas/IpamOperatingRegion' - xml: name: item IpamState: type: string enum: - create-in-progress - create-complete - create-failed - modify-in-progress - modify-complete - modify-failed - delete-in-progress - delete-complete - delete-failed - isolate-in-progress - isolate-complete - restore-in-progress IpamAddressHistoryResourceType: type: string enum: - eip - vpc - subnet - network-interface - instance IpamComplianceStatus: type: string enum: - compliant - noncompliant - unmanaged - ignored IpamOverlapStatus: type: string enum: - overlapping - nonoverlapping - ignored IpamAddressHistoryRecord: type: object properties: ResourceOwnerId: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceOwnerId description: The ID of the resource owner. ResourceRegion: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceRegion description: The Amazon Web Services Region of the resource. ResourceType: allOf: - $ref: '#/components/schemas/IpamAddressHistoryResourceType' - xml: name: resourceType description: The type of the resource. ResourceId: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceId description: The ID of the resource. ResourceCidr: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceCidr description: The CIDR of the resource. ResourceName: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceName description: The name of the resource. ResourceComplianceStatus: allOf: - $ref: '#/components/schemas/IpamComplianceStatus' - xml: name: resourceComplianceStatus description: 'The compliance status of a resource. For more information on compliance statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' ResourceOverlapStatus: allOf: - $ref: '#/components/schemas/IpamOverlapStatus' - xml: name: resourceOverlapStatus description: 'The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see Monitor CIDR usage by resource in the Amazon VPC IPAM User Guide.' VpcId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcId description: The VPC ID of the resource. SampledStartTime: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - xml: name: sampledStartTime description: 'Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.' SampledEndTime: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - xml: name: sampledEndTime description: 'Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.' description: 'The historical record of a CIDR within an IPAM scope. For more information, see View the history of IP addresses in the Amazon VPC IPAM User Guide. ' IpamAssociatedResourceDiscoveryStatus: type: string enum: - active - not-found IpamCidrAuthorizationContext: type: object properties: Message: allOf: - $ref: '#/components/schemas/String' - description: The plain-text authorization message for the prefix and account. Signature: allOf: - $ref: '#/components/schemas/String' - description: The signed authorization message for the prefix and account. description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. IpamDiscoveryFailureReason: type: object properties: Code: allOf: - $ref: '#/components/schemas/IpamDiscoveryFailureCode' - xml: name: code description: 'The discovery failure code.
assume-role-failure - IPAM could not assume the Amazon Web Services IAM service-linked role. This could be because of any of the following:
SLR has not been created yet and IPAM is still creating it.
You have opted-out of the IPAM home Region.
Account you are using as your IPAM account has been suspended.
throttling-failure - IPAM account is already using the allotted transactions per second and IPAM is receiving a throttling error when assuming the Amazon Web Services IAM SLR.
unauthorized-failure - Amazon Web Services account making the request is not authorized. For more information, see AuthFailure in the Amazon Elastic Compute Cloud API Reference.
The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:
For resources that are VPCs, this is the percentage of IP address space in the VPC that''s taken up by subnet CIDRs.
For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that''s in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that''s been allocated to Elastic IP addresses (EIPs).
The operating Regions for an IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' IpamScopeType: type: string enum: - public - private IpamPoolState: type: string enum: - create-in-progress - create-complete - create-failed - modify-in-progress - modify-complete - modify-failed - delete-in-progress - delete-complete - delete-failed - isolate-in-progress - isolate-complete - restore-in-progress IpamPoolAllocationResourceType: type: string enum: - ipam-pool - vpc - ec2-public-ipv4-pool - custom IpamPoolCidrState: type: string enum: - pending-provision - provisioned - failed-provision - pending-deprovision - deprovisioned - failed-deprovision - pending-import - failed-import IpamPoolCidrFailureReason: type: object properties: Code: allOf: - $ref: '#/components/schemas/IpamPoolCidrFailureCode' - xml: name: code description: An error code related to why an IPAM pool CIDR failed to be provisioned. Message: allOf: - $ref: '#/components/schemas/String' - xml: name: message description: A message related to why an IPAM pool CIDR failed to be provisioned. description: Details related to why an IPAM pool CIDR failed to be provisioned. IpamPoolCidrId: type: string IpamPoolCidrFailureCode: type: string enum: - cidr-not-available - limit-exceeded IpamResourceCidr: type: object properties: IpamId: allOf: - $ref: '#/components/schemas/IpamId' - xml: name: ipamId description: The IPAM ID for an IPAM resource. IpamScopeId: allOf: - $ref: '#/components/schemas/IpamScopeId' - xml: name: ipamScopeId description: The scope ID for an IPAM resource. IpamPoolId: allOf: - $ref: '#/components/schemas/IpamPoolId' - xml: name: ipamPoolId description: The pool ID for an IPAM resource. ResourceRegion: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceRegion description: The Amazon Web Services Region for an IPAM resource. ResourceOwnerId: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceOwnerId description: The Amazon Web Services account number of the owner of an IPAM resource. ResourceId: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceId description: The ID of an IPAM resource. ResourceName: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceName description: The name of an IPAM resource. ResourceCidr: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceCidr description: The CIDR for an IPAM resource. ResourceType: allOf: - $ref: '#/components/schemas/IpamResourceType' - xml: name: resourceType description: The type of IPAM resource. ResourceTags: allOf: - $ref: '#/components/schemas/IpamResourceTagList' - xml: name: resourceTagSet description: The tags for an IPAM resource. IpUsage: allOf: - $ref: '#/components/schemas/BoxedDouble' - xml: name: ipUsage description: 'The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:
For resources that are VPCs, this is the percentage of IP address space in the VPC that''s taken up by subnet CIDRs.
For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that''s in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated.
For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that''s been allocated to Elastic IP addresses (EIPs).
Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.'
IpamScopeState:
type: string
enum:
- create-in-progress
- create-complete
- create-failed
- modify-in-progress
- modify-complete
- modify-failed
- delete-in-progress
- delete-complete
- delete-failed
- isolate-in-progress
- isolate-complete
- restore-in-progress
Ipv4PrefixSpecificationResponse:
type: object
properties:
Ipv4Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv4Prefix
description: The IPv4 delegated prefixes assigned to the network interface.
description: Information about the IPv4 delegated prefixes assigned to a network interface.
Ipv4PrefixListResponse:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv4PrefixSpecificationResponse'
- xml:
name: item
Ipv4PrefixSpecification:
type: object
properties:
Ipv4Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv4Prefix
description: 'The IPv4 prefix. For information, see Assigning prefixes to Amazon EC2 network interfaces in the Amazon Elastic Compute Cloud User Guide.'
description: Describes an IPv4 prefix.
Ipv6Address:
type: string
Ipv6CidrAssociation:
type: object
properties:
Ipv6Cidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6Cidr
description: The IPv6 CIDR block.
AssociatedResource:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associatedResource
description: The resource that's associated with the IPv6 CIDR block.
description: Describes an IPv6 CIDR block association.
Ipv6CidrBlock:
type: object
properties:
Ipv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6CidrBlock
description: The IPv6 CIDR block.
description: Describes an IPv6 CIDR block.
Ipv6CidrBlockSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv6CidrBlock'
- xml:
name: item
Ipv6Flag:
type: boolean
PoolCidrBlocksSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/PoolCidrBlock'
- xml:
name: item
Ipv6Pool:
type: object
properties:
PoolId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: poolId
description: The ID of the address pool.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description for the address pool.
PoolCidrBlocks:
allOf:
- $ref: '#/components/schemas/PoolCidrBlocksSet'
- xml:
name: poolCidrBlockSet
description: The CIDR blocks for the address pool.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags for the address pool.
description: Describes an IPv6 address pool.
Ipv6PrefixSpecificationResponse:
type: object
properties:
Ipv6Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6Prefix
description: The IPv6 delegated prefixes assigned to the network interface.
description: Information about the IPv6 delegated prefixes assigned to a network interface.
Ipv6PrefixListResponse:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv6PrefixSpecificationResponse'
- xml:
name: item
Ipv6PrefixSpecification:
type: object
properties:
Ipv6Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipv6Prefix
description: The IPv6 prefix.
description: Describes the IPv6 prefix.
Ipv6PrefixesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Ipv6PrefixSpecification'
- xml:
name: item
Ipv6Range:
type: object
properties:
CidrIpv6:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrIpv6
description: 'The IPv6 CIDR range. You can either specify a CIDR range or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: 'A description for the security group rule that references this IPv6 address range.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' description: Describes an IPv6 range. KeyPairInfo: type: object properties: KeyPairId: allOf: - $ref: '#/components/schemas/String' - xml: name: keyPairId description: The ID of the key pair. KeyFingerprint: allOf: - $ref: '#/components/schemas/String' - xml: name: keyFingerprint description: 'If you used CreateKeyPair to create the key pair:
For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used ImportKeyPair to provide Amazon Web Services the public key:
For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8.
If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in ISO 8601 date-time format, in the UTC time zone.
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in ISO 8601 date-time format, in the UTC time zone.
' description: Describes a key pair. LastError: type: object properties: Message: allOf: - $ref: '#/components/schemas/String' - xml: name: message description: The error message for the VPC endpoint error. Code: allOf: - $ref: '#/components/schemas/String' - xml: name: code description: The error code for the VPC endpoint error. description: The last error that occurred for a VPC endpoint. LaunchPermission: type: object properties: Group: allOf: - $ref: '#/components/schemas/PermissionGroup' - xml: name: group description: The name of the group. UserId: allOf: - $ref: '#/components/schemas/String' - xml: name: userId description: 'The Amazon Web Services account ID.
Constraints: Up to 10 000 account IDs can be specified in a single request.
' OrganizationArn: allOf: - $ref: '#/components/schemas/String' - xml: name: organizationArn description: The Amazon Resource Name (ARN) of an organization. OrganizationalUnitArn: allOf: - $ref: '#/components/schemas/String' - xml: name: organizationalUnitArn description: The Amazon Resource Name (ARN) of an organizational unit (OU). description: Describes a launch permission. LaunchPermissionModifications: type: object properties: Add: allOf: - $ref: '#/components/schemas/LaunchPermissionList' - description: 'The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.' Remove: allOf: - $ref: '#/components/schemas/LaunchPermissionList' - description: 'The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.' description: Describes a launch permission modification. LaunchSpecification: type: object properties: UserData: allOf: - $ref: '#/components/schemas/SensitiveUserData' - xml: name: userData description: The base64-encoded user data that instances use when starting up. User data is limited to 16 KB. SecurityGroups: allOf: - $ref: '#/components/schemas/GroupIdentifierList' - xml: name: groupSet description: The IDs of the security groups. AddressingType: allOf: - $ref: '#/components/schemas/String' - xml: name: addressingType description: Deprecated. BlockDeviceMappings: allOf: - $ref: '#/components/schemas/BlockDeviceMappingList' - xml: name: blockDeviceMapping description: The block device mapping entries. EbsOptimized: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: ebsOptimized description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.
SpotFleetLaunchSpecification currently does not support Elastic Fabric Adapter (EFA). To specify an EFA, you must use LaunchTemplateConfig.
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.
' TagSpecifications: allOf: - $ref: '#/components/schemas/SpotFleetTagSpecificationList' - xml: name: tagSpecificationSet description: The tags to apply during creation. InstanceRequirements: allOf: - $ref: '#/components/schemas/InstanceRequirements' - xml: name: instanceRequirements description: 'The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.
If you specify InstanceRequirements, you can''t specify InstanceType.
SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.'
LaunchTemplateAutoRecoveryState:
type: string
enum:
- default
- disabled
LaunchTemplateEbsBlockDevice:
type: object
properties:
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: encrypted
description: Indicates whether the EBS volume is encrypted.
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: deleteOnTermination
description: Indicates whether the EBS volume is deleted on instance termination.
Iops:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: iops
description: 'The number of I/O operations per second (IOPS) that the volume supports. '
KmsKeyId:
allOf:
- $ref: '#/components/schemas/KmsKeyId'
- xml:
name: kmsKeyId
description: The ARN of the Key Management Service (KMS) CMK used for encryption.
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- xml:
name: snapshotId
description: The ID of the snapshot.
VolumeSize:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: volumeSize
description: 'The size of the volume, in GiB.'
VolumeType:
allOf:
- $ref: '#/components/schemas/VolumeType'
- xml:
name: volumeType
description: The volume type.
Throughput:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: throughput
description: 'The throughput that the volume supports, in MiB/s.'
description: Describes a block device for an EBS volume.
LaunchTemplateBlockDeviceMapping:
type: object
properties:
DeviceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deviceName
description: The device name.
VirtualName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: virtualName
description: The virtual device name (ephemeralN).
Ebs:
allOf:
- $ref: '#/components/schemas/LaunchTemplateEbsBlockDevice'
- xml:
name: ebs
description: Information about the block device for an EBS volume.
NoDevice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: noDevice
description: 'To omit the device from the block device mapping, specify an empty string.'
description: Describes a block device mapping.
LaunchTemplateBlockDeviceMappingList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateBlockDeviceMapping'
- xml:
name: item
LaunchTemplateEbsBlockDeviceRequest:
type: object
properties:
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can''t specify an encryption value.'
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the EBS volume is deleted on instance termination.
Iops:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The number of I/O operations per second (IOPS). For gp3, io1, and io2 volumes, this represents the number of IOPS that are provisioned for the volume. For gp2 volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
For io1 and io2 volumes, we guarantee 64,000 IOPS only for Instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS.
This parameter is supported for io1, io2, and gp3 volumes only. This parameter is not supported for gp2, st1, sc1, or standard volumes.
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
The throughput to provision for a gp3 volume, with a maximum of 1,000 MiB/s.
Valid Range: Minimum value of 125. Maximum value of 1000.
' description: The parameters for a block device for an EBS volume. LaunchTemplateBlockDeviceMappingRequest: type: object properties: DeviceName: allOf: - $ref: '#/components/schemas/String' - description: 'The device name (for example, /dev/sdh or xvdh).' VirtualName: allOf: - $ref: '#/components/schemas/String' - description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.' Ebs: allOf: - $ref: '#/components/schemas/LaunchTemplateEbsBlockDeviceRequest' - description: Parameters used to automatically set up EBS volumes when the instance is launched. NoDevice: allOf: - $ref: '#/components/schemas/String' - description: 'To omit the device from the block device mapping, specify an empty string.' description: Describes a block device mapping. LaunchTemplateCapacityReservationSpecificationResponse: type: object properties: CapacityReservationPreference: allOf: - $ref: '#/components/schemas/CapacityReservationPreference' - xml: name: capacityReservationPreference description: 'Indicates the instance''s Capacity Reservation preferences. Possible preferences include:
open - The instance can run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
none - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
The number of elastic inference accelerators to attach to the instance.
Default: 1
' description: ' Describes an elastic inference accelerator. ' LaunchTemplateElasticInferenceAcceleratorResponse: type: object properties: Type: allOf: - $ref: '#/components/schemas/String' - xml: name: type description: ' The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge. ' Count: allOf: - $ref: '#/components/schemas/Integer' - xml: name: count description: 'The number of elastic inference accelerators to attach to the instance.
Default: 1
' description: ' Describes an elastic inference accelerator. ' LaunchTemplateElasticInferenceAcceleratorResponseList: type: array items: allOf: - $ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponse' - xml: name: item LaunchTemplateEnclaveOptions: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: enabled description: 'If this parameter is set totrue, the instance is enabled for Amazon Web Services Nitro Enclaves; otherwise, it is not enabled for Amazon Web Services Nitro Enclaves.'
description: Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves.
LaunchTemplateErrorCode:
type: string
enum:
- launchTemplateIdDoesNotExist
- launchTemplateIdMalformed
- launchTemplateNameDoesNotExist
- launchTemplateNameMalformed
- launchTemplateVersionDoesNotExist
- unexpectedError
LaunchTemplateHibernationOptions:
type: object
properties:
Configured:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: configured
description: 'If this parameter is set to true, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.'
description: Indicates whether an instance is configured for hibernation.
LaunchTemplateHttpTokensState:
type: string
enum:
- optional
- required
LaunchTemplateIamInstanceProfileSpecification:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) of the instance profile.
Name:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: name
description: The name of the instance profile.
description: Describes an IAM instance profile.
LaunchTemplateInstanceMaintenanceOptions:
type: object
properties:
AutoRecovery:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAutoRecoveryState'
- xml:
name: autoRecovery
description: Disables the automatic recovery behavior of your instance or sets it to default.
description: The maintenance options of your instance.
LaunchTemplateSpotMarketOptions:
type: object
properties:
MaxPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: maxPrice
description: 'The maximum hourly price you''re willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The maximum hourly price you''re willing to pay for the Spot Instances. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). Supported only for persistent requests.
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, ValidUntil is not supported. The request remains active until all instances launch or you cancel the request.
Default: 7 days from the current date
' InstanceInterruptionBehavior: allOf: - $ref: '#/components/schemas/InstanceInterruptionBehavior' - description: The behavior when a Spot Instance is interrupted. The default isterminate.
description: The options for Spot Instances.
LaunchTemplateInstanceMetadataEndpointState:
type: string
enum:
- disabled
- enabled
LaunchTemplateInstanceMetadataOptionsState:
type: string
enum:
- pending
- applied
LaunchTemplateInstanceMetadataProtocolIpv6:
type: string
enum:
- disabled
- enabled
LaunchTemplateInstanceMetadataTagsState:
type: string
enum:
- disabled
- enabled
LaunchTemplateInstanceMetadataOptions:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMetadataOptionsState'
- xml:
name: state
description: The state of the metadata option changes.
pending - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.
applied - The metadata options have been successfully applied on the instance.
Indicates whether IMDSv2 is optional or required.
optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel.
Default: 1
Possible values: Integers from 1 to 64
' HttpEndpoint: allOf: - $ref: '#/components/schemas/LaunchTemplateInstanceMetadataEndpointState' - xml: name: httpEndpoint description: 'Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is enabled.
If you specify a value of disabled, you will not be able to access your instance metadata.
Enables or disables the IPv6 endpoint for the instance metadata service.
Default: disabled
Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
' AssociatePublicIpAddress: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: associatePublicIpAddress description: Indicates whether to associate a public IPv4 address with eth0 for a new network interface. DeleteOnTermination: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: deleteOnTermination description: Indicates whether the network interface is deleted when the instance is terminated. Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: A description for the network interface. DeviceIndex: allOf: - $ref: '#/components/schemas/Integer' - xml: name: deviceIndex description: The device index for the network interface attachment. Groups: allOf: - $ref: '#/components/schemas/GroupIdStringList' - xml: name: groupSet description: The IDs of one or more security groups. InterfaceType: allOf: - $ref: '#/components/schemas/String' - xml: name: interfaceType description: The type of network interface. Ipv6AddressCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: ipv6AddressCount description: The number of IPv6 addresses for the network interface. Ipv6Addresses: allOf: - $ref: '#/components/schemas/InstanceIpv6AddressList' - xml: name: ipv6AddressesSet description: The IPv6 addresses for the network interface. NetworkInterfaceId: allOf: - $ref: '#/components/schemas/NetworkInterfaceId' - xml: name: networkInterfaceId description: The ID of the network interface. PrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIpAddress description: The primary private IPv4 address of the network interface. PrivateIpAddresses: allOf: - $ref: '#/components/schemas/PrivateIpAddressSpecificationList' - xml: name: privateIpAddressesSet description: One or more private IPv4 addresses. SecondaryPrivateIpAddressCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: secondaryPrivateIpAddressCount description: The number of secondary private IPv4 addresses for the network interface. SubnetId: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: subnetId description: The ID of the subnet for the network interface. NetworkCardIndex: allOf: - $ref: '#/components/schemas/Integer' - xml: name: networkCardIndex description: The index of the network card. Ipv4Prefixes: allOf: - $ref: '#/components/schemas/Ipv4PrefixListResponse' - xml: name: ipv4PrefixSet description: One or more IPv4 prefixes assigned to the network interface. Ipv4PrefixCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: ipv4PrefixCount description: The number of IPv4 prefixes that Amazon Web Services automatically assigned to the network interface. Ipv6Prefixes: allOf: - $ref: '#/components/schemas/Ipv6PrefixListResponse' - xml: name: ipv6PrefixSet description: One or more IPv6 prefixes assigned to the network interface. Ipv6PrefixCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: ipv6PrefixCount description: The number of IPv6 prefixes that Amazon Web Services automatically assigned to the network interface. PrimaryIpv6: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: primaryIpv6 description: 'The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.' description: Describes a network interface. LaunchTemplateInstanceNetworkInterfaceSpecificationList: type: array items: allOf: - $ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecification' - xml: name: item LaunchTemplateInstanceNetworkInterfaceSpecificationRequest: type: object properties: AssociateCarrierIpAddress: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Associates a Carrier IP address with eth0 for a new network interface.
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see Carrier IP addresses in the Wavelength Developer Guide.
' AssociatePublicIpAddress: allOf: - $ref: '#/components/schemas/Boolean' - description: Associates a public IPv4 address with eth0 for a new network interface. DeleteOnTermination: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether the network interface is deleted when the instance is terminated. Description: allOf: - $ref: '#/components/schemas/String' - description: A description for the network interface. DeviceIndex: allOf: - $ref: '#/components/schemas/Integer' - description: The device index for the network interface attachment. Groups: allOf: - $ref: '#/components/schemas/SecurityGroupIdStringList' - xml: name: SecurityGroupId description: The IDs of one or more security groups. InterfaceType: allOf: - $ref: '#/components/schemas/String' - description: 'The type of network interface. To create an Elastic Fabric Adapter (EFA), specify efa. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA, specify interface or omit this parameter.
Valid values: interface | efa
Ipv4PrefixCount option.
Ipv4PrefixCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv4Prefix option.
Ipv6Prefixes:
allOf:
- $ref: '#/components/schemas/Ipv6PrefixList'
- xml:
name: Ipv6Prefix
description: One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the Ipv6PrefixCount option.
Ipv6PrefixCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the Ipv6Prefix option.
PrimaryIpv6:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'The primary IPv6 address of the network interface. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information about primary IPv6 addresses, see RunInstances.'
description: The parameters for a network interface.
LaunchTemplateLicenseConfiguration:
type: object
properties:
LicenseConfigurationArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: licenseConfigurationArn
description: The Amazon Resource Name (ARN) of the license configuration.
description: Describes a license configuration.
LaunchTemplateLicenseConfigurationRequest:
type: object
properties:
LicenseConfigurationArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Resource Name (ARN) of the license configuration.
description: Describes a license configuration.
LaunchTemplateLicenseList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LaunchTemplateLicenseConfiguration'
- xml:
name: item
LaunchTemplateOverrides:
type: object
properties:
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: The instance type.
SpotPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotPrice
description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The priority for the launch template override. The highest priority is launched first.
If OnDemandAllocationStrategy is set to prioritized, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.
If the Spot AllocationStrategy is set to capacityOptimizedPrioritized, Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.
Valid values are whole numbers starting at 0. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.
The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.
If you specify InstanceRequirements, you can''t specify InstanceType.
dedicated runs on single-tenant hardware. '
SpreadDomain:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spreadDomain
description: Reserved for future use.
HostResourceGroupArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hostResourceGroupArn
description: 'The ARN of the host resource group in which to launch the instances. '
PartitionNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: partitionNumber
description: The number of the partition the instance should launch in. Valid only if the placement group strategy is set to partition.
GroupId:
allOf:
- $ref: '#/components/schemas/PlacementGroupId'
- xml:
name: groupId
description: The Group ID of the placement group. You must specify the Placement Group Group ID to launch an instance in a shared placement group.
description: Describes the placement of an instance.
LaunchTemplatePrivateDnsNameOptions:
type: object
properties:
HostnameType:
allOf:
- $ref: '#/components/schemas/HostnameType'
- xml:
name: hostnameType
description: The type of hostname to assign to an instance.
EnableResourceNameDnsARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enableResourceNameDnsARecord
description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
EnableResourceNameDnsAAAARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enableResourceNameDnsAAAARecord
description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
description: Describes the options for instance hostnames.
LaunchTemplateSpecification:
type: object
properties:
LaunchTemplateId:
allOf:
- $ref: '#/components/schemas/LaunchTemplateId'
- description: 'The ID of the launch template.
You must specify the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify the LaunchTemplateName or the LaunchTemplateId, but not both.
The launch template version number, $Latest, or $Default.
If the value is $Latest, Amazon EC2 uses the latest version of the launch template.
If the value is $Default, Amazon EC2 uses the default version of the launch template.
Default: The default version of the launch template.
' description: 'The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.' SpotInstanceType: type: string enum: - one-time - persistent ResourceType: type: string enum: - capacity-reservation - client-vpn-endpoint - customer-gateway - carrier-gateway - coip-pool - dedicated-host - dhcp-options - egress-only-internet-gateway - elastic-ip - elastic-gpu - export-image-task - export-instance-task - fleet - fpga-image - host-reservation - image - import-image-task - import-snapshot-task - instance - instance-event-window - internet-gateway - ipam - ipam-pool - ipam-scope - ipv4pool-ec2 - ipv6pool-ec2 - key-pair - launch-template - local-gateway - local-gateway-route-table - local-gateway-virtual-interface - local-gateway-virtual-interface-group - local-gateway-route-table-vpc-association - local-gateway-route-table-virtual-interface-group-association - natgateway - network-acl - network-interface - network-insights-analysis - network-insights-path - network-insights-access-scope - network-insights-access-scope-analysis - placement-group - prefix-list - replace-root-volume-task - reserved-instances - route-table - security-group - security-group-rule - snapshot - spot-fleet-request - spot-instances-request - subnet - subnet-cidr-reservation - traffic-mirror-filter - traffic-mirror-session - traffic-mirror-target - transit-gateway - transit-gateway-attachment - transit-gateway-connect-peer - transit-gateway-multicast-domain - transit-gateway-policy-table - transit-gateway-route-table - transit-gateway-route-table-announcement - volume - vpc - vpc-endpoint - vpc-endpoint-connection - vpc-endpoint-service - vpc-endpoint-service-permission - vpc-peering-connection - vpn-connection - vpn-gateway - vpc-flow-log - capacity-reservation-fleet - traffic-mirror-filter-rule - vpc-endpoint-connection-device-type - verified-access-instance - verified-access-group - verified-access-endpoint - verified-access-policy - verified-access-trust-provider - vpn-connection-device-type - vpc-block-public-access-exclusion - ipam-resource-discovery - ipam-resource-discovery-association - instance-connect-endpoint LaunchTemplateTagSpecification: type: object properties: ResourceType: allOf: - $ref: '#/components/schemas/ResourceType' - xml: name: resourceType description: The type of resource to tag. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: The tags for the resource. description: The tags specification for the launch template. LaunchTemplateTagSpecificationList: type: array items: allOf: - $ref: '#/components/schemas/LaunchTemplateTagSpecification' - xml: name: item LaunchTemplateTagSpecificationRequest: type: object properties: ResourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: 'The type of resource to tag.
The Valid Values are all the resource types that can be tagged. However, when creating a launch template, you can specify tags for the following resource types only: instance | volume | elastic-gpu | network-interface | spot-instances-request
To tag a resource after it has been created, see CreateTags.
' Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: Tag description: The tags to apply to the resource. description: The tags specification for the resources that are created during instance launch. LaunchTemplatesMonitoring: type: object properties: Enabled: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: enabled description: 'Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.' description: Describes the monitoring for the instance. LicenseConfiguration: type: object properties: LicenseConfigurationArn: allOf: - $ref: '#/components/schemas/String' - xml: name: licenseConfigurationArn description: The Amazon Resource Name (ARN) of the license configuration. description: Describes a license configuration. LicenseSpecificationListRequest: type: array items: allOf: - $ref: '#/components/schemas/LicenseConfigurationRequest' - xml: name: item ListImagesInRecycleBinMaxResults: type: integer minimum: 1 maximum: 1000 ListImagesInRecycleBinRequest: type: object title: ListImagesInRecycleBinRequest properties: ImageIds: allOf: - $ref: '#/components/schemas/ImageIdStringList' - xml: name: ImageId description: The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request. NextToken: allOf: - $ref: '#/components/schemas/String' - description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. MaxResults: allOf: - $ref: '#/components/schemas/ListImagesInRecycleBinMaxResults' - description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ListSnapshotsInRecycleBinMaxResults:
type: integer
minimum: 5
maximum: 1000
ListSnapshotsInRecycleBinRequest:
type: object
title: ListSnapshotsInRecycleBinRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/ListSnapshotsInRecycleBinMaxResults'
- description: 'The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
SnapshotIds:
allOf:
- $ref: '#/components/schemas/SnapshotIdStringList'
- xml:
name: SnapshotId
description: The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SnapshotRecycleBinInfoList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SnapshotRecycleBinInfo'
- xml:
name: item
ListingStatus:
type: string
enum:
- active
- pending
- cancelled
- closed
TargetGroupsConfig:
type: object
properties:
TargetGroups:
allOf:
- $ref: '#/components/schemas/TargetGroups'
- xml:
name: targetGroups
description: One or more target groups.
description: Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
LoadPermission:
type: object
properties:
UserId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: userId
description: The Amazon Web Services account ID.
Group:
allOf:
- $ref: '#/components/schemas/PermissionGroup'
- xml:
name: group
description: The name of the group.
description: Describes a load permission.
LoadPermissionRequest:
type: object
properties:
Group:
allOf:
- $ref: '#/components/schemas/PermissionGroup'
- description: The name of the group.
UserId:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Web Services account ID.
description: Describes a load permission.
LoadPermissionModifications:
type: object
properties:
Add:
allOf:
- $ref: '#/components/schemas/LoadPermissionListRequest'
- description: The load permissions to add.
Remove:
allOf:
- $ref: '#/components/schemas/LoadPermissionListRequest'
- description: The load permissions to remove.
description: Describes modifications to the load permissions of an Amazon FPGA image (AFI).
LocalGateway:
type: object
properties:
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- xml:
name: localGatewayId
description: The ID of the local gateway.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: The Amazon Resource Name (ARN) of the Outpost.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the local gateway.
State:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: state
description: The state of the local gateway.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the local gateway.
description: Describes a local gateway.
LocalGatewayRouteType:
type: string
enum:
- static
- propagated
LocalGatewayRouteState:
type: string
enum:
- pending
- active
- blackhole
- deleting
- deleted
LocalGatewayRouteList:
type: array
items:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoute'
- xml:
name: item
LocalGatewayVirtualInterface:
type: object
properties:
LocalGatewayVirtualInterfaceId:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceId'
- xml:
name: localGatewayVirtualInterfaceId
description: The ID of the virtual interface.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localGatewayId
description: The ID of the local gateway.
Vlan:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: vlan
description: The ID of the VLAN.
LocalAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localAddress
description: The local address.
PeerAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: peerAddress
description: The peer address.
LocalBgpAsn:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: localBgpAsn
description: The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.
PeerBgpAsn:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: peerBgpAsn
description: The peer BGP ASN.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the local gateway virtual interface.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the virtual interface.
description: Describes a local gateway virtual interface.
LocalGatewayVirtualInterfaceGroup:
type: object
properties:
LocalGatewayVirtualInterfaceGroupId:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceGroupId'
- xml:
name: localGatewayVirtualInterfaceGroupId
description: The ID of the virtual interface group.
LocalGatewayVirtualInterfaceIds:
allOf:
- $ref: '#/components/schemas/LocalGatewayVirtualInterfaceIdSet'
- xml:
name: localGatewayVirtualInterfaceIdSet
description: The IDs of the virtual interfaces.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localGatewayId
description: The ID of the local gateway.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The ID of the Amazon Web Services account that owns the local gateway virtual interface group.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the virtual interface group.
description: Describes a local gateway virtual interface group.
LocalStorageType:
type: string
enum:
- hdd
- ssd
PrefixListState:
type: string
enum:
- create-in-progress
- create-complete
- create-failed
- modify-in-progress
- modify-complete
- modify-failed
- restore-in-progress
- restore-complete
- restore-failed
- delete-in-progress
- delete-complete
- delete-failed
MaxIpv4AddrPerInterface:
type: integer
MaxIpv6AddrPerInterface:
type: integer
MaxNetworkInterfaces:
type: integer
MaxResults:
type: integer
MaximumNetworkCards:
type: integer
MembershipType:
type: string
enum:
- static
- igmp
MemorySize:
type: integer
MetricPoint:
type: object
properties:
StartDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: startDate
description: 'The start date for the metric point. The starting date for the metric point. The starting time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-10T12:00:00.000Z.'
EndDate:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: endDate
description: 'The end date for the metric point. The ending time must be formatted as yyyy-mm-ddThh:mm:ss. For example, 2022-06-12T12:00:00.000Z.'
Value:
allOf:
- $ref: '#/components/schemas/Float'
- xml:
name: value
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: The status of the metric point.
description: Indicates whether the network was healthy or degraded at a particular point. The value is aggregated from the startDate to the endDate. Currently only five_minutes is supported.
ModifyAddressAttributeRequest:
type: object
required:
- AllocationId
title: ModifyAddressAttributeRequest
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/AllocationId'
- description: '[EC2-VPC] The allocation ID.'
DomainName:
allOf:
- $ref: '#/components/schemas/String'
- description: The domain name to modify for the IP address.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyAvailabilityZoneOptInStatus:
type: string
enum:
- opted-in
- not-opted-in
ModifyAvailabilityZoneGroupRequest:
type: object
required:
- GroupName
- OptInStatus
title: ModifyAvailabilityZoneGroupRequest
properties:
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The name of the Availability Zone group, Local Zone group, or Wavelength Zone group.'
OptInStatus:
allOf:
- $ref: '#/components/schemas/ModifyAvailabilityZoneOptInStatus'
- description: 'Indicates whether you are opted in to the Local Zone group or Wavelength Zone group. The only valid value is opted-in. You must contact Amazon Web Services Support to opt out of a Local Zone or Wavelength Zone group.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyCapacityReservationFleetRequest:
type: object
required:
- CapacityReservationFleetId
title: ModifyCapacityReservationFleetRequest
properties:
CapacityReservationFleetId:
allOf:
- $ref: '#/components/schemas/CapacityReservationFleetId'
- description: The ID of the Capacity Reservation Fleet to modify.
TotalTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: '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:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- description: 'The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to expired and all of the Capacity Reservations in the Fleet expire.
The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation Fleet is guaranteed to expire between 13:30:55 and 14:30:55 on 5/31/2019.
You can''t specify EndDate and RemoveEndDate in the same request.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
RemoveEndDate:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the CancelCapacityReservationFleet action.
You can''t specify RemoveEndDate and EndDate in the same request.
' ModifyCapacityReservationRequest: type: object required: - CapacityReservationId title: ModifyCapacityReservationRequest properties: CapacityReservationId: allOf: - $ref: '#/components/schemas/CapacityReservationId' - description: The ID of the Capacity Reservation. InstanceCount: allOf: - $ref: '#/components/schemas/Integer' - description: The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than1000 in a single request.
EndDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation''s state changes to expired when it reaches its end date and time.
The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019.
You must provide an EndDate value if EndDateType is limited. Omit EndDate if EndDateType is unlimited.
Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types:
unlimited - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an EndDate value if EndDateType is unlimited.
limited - The Capacity Reservation expires automatically at a specified date and time. You must provide an EndDate value if EndDateType is limited.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
AdditionalInfo:
allOf:
- $ref: '#/components/schemas/String'
- description: Reserved for future use.
ModifyClientVpnEndpointRequest:
type: object
required:
- ClientVpnEndpointId
title: ModifyClientVpnEndpointRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint to modify.
ServerCertificateArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).
ConnectionLogOptions:
allOf:
- $ref: '#/components/schemas/ConnectionLogOptions'
- description: '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
The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
Valid Values: 443 | 1194
Default Value: 443
Indicates whether the VPN is split-tunnel.
For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/ClientVpnSecurityGroupIdSet'
- xml:
name: SecurityGroupId
description: The IDs of one or more security groups to apply to the target network.
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC to associate with the Client VPN endpoint.
SelfServicePortal:
allOf:
- $ref: '#/components/schemas/SelfServicePortal'
- description: Specify whether to enable the self-service portal for the Client VPN endpoint.
ClientConnectOptions:
allOf:
- $ref: '#/components/schemas/ClientConnectOptions'
- description: The options for managing connection authorization for new client connections.
SessionTimeoutHours:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceFamily:
allOf:
- $ref: '#/components/schemas/UnlimitedSupportedInstanceFamily'
- description: The instance family.
CpuCredits:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The credit option for CPU usage of the instance family.
Valid Values: standard | unlimited
The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.
You can specify the KMS key using any of the following:
Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.
Key alias. For example, alias/ExampleAlias.
Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.
Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.
Amazon EBS does not support asymmetric KMS keys.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyFleetRequest:
type: object
required:
- FleetId
title: ModifyFleetRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ExcessCapacityTerminationPolicy:
allOf:
- $ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy'
- description: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FpgaImageId:
allOf:
- $ref: '#/components/schemas/FpgaImageId'
- description: The ID of the AFI.
Attribute:
allOf:
- $ref: '#/components/schemas/FpgaImageAttributeName'
- description: The name of the attribute.
OperationType:
allOf:
- $ref: '#/components/schemas/OperationType'
- description: The operation type.
UserIds:
allOf:
- $ref: '#/components/schemas/UserIdStringList'
- xml:
name: UserId
description: The Amazon Web Services account IDs. This parameter is valid only when modifying the loadPermission attribute.
UserGroups:
allOf:
- $ref: '#/components/schemas/UserGroupStringList'
- xml:
name: UserGroup
description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeStringList'
- xml:
name: ProductCode
description: 'The product codes. After you add a product code to an AFI, it can''t be removed. This parameter is valid only when modifying the productCodes attribute.'
LoadPermission:
allOf:
- $ref: '#/components/schemas/LoadPermissionModifications'
- description: The load permission for the AFI.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the AFI.
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: A name for the AFI.
ModifyHostsRequest:
type: object
required:
- HostIds
title: ModifyHostsRequest
properties:
AutoPlacement:
allOf:
- $ref: '#/components/schemas/AutoPlacement'
- xml:
name: autoPlacement
description: Specify whether to enable or disable auto-placement.
HostIds:
allOf:
- $ref: '#/components/schemas/RequestHostIdList'
- xml:
name: hostId
description: The IDs of the Dedicated Hosts to modify.
HostRecovery:
allOf:
- $ref: '#/components/schemas/HostRecovery'
- description: 'Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see Host recovery in the Amazon EC2 User Guide.'
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type.
If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request.
' InstanceFamily: allOf: - $ref: '#/components/schemas/String' - description: 'Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family.
If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request.
' HostMaintenance: allOf: - $ref: '#/components/schemas/HostMaintenance' - description: 'Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see Host maintenance in the Amazon EC2 User Guide.' UnsuccessfulItemList: type: array items: allOf: - $ref: '#/components/schemas/UnsuccessfulItem' - xml: name: item ModifyIdFormatRequest: type: object required: - Resource - UseLongIds title: ModifyIdFormatRequest properties: Resource: allOf: - $ref: '#/components/schemas/String' - description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
all to modify the ID format for all IAM users, IAM roles, and the root user of the account.'
Resource:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resource
description: 'The type of resource: bundle | conversion-task | customer-gateway | dhcp-options | elastic-ip-allocation | elastic-ip-association | export-task | flow-log | image | import-task | internet-gateway | network-acl | network-acl-association | network-interface | network-interface-attachment | prefix-list | route-table | route-table-association | security-group | subnet | subnet-cidr-block-association | vpc | vpc-cidr-block-association | vpc-endpoint | vpc-peering-connection | vpn-connection | vpn-gateway.
Alternatively, use the all-current option to include all resource types that are currently within their opt-in period for longer IDs.
The name of the attribute to modify.
Valid values: description | imdsSupport | launchPermission
Attribute parameter is launchPermission.
ProductCodes:
allOf:
- $ref: '#/components/schemas/ProductCodeStringList'
- xml:
name: ProductCode
description: Not supported.
UserGroups:
allOf:
- $ref: '#/components/schemas/UserGroupStringList'
- xml:
name: UserGroup
description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
UserIds:
allOf:
- $ref: '#/components/schemas/UserIdStringList'
- xml:
name: UserId
description: The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or imdsSupport.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
OrganizationArns:
allOf:
- $ref: '#/components/schemas/OrganizationArnStringList'
- xml:
name: OrganizationArn
description: The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
OrganizationalUnitArns:
allOf:
- $ref: '#/components/schemas/OrganizationalUnitArnStringList'
- xml:
name: OrganizationalUnitArn
description: The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
ImdsSupport:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: 'Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to v2.0, you can''t undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.
true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
Attribute:
allOf:
- $ref: '#/components/schemas/InstanceAttributeName'
- xml:
name: attribute
description: 'The name of the attribute to modify.
You can modify the following attributes only: disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions
Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Update the block device mapping when launching an instance in the Amazon EC2 User Guide.
' DisableApiTermination: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - xml: name: disableApiTermination description: 'If the value istrue, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. You cannot use this parameter for Spot Instances.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EbsOptimized:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: ebsOptimized
description: Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
EnaSupport:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: enaSupport
description: Set to true to enable enhanced networking with ENA for the instance.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
Groups: allOf: - $ref: '#/components/schemas/GroupIdStringList' - xml: name: GroupId description: 'Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it''s just the default security group for the VPC.' InstanceId: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: instanceId description: The ID of the instance. InstanceInitiatedShutdownBehavior: allOf: - $ref: '#/components/schemas/AttributeValue' - xml: name: instanceInitiatedShutdownBehavior description: Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). InstanceType: allOf: - $ref: '#/components/schemas/AttributeValue' - xml: name: instanceType description: 'Changes the instance type to the specified value. For more information, see Instance types in the Amazon EC2 User Guide. If the instance type is not valid, the error returned isInvalidInstanceAttributeValue.'
Kernel:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: kernel
description: 'Changes the instance''s kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
Ramdisk:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: ramdisk
description: 'Changes the instance''s RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB.'
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: sriovNetSupport
description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance.
There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time.
This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable.
UserData: allOf: - $ref: '#/components/schemas/BlobAttributeValue' - xml: name: userData description: 'Changes the instance''s user data to the specified value. If you are using an Amazon Web Services SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.' Value: allOf: - $ref: '#/components/schemas/String' - xml: name: value description: 'A new value for the attribute. Use only with thekernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.'
DisableApiStop:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: 'Indicates whether an instance is enabled for stop protection. For more information, see Stop Protection.
' ModifyInstanceCapacityReservationAttributesRequest: type: object required: - InstanceId - CapacityReservationSpecification title: ModifyInstanceCapacityReservationAttributesRequest properties: InstanceId: allOf: - $ref: '#/components/schemas/InstanceId' - description: The ID of the instance to be modified. CapacityReservationSpecification: allOf: - $ref: '#/components/schemas/CapacityReservationSpecification' - description: Information about the Capacity Reservation targeting option. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyInstanceCreditSpecificationRequest:
type: object
required:
- InstanceCreditSpecifications
title: ModifyInstanceCreditSpecificationRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
InstanceCreditSpecifications:
allOf:
- $ref: '#/components/schemas/InstanceCreditSpecificationListRequest'
- xml:
name: InstanceCreditSpecification
description: Information about the credit option for CPU usage.
SuccessfulInstanceCreditSpecificationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SuccessfulInstanceCreditSpecificationItem'
- xml:
name: item
UnsuccessfulInstanceCreditSpecificationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItem'
- xml:
name: item
ModifyInstanceEventStartTimeRequest:
type: object
required:
- InstanceId
- InstanceEventId
- NotBefore
title: ModifyInstanceEventStartTimeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance with the scheduled event.
InstanceEventId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the event whose date and time you are modifying.
NotBefore:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: The new date and time when the event will take place.
ModifyInstanceEventWindowRequest:
type: object
required:
- InstanceEventWindowId
title: ModifyInstanceEventWindowRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Name:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the event window.
InstanceEventWindowId:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowId'
- description: The ID of the event window.
TimeRanges:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowTimeRangeRequestSet'
- xml:
name: TimeRange
description: The time ranges of the event window.
CronExpression:
allOf:
- $ref: '#/components/schemas/InstanceEventWindowCronExpression'
- description: 'The cron expression of the event window, for example, * 0-4,20-23 * * 1,5.
Constraints:
Only hour and day of the week values are supported.
For day of the week values, you can specify either integers 0 through 6, or alternative single values SUN through SAT.
The minute, month, and year must be specified by *.
The hour value must be one or a multiple range, for example, 0-4 or 0-4,20-23.
Each hour range must be >= 2 hours, for example, 0-2 or 20-23.
The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours.
For more information about cron expressions, see cron on the Wikipedia website.
' ModifyInstanceMaintenanceOptionsRequest: type: object required: - InstanceId title: ModifyInstanceMaintenanceOptionsRequest properties: InstanceId: allOf: - $ref: '#/components/schemas/InstanceId' - description: The ID of the instance. AutoRecovery: allOf: - $ref: '#/components/schemas/InstanceAutoRecoveryState' - description: Disables the automatic recovery behavior of your instance or sets it to default. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyInstanceMetadataOptionsRequest:
type: object
required:
- InstanceId
title: ModifyInstanceMetadataOptionsRequest
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
HttpTokens:
allOf:
- $ref: '#/components/schemas/HttpTokensState'
- description: 'IMDSv2 uses token-backed sessions. Set the use of HTTP tokens to optional (in other words, set the use of IMDSv2 to optional) or required (in other words, set the use of IMDSv2 to required).
optional - When IMDSv2 is optional, you can choose to retrieve instance metadata with or without a session token in your request. If you retrieve the IAM role credentials without a token, the IMDSv1 role credentials are returned. If you retrieve the IAM role credentials using a valid session token, the IMDSv2 role credentials are returned.
required - When IMDSv2 is required, you must send a session token with any instance metadata retrieval requests. In this state, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available.
Default: optional
The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained.
Possible values: Integers from 1 to 64
' HttpEndpoint: allOf: - $ref: '#/components/schemas/InstanceMetadataEndpointState' - description: 'Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained.
If you specify a value of disabled, you cannot access your instance metadata.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
HttpProtocolIpv6:
allOf:
- $ref: '#/components/schemas/InstanceMetadataProtocolState'
- description: Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint.
InstanceMetadataTags:
allOf:
- $ref: '#/components/schemas/InstanceMetadataTagsState'
- description: 'Set to enabled to allow access to instance tags from the instance metadata. Set to disabled to turn off access to instance tags from the instance metadata. For more information, see Work with instance tags using the instance metadata.
Default: disabled
The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of default. For cluster and partition placement groups, the instance must have a tenancy of default or dedicated.
To remove an instance from a placement group, specify an empty string ("").
' HostId: allOf: - $ref: '#/components/schemas/DedicatedHostId' - xml: name: hostId description: The ID of the Dedicated Host with which to associate the instance. InstanceId: allOf: - $ref: '#/components/schemas/InstanceId' - xml: name: instanceId description: The ID of the instance that you are modifying. Tenancy: allOf: - $ref: '#/components/schemas/HostTenancy' - xml: name: tenancy description: 'The tenancy for the instance.
For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of host. You can''t change the tenancy from host to dedicated or default. Attempting to make one of these unsupported tenancy changes results in an InvalidRequest error code.
partition.
HostResourceGroupArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN of the host resource group in which to place the instance. The instance must have a tenancy of host to specify this parameter.
GroupId:
allOf:
- $ref: '#/components/schemas/PlacementGroupId'
- description: The Group Id of a placement group. You must specify the Placement Group Group Id to launch an instance in a shared placement group.
ModifyIpamPoolRequest:
type: object
required:
- IpamPoolId
title: ModifyIpamPoolRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool you want to modify.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the IPAM pool you want to modify.
AutoImport:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool''s allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only.
A locale must be set on the pool for this feature to work.
' AllocationMinNetmaskLength: allOf: - $ref: '#/components/schemas/IpamNetmaskLength' - description: The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length. AllocationMaxNetmaskLength: allOf: - $ref: '#/components/schemas/IpamNetmaskLength' - description: The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length. AllocationDefaultNetmaskLength: allOf: - $ref: '#/components/schemas/IpamNetmaskLength' - description: 'The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16.' ClearAllocationDefaultNetmaskLength: allOf: - $ref: '#/components/schemas/Boolean' - description: Clear the default netmask length allocation rule for this pool. AddAllocationResourceTags: allOf: - $ref: '#/components/schemas/RequestIpamResourceTagList' - xml: name: AddAllocationResourceTag description: 'Add tag allocation rules to a pool. For more information about allocation rules, see Create a top-level pool in the Amazon VPC IPAM User Guide.' RemoveAllocationResourceTags: allOf: - $ref: '#/components/schemas/RequestIpamResourceTagList' - xml: name: RemoveAllocationResourceTag description: Remove tag allocation rules from a pool. RemoveIpamOperatingRegionSet: type: array items: $ref: '#/components/schemas/RemoveIpamOperatingRegion' minItems: 0 maxItems: 50 ModifyIpamRequest: type: object required: - IpamId title: ModifyIpamRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
IpamId:
allOf:
- $ref: '#/components/schemas/IpamId'
- description: The ID of the IPAM you want to modify.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the IPAM you want to modify.
AddOperatingRegions:
allOf:
- $ref: '#/components/schemas/AddIpamOperatingRegionSet'
- xml:
name: AddOperatingRegion
description: 'Choose the operating Regions for the IPAM. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
For more information about operating Regions, see Create an IPAM in the Amazon VPC IPAM User Guide.
' RemoveOperatingRegions: allOf: - $ref: '#/components/schemas/RemoveIpamOperatingRegionSet' - xml: name: RemoveOperatingRegion description: The operating Regions to remove. ModifyIpamResourceCidrRequest: type: object required: - ResourceId - ResourceCidr - ResourceRegion - CurrentIpamScopeId - Monitored title: ModifyIpamResourceCidrRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: '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 isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the resource you want to modify.
ResourceCidr:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR of the resource you want to modify.
ResourceRegion:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Web Services Region of the resource you want to modify.
CurrentIpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- description: The ID of the current scope that the resource CIDR is in.
DestinationIpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- description: The ID of the scope you want to transfer the resource CIDR to.
Monitored:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR.'
ModifyIpamResourceDiscoveryRequest:
type: object
required:
- IpamResourceDiscoveryId
title: ModifyIpamResourceDiscoveryRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamResourceDiscoveryId:
allOf:
- $ref: '#/components/schemas/IpamResourceDiscoveryId'
- description: A resource discovery ID.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A resource discovery description.
AddOperatingRegions:
allOf:
- $ref: '#/components/schemas/AddIpamOperatingRegionSet'
- xml:
name: AddOperatingRegion
description: Add operating Regions to the resource discovery. Operating Regions are Amazon Web Services Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the Amazon Web Services Regions you select as operating Regions.
RemoveOperatingRegions:
allOf:
- $ref: '#/components/schemas/RemoveIpamOperatingRegionSet'
- xml:
name: RemoveOperatingRegion
description: Remove operating Regions.
ModifyIpamScopeRequest:
type: object
required:
- IpamScopeId
title: ModifyIpamScopeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamScopeId:
allOf:
- $ref: '#/components/schemas/IpamScopeId'
- description: The ID of the scope you want to modify.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description of the scope you want to modify.
ModifyLaunchTemplateRequest:
type: object
title: ModifyLaunchTemplateRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: '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: allOf: - $ref: '#/components/schemas/LaunchTemplateId' - description: 'The ID of the launch template.
You must specify either the LaunchTemplateId or the LaunchTemplateName, but not both.
The name of the launch template.
You must specify either the LaunchTemplateName or the LaunchTemplateId, but not both.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: ' The ID of the prefix list. Use a prefix list in place of DestinationCidrBlock. You cannot use DestinationPrefixListId and DestinationCidrBlock in the same request. '
RemovePrefixListEntries:
type: array
items:
$ref: '#/components/schemas/RemovePrefixListEntry'
minItems: 0
maxItems: 100
ModifyManagedPrefixListRequest:
type: object
required:
- PrefixListId
title: ModifyManagedPrefixListRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list.
CurrentVersion:
allOf:
- $ref: '#/components/schemas/Long'
- description: The current version of the prefix list.
PrefixListName:
allOf:
- $ref: '#/components/schemas/String'
- description: A name for the prefix list.
AddEntries:
allOf:
- $ref: '#/components/schemas/AddPrefixListEntries'
- xml:
name: AddEntry
description: One or more entries to add to the prefix list.
RemoveEntries:
allOf:
- $ref: '#/components/schemas/RemovePrefixListEntries'
- xml:
name: RemoveEntry
description: One or more entries to remove from the prefix list.
MaxEntries:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time.
If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size.
' NetworkInterfaceAttachmentChanges: type: object properties: AttachmentId: allOf: - $ref: '#/components/schemas/NetworkInterfaceAttachmentId' - xml: name: attachmentId description: The ID of the network interface attachment. DeleteOnTermination: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: deleteOnTermination description: Indicates whether the network interface is deleted when the instance is terminated. description: Describes an attachment change. ModifyNetworkInterfaceAttributeRequest: type: object required: - NetworkInterfaceId title: ModifyNetworkInterfaceAttributeRequest properties: Attachment: allOf: - $ref: '#/components/schemas/NetworkInterfaceAttachmentChanges' - xml: name: attachment description: 'Information about the interface attachment. If modifying thedelete on termination attribute, you must specify the ID of the interface attachment.'
Description:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- xml:
name: description
description: A description for the network interface.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Groups:
allOf:
- $ref: '#/components/schemas/SecurityGroupIdStringList'
- xml:
name: SecurityGroupId
description: 'Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it''s just the default security group in the VPC. You must specify the ID of the security group, not the name.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- xml:
name: sourceDestCheck
description: 'Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is true, source/destination checks are enabled; otherwise, they are disabled. The default value is true. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls.'
EnaSrdSpecification:
allOf:
- $ref: '#/components/schemas/EnaSrdSpecification'
- description: Updates the ENA Express configuration for the network interface that’s attached to the instance.
EnablePrimaryIpv6:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.'
description: Contains the parameters for ModifyNetworkInterfaceAttribute.
ModifyPrivateDnsNameOptionsRequest:
type: object
required:
- InstanceId
title: ModifyPrivateDnsNameOptionsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- description: The ID of the instance.
PrivateDnsHostnameType:
allOf:
- $ref: '#/components/schemas/HostnameType'
- description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
EnableResourceNameDnsARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
EnableResourceNameDnsAAAARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
ReservedInstancesConfigurationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservedInstancesConfiguration'
- xml:
name: item
ModifyReservedInstancesRequest:
type: object
required:
- ReservedInstancesIds
- TargetConfigurations
title: ModifyReservedInstancesRequest
properties:
ReservedInstancesIds:
allOf:
- $ref: '#/components/schemas/ReservedInstancesIdStringList'
- xml:
name: ReservedInstancesId
description: The IDs of the Reserved Instances to modify.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
TargetConfigurations:
allOf:
- $ref: '#/components/schemas/ReservedInstancesConfigurationList'
- xml:
name: ReservedInstancesConfigurationSetItemType
description: The configuration settings for the Reserved Instances to modify.
description: Contains the parameters for ModifyReservedInstances.
SecurityGroupRuleUpdateList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleUpdate'
- xml:
name: item
ModifySecurityGroupRulesRequest:
type: object
required:
- GroupId
- SecurityGroupRules
title: ModifySecurityGroupRulesRequest
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- description: The ID of the security group.
SecurityGroupRules:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleUpdateList'
- xml:
name: SecurityGroupRule
description: Information about the security group properties to update.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifySnapshotAttributeRequest:
type: object
required:
- SnapshotId
title: ModifySnapshotAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/SnapshotAttributeName'
- description: The snapshot attribute to modify. Only volume creation permissions can be modified.
CreateVolumePermission:
allOf:
- $ref: '#/components/schemas/CreateVolumePermissionModifications'
- description: A JSON representation of the snapshot attribute modification.
GroupNames:
allOf:
- $ref: '#/components/schemas/GroupNameStringList'
- xml:
name: UserGroup
description: The group to modify for the snapshot.
OperationType:
allOf:
- $ref: '#/components/schemas/OperationType'
- description: The type of operation to perform to the attribute.
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: The ID of the snapshot.
UserIds:
allOf:
- $ref: '#/components/schemas/UserIdStringList'
- xml:
name: UserId
description: The account ID to modify for the snapshot.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TargetStorageTier:
type: string
enum:
- archive
ModifySnapshotTierRequest:
type: object
required:
- SnapshotId
title: ModifySnapshotTierRequest
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: The ID of the snapshot.
StorageTier:
allOf:
- $ref: '#/components/schemas/TargetStorageTier'
- description: The name of the storage tier. You must specify archive.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifySpotFleetRequestRequest:
type: object
required:
- SpotFleetRequestId
title: ModifySpotFleetRequestRequest
properties:
ExcessCapacityTerminationPolicy:
allOf:
- $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
- xml:
name: excessCapacityTerminationPolicy
description: Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
LaunchTemplateConfigs) in your Spot Fleet request. If you specified LaunchSpecifications in your Spot Fleet request, then omit this parameter.'
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestId'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
TargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: targetCapacity
description: The size of the fleet.
OnDemandTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of On-Demand Instances in the fleet.
Context:
allOf:
- $ref: '#/components/schemas/String'
- description: Reserved.
description: Contains the parameters for ModifySpotFleetRequest.
ModifySubnetAttributeRequest:
type: object
required:
- SubnetId
title: ModifySubnetAttributeRequest
properties:
AssignIpv6AddressOnCreation:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: 'Specify true to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that''s created when launching an instance into the subnet (the instance therefore receives an IPv6 address).
If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it''s created using version 2016-11-15 or later of the Amazon EC2 API.
true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: subnetId
description: The ID of the subnet.
MapCustomerOwnedIpOnLaunch:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: 'Specify true to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address.
When this value is true, you must specify the customer-owned IP pool using CustomerOwnedIpv4Pool.
The customer-owned IPv4 address pool associated with the subnet.
You must set this value when you specify true for MapCustomerOwnedIpOnLaunch.
1 indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0). '
DisableLniAtDeviceIndex:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: ' Specify true to indicate that local network interfaces at the current position should be disabled. '
TrafficMirrorNetworkServiceList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorNetworkService'
- xml:
name: item
ModifyTrafficMirrorFilterNetworkServicesRequest:
type: object
required:
- TrafficMirrorFilterId
title: ModifyTrafficMirrorFilterNetworkServicesRequest
properties:
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterId'
- description: The ID of the Traffic Mirror filter.
AddNetworkServices:
allOf:
- $ref: '#/components/schemas/TrafficMirrorNetworkServiceList'
- xml:
name: AddNetworkService
description: 'The network service, for example Amazon DNS, that you want to mirror.'
RemoveNetworkServices:
allOf:
- $ref: '#/components/schemas/TrafficMirrorNetworkServiceList'
- xml:
name: RemoveNetworkService
description: 'The network service, for example Amazon DNS, that you no longer want to mirror.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TrafficMirrorFilterRuleFieldList:
type: array
items:
$ref: '#/components/schemas/TrafficMirrorFilterRuleField'
ModifyTrafficMirrorFilterRuleRequest:
type: object
required:
- TrafficMirrorFilterRuleId
title: ModifyTrafficMirrorFilterRuleRequest
properties:
TrafficMirrorFilterRuleId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterRuleIdWithResolver'
- description: The ID of the Traffic Mirror rule.
TrafficDirection:
allOf:
- $ref: '#/components/schemas/TrafficDirection'
- description: The type of traffic to assign to the rule.
RuleNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 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:
allOf:
- $ref: '#/components/schemas/TrafficMirrorRuleAction'
- description: The action to assign to the rule.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
- description: The destination ports that are associated with the Traffic Mirror rule.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/TrafficMirrorPortRangeRequest'
- description: The port range to assign to the Traffic Mirror rule.
Protocol:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The protocol, for example TCP, to assign to the Traffic Mirror rule.'
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: The destination CIDR block to assign to the Traffic Mirror rule.
SourceCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: The source CIDR block to assign to the Traffic Mirror rule.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description to assign to the Traffic Mirror rule.
RemoveFields:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterRuleFieldList'
- xml:
name: RemoveField
description: 'The properties that you want to remove from the Traffic Mirror filter rule.
When you remove a property from a Traffic Mirror filter rule, the property is set to the default.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
TrafficMirrorSessionFieldList:
type: array
items:
$ref: '#/components/schemas/TrafficMirrorSessionField'
ModifyTrafficMirrorSessionRequest:
type: object
required:
- TrafficMirrorSessionId
title: ModifyTrafficMirrorSessionRequest
properties:
TrafficMirrorSessionId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorSessionId'
- description: The ID of the Traffic Mirror session.
TrafficMirrorTargetId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorTargetId'
- description: 'The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source.'
TrafficMirrorFilterId:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterId'
- description: The ID of the Traffic Mirror filter.
PacketLength:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet.'
SessionNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 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: allOf: - $ref: '#/components/schemas/Integer' - description: The virtual network ID of the Traffic Mirror session. Description: allOf: - $ref: '#/components/schemas/String' - description: The description to assign to the Traffic Mirror session. RemoveFields: allOf: - $ref: '#/components/schemas/TrafficMirrorSessionFieldList' - xml: name: RemoveField description: 'The properties that you want to remove from the Traffic Mirror session.
When you remove a property from a Traffic Mirror session, the property is set to the default.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyTransitGatewayOptions:
type: object
properties:
AddTransitGatewayCidrBlocks:
allOf:
- $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
- description: 'Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.'
RemoveTransitGatewayCidrBlocks:
allOf:
- $ref: '#/components/schemas/TransitGatewayCidrBlockStringList'
- description: Removes CIDR blocks for the transit gateway.
VpnEcmpSupport:
allOf:
- $ref: '#/components/schemas/VpnEcmpSupportValue'
- description: Enable or disable Equal Cost Multipath Protocol support.
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- description: Enable or disable DNS support.
AutoAcceptSharedAttachments:
allOf:
- $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue'
- description: Enable or disable automatic acceptance of attachment requests.
DefaultRouteTableAssociation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTableAssociationValue'
- description: Enable or disable automatic association with the default association route table.
AssociationDefaultRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the default association route table.
DefaultRouteTablePropagation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTablePropagationValue'
- description: Enable or disable automatic propagation of routes to the default propagation route table.
PropagationDefaultRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the default propagation route table.
AmazonSideAsn:
allOf:
- $ref: '#/components/schemas/Long'
- description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
The modify ASN operation is not allowed on a transit gateway with active BGP sessions. You must first delete all transit gateway attachments that have BGP configured prior to modifying the ASN on the transit gateway.
description: The transit gateway options. ModifyTransitGatewayPrefixListReferenceRequest: type: object required: - TransitGatewayRouteTableId - PrefixListId title: ModifyTransitGatewayPrefixListReferenceRequest properties: TransitGatewayRouteTableId: allOf: - $ref: '#/components/schemas/TransitGatewayRouteTableId' - description: The ID of the transit gateway route table. PrefixListId: allOf: - $ref: '#/components/schemas/PrefixListResourceId' - description: The ID of the prefix list. TransitGatewayAttachmentId: allOf: - $ref: '#/components/schemas/TransitGatewayAttachmentId' - description: The ID of the attachment to which traffic is routed. Blackhole: allOf: - $ref: '#/components/schemas/Boolean' - description: Indicates whether to drop traffic that matches this route. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyTransitGatewayRequest:
type: object
required:
- TransitGatewayId
title: ModifyTransitGatewayRequest
properties:
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description for the transit gateway.
Options:
allOf:
- $ref: '#/components/schemas/ModifyTransitGatewayOptions'
- description: The options to modify.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyTransitGatewayVpcAttachmentRequestOptions:
type: object
properties:
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- description: Enable or disable DNS support. The default is enable.
Ipv6Support:
allOf:
- $ref: '#/components/schemas/Ipv6SupportValue'
- description: Enable or disable IPv6 support. The default is enable.
ApplianceModeSupport:
allOf:
- $ref: '#/components/schemas/ApplianceModeSupportValue'
- description: '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.'
description: Describes the options for a VPC attachment.
ModifyTransitGatewayVpcAttachmentRequest:
type: object
required:
- TransitGatewayAttachmentId
title: ModifyTransitGatewayVpcAttachmentRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
AddSubnetIds:
allOf:
- $ref: '#/components/schemas/TransitGatewaySubnetIdList'
- description: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
RemoveSubnetIds:
allOf:
- $ref: '#/components/schemas/TransitGatewaySubnetIdList'
- description: The IDs of one or more subnets to remove.
Options:
allOf:
- $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentRequestOptions'
- description: The new VPC attachment options.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVerifiedAccessEndpointEniOptions:
type: object
properties:
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
description: Describes the options when modifying a Verified Access endpoint with the network-interface type.
ModifyVerifiedAccessEndpointLoadBalancerOptions:
type: object
properties:
SubnetIds:
allOf:
- $ref: '#/components/schemas/ModifyVerifiedAccessEndpointSubnetIdList'
- xml:
name: SubnetId
description: The IDs of the subnets.
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- description: The IP port number.
description: Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using the load-balancer type.
ModifyVerifiedAccessEndpointPolicyRequest:
type: object
required:
- VerifiedAccessEndpointId
- PolicyEnabled
title: ModifyVerifiedAccessEndpointPolicyRequest
properties:
VerifiedAccessEndpointId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointId'
- description: The ID of the Verified Access endpoint.
PolicyEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: The status of the Verified Access policy.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- description: The Verified Access policy document.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVerifiedAccessEndpointRequest:
type: object
required:
- VerifiedAccessEndpointId
title: ModifyVerifiedAccessEndpointRequest
properties:
VerifiedAccessEndpointId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointId'
- description: The ID of the Verified Access endpoint.
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- description: The ID of the Verified Access group.
LoadBalancerOptions:
allOf:
- $ref: '#/components/schemas/ModifyVerifiedAccessEndpointLoadBalancerOptions'
- description: The load balancer details if creating the Verified Access endpoint as load-balancertype.
NetworkInterfaceOptions:
allOf:
- $ref: '#/components/schemas/ModifyVerifiedAccessEndpointEniOptions'
- description: The network interface options.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access endpoint.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVerifiedAccessGroupPolicyRequest:
type: object
required:
- VerifiedAccessGroupId
- PolicyEnabled
title: ModifyVerifiedAccessGroupPolicyRequest
properties:
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- description: The ID of the Verified Access group.
PolicyEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: The status of the Verified Access policy.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- description: The Verified Access policy document.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVerifiedAccessGroupRequest:
type: object
required:
- VerifiedAccessGroupId
title: ModifyVerifiedAccessGroupRequest
properties:
VerifiedAccessGroupId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessGroupId'
- description: The ID of the Verified Access group.
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- description: The ID of the Verified Access instance.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access group.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VerifiedAccessLogOptions:
type: object
properties:
S3:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogS3DestinationOptions'
- description: Sends Verified Access logs to Amazon S3.
CloudWatchLogs:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogCloudWatchLogsDestinationOptions'
- description: Sends Verified Access logs to CloudWatch Logs.
KinesisDataFirehose:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogKinesisDataFirehoseDestinationOptions'
- description: Sends Verified Access logs to Kinesis.
LogVersion:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The logging version to use.
Valid values: ocsf-0.1 | ocsf-1.0.0-rc.2
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
VerifiedAccessInstanceLoggingConfiguration:
type: object
properties:
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessInstanceId
description: The ID of the Amazon Web Services Verified Access instance.
AccessLogs:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogs'
- xml:
name: accessLogs
description: Details about the logging options.
description: Describes logging options for an Amazon Web Services Verified Access instance.
ModifyVerifiedAccessInstanceRequest:
type: object
required:
- VerifiedAccessInstanceId
title: ModifyVerifiedAccessInstanceRequest
properties:
VerifiedAccessInstanceId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessInstanceId'
- description: The ID of the Verified Access instance.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access instance.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
ModifyVerifiedAccessTrustProviderOidcOptions:
type: object
properties:
Issuer:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC issuer.
AuthorizationEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC authorization endpoint.
TokenEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC token endpoint.
UserInfoEndpoint:
allOf:
- $ref: '#/components/schemas/String'
- description: The OIDC user info endpoint.
ClientId:
allOf:
- $ref: '#/components/schemas/String'
- description: The client identifier.
ClientSecret:
allOf:
- $ref: '#/components/schemas/ClientSecretType'
- description: The client secret.
Scope:
allOf:
- $ref: '#/components/schemas/String'
- description: 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.
description: Options for an OpenID Connect-compatible user-identity trust provider.
ModifyVerifiedAccessTrustProviderRequest:
type: object
required:
- VerifiedAccessTrustProviderId
title: ModifyVerifiedAccessTrustProviderRequest
properties:
VerifiedAccessTrustProviderId:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderId'
- description: The ID of the Verified Access trust provider.
OidcOptions:
allOf:
- $ref: '#/components/schemas/ModifyVerifiedAccessTrustProviderOidcOptions'
- description: The options for an OpenID Connect-compatible user-identity trust provider.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: A description for the Verified Access trust provider.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.'
ModifyVolumeAttributeRequest:
type: object
required:
- VolumeId
title: ModifyVolumeAttributeRequest
properties:
AutoEnableIO:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Indicates whether the volume should be auto-enabled for I/O operations.
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeId'
- description: The ID of the volume.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVolumeRequest:
type: object
required:
- VolumeId
title: ModifyVolumeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VolumeId:
allOf:
- $ref: '#/components/schemas/VolumeId'
- description: The ID of the volume.
Size:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume.
The following are the supported volumes sizes for each volume type:
gp2 and gp3: 1-16,384
io1 and io2: 4-16,384
st1 and sc1: 125-16,384
standard: 1-1,024
Default: The existing size is retained.
' VolumeType: allOf: - $ref: '#/components/schemas/VolumeType' - description: 'The target EBS volume type of the volume. For more information, see Amazon EBS volume types in the Amazon Elastic Compute Cloud User Guide.
Default: The existing type is retained.
' Iops: allOf: - $ref: '#/components/schemas/Integer' - description: 'The target IOPS rate of the volume. This parameter is valid only for gp3, io1, and io2 volumes.
The following are the supported values for each volume type:
gp3: 3,000-16,000 IOPS
io1: 100-64,000 IOPS
io2: 100-64,000 IOPS
Default: The existing value is retained if you keep the same volume type. If you change the volume type to io1, io2, or gp3, the default is 3,000.
The target throughput of the volume, in MiB/s. This parameter is valid only for gp3 volumes. The maximum value is 1,000.
Default: The existing value is retained if the source and target volume type is gp3. Otherwise, the default value is 125.
Valid Range: Minimum value of 125. Maximum value of 1000.
' MultiAttachEnabled: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro-based instances in the same Availability Zone. This parameter is supported withio1 and io2 volumes only. For more information, see Amazon EBS Multi-Attach in the Amazon Elastic Compute Cloud User Guide.'
VolumeModification:
type: object
properties:
VolumeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeId
description: The ID of the volume.
ModificationState:
allOf:
- $ref: '#/components/schemas/VolumeModificationState'
- xml:
name: modificationState
description: The current modification state. The modification state is null for unmodified volumes.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: A status message about the modification progress or failure.
TargetSize:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: targetSize
description: 'The target size of the volume, in GiB.'
TargetIops:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: targetIops
description: The target IOPS rate of the volume.
TargetVolumeType:
allOf:
- $ref: '#/components/schemas/VolumeType'
- xml:
name: targetVolumeType
description: The target EBS volume type of the volume.
TargetThroughput:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: targetThroughput
description: 'The target throughput of the volume, in MiB/s.'
TargetMultiAttachEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: targetMultiAttachEnabled
description: The target setting for Amazon EBS Multi-Attach.
OriginalSize:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: originalSize
description: 'The original size of the volume, in GiB.'
OriginalIops:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: originalIops
description: The original IOPS rate of the volume.
OriginalVolumeType:
allOf:
- $ref: '#/components/schemas/VolumeType'
- xml:
name: originalVolumeType
description: The original EBS volume type of the volume.
OriginalThroughput:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: originalThroughput
description: 'The original throughput of the volume, in MiB/s.'
OriginalMultiAttachEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: originalMultiAttachEnabled
description: The original setting for Amazon EBS Multi-Attach.
Progress:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: progress
description: 'The modification progress, from 0 to 100 percent complete.'
StartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: startTime
description: The modification start time.
EndTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: endTime
description: The modification completion or failure time.
description: 'Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
' ModifyVpcAttributeRequest: type: object required: - VpcId title: ModifyVpcAttributeRequest properties: EnableDnsHostnames: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - description: 'Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you''ve enabled DNS support.
' EnableDnsSupport: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - description: 'Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled.
You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute.
' VpcId: allOf: - $ref: '#/components/schemas/VpcId' - xml: name: vpcId description: The ID of the VPC. EnableNetworkAddressUsageMetrics: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - description: Indicates whether Network Address Usage metrics are enabled for your VPC. ModifyVpcEndpointConnectionNotificationRequest: type: object required: - ConnectionNotificationId title: ModifyVpcEndpointConnectionNotificationRequest properties: DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ConnectionNotificationId:
allOf:
- $ref: '#/components/schemas/ConnectionNotificationId'
- description: The ID of the notification.
ConnectionNotificationArn:
allOf:
- $ref: '#/components/schemas/String'
- description: The ARN for the SNS topic for the notification.
ConnectionEvents:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: 'The events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.'
ModifyVpcEndpointRequest:
type: object
required:
- VpcEndpointId
title: ModifyVpcEndpointRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcEndpointId:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- description: The ID of the endpoint.
ResetPolicy:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
PolicyDocument:
allOf:
- $ref: '#/components/schemas/String'
- description: (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format.
AddRouteTableIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
- xml:
name: AddRouteTableId
description: (Gateway endpoint) The IDs of the route tables to associate with the endpoint.
RemoveRouteTableIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointRouteTableIdList'
- xml:
name: RemoveRouteTableId
description: (Gateway endpoint) The IDs of the route tables to disassociate from the endpoint.
AddSubnetIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointSubnetIdList'
- xml:
name: AddSubnetId
description: '(Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet.'
RemoveSubnetIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointSubnetIdList'
- xml:
name: RemoveSubnetId
description: (Interface endpoint) The IDs of the subnets from which to remove the endpoint.
AddSecurityGroupIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointSecurityGroupIdList'
- xml:
name: AddSecurityGroupId
description: (Interface endpoint) The IDs of the security groups to associate with the network interface.
RemoveSecurityGroupIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointSecurityGroupIdList'
- xml:
name: RemoveSecurityGroupId
description: (Interface endpoint) The IDs of the security groups to disassociate from the network interface.
IpAddressType:
allOf:
- $ref: '#/components/schemas/IpAddressType'
- description: The IP address type for the endpoint.
DnsOptions:
allOf:
- $ref: '#/components/schemas/DnsOptionsSpecification'
- description: The DNS options for the endpoint.
PrivateDnsEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC.
ModifyVpcEndpointServiceConfigurationRequest:
type: object
required:
- ServiceId
title: ModifyVpcEndpointServiceConfigurationRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the service.
PrivateDnsName:
allOf:
- $ref: '#/components/schemas/String'
- description: (Interface endpoint configuration) The private DNS name to assign to the endpoint service.
RemovePrivateDnsName:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: (Interface endpoint configuration) Removes the private DNS name of the endpoint service.
AcceptanceRequired:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether requests to create an endpoint to your service must be accepted.
AddNetworkLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: AddNetworkLoadBalancerArn
description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
RemoveNetworkLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: RemoveNetworkLoadBalancerArn
description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
AddGatewayLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: AddGatewayLoadBalancerArn
description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to your service configuration.
RemoveGatewayLoadBalancerArns:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: RemoveGatewayLoadBalancerArn
description: The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from your service configuration.
AddSupportedIpAddressTypes:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: AddSupportedIpAddressType
description: The IP address types to add to your service configuration.
RemoveSupportedIpAddressTypes:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: RemoveSupportedIpAddressType
description: The IP address types to remove from your service configuration.
PayerResponsibility:
type: string
enum:
- ServiceOwner
ModifyVpcEndpointServicePayerResponsibilityRequest:
type: object
required:
- ServiceId
- PayerResponsibility
title: ModifyVpcEndpointServicePayerResponsibilityRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the service.
PayerResponsibility:
allOf:
- $ref: '#/components/schemas/PayerResponsibility'
- description: 'The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner.'
ModifyVpcEndpointServicePermissionsRequest:
type: object
required:
- ServiceId
title: ModifyVpcEndpointServicePermissionsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the service.
AddAllowedPrincipals:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: 'The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).'
RemoveAllowedPrincipals:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list.
PeeringConnectionOptionsRequest:
type: object
properties:
AllowDnsResolutionFromRemoteVpc:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.'
AllowEgressFromLocalClassicLinkToRemoteVpc:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Deprecated.
description: The VPC peering connection options.
ModifyVpcPeeringConnectionOptionsRequest:
type: object
required:
- VpcPeeringConnectionId
title: ModifyVpcPeeringConnectionOptionsRequest
properties:
AccepterPeeringConnectionOptions:
allOf:
- $ref: '#/components/schemas/PeeringConnectionOptionsRequest'
- description: The VPC peering connection options for the accepter VPC.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RequesterPeeringConnectionOptions:
allOf:
- $ref: '#/components/schemas/PeeringConnectionOptionsRequest'
- description: The VPC peering connection options for the requester VPC.
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionId'
- description: The ID of the VPC peering connection.
PeeringConnectionOptions:
type: object
properties:
AllowDnsResolutionFromRemoteVpc:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowDnsResolutionFromRemoteVpc
description: 'If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.'
AllowEgressFromLocalClassicLinkToRemoteVpc:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowEgressFromLocalClassicLinkToRemoteVpc
description: Deprecated.
AllowEgressFromLocalVpcToRemoteClassicLink:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: allowEgressFromLocalVpcToRemoteClassicLink
description: Deprecated.
description: Describes the VPC peering connection options.
VpcTenancy:
type: string
enum:
- default
ModifyVpcTenancyRequest:
type: object
required:
- VpcId
- InstanceTenancy
title: ModifyVpcTenancyRequest
properties:
VpcId:
allOf:
- $ref: '#/components/schemas/VpcId'
- description: The ID of the VPC.
InstanceTenancy:
allOf:
- $ref: '#/components/schemas/VpcTenancy'
- description: 'The instance tenancy attribute for the VPC. '
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVpnConnectionOptionsRequest:
type: object
required:
- VpnConnectionId
title: ModifyVpnConnectionOptionsRequest
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: 'The ID of the Site-to-Site VPN connection. '
LocalIpv4NetworkCidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: 0.0.0.0/0
The IPv4 CIDR on the Amazon Web Services side of the VPN connection.
Default: 0.0.0.0/0
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.
Default: ::/0
The IPv6 CIDR on the Amazon Web Services side of the VPN connection.
Default: ::/0
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVpnConnectionRequest:
type: object
required:
- VpnConnectionId
title: ModifyVpnConnectionRequest
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: The ID of the VPN connection.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of the transit gateway.
CustomerGatewayId:
allOf:
- $ref: '#/components/schemas/CustomerGatewayId'
- description: The ID of the customer gateway at your end of the VPN connection.
VpnGatewayId:
allOf:
- $ref: '#/components/schemas/VpnGatewayId'
- description: The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVpnTunnelCertificateRequest:
type: object
required:
- VpnConnectionId
- VpnTunnelOutsideIpAddress
title: ModifyVpnTunnelCertificateRequest
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: The ID of the Amazon Web Services Site-to-Site VPN connection.
VpnTunnelOutsideIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The external IP address of the VPN tunnel.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ModifyVpnTunnelOptionsSpecification:
type: object
properties:
TunnelInsideCidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
' Phase1LifetimeSeconds: allOf: - $ref: '#/components/schemas/Integer' - description: 'The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
The number of seconds after which a DPD timeout occurs.
Constraints: A value greater than or equal to 30.
Default: 30
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SkipTunnelReplacement:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Choose whether or not to trigger immediate tunnel replacement.
Valid values: True | False
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
MonitoringState:
type: string
enum:
- disabled
- disabling
- enabled
- pending
MoveAddressToVpcRequest:
type: object
required:
- PublicIp
title: MoveAddressToVpcRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The Elastic IP address.
Status:
type: string
enum:
- MoveInProgress
- InVpc
- InClassic
MoveByoipCidrToIpamRequest:
type: object
required:
- Cidr
- IpamPoolId
- IpamPoolOwner
title: MoveByoipCidrToIpamRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: The BYOIP CIDR.
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The IPAM pool ID.
IpamPoolOwner:
allOf:
- $ref: '#/components/schemas/String'
- description: The Amazon Web Services account ID of the owner of the IPAM pool.
MoveStatus:
type: string
enum:
- movingToVpc
- restoringToClassic
MovingAddressStatus:
type: object
properties:
MoveStatus:
allOf:
- $ref: '#/components/schemas/MoveStatus'
- xml:
name: moveStatus
description: The status of the Elastic IP address that's being moved or restored.
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The Elastic IP address.
description: This action is deprecated.
Describes the status of a moving Elastic IP address.
ProvisionedBandwidth: type: object properties: ProvisionTime: allOf: - $ref: '#/components/schemas/DateTime' - xml: name: provisionTime description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' Provisioned: allOf: - $ref: '#/components/schemas/String' - xml: name: provisioned description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' RequestTime: allOf: - $ref: '#/components/schemas/DateTime' - xml: name: requestTime description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' Requested: allOf: - $ref: '#/components/schemas/String' - xml: name: requested description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' Status: allOf: - $ref: '#/components/schemas/String' - xml: name: status description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' description: 'Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.' NatGatewayState: type: string enum: - pending - failed - available - deleting - deleted NatGatewayAddressStatus: type: string enum: - assigning - unassigning - associating - disassociating - succeeded - failed NatGatewayAddress: type: object properties: AllocationId: allOf: - $ref: '#/components/schemas/String' - xml: name: allocationId description: '[Public NAT gateway only] The allocation ID of the Elastic IP address that''s associated with the NAT gateway.' NetworkInterfaceId: allOf: - $ref: '#/components/schemas/String' - xml: name: networkInterfaceId description: The ID of the network interface associated with the NAT gateway. PrivateIp: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIp description: The private IP address associated with the NAT gateway. PublicIp: allOf: - $ref: '#/components/schemas/String' - xml: name: publicIp description: '[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.' AssociationId: allOf: - $ref: '#/components/schemas/String' - xml: name: associationId description: '[Public NAT gateway only] The association ID of the Elastic IP address that''s associated with the NAT gateway.' IsPrimary: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: isPrimary description: Defines if the IP address is the primary address. FailureMessage: allOf: - $ref: '#/components/schemas/String' - xml: name: failureMessage description: The address failure message. Status: allOf: - $ref: '#/components/schemas/NatGatewayAddressStatus' - xml: name: status description: The address status. description: Describes the IP addresses and network interface associated with a NAT gateway. NetworkAclAssociationList: type: array items: allOf: - $ref: '#/components/schemas/NetworkAclAssociation' - xml: name: item NetworkAclEntryList: type: array items: allOf: - $ref: '#/components/schemas/NetworkAclEntry' - xml: name: item NetworkAclAssociation: type: object properties: NetworkAclAssociationId: allOf: - $ref: '#/components/schemas/String' - xml: name: networkAclAssociationId description: The ID of the association between a network ACL and a subnet. NetworkAclId: allOf: - $ref: '#/components/schemas/String' - xml: name: networkAclId description: The ID of the network ACL. SubnetId: allOf: - $ref: '#/components/schemas/String' - xml: name: subnetId description: The ID of the subnet. description: Describes an association between a network ACL and a subnet. NetworkAclAssociationId: type: string NetworkAclEntry: type: object properties: CidrBlock: allOf: - $ref: '#/components/schemas/String' - xml: name: cidrBlock description: 'The IPv4 network range to allow or deny, in CIDR notation.' Egress: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: egress description: Indicates whether the rule is an egress rule (applied to traffic leaving the subnet). IcmpTypeCode: allOf: - $ref: '#/components/schemas/IcmpTypeCode' - xml: name: icmpTypeCode description: 'ICMP protocol: The ICMP type and code.' Ipv6CidrBlock: allOf: - $ref: '#/components/schemas/String' - xml: name: ipv6CidrBlock description: 'The IPv6 network range to allow or deny, in CIDR notation.' PortRange: allOf: - $ref: '#/components/schemas/PortRange' - xml: name: portRange description: 'TCP or UDP protocols: The range of ports the rule applies to.' Protocol: allOf: - $ref: '#/components/schemas/String' - xml: name: protocol description: The protocol number. A value of "-1" means all protocols. RuleAction: allOf: - $ref: '#/components/schemas/RuleAction' - xml: name: ruleAction description: Indicates whether to allow or deny the traffic that matches the rule. RuleNumber: allOf: - $ref: '#/components/schemas/Integer' - xml: name: ruleNumber description: The rule number for the entry. ACL entries are processed in ascending order by rule number. description: Describes an entry in a network ACL. NetworkCardIndex: type: integer NetworkPerformance: type: string PeakBandwidthInGbps: type: number format: double NetworkCardInfo: type: object properties: NetworkCardIndex: allOf: - $ref: '#/components/schemas/NetworkCardIndex' - xml: name: networkCardIndex description: The index of the network card. NetworkPerformance: allOf: - $ref: '#/components/schemas/NetworkPerformance' - xml: name: networkPerformance description: The network performance of the network card. MaximumNetworkInterfaces: allOf: - $ref: '#/components/schemas/MaxNetworkInterfaces' - xml: name: maximumNetworkInterfaces description: The maximum number of network interfaces for the network card. BaselineBandwidthInGbps: allOf: - $ref: '#/components/schemas/BaselineBandwidthInGbps' - xml: name: baselineBandwidthInGbps description: 'The baseline network performance of the network card, in Gbps.' PeakBandwidthInGbps: allOf: - $ref: '#/components/schemas/PeakBandwidthInGbps' - xml: name: peakBandwidthInGbps description: 'The peak (burst) network performance of the network card, in Gbps.' description: Describes the network card support of the instance type. NetworkCardInfoList: type: array items: allOf: - $ref: '#/components/schemas/NetworkCardInfo' - xml: name: item NetworkInsightsAccessScopeAnalysis: type: object properties: NetworkInsightsAccessScopeAnalysisId: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScopeAnalysisId' - xml: name: networkInsightsAccessScopeAnalysisId description: The ID of the Network Access Scope analysis. NetworkInsightsAccessScopeAnalysisArn: allOf: - $ref: '#/components/schemas/ResourceArn' - xml: name: networkInsightsAccessScopeAnalysisArn description: The Amazon Resource Name (ARN) of the Network Access Scope analysis. NetworkInsightsAccessScopeId: allOf: - $ref: '#/components/schemas/NetworkInsightsAccessScopeId' - xml: name: networkInsightsAccessScopeId description: The ID of the Network Access Scope. Status: allOf: - $ref: '#/components/schemas/AnalysisStatus' - xml: name: status description: The status. StatusMessage: allOf: - $ref: '#/components/schemas/String' - xml: name: statusMessage description: The status message. WarningMessage: allOf: - $ref: '#/components/schemas/String' - xml: name: warningMessage description: The warning message. StartDate: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - xml: name: startDate description: The analysis start date. EndDate: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - xml: name: endDate description: The analysis end date. FindingsFound: allOf: - $ref: '#/components/schemas/FindingsFound' - xml: name: findingsFound description: Indicates whether there are findings. AnalyzedEniCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: analyzedEniCount description: The number of network interfaces analyzed. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: The tags. description: Describes a Network Access Scope analysis. NetworkInsightsAnalysis: type: object properties: NetworkInsightsAnalysisId: allOf: - $ref: '#/components/schemas/NetworkInsightsAnalysisId' - xml: name: networkInsightsAnalysisId description: The ID of the network insights analysis. NetworkInsightsAnalysisArn: allOf: - $ref: '#/components/schemas/ResourceArn' - xml: name: networkInsightsAnalysisArn description: The Amazon Resource Name (ARN) of the network insights analysis. NetworkInsightsPathId: allOf: - $ref: '#/components/schemas/NetworkInsightsPathId' - xml: name: networkInsightsPathId description: The ID of the path. AdditionalAccounts: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: additionalAccountSet description: The member accounts that contain resources that the path can traverse. FilterInArns: allOf: - $ref: '#/components/schemas/ArnList' - xml: name: filterInArnSet description: The Amazon Resource Names (ARN) of the resources that the path must traverse. StartDate: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - xml: name: startDate description: The time the analysis started. Status: allOf: - $ref: '#/components/schemas/AnalysisStatus' - xml: name: status description: The status of the network insights analysis. StatusMessage: allOf: - $ref: '#/components/schemas/String' - xml: name: statusMessage description: 'The status message, if the status isfailed.'
WarningMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: warningMessage
description: The warning message.
NetworkPathFound:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: networkPathFound
description: Indicates whether the destination is reachable from the source.
ForwardPathComponents:
allOf:
- $ref: '#/components/schemas/PathComponentList'
- xml:
name: forwardPathComponentSet
description: The components in the path from source to destination.
ReturnPathComponents:
allOf:
- $ref: '#/components/schemas/PathComponentList'
- xml:
name: returnPathComponentSet
description: The components in the path from destination to source.
Explanations:
allOf:
- $ref: '#/components/schemas/ExplanationList'
- xml:
name: explanationSet
description: 'The explanations. For more information, see Reachability Analyzer explanation codes.'
AlternatePathHints:
allOf:
- $ref: '#/components/schemas/AlternatePathHintList'
- xml:
name: alternatePathHintSet
description: Potential intermediate components.
SuggestedAccounts:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: suggestedAccountSet
description: Potential intermediate accounts.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags.
description: Describes a network insights analysis.
PathFilter:
type: object
properties:
SourceAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- xml:
name: sourceAddress
description: The source IPv4 address.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/FilterPortRange'
- xml:
name: sourcePortRange
description: The source port range.
DestinationAddress:
allOf:
- $ref: '#/components/schemas/IpAddress'
- xml:
name: destinationAddress
description: The destination IPv4 address.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/FilterPortRange'
- xml:
name: destinationPortRange
description: The destination port range.
description: Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.
NetworkInterfaceAssociation:
type: object
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: allocationId
description: The allocation ID.
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The association ID.
IpOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipOwnerId
description: The ID of the Elastic IP address owner.
PublicDnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicDnsName
description: The public DNS name.
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The address of the Elastic IP address bound to the network interface.
CustomerOwnedIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: customerOwnedIp
description: The customer-owned IP address associated with the network interface.
CarrierIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: carrierIp
description: The carrier IP address associated with the network interface.
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.
description: 'Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone).' NetworkInterfaceType: type: string enum: - interface - natGateway - efa - trunk - load_balancer - network_load_balancer - vpc_endpoint - branch - transit_gateway - lambda - quicksight - global_accelerator_managed - api_gateway_managed - gateway_load_balancer - gateway_load_balancer_endpoint - iot_rules_managed - aws_codestar_connections_managed NetworkInterfaceIpv6AddressesList: type: array items: allOf: - $ref: '#/components/schemas/NetworkInterfaceIpv6Address' - xml: name: item NetworkInterfacePrivateIpAddressList: type: array items: allOf: - $ref: '#/components/schemas/NetworkInterfacePrivateIpAddress' - xml: name: item NetworkInterfaceIpv6Address: type: object properties: Ipv6Address: allOf: - $ref: '#/components/schemas/String' - xml: name: ipv6Address description: The IPv6 address. IsPrimaryIpv6: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: isPrimaryIpv6 description: 'Determines if an IPv6 address associated with a network interface is the primary IPv6 address. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. For more information, see ModifyNetworkInterfaceAttribute.' description: Describes an IPv6 address associated with a network interface. NetworkInterfacePermissionState: type: object properties: State: allOf: - $ref: '#/components/schemas/NetworkInterfacePermissionStateCode' - xml: name: state description: The state of the permission. StatusMessage: allOf: - $ref: '#/components/schemas/String' - xml: name: statusMessage description: 'A status message, if applicable.' description: Describes the state of a network interface permission. NetworkInterfacePermissionStateCode: type: string enum: - pending - granted - revoking - revoked NetworkInterfacePrivateIpAddress: type: object properties: Association: allOf: - $ref: '#/components/schemas/NetworkInterfaceAssociation' - xml: name: association description: The association information for an Elastic IP address (IPv4) associated with the network interface. Primary: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: primary description: Indicates whether this IPv4 address is the primary private IPv4 address of the network interface. PrivateDnsName: allOf: - $ref: '#/components/schemas/String' - xml: name: privateDnsName description: The private DNS name. PrivateIpAddress: allOf: - $ref: '#/components/schemas/String' - xml: name: privateIpAddress description: The private IPv4 address. description: Describes the private IPv4 address of a network interface. NitroTpmSupportedVersionsList: type: array items: allOf: - $ref: '#/components/schemas/NitroTpmSupportedVersionType' - xml: name: item NitroTpmSupportedVersionType: type: string OccurrenceDaySet: type: array items: allOf: - $ref: '#/components/schemas/Integer' - xml: name: item OidcOptions: type: object properties: Issuer: allOf: - $ref: '#/components/schemas/String' - xml: name: issuer description: The OIDC issuer. AuthorizationEndpoint: allOf: - $ref: '#/components/schemas/String' - xml: name: authorizationEndpoint description: The OIDC authorization endpoint. TokenEndpoint: allOf: - $ref: '#/components/schemas/String' - xml: name: tokenEndpoint description: The OIDC token endpoint. UserInfoEndpoint: allOf: - $ref: '#/components/schemas/String' - xml: name: userInfoEndpoint description: The OIDC user info endpoint. ClientId: allOf: - $ref: '#/components/schemas/String' - xml: name: clientId description: The client identifier. ClientSecret: allOf: - $ref: '#/components/schemas/ClientSecretType' - xml: name: clientSecret description: The client secret. Scope: allOf: - $ref: '#/components/schemas/String' - xml: name: scope description: The OpenID Connect (OIDC) scope specified. description: Describes the options for an OpenID Connect-compatible user-identity trust provider. ProtocolList: type: array items: allOf: - $ref: '#/components/schemas/Protocol' - xml: name: item PacketHeaderStatement: type: object properties: SourceAddresses: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: sourceAddressSet description: The source addresses. DestinationAddresses: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: destinationAddressSet description: The destination addresses. SourcePorts: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: sourcePortSet description: The source ports. DestinationPorts: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: destinationPortSet description: The destination ports. SourcePrefixLists: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: sourcePrefixListSet description: The source prefix lists. DestinationPrefixLists: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: destinationPrefixListSet description: The destination prefix lists. Protocols: allOf: - $ref: '#/components/schemas/ProtocolList' - xml: name: protocolSet description: The protocols. description: Describes a packet header statement. PacketHeaderStatementRequest: type: object properties: SourceAddresses: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: SourceAddress description: The source addresses. DestinationAddresses: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: DestinationAddress description: The destination addresses. SourcePorts: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: SourcePort description: The source ports. DestinationPorts: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: DestinationPort description: The destination ports. SourcePrefixLists: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: SourcePrefixList description: The source prefix lists. DestinationPrefixLists: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: DestinationPrefixList description: The destination prefix lists. Protocols: allOf: - $ref: '#/components/schemas/ProtocolList' - xml: name: Protocol description: The protocols. description: Describes a packet header statement. PathComponent: type: object properties: SequenceNumber: allOf: - $ref: '#/components/schemas/Integer' - xml: name: sequenceNumber description: The sequence number. AclRule: allOf: - $ref: '#/components/schemas/AnalysisAclRule' - xml: name: aclRule description: The network ACL rule. AttachedTo: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: attachedTo description: The resource to which the path component is attached. Component: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: component description: The component. DestinationVpc: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: destinationVpc description: The destination VPC. OutboundHeader: allOf: - $ref: '#/components/schemas/AnalysisPacketHeader' - xml: name: outboundHeader description: The outbound header. InboundHeader: allOf: - $ref: '#/components/schemas/AnalysisPacketHeader' - xml: name: inboundHeader description: The inbound header. RouteTableRoute: allOf: - $ref: '#/components/schemas/AnalysisRouteTableRoute' - xml: name: routeTableRoute description: The route table route. SecurityGroupRule: allOf: - $ref: '#/components/schemas/AnalysisSecurityGroupRule' - xml: name: securityGroupRule description: The security group rule. SourceVpc: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: sourceVpc description: The source VPC. Subnet: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: subnet description: The subnet. Vpc: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: vpc description: The component VPC. AdditionalDetails: allOf: - $ref: '#/components/schemas/AdditionalDetailList' - xml: name: additionalDetailSet description: The additional details. TransitGateway: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: transitGateway description: The transit gateway. TransitGatewayRouteTableRoute: allOf: - $ref: '#/components/schemas/TransitGatewayRouteTableRoute' - xml: name: transitGatewayRouteTableRoute description: The route in a transit gateway route table. Explanations: allOf: - $ref: '#/components/schemas/ExplanationList' - xml: name: explanationSet description: The explanation codes. ElasticLoadBalancerListener: allOf: - $ref: '#/components/schemas/AnalysisComponent' - xml: name: elasticLoadBalancerListener description: The load balancer listener. FirewallStatelessRule: allOf: - $ref: '#/components/schemas/FirewallStatelessRule' - xml: name: firewallStatelessRule description: The Network Firewall stateless rule. FirewallStatefulRule: allOf: - $ref: '#/components/schemas/FirewallStatefulRule' - xml: name: firewallStatefulRule description: The Network Firewall stateful rule. ServiceName: allOf: - $ref: '#/components/schemas/String' - xml: name: serviceName description: The name of the VPC endpoint service. description: Describes a path component. ResourceStatement: type: object properties: Resources: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: resourceSet description: The resources. ResourceTypes: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: resourceTypeSet description: The resource types. description: Describes a resource statement. ResourceStatementRequest: type: object properties: Resources: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: Resource description: The resources. ResourceTypes: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: ResourceType description: The resource types. description: Describes a resource statement. PeeringAttachmentStatus: type: object properties: Code: allOf: - $ref: '#/components/schemas/String' - xml: name: code description: The status code. Message: allOf: - $ref: '#/components/schemas/String' - xml: name: message description: 'The status message, if applicable.' description: The status of the transit gateway peering attachment. PeeringTgwInfo: type: object properties: TransitGatewayId: allOf: - $ref: '#/components/schemas/String' - xml: name: transitGatewayId description: The ID of the transit gateway. CoreNetworkId: allOf: - $ref: '#/components/schemas/String' - xml: name: coreNetworkId description: The ID of the core network where the transit gateway peer is located. OwnerId: allOf: - $ref: '#/components/schemas/String' - xml: name: ownerId description: The ID of the Amazon Web Services account that owns the transit gateway. Region: allOf: - $ref: '#/components/schemas/String' - xml: name: region description: The Region of the transit gateway. description: Information about the transit gateway in the peering attachment. Phase1DHGroupNumbersListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/Integer' - xml: name: value description: The Diffie-Hellmann group number. description: The Diffie-Hellmann group number for phase 1 IKE negotiations. Phase1DHGroupNumbersList: type: array items: allOf: - $ref: '#/components/schemas/Phase1DHGroupNumbersListValue' - xml: name: item Phase1DHGroupNumbersRequestListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/Integer' - description: The Diffie-Hellmann group number. description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations. Phase1EncryptionAlgorithmsListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - xml: name: value description: The value for the encryption algorithm. description: The encryption algorithm for phase 1 IKE negotiations. Phase1EncryptionAlgorithmsList: type: array items: allOf: - $ref: '#/components/schemas/Phase1EncryptionAlgorithmsListValue' - xml: name: item Phase1EncryptionAlgorithmsRequestListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - description: The value for the encryption algorithm. description: Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations. Phase1IntegrityAlgorithmsListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - xml: name: value description: The value for the integrity algorithm. description: The integrity algorithm for phase 1 IKE negotiations. Phase1IntegrityAlgorithmsList: type: array items: allOf: - $ref: '#/components/schemas/Phase1IntegrityAlgorithmsListValue' - xml: name: item Phase1IntegrityAlgorithmsRequestListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - description: The value for the integrity algorithm. description: Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations. Phase2DHGroupNumbersListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/Integer' - xml: name: value description: The Diffie-Hellmann group number. description: The Diffie-Hellmann group number for phase 2 IKE negotiations. Phase2DHGroupNumbersList: type: array items: allOf: - $ref: '#/components/schemas/Phase2DHGroupNumbersListValue' - xml: name: item Phase2DHGroupNumbersRequestListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/Integer' - description: The Diffie-Hellmann group number. description: Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations. Phase2EncryptionAlgorithmsListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - xml: name: value description: The encryption algorithm. description: The encryption algorithm for phase 2 IKE negotiations. Phase2EncryptionAlgorithmsList: type: array items: allOf: - $ref: '#/components/schemas/Phase2EncryptionAlgorithmsListValue' - xml: name: item Phase2EncryptionAlgorithmsRequestListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - description: The encryption algorithm. description: Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations. Phase2IntegrityAlgorithmsListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - xml: name: value description: The integrity algorithm. description: The integrity algorithm for phase 2 IKE negotiations. Phase2IntegrityAlgorithmsList: type: array items: allOf: - $ref: '#/components/schemas/Phase2IntegrityAlgorithmsListValue' - xml: name: item Phase2IntegrityAlgorithmsRequestListValue: type: object properties: Value: allOf: - $ref: '#/components/schemas/String' - description: The integrity algorithm. description: Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations. PlacementGroupState: type: string enum: - pending - available - deleting - deleted PlacementGroupStrategyList: type: array items: allOf: - $ref: '#/components/schemas/PlacementGroupStrategy' - xml: name: item PlacementGroupStrategy: type: string enum: - cluster - partition - spread PoolCidrBlock: type: object properties: Cidr: allOf: - $ref: '#/components/schemas/String' - xml: name: poolCidrBlock description: The CIDR block. description: Describes a CIDR block for an address pool. PrefixList: type: object properties: Cidrs: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: cidrSet description: The IP address range of the Amazon Web Service. PrefixListId: allOf: - $ref: '#/components/schemas/String' - xml: name: prefixListId description: The ID of the prefix. PrefixListName: allOf: - $ref: '#/components/schemas/String' - xml: name: prefixListName description: The name of the prefix. description: Describes prefixes for Amazon Web Services services. PrefixListAssociation: type: object properties: ResourceId: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceId description: The ID of the resource. ResourceOwner: allOf: - $ref: '#/components/schemas/String' - xml: name: resourceOwner description: The owner of the resource. description: Describes the resource with which a prefix list is associated. PrefixListEntry: type: object properties: Cidr: allOf: - $ref: '#/components/schemas/String' - xml: name: cidr description: The CIDR block. Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: The description. description: Describes a prefix list entry. PrefixListId: type: object properties: Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: 'A description for the security group rule that references this prefix list ID.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
' PrefixListId: allOf: - $ref: '#/components/schemas/String' - xml: name: prefixListId description: The ID of the prefix. description: Describes a prefix list ID. PrefixListIdSet: type: array items: allOf: - $ref: '#/components/schemas/String' - xml: name: item PriceSchedule: type: object properties: Active: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: active description: 'The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.
' CurrencyCode: allOf: - $ref: '#/components/schemas/CurrencyCodeValues' - xml: name: currencyCode description: 'The currency for transacting the Reserved Instance resale. At this time, the only supported currency isUSD.'
Price:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: price
description: The fixed price for the term.
Term:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: term
description: 'The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.'
description: Describes the price for a Reserved Instance.
PriceScheduleList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PriceSchedule'
- xml:
name: item
PricingDetail:
type: object
properties:
Count:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: count
description: The number of reservations available for the price.
Price:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: price
description: The price per instance.
description: Describes a Reserved Instance offering.
PricingDetailsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PricingDetail'
- xml:
name: item
PrincipalIdFormat:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: PrincipalIdFormatARN description
Statuses:
allOf:
- $ref: '#/components/schemas/IdFormatList'
- xml:
name: statusSet
description: PrincipalIdFormatStatuses description
description: PrincipalIdFormat description
PrivateDnsDetails:
type: object
properties:
PrivateDnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateDnsName
description: The private DNS name assigned to the VPC endpoint service.
description: Information about the Private DNS name for interface endpoints.
PrivateDnsDetailsSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/PrivateDnsDetails'
- xml:
name: item
PrivateDnsNameConfiguration:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/DnsNameState'
- xml:
name: state
description: The verification state of the VPC endpoint service.
>Consumers of the endpoint service can use the private name only when the state is verified.
value text to the name.
description: Information about the private DNS name for the service endpoint.
PrivateDnsNameOptionsOnLaunch:
type: object
properties:
HostnameType:
allOf:
- $ref: '#/components/schemas/HostnameType'
- xml:
name: hostnameType
description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
EnableResourceNameDnsARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enableResourceNameDnsARecord
description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
EnableResourceNameDnsAAAARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enableResourceNameDnsAAAARecord
description: Indicates whether to respond to DNS queries for instance hostname with DNS AAAA records.
description: Describes the options for instance hostnames.
PrivateDnsNameOptionsRequest:
type: object
properties:
HostnameType:
allOf:
- $ref: '#/components/schemas/HostnameType'
- description: 'The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID.'
EnableResourceNameDnsARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS A records.
EnableResourceNameDnsAAAARecord:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records.
description: Describes the options for instance hostnames.
ScheduledInstancesPrivateIpAddressConfig:
type: object
properties:
Primary:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.'
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The IPv4 address.
description: Describes a private IPv4 address for a Scheduled Instance.
PrivateIpAddressConfigSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesPrivateIpAddressConfig'
- xml:
name: PrivateIpAddressConfigSet
ProcessorSustainedClockSpeed:
type: number
format: double
SupportedAdditionalProcessorFeatureList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SupportedAdditionalProcessorFeature'
- xml:
name: item
ProductCodeValues:
type: string
enum:
- devpay
- marketplace
ProductCode:
type: object
properties:
ProductCodeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: productCode
description: The product code.
ProductCodeType:
allOf:
- $ref: '#/components/schemas/ProductCodeValues'
- xml:
name: type
description: The type of product code.
description: Describes a product code.
PropagatingVgw:
type: object
properties:
GatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: gatewayId
description: The ID of the virtual private gateway.
description: Describes a virtual private gateway propagating route.
PropagatingVgwList:
type: array
items:
allOf:
- $ref: '#/components/schemas/PropagatingVgw'
- xml:
name: item
ProtocolInt:
type: integer
minimum: 0
maximum: 255
ProvisionByoipCidrRequest:
type: object
required:
- Cidr
title: ProvisionByoipCidrRequest
properties:
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 prefix you can specify is /56. The address range cannot overlap with another address range that you''ve brought to this or another Region.'
CidrAuthorizationContext:
allOf:
- $ref: '#/components/schemas/CidrAuthorizationContext'
- description: A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
PubliclyAdvertisable:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
' Description: allOf: - $ref: '#/components/schemas/String' - description: A description for the address range and the address pool. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
PoolTagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: PoolTagSpecification
description: The tags to apply to the address pool.
MultiRegion:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Reserved.
ProvisionIpamPoolCidrRequest:
type: object
required:
- IpamPoolId
title: ProvisionIpamPoolCidrRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool to which you want to assign a CIDR.
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process.
CidrAuthorizationContext:
allOf:
- $ref: '#/components/schemas/IpamCidrAuthorizationContext'
- description: A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option applies to public pools only.
NetmaskLength:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
ProvisionPublicIpv4PoolCidrRequest:
type: object
required:
- IpamPoolId
- PoolId
- NetmaskLength
title: ProvisionPublicIpv4PoolCidrRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool you would like to use to allocate this CIDR.
PoolId:
allOf:
- $ref: '#/components/schemas/Ipv4PoolEc2Id'
- description: The ID of the public IPv4 pool you would like to use for this CIDR.
NetmaskLength:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The netmask length of the CIDR you would like to allocate to the public IPv4 pool.
PublicIpv4PoolRange:
type: object
properties:
FirstAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: firstAddress
description: The first IP address in the range.
LastAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: lastAddress
description: The last IP address in the range.
AddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: addressCount
description: The number of addresses in the range.
AvailableAddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: availableAddressCount
description: The number of available addresses in the range.
description: Describes an address range of an IPv4 address pool.
PublicIpv4PoolRangeSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/PublicIpv4PoolRange'
- xml:
name: item
PublicIpv4Pool:
type: object
properties:
PoolId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: poolId
description: The ID of the address pool.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the address pool.
PoolAddressRanges:
allOf:
- $ref: '#/components/schemas/PublicIpv4PoolRangeSet'
- xml:
name: poolAddressRangeSet
description: The address ranges.
TotalAddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalAddressCount
description: The total number of addresses.
TotalAvailableAddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalAvailableAddressCount
description: The total number of available addresses.
NetworkBorderGroup:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkBorderGroup
description: The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where Amazon Web Services advertises public IP addresses.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags for the address pool.
description: Describes an IPv4 address pool.
Purchase:
type: object
properties:
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency in which the UpfrontPrice and HourlyPrice amounts are specified. At this time, the only supported currency is USD.'
Duration:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: duration
description: The duration of the reservation's term in seconds.
HostIdSet:
allOf:
- $ref: '#/components/schemas/ResponseHostIdSet'
- xml:
name: hostIdSet
description: The IDs of the Dedicated Hosts associated with the reservation.
HostReservationId:
allOf:
- $ref: '#/components/schemas/HostReservationId'
- xml:
name: hostReservationId
description: The ID of the reservation.
HourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hourlyPrice
description: The hourly price of the reservation per hour.
InstanceFamily:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceFamily
description: The instance family on the Dedicated Host that the reservation can be associated with.
PaymentOption:
allOf:
- $ref: '#/components/schemas/PaymentOption'
- xml:
name: paymentOption
description: The payment option for the reservation.
UpfrontPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: upfrontPrice
description: The upfront price of the reservation.
description: Describes the result of the purchase.
PurchaseHostReservationRequest:
type: object
required:
- HostIdSet
- OfferingId
title: PurchaseHostReservationRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.'
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- description: 'The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.'
HostIdSet:
allOf:
- $ref: '#/components/schemas/RequestHostIdSet'
- description: The IDs of the Dedicated Hosts with which the reservation will be associated.
LimitPrice:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The specified limit is checked against the total upfront cost of the reservation (calculated as the offering''s upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is USD. For example, to indicate a limit price of USD 100, specify 100.00.'
OfferingId:
allOf:
- $ref: '#/components/schemas/OfferingId'
- description: The ID of the offering.
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply to the Dedicated Host Reservation during purchase.
PurchaseRequestSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/PurchaseRequest'
- xml:
name: PurchaseRequest
minItems: 1
ReservedInstanceLimitPrice:
type: object
properties:
Amount:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: amount
description: Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.'
description: Describes the limit price of a Reserved Instance offering.
PurchaseReservedInstancesOfferingRequest:
type: object
required:
- InstanceCount
- ReservedInstancesOfferingId
title: PurchaseReservedInstancesOfferingRequest
properties:
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of Reserved Instances to purchase.
ReservedInstancesOfferingId:
allOf:
- $ref: '#/components/schemas/ReservedInstancesOfferingId'
- description: The ID of the Reserved Instance offering to purchase.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
LimitPrice:
allOf:
- $ref: '#/components/schemas/ReservedInstanceLimitPrice'
- xml:
name: limitPrice
description: Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices.
PurchaseTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- description: 'The time at which to purchase the Reserved Instance, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
description: Contains the parameters for PurchaseReservedInstancesOffering.
PurchaseScheduledInstancesRequest:
type: object
required:
- PurchaseRequests
title: PurchaseScheduledInstancesRequest
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PurchaseRequests:
allOf:
- $ref: '#/components/schemas/PurchaseRequestSet'
- xml:
name: PurchaseRequest
description: The purchase requests.
description: Contains the parameters for PurchaseScheduledInstances.
PurchasedScheduledInstanceSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ScheduledInstance'
- xml:
name: item
ScheduledInstance:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
CreateDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: createDate
description: The date when the Scheduled Instance was purchased.
HourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hourlyPrice
description: The hourly price for a single instance.
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: instanceCount
description: The number of instances.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: The instance type.
NetworkPlatform:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkPlatform
description: The network platform.
NextSlotStartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: nextSlotStartTime
description: The time for the next schedule to start.
Platform:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: platform
description: The platform (Linux/UNIX or Windows).
PreviousSlotEndTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: previousSlotEndTime
description: The time that the previous schedule ended or will end.
Recurrence:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceRecurrence'
- xml:
name: recurrence
description: The schedule recurrence.
ScheduledInstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: scheduledInstanceId
description: The Scheduled Instance ID.
SlotDurationInHours:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: slotDurationInHours
description: The number of hours in the schedule.
TermEndDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: termEndDate
description: The end date for the Scheduled Instance.
TermStartDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: termStartDate
description: The start date for the Scheduled Instance.
TotalScheduledInstanceHours:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalScheduledInstanceHours
description: The total number of hours for a single instance for the entire term.
description: Describes a Scheduled Instance.
ReasonCodesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReportInstanceReasonCodes'
- xml:
name: item
RebootInstancesRequest:
type: object
required:
- InstanceIds
title: RebootInstancesRequest
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdStringList'
- xml:
name: InstanceId
description: The instance IDs.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RecurringChargeFrequency:
type: string
enum:
- Hourly
RecurringCharge:
type: object
properties:
Amount:
allOf:
- $ref: '#/components/schemas/Double'
- xml:
name: amount
description: The amount of the recurring charge.
Frequency:
allOf:
- $ref: '#/components/schemas/RecurringChargeFrequency'
- xml:
name: frequency
description: The frequency of the recurring charge.
description: Describes a recurring charge.
RecurringChargesList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RecurringCharge'
- xml:
name: item
ReferencedSecurityGroup:
type: object
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the security group.
PeeringStatus:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: peeringStatus
description: 'The status of a VPC peering connection, if applicable.'
UserId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: userId
description: The Amazon Web Services account ID.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcPeeringConnectionId
description: The ID of the VPC peering connection.
description: ' Describes the security group that is referenced in the security group rule.'
Region:
type: object
properties:
Endpoint:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: regionEndpoint
description: The Region service endpoint.
RegionName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: regionName
description: The name of the Region.
OptInStatus:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: optInStatus
description: 'The Region opt-in status. The possible values are opt-in-not-required, opted-in, and not-opted-in.'
description: Describes a Region.
StringType:
type: string
minLength: 0
maxLength: 64000
RegisterImageRequest:
type: object
required:
- Name
title: RegisterImageRequest
properties:
ImageLocation:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the aws-exec-read canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see Canned ACLs in the Amazon S3 Service Developer Guide.'
Architecture:
allOf:
- $ref: '#/components/schemas/ArchitectureValues'
- xml:
name: architecture
description: 'The architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
The block device mapping entries.
If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can''t specify the encryption state of the volume.
If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, Amazon EBS local snapshots on Outposts in the Amazon EC2 User Guide.
' Description: allOf: - $ref: '#/components/schemas/String' - xml: name: description description: A description for your AMI. DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
EnaSupport:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enaSupport
description: Set to true to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
KernelId: allOf: - $ref: '#/components/schemas/KernelId' - xml: name: kernelId description: The ID of the kernel. Name: allOf: - $ref: '#/components/schemas/String' - xml: name: name description: 'A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes (''), at-signs (@), or underscores(_)
' BillingProducts: allOf: - $ref: '#/components/schemas/BillingProductList' - xml: name: BillingProduct description: 'The billing product codes. Your account must be authorized to specify billing product codes.
If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the Amazon Web Services Marketplace. You must first register as a seller on the Amazon Web Services Marketplace. For more information, see Getting started as a seller and AMI-based products in the Amazon Web Services Marketplace Seller Guide.
' RamdiskId: allOf: - $ref: '#/components/schemas/RamdiskId' - xml: name: ramdiskId description: The ID of the RAM disk. RootDeviceName: allOf: - $ref: '#/components/schemas/String' - xml: name: rootDeviceName description: 'The device name of the root device volume (for example,/dev/sda1).'
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sriovNetSupport
description: Set to simple to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI.
There is no way to disable sriovNetSupport at this time.
This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable.
VirtualizationType: allOf: - $ref: '#/components/schemas/String' - xml: name: virtualizationType description: 'The type of virtualization (hvm | paravirtual).
Default: paravirtual
The boot mode of the AMI. A value of uefi-preferred indicates that the AMI supports both UEFI and Legacy BIOS.
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see Boot modes in the Amazon EC2 User Guide.
' TpmSupport: allOf: - $ref: '#/components/schemas/TpmSupportValues' - description: 'Set tov2.0 to enable Trusted Platform Module (TPM) support. For more information, see NitroTPM in the Amazon EC2 User Guide.'
UefiData:
allOf:
- $ref: '#/components/schemas/StringType'
- description: 'Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the GetInstanceUefiData command. You can inspect and modify the UEFI data by using the python-uefivars tool on GitHub. For more information, see UEFI Secure Boot in the Amazon EC2 User Guide.'
ImdsSupport:
allOf:
- $ref: '#/components/schemas/ImdsSupportValues'
- description: 'Set to v2.0 to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have HttpTokens automatically set to required so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, HttpPutResponseHopLimit is set to 2. For more information, see Configure the AMI in the Amazon EC2 User Guide.
If you set the value to v2.0, make sure that your AMI software can support IMDSv2.
true to register all tag keys.
InstanceTagKeys:
allOf:
- $ref: '#/components/schemas/InstanceTagKeySet'
- xml:
name: InstanceTagKey
description: The tag keys to register.
description: Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either IncludeAllTagsOfInstance or InstanceTagKeys in the request
RegisterInstanceEventNotificationAttributesRequest:
type: object
required:
- InstanceTagAttribute
title: RegisterInstanceEventNotificationAttributesRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceTagAttribute:
allOf:
- $ref: '#/components/schemas/RegisterInstanceTagAttributeRequest'
- description: Information about the tag keys to register.
RegisterTransitGatewayMulticastGroupMembersRequest:
type: object
required:
- TransitGatewayMulticastDomainId
- NetworkInterfaceIds
title: RegisterTransitGatewayMulticastGroupMembersRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayNetworkInterfaceIdList'
- description: The group members' network interface IDs to register with the transit gateway multicast group.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastRegisteredGroupMembers:
type: object
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayMulticastDomainId
description: The ID of the transit gateway multicast domain.
RegisteredNetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: registeredNetworkInterfaceIds
description: The ID of the registered network interfaces.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupIpAddress
description: The IP address assigned to the transit gateway multicast group.
description: Describes the registered transit gateway multicast group members.
RegisterTransitGatewayMulticastGroupSourcesRequest:
type: object
required:
- TransitGatewayMulticastDomainId
- NetworkInterfaceIds
title: RegisterTransitGatewayMulticastGroupSourcesRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The IP address assigned to the transit gateway multicast group.
NetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/TransitGatewayNetworkInterfaceIdList'
- description: The group sources' network interface IDs to register with the transit gateway multicast group.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastRegisteredGroupSources:
type: object
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayMulticastDomainId
description: The ID of the transit gateway multicast domain.
RegisteredNetworkInterfaceIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: registeredNetworkInterfaceIds
description: The IDs of the network interfaces members registered with the transit gateway multicast group.
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupIpAddress
description: The IP address assigned to the transit gateway multicast group.
description: Describes the members registered with the transit gateway multicast group.
RejectTransitGatewayMulticastDomainAssociationsRequest:
type: object
title: RejectTransitGatewayMulticastDomainAssociationsRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway attachment.
SubnetIds:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- description: The IDs of the subnets to associate with the transit gateway multicast domain.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RejectTransitGatewayPeeringAttachmentRequest:
type: object
required:
- TransitGatewayAttachmentId
title: RejectTransitGatewayPeeringAttachmentRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the transit gateway peering attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RejectTransitGatewayVpcAttachmentRequest:
type: object
required:
- TransitGatewayAttachmentId
title: RejectTransitGatewayVpcAttachmentRequest
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RejectVpcEndpointConnectionsRequest:
type: object
required:
- ServiceId
- VpcEndpointIds
title: RejectVpcEndpointConnectionsRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the service.
VpcEndpointIds:
allOf:
- $ref: '#/components/schemas/VpcEndpointIdList'
- xml:
name: VpcEndpointId
description: The IDs of the VPC endpoints.
RejectVpcPeeringConnectionRequest:
type: object
required:
- VpcPeeringConnectionId
title: RejectVpcPeeringConnectionRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionId'
- xml:
name: vpcPeeringConnectionId
description: The ID of the VPC peering connection.
ReleaseAddressRequest:
type: object
title: ReleaseAddressRequest
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/AllocationId'
- description: The allocation ID. This parameter is required.
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- description: Deprecated.
NetworkBorderGroup:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP addresses.
If you provide an incorrect network border group, you receive an InvalidAddress.NotFound error.
You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you receive an InvalidParameterCombination error.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReleaseHostsRequest:
type: object
required:
- HostIds
title: ReleaseHostsRequest
properties:
HostIds:
allOf:
- $ref: '#/components/schemas/RequestHostIdList'
- xml:
name: hostId
description: The IDs of the Dedicated Hosts to release.
ReleaseIpamPoolAllocationRequest:
type: object
required:
- IpamPoolId
- Cidr
- IpamPoolAllocationId
title: ReleaseIpamPoolAllocationRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: '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.'
IpamPoolId:
allOf:
- $ref: '#/components/schemas/IpamPoolId'
- description: The ID of the IPAM pool which contains the allocation you want to release.
Cidr:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR of the allocation you want to release.
IpamPoolAllocationId:
allOf:
- $ref: '#/components/schemas/IpamPoolAllocationId'
- description: The ID of the allocation.
ReplaceIamInstanceProfileAssociationRequest:
type: object
required:
- IamInstanceProfile
- AssociationId
title: ReplaceIamInstanceProfileAssociationRequest
properties:
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileSpecification'
- description: The IAM instance profile.
AssociationId:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociationId'
- description: The ID of the existing IAM instance profile association.
ReplaceNetworkAclAssociationRequest:
type: object
required:
- AssociationId
- NetworkAclId
title: ReplaceNetworkAclAssociationRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/NetworkAclAssociationId'
- xml:
name: associationId
description: The ID of the current association between the original network ACL and the subnet.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkAclId:
allOf:
- $ref: '#/components/schemas/NetworkAclId'
- xml:
name: networkAclId
description: The ID of the new network ACL to associate with the subnet.
ReplaceNetworkAclEntryRequest:
type: object
required:
- Egress
- NetworkAclId
- Protocol
- RuleAction
- RuleNumber
title: ReplaceNetworkAclEntryRequest
properties:
CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrBlock
description: 'The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Egress:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: egress
description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' IcmpTypeCode: allOf: - $ref: '#/components/schemas/IcmpTypeCode' - xml: name: Icmp description: 'ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.' Ipv6CidrBlock: allOf: - $ref: '#/components/schemas/String' - xml: name: ipv6CidrBlock description: 'The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).'
NetworkAclId:
allOf:
- $ref: '#/components/schemas/NetworkAclId'
- xml:
name: networkAclId
description: The ID of the ACL.
PortRange:
allOf:
- $ref: '#/components/schemas/PortRange'
- xml:
name: portRange
description: 'TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).'
Protocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: protocol
description: '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.'
RuleAction:
allOf:
- $ref: '#/components/schemas/RuleAction'
- xml:
name: ruleAction
description: Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: ruleNumber
description: The rule number of the entry to replace.
ReplaceRootVolumeTaskState:
type: string
enum:
- pending
- in-progress
- failing
- succeeded
- failed
- failed-detached
ReplaceRouteRequest:
type: object
required:
- RouteTableId
title: ReplaceRouteRequest
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
DestinationIpv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationIpv6CidrBlock
description: The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list for the route.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
VpcEndpointId:
allOf:
- $ref: '#/components/schemas/VpcEndpointId'
- description: The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.
EgressOnlyInternetGatewayId:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGatewayId'
- xml:
name: egressOnlyInternetGatewayId
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
GatewayId:
allOf:
- $ref: '#/components/schemas/RouteGatewayId'
- xml:
name: gatewayId
description: The ID of an internet gateway or virtual private gateway.
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of a NAT instance in your VPC.
LocalTarget:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Specifies whether to reset the local route to its default target (local).
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- xml:
name: natGatewayId
description: '[IPv4 traffic only] The ID of a NAT gateway.'
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/TransitGatewayId'
- description: The ID of a transit gateway.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/LocalGatewayId'
- description: The ID of the local gateway.
CarrierGatewayId:
allOf:
- $ref: '#/components/schemas/CarrierGatewayId'
- description: '[IPv4 traffic only] The ID of a carrier gateway.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of a network interface.
RouteTableId:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: routeTableId
description: The ID of the route table.
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionId'
- xml:
name: vpcPeeringConnectionId
description: The ID of a VPC peering connection.
CoreNetworkArn:
allOf:
- $ref: '#/components/schemas/CoreNetworkArn'
- description: The Amazon Resource Name (ARN) of the core network.
ReplaceRouteTableAssociationRequest:
type: object
required:
- AssociationId
- RouteTableId
title: ReplaceRouteTableAssociationRequest
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/RouteTableAssociationId'
- xml:
name: associationId
description: The association ID.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RouteTableId:
allOf:
- $ref: '#/components/schemas/RouteTableId'
- xml:
name: routeTableId
description: The ID of the new route table to associate with the subnet.
ReplaceTransitGatewayRouteRequest:
type: object
required:
- DestinationCidrBlock
- TransitGatewayRouteTableId
title: ReplaceTransitGatewayRouteRequest
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR range used for the destination match. Routing decisions are based on the most specific match.
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the route table.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- description: The ID of the attachment.
Blackhole:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether traffic matching this route is to be dropped.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReplaceVpnTunnelRequest:
type: object
required:
- VpnConnectionId
- VpnTunnelOutsideIpAddress
title: ReplaceVpnTunnelRequest
properties:
VpnConnectionId:
allOf:
- $ref: '#/components/schemas/VpnConnectionId'
- description: 'The ID of the Site-to-Site VPN connection. '
VpnTunnelOutsideIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The external IP address of the VPN tunnel.
ApplyPendingMaintenance:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Trigger pending tunnel endpoint maintenance.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ReplacementStrategy:
type: string
enum:
- launch
- launch-before-terminate
ReportStatusType:
type: string
enum:
- ok
- impaired
ReportInstanceStatusRequest:
type: object
required:
- Instances
- ReasonCodes
- Status
title: ReportInstanceStatusRequest
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: Descriptive text about the health state of your instance.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EndTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: endTime
description: The time at which the reported instance health state ended.
Instances:
allOf:
- $ref: '#/components/schemas/InstanceIdStringList'
- xml:
name: instanceId
description: The instances.
ReasonCodes:
allOf:
- $ref: '#/components/schemas/ReasonCodesList'
- xml:
name: reasonCode
description: 'The reason codes that describe the health state of your instance.
instance-stuck-in-state: My instance is stuck in a state.
unresponsive: My instance is unresponsive.
not-accepting-credentials: My instance is not accepting my credentials.
password-not-available: A password is not available for my instance.
performance-network: My instance is experiencing performance problems that I believe are network related.
performance-instance-store: My instance is experiencing performance problems that I believe are related to the instance stores.
performance-ebs-volume: My instance is experiencing performance problems that I believe are related to an EBS volume.
performance-other: My instance is experiencing performance problems.
other: [explain using the description parameter]
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see Allocation strategies for Spot Instances in the Amazon EC2 User Guide.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use capacityOptimizedPrioritized. Set a priority for each instance type by using the Priority parameter for LaunchTemplateOverrides. You can assign the same priority to different LaunchTemplateOverrides. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. capacityOptimizedPrioritized is supported only if your Spot Fleet uses a launch template. Note that if the OnDemandAllocationStrategy is set to prioritized, the same priority is applied when fulfilling On-Demand capacity.
Spot Fleet requests instances from all of the Spot Instance pools that you specify.
Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn''t have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: lowestPrice
lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.'
SpotMaintenanceStrategies:
allOf:
- $ref: '#/components/schemas/SpotMaintenanceStrategies'
- xml:
name: spotMaintenanceStrategies
description: The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see Ensuring Idempotency.'
ExcessCapacityTerminationPolicy:
allOf:
- $ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
- xml:
name: excessCapacityTerminationPolicy
description: Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
Supported only for fleets of type maintain.
TerminateInstancesWithExpiration.'
LaunchSpecifications:
allOf:
- $ref: '#/components/schemas/LaunchSpecsList'
- xml:
name: launchSpecifications
description: 'The launch specifications for the Spot Fleet request. If you specify LaunchSpecifications, you can''t specify LaunchTemplateConfigs. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
LaunchTemplateConfigs:
allOf:
- $ref: '#/components/schemas/LaunchTemplateConfigList'
- xml:
name: launchTemplateConfigs
description: 'The launch template and overrides. If you specify LaunchTemplateConfigs, you can''t specify LaunchSpecifications. If you include On-Demand capacity in your request, you must use LaunchTemplateConfigs.'
SpotPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotPrice
description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
maintain, you can specify a target capacity of 0 and add capacity later.'
OnDemandTargetCapacity:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: onDemandTargetCapacity
description: 'The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.'
OnDemandMaxTotalPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: onDemandMaxTotalPrice
description: 'The maximum amount per hour for On-Demand Instances that you''re willing to pay. You can use the onDemandMaxTotalPrice parameter, the spotMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
SpotMaxTotalPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotMaxTotalPrice
description: 'The maximum amount per hour for Spot Instances that you''re willing to pay. You can use the spotdMaxTotalPrice parameter, the onDemandMaxTotalPrice parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you''re willing to pay. When the maximum amount you''re willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.'
TerminateInstancesWithExpiration:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: terminateInstancesWithExpiration
description: Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
Type:
allOf:
- $ref: '#/components/schemas/FleetType'
- xml:
name: type
description: 'The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is request, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is maintain, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: maintain. instant is listed but is not used by Spot Fleet.'
ValidFrom:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: validFrom
description: 'The start date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). By default, Amazon EC2 starts fulfilling the request immediately.'
ValidUntil:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: validUntil
description: 'The end date and time of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.'
ReplaceUnhealthyInstances:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: replaceUnhealthyInstances
description: Indicates whether Spot Fleet should replace unhealthy instances.
InstanceInterruptionBehavior:
allOf:
- $ref: '#/components/schemas/InstanceInterruptionBehavior'
- xml:
name: instanceInterruptionBehavior
description: The behavior when a Spot Instance is interrupted. The default is terminate.
LoadBalancersConfig:
allOf:
- $ref: '#/components/schemas/LoadBalancersConfig'
- xml:
name: loadBalancersConfig
description: 'One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.
' InstancePoolsToUseCount: allOf: - $ref: '#/components/schemas/Integer' - xml: name: instancePoolsToUseCount description: 'The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.
' Context: allOf: - $ref: '#/components/schemas/String' - xml: name: context description: Reserved. TargetCapacityUnitType: allOf: - $ref: '#/components/schemas/TargetCapacityUnitType' - xml: name: targetCapacityUnitType description: 'The unit for the target capacity. TargetCapacityUnitType can only be specified when InstanceRequirements is specified.
Default: units (translates to number of instances)
ResourceType must be spot-fleet-request, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the launch template (valid only if you use LaunchTemplateConfigs) or in the SpotFleetTagSpecification (valid only if you use LaunchSpecifications). For information about tagging after launch, see Tagging Your Resources.'
description: Describes the configuration of a Spot Fleet request.
RequestSpotFleetRequest:
type: object
required:
- SpotFleetRequestConfig
title: RequestSpotFleetRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SpotFleetRequestConfig:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestConfigData'
- xml:
name: spotFleetRequestConfig
description: The configuration for the Spot Fleet request.
description: Contains the parameters for RequestSpotFleet.
RequestSpotLaunchSpecification:
type: object
properties:
SecurityGroupIds:
allOf:
- $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupIdList'
- xml:
name: SecurityGroupId
description: The IDs of the security groups.
SecurityGroups:
allOf:
- $ref: '#/components/schemas/RequestSpotLaunchSpecificationSecurityGroupList'
- xml:
name: SecurityGroup
description: Not supported.
AddressingType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: addressingType
description: Deprecated.
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/BlockDeviceMappingList'
- xml:
name: blockDeviceMapping
description: 'The block device mapping entries. You can''t specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.'
EbsOptimized:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ebsOptimized
description: 'Indicates whether the instance is optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS Optimized instance.
Default: false
Indicates whether basic or detailed monitoring is enabled for the instance.
Default: Disabled
' NetworkInterfaces: allOf: - $ref: '#/components/schemas/InstanceNetworkInterfaceSpecificationList' - xml: name: NetworkInterface description: 'The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.' Placement: allOf: - $ref: '#/components/schemas/SpotPlacement' - xml: name: placement description: The placement information for the instance. RamdiskId: allOf: - $ref: '#/components/schemas/RamdiskId' - xml: name: ramdiskId description: The ID of the RAM disk. SubnetId: allOf: - $ref: '#/components/schemas/SubnetId' - xml: name: subnetId description: The ID of the subnet in which to launch the instance. UserData: allOf: - $ref: '#/components/schemas/SensitiveUserData' - xml: name: userData description: The base64-encoded user data that instances use when starting up. User data is limited to 16 KB. description: Describes the launch specification for an instance. RequestSpotInstancesRequest: type: object title: RequestSpotInstancesRequest properties: AvailabilityZoneGroup: allOf: - $ref: '#/components/schemas/String' - xml: name: availabilityZoneGroup description: 'The user-specified name for a logical grouping of requests.
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.
Default: Instances are launched in any available Availability Zone.
' BlockDurationMinutes: allOf: - $ref: '#/components/schemas/Integer' - xml: name: blockDurationMinutes description: Deprecated. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon EC2 User Guide for Linux Instances.' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: instanceCount
description: 'The maximum number of Spot Instances to launch.
Default: 1
' LaunchGroup: allOf: - $ref: '#/components/schemas/String' - xml: name: launchGroup description: 'The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
' LaunchSpecification: allOf: - $ref: '#/components/schemas/RequestSpotLaunchSpecification' - description: The launch specification. SpotPrice: allOf: - $ref: '#/components/schemas/String' - xml: name: spotPrice description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The Spot Instance request type.
Default: one-time
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.
' ValidUntil: allOf: - $ref: '#/components/schemas/DateTime' - xml: name: validUntil description: 'The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the ValidUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the ValidUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
ResourceType must be spot-instances-request, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see CreateTags. '
InstanceInterruptionBehavior:
allOf:
- $ref: '#/components/schemas/InstanceInterruptionBehavior'
- description: The behavior when a Spot Instance is interrupted. The default is terminate.
description: Contains the parameters for RequestSpotInstances.
ReservedInstanceReservationValue:
type: object
properties:
ReservationValue:
allOf:
- $ref: '#/components/schemas/ReservationValue'
- xml:
name: reservationValue
description: The total value of the Convertible Reserved Instance that you are exchanging.
ReservedInstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstanceId
description: The ID of the Convertible Reserved Instance that you are exchanging.
description: The total value of the Convertible Reserved Instance.
ReservedInstanceState:
type: string
enum:
- payment-pending
- active
- payment-failed
- retired
- queued
- queued-deleted
scope:
type: string
enum:
- Availability Zone
- Region
ReservedInstances:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone in which the Reserved Instance can be used.
Duration:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: duration
description: 'The duration of the Reserved Instance, in seconds.'
End:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: end
description: The time when the Reserved Instance expires.
FixedPrice:
allOf:
- $ref: '#/components/schemas/Float'
- xml:
name: fixedPrice
description: The purchase price of the Reserved Instance.
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: instanceCount
description: The number of reservations purchased.
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: The instance type on which the Reserved Instance can be used.
ProductDescription:
allOf:
- $ref: '#/components/schemas/RIProductDescription'
- xml:
name: productDescription
description: The Reserved Instance product platform description.
ReservedInstancesId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesId
description: The ID of the Reserved Instance.
Start:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: start
description: The date and time the Reserved Instance started.
State:
allOf:
- $ref: '#/components/schemas/ReservedInstanceState'
- xml:
name: state
description: The state of the Reserved Instance purchase.
UsagePrice:
allOf:
- $ref: '#/components/schemas/Float'
- xml:
name: usagePrice
description: 'The usage price of the Reserved Instance, per hour.'
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency of the Reserved Instance. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.'
InstanceTenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- xml:
name: instanceTenancy
description: The tenancy of the instance.
OfferingClass:
allOf:
- $ref: '#/components/schemas/OfferingClassType'
- xml:
name: offeringClass
description: The offering class of the Reserved Instance.
OfferingType:
allOf:
- $ref: '#/components/schemas/OfferingTypeValues'
- xml:
name: offeringType
description: The Reserved Instance offering type.
RecurringCharges:
allOf:
- $ref: '#/components/schemas/RecurringChargesList'
- xml:
name: recurringCharges
description: The recurring charge tag assigned to the resource.
Scope:
allOf:
- $ref: '#/components/schemas/scope'
- xml:
name: scope
description: The scope of the Reserved Instance.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the resource.
description: Describes a Reserved Instance.
ReservedInstancesId:
type: object
properties:
ReservedInstancesId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesId
description: The ID of the Reserved Instance.
description: Describes the ID of a Reserved Instance.
ReservedInstancesListing:
type: object
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.'
CreateDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: createDate
description: The time the listing was created.
InstanceCounts:
allOf:
- $ref: '#/components/schemas/InstanceCountList'
- xml:
name: instanceCounts
description: The number of instances in this state.
PriceSchedules:
allOf:
- $ref: '#/components/schemas/PriceScheduleList'
- xml:
name: priceSchedules
description: The price of the Reserved Instance listing.
ReservedInstancesId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesId
description: The ID of the Reserved Instance.
ReservedInstancesListingId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesListingId
description: The ID of the Reserved Instance listing.
Status:
allOf:
- $ref: '#/components/schemas/ListingStatus'
- xml:
name: status
description: The status of the Reserved Instance listing.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: The reason for the current status of the Reserved Instance listing. The response can be blank.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the resource.
UpdateDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: updateDate
description: The last modified timestamp of the listing.
description: Describes a Reserved Instance listing.
ReservedInstancesModificationResultList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservedInstancesModificationResult'
- xml:
name: item
ReservedIntancesIds:
type: array
items:
allOf:
- $ref: '#/components/schemas/ReservedInstancesId'
- xml:
name: item
ReservedInstancesModification:
type: object
properties:
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientToken
description: 'A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see Ensuring Idempotency.'
CreateDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: createDate
description: The time when the modification request was created.
EffectiveDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: effectiveDate
description: The time for the modification to become effective.
ModificationResults:
allOf:
- $ref: '#/components/schemas/ReservedInstancesModificationResultList'
- xml:
name: modificationResultSet
description: Contains target configurations along with their corresponding new Reserved Instance IDs.
ReservedInstancesIds:
allOf:
- $ref: '#/components/schemas/ReservedIntancesIds'
- xml:
name: reservedInstancesSet
description: The IDs of one or more Reserved Instances.
ReservedInstancesModificationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesModificationId
description: A unique ID for the Reserved Instance modification.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: The status of the Reserved Instances modification request.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: The reason for the status.
UpdateDate:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: updateDate
description: The time when the modification request was last updated.
description: Describes a Reserved Instance modification.
ReservedInstancesModificationResult:
type: object
properties:
ReservedInstancesId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesId
description: The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.
TargetConfiguration:
allOf:
- $ref: '#/components/schemas/ReservedInstancesConfiguration'
- xml:
name: targetConfiguration
description: The target Reserved Instances configurations supplied as part of the modification request.
description: Describes the modification request/s.
ReservedInstancesOffering:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone in which the Reserved Instance can be used.
Duration:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: duration
description: 'The duration of the Reserved Instance, in seconds.'
FixedPrice:
allOf:
- $ref: '#/components/schemas/Float'
- xml:
name: fixedPrice
description: The purchase price of the Reserved Instance.
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: The instance type on which the Reserved Instance can be used.
ProductDescription:
allOf:
- $ref: '#/components/schemas/RIProductDescription'
- xml:
name: productDescription
description: The Reserved Instance product platform description.
ReservedInstancesOfferingId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesOfferingId
description: The ID of the Reserved Instance offering. This is the offering ID used in GetReservedInstancesExchangeQuote to confirm that an exchange can be made.
UsagePrice:
allOf:
- $ref: '#/components/schemas/Float'
- xml:
name: usagePrice
description: 'The usage price of the Reserved Instance, per hour.'
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCodeValues'
- xml:
name: currencyCode
description: 'The currency of the Reserved Instance offering you are purchasing. It''s specified using ISO 4217 standard currency codes. At this time, the only supported currency is USD.'
InstanceTenancy:
allOf:
- $ref: '#/components/schemas/Tenancy'
- xml:
name: instanceTenancy
description: The tenancy of the instance.
Marketplace:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: marketplace
description: 'Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or Amazon Web Services. If it''s a Reserved Instance Marketplace offering, this is true.'
OfferingClass:
allOf:
- $ref: '#/components/schemas/OfferingClassType'
- xml:
name: offeringClass
description: 'If convertible it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If standard, it is not possible to perform an exchange.'
OfferingType:
allOf:
- $ref: '#/components/schemas/OfferingTypeValues'
- xml:
name: offeringType
description: The Reserved Instance offering type.
PricingDetails:
allOf:
- $ref: '#/components/schemas/PricingDetailsList'
- xml:
name: pricingDetailsSet
description: The pricing details of the Reserved Instance offering.
RecurringCharges:
allOf:
- $ref: '#/components/schemas/RecurringChargesList'
- xml:
name: recurringCharges
description: The recurring charge tag assigned to the resource.
Scope:
allOf:
- $ref: '#/components/schemas/scope'
- xml:
name: scope
description: Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.
description: Describes a Reserved Instance offering.
ResetAddressAttributeRequest:
type: object
required:
- AllocationId
- Attribute
title: ResetAddressAttributeRequest
properties:
AllocationId:
allOf:
- $ref: '#/components/schemas/AllocationId'
- description: '[EC2-VPC] The allocation ID.'
Attribute:
allOf:
- $ref: '#/components/schemas/AddressAttributeName'
- description: The attribute of the IP address.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ResetEbsDefaultKmsKeyIdRequest:
type: object
title: ResetEbsDefaultKmsKeyIdRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ResetFpgaImageAttributeName:
type: string
enum:
- loadPermission
ResetFpgaImageAttributeRequest:
type: object
required:
- FpgaImageId
title: ResetFpgaImageAttributeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
FpgaImageId:
allOf:
- $ref: '#/components/schemas/FpgaImageId'
- description: The ID of the AFI.
Attribute:
allOf:
- $ref: '#/components/schemas/ResetFpgaImageAttributeName'
- description: The attribute.
ResetImageAttributeName:
type: string
enum:
- launchPermission
ResetImageAttributeRequest:
type: object
required:
- Attribute
- ImageId
title: ResetImageAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/ResetImageAttributeName'
- description: The attribute to reset (currently you can only reset the launch permission attribute).
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
description: Contains the parameters for ResetImageAttribute.
ResetInstanceAttributeRequest:
type: object
required:
- Attribute
- InstanceId
title: ResetInstanceAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/InstanceAttributeName'
- xml:
name: attribute
description: 'The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: The ID of the instance.
ResetNetworkInterfaceAttributeRequest:
type: object
required:
- NetworkInterfaceId
title: ResetNetworkInterfaceAttributeRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourceDestCheck
description: The source/destination checking attribute. Resets the value to true.
description: Contains the parameters for ResetNetworkInterfaceAttribute.
ResetSnapshotAttributeRequest:
type: object
required:
- Attribute
- SnapshotId
title: ResetSnapshotAttributeRequest
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/SnapshotAttributeName'
- description: 'The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.'
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: The ID of the snapshot.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RestoreAddressToClassicRequest:
type: object
required:
- PublicIp
title: RestoreAddressToClassicRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PublicIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: publicIp
description: The Elastic IP address.
RestoreImageFromRecycleBinRequest:
type: object
required:
- ImageId
title: RestoreImageFromRecycleBinRequest
properties:
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI to restore.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RestoreManagedPrefixListVersionRequest:
type: object
required:
- PrefixListId
- PreviousVersion
- CurrentVersion
title: RestoreManagedPrefixListVersionRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
PrefixListId:
allOf:
- $ref: '#/components/schemas/PrefixListResourceId'
- description: The ID of the prefix list.
PreviousVersion:
allOf:
- $ref: '#/components/schemas/Long'
- description: The version to restore.
CurrentVersion:
allOf:
- $ref: '#/components/schemas/Long'
- description: The current version number for the prefix list.
RestoreSnapshotFromRecycleBinRequest:
type: object
required:
- SnapshotId
title: RestoreSnapshotFromRecycleBinRequest
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: The ID of the snapshot to restore.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SnapshotState:
type: string
enum:
- pending
- completed
- error
- recoverable
- recovering
RestoreSnapshotTierRequestTemporaryRestoreDays:
type: integer
RestoreSnapshotTierRequest:
type: object
required:
- SnapshotId
title: RestoreSnapshotTierRequest
properties:
SnapshotId:
allOf:
- $ref: '#/components/schemas/SnapshotId'
- description: The ID of the snapshot to restore.
TemporaryRestoreDays:
allOf:
- $ref: '#/components/schemas/RestoreSnapshotTierRequestTemporaryRestoreDays'
- description: 'Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.
To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.
true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RevokeClientVpnIngressRequest:
type: object
required:
- ClientVpnEndpointId
- TargetNetworkCidr
title: RevokeClientVpnIngressRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint with which the authorization rule is associated.
TargetNetworkCidr:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IPv4 address range, in CIDR notation, of the network for which access is being removed.'
AccessGroupId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ID of the Active Directory group for which to revoke access. '
RevokeAllGroups:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether access should be revoked for all clients.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
RevokeSecurityGroupEgressRequest:
type: object
required:
- GroupId
title: RevokeSecurityGroupEgressRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: groupId
description: The ID of the security group.
IpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- xml:
name: ipPermissions
description: The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.
SecurityGroupRuleIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleIdList'
- xml:
name: SecurityGroupRuleId
description: The IDs of the security group rules.
CidrIp:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: cidrIp
description: Not supported. Use a set of IP permissions to specify the CIDR.
FromPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: fromPort
description: Not supported. Use a set of IP permissions to specify the port.
IpProtocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipProtocol
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
ToPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: toPort
description: Not supported. Use a set of IP permissions to specify the port.
SourceSecurityGroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourceSecurityGroupName
description: Not supported. Use a set of IP permissions to specify a destination security group.
SourceSecurityGroupOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourceSecurityGroupOwnerId
description: Not supported. Use a set of IP permissions to specify a destination security group.
RevokeSecurityGroupIngressRequest:
type: object
title: RevokeSecurityGroupIngressRequest
properties:
CidrIp:
allOf:
- $ref: '#/components/schemas/String'
- description: The CIDR IP address range. You can't specify this parameter when specifying a source security group.
FromPort:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the type number. A value of -1 indicates all ICMP types.'
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- description: The ID of the security group.
GroupName:
allOf:
- $ref: '#/components/schemas/SecurityGroupName'
- description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
IpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- description: The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.
IpProtocol:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.'
SourceSecurityGroupName:
allOf:
- $ref: '#/components/schemas/String'
- description: '[Default VPC] The name of the source security group. You can''t specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. The source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.'
SourceSecurityGroupOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- description: Not supported.
ToPort:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the code. A value of -1 indicates all ICMP codes.'
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SecurityGroupRuleIds:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleIdList'
- xml:
name: SecurityGroupRuleId
description: The IDs of the security group rules.
RootDeviceType:
type: string
enum:
- ebs
- instance-store
RouteOrigin:
type: string
enum:
- CreateRouteTable
- CreateRoute
- EnableVgwRoutePropagation
RouteState:
type: string
enum:
- active
- blackhole
Route:
type: object
properties:
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: The IPv4 CIDR block used for the destination match.
DestinationIpv6CidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationIpv6CidrBlock
description: The IPv6 CIDR block used for the destination match.
DestinationPrefixListId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationPrefixListId
description: The prefix of the Amazon Web Service.
EgressOnlyInternetGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: egressOnlyInternetGatewayId
description: The ID of the egress-only internet gateway.
GatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: gatewayId
description: The ID of a gateway attached to your VPC.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of a NAT instance in your VPC.
InstanceOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceOwnerId
description: The ID of Amazon Web Services account that owns the instance.
NatGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: natGatewayId
description: The ID of a NAT gateway.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayId
description: The ID of a transit gateway.
LocalGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: localGatewayId
description: The ID of the local gateway.
CarrierGatewayId:
allOf:
- $ref: '#/components/schemas/CarrierGatewayId'
- xml:
name: carrierGatewayId
description: The ID of the carrier gateway.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
Origin:
allOf:
- $ref: '#/components/schemas/RouteOrigin'
- xml:
name: origin
description: Describes how the route was created.
CreateRouteTable - The route was automatically created when the route table was created.
CreateRoute - The route was manually added to the route table.
EnableVgwRoutePropagation - The route was propagated by route propagation.
blackhole state indicates that the route''s target isn''t available (for example, the specified gateway isn''t attached to the VPC, or the specified NAT instance has been terminated).'
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcPeeringConnectionId
description: The ID of a VPC peering connection.
CoreNetworkArn:
allOf:
- $ref: '#/components/schemas/CoreNetworkArn'
- xml:
name: coreNetworkArn
description: The Amazon Resource Name (ARN) of the core network.
description: Describes a route in a route table.
RouteList:
type: array
items:
allOf:
- $ref: '#/components/schemas/Route'
- xml:
name: item
RouteTableAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/RouteTableAssociation'
- xml:
name: item
RouteTableAssociation:
type: object
properties:
Main:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: main
description: Indicates whether this is the main route table.
RouteTableAssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: routeTableAssociationId
description: The ID of the association.
RouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: routeTableId
description: The ID of the route table.
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetId
description: The ID of the subnet. A subnet ID is not returned for an implicit association.
GatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: gatewayId
description: The ID of the internet gateway or virtual private gateway.
AssociationState:
allOf:
- $ref: '#/components/schemas/RouteTableAssociationState'
- xml:
name: associationState
description: The state of the association.
description: Describes an association between a route table and a subnet or gateway.
RouteTableAssociationStateCode:
type: string
enum:
- associating
- associated
- disassociating
- disassociated
- failed
RuleGroupRuleOptionsPair:
type: object
properties:
RuleGroupArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ruleGroupArn
description: The ARN of the rule group.
RuleOptions:
allOf:
- $ref: '#/components/schemas/RuleOptionList'
- xml:
name: ruleOptionSet
description: The rule options.
description: Describes the rule options for a stateful rule group.
RuleGroupTypePair:
type: object
properties:
RuleGroupArn:
allOf:
- $ref: '#/components/schemas/ResourceArn'
- xml:
name: ruleGroupArn
description: The ARN of the rule group.
RuleGroupType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ruleGroupType
description: The rule group type. The possible values are Domain List and Suricata.
description: Describes the type of a stateful rule group.
RuleOption:
type: object
properties:
Keyword:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: keyword
description: The Suricata keyword.
Settings:
allOf:
- $ref: '#/components/schemas/StringList'
- xml:
name: settingSet
description: The settings for the keyword.
description: Describes additional settings for a stateful rule.
RunInstancesUserData:
type: string
format: password
RunInstancesRequest:
type: object
required:
- MaxCount
- MinCount
title: RunInstancesRequest
properties:
BlockDeviceMappings:
allOf:
- $ref: '#/components/schemas/BlockDeviceMappingRequestList'
- xml:
name: BlockDeviceMapping
description: 'The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see Block device mappings in the Amazon EC2 User Guide.'
ImageId:
allOf:
- $ref: '#/components/schemas/ImageId'
- description: The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: 'The instance type. For more information, see Instance types in the Amazon EC2 User Guide.'
Ipv6AddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
Ipv6Addresses: allOf: - $ref: '#/components/schemas/InstanceIpv6AddressList' - xml: name: Ipv6Address description:The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
KernelId: allOf: - $ref: '#/components/schemas/KernelId' - description: 'The ID of the kernel.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The name of the key pair. You can create a key pair using CreateKeyPair or ImportKeyPair.
If you do not specify a key pair, you can''t connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
The maximum number of instances to launch. If you specify more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above MinCount.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 FAQ.
' MinCount: allOf: - $ref: '#/components/schemas/Integer' - description: 'The minimum number of instances to launch. If you specify a minimum that is more instances than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches no instances.
Constraints: Between 1 and the maximum number you''re allowed for the specified instance type. For more information about the default limits, and how to request an increase, see How many instances can I run in Amazon EC2 in the Amazon EC2 General FAQ.
' Monitoring: allOf: - $ref: '#/components/schemas/RunInstancesMonitoringEnabled' - description: Specifies whether detailed monitoring is enabled for the instance. Placement: allOf: - $ref: '#/components/schemas/Placement' - description: The placement for the instance. RamdiskId: allOf: - $ref: '#/components/schemas/RamdiskId' - description: 'The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the Amazon Web Services Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon EC2 User Guide.
The IDs of the security groups. You can create a security group using CreateSecurityGroup.
If you specify a network interface, you must specify any security groups as part of the network interface.
' SecurityGroups: allOf: - $ref: '#/components/schemas/SecurityGroupStringList' - xml: name: SecurityGroup description: '[Default VPC] The names of the security groups.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
' SubnetId: allOf: - $ref: '#/components/schemas/SubnetId' - description: 'The ID of the subnet to launch the instance into.
If you specify a network interface, you must specify any subnets as part of the network interface.
' UserData: allOf: - $ref: '#/components/schemas/RunInstancesUserData' - description: 'The user data script to make available to the instance. For more information, see Run commands on your Linux instance at launch and Run commands on your Windows instance at launch. If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB.' AdditionalInfo: allOf: - $ref: '#/components/schemas/String' - xml: name: additionalInfo description: Reserved. ClientToken: allOf: - $ref: '#/components/schemas/String' - xml: name: clientToken description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.
For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' DisableApiTermination: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: disableApiTermination description: 'If you set this parameter to true, you can''t terminate the instance using the Amazon EC2 console, CLI, or API; otherwise, you can. To change this attribute after launch, use ModifyInstanceAttribute. Alternatively, if you set InstanceInitiatedShutdownBehavior to terminate, you can terminate the instance by running the shutdown command from the instance.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
EbsOptimized:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: ebsOptimized
description: 'Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
ElasticGpuSpecification: allOf: - $ref: '#/components/schemas/ElasticGpuSpecifications' - description: 'An elastic GPU to associate with the instance. An Elastic GPU is a GPU resource that you can attach to your Windows instance to accelerate the graphics performance of your applications. For more information, see Amazon EC2 Elastic GPUs in the Amazon EC2 User Guide.' ElasticInferenceAccelerators: allOf: - $ref: '#/components/schemas/ElasticInferenceAccelerators' - xml: name: ElasticInferenceAccelerator description: 'An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.
You cannot specify accelerators from different generations in the same request.
Starting April 15, 2023, Amazon Web Services will not onboard new customers to Amazon Elastic Inference (EI), and will help current customers migrate their workloads to options that offer better price and performance. After April 15, 2023, new customers will not be able to launch instances with Amazon EI accelerators in Amazon SageMaker, Amazon ECS, or Amazon EC2. However, customers who have used Amazon EI at least once during the past 30-day period are considered current customers and will be able to continue using the service.
The tags to apply to the resources that are created during instance launch.
You can specify tags for the following resources only:
Instances
Volumes
Elastic graphics
Spot Instance requests
Network interfaces
To tag a resource after it has been created, see CreateTags.
' LaunchTemplate: allOf: - $ref: '#/components/schemas/LaunchTemplateSpecification' - description: 'The launch template to use to launch the instances. Any parameters that you specify in RunInstances override the same parameters in the launch template. You can specify either the name or ID of a launch template, but not both.' InstanceMarketOptions: allOf: - $ref: '#/components/schemas/InstanceMarketOptionsRequest' - description: 'The market (purchasing) option for the instances.
For RunInstances, persistent Spot Instance requests are only supported when InstanceInterruptionBehavior is set to either hibernate or stop.
The credit option for CPU usage of the burstable performance instance. Valid values are standard and unlimited. To change this attribute after launch, use ModifyInstanceCreditSpecification. For more information, see Burstable performance instances in the Amazon EC2 User Guide.
Default: standard (T2 instances) or unlimited (T3/T3a/T4g instances)
For T3 instances with host tenancy, only standard is supported.
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).'
HibernationOptions:
allOf:
- $ref: '#/components/schemas/HibernationOptionsRequest'
- description: 'Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
You can''t enable hibernation and Amazon Web Services Nitro Enclaves on the same instance.
' LicenseSpecifications: allOf: - $ref: '#/components/schemas/LicenseSpecificationListRequest' - xml: name: LicenseSpecification description: The license configurations. MetadataOptions: allOf: - $ref: '#/components/schemas/InstanceMetadataOptionsRequest' - description: 'The metadata options for the instance. For more information, see Instance metadata and user data.' EnclaveOptions: allOf: - $ref: '#/components/schemas/EnclaveOptionsRequest' - description: 'Indicates whether the instance is enabled for Amazon Web Services Nitro Enclaves. For more information, see What is Amazon Web Services Nitro Enclaves? in the Amazon Web Services Nitro Enclaves User Guide.
You can''t enable Amazon Web Services Nitro Enclaves and hibernation on the same instance.
' PrivateDnsNameOptions: allOf: - $ref: '#/components/schemas/PrivateDnsNameOptionsRequest' - description: 'The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.' MaintenanceOptions: allOf: - $ref: '#/components/schemas/InstanceMaintenanceOptionsRequest' - description: The maintenance and recovery options for the instance. DisableApiStop: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether an instance is enabled for stop protection. For more information, see Stop protection. ' EnablePrimaryIpv6: allOf: - $ref: '#/components/schemas/Boolean' - description: 'If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, Amazon Web Services will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.' ScheduledInstancesLaunchSpecification: type: object required: - ImageId properties: BlockDeviceMappings: allOf: - $ref: '#/components/schemas/ScheduledInstancesBlockDeviceMappingSet' - xml: name: BlockDeviceMapping description: The block device mapping entries. EbsOptimized: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether the instances are optimized for EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn''t available with all instance types. Additional usage charges apply when using an EBS-optimized instance.
Default: false
Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The number of instances.
Default: 1
' LaunchSpecification: allOf: - $ref: '#/components/schemas/ScheduledInstancesLaunchSpecification' - description: 'The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.' ScheduledInstanceId: allOf: - $ref: '#/components/schemas/ScheduledInstanceId' - description: The Scheduled Instance ID. description: Contains the parameters for RunScheduledInstances. ScheduledInstanceRecurrence: type: object properties: Frequency: allOf: - $ref: '#/components/schemas/String' - xml: name: frequency description: 'The frequency (Daily, Weekly, or Monthly).'
Interval:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: interval
description: 'The interval quantity. The interval unit depends on the value of frequency. For example, every 2 weeks or every 2 months.'
OccurrenceDaySet:
allOf:
- $ref: '#/components/schemas/OccurrenceDaySet'
- xml:
name: occurrenceDaySet
description: 'The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).'
OccurrenceRelativeToEnd:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: occurrenceRelativeToEnd
description: Indicates whether the occurrence is relative to the end of the specified week or month.
OccurrenceUnit:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: occurrenceUnit
description: The unit for occurrenceDaySet (DayOfWeek or DayOfMonth).
description: Describes the recurring schedule for a Scheduled Instance.
ScheduledInstanceAvailability:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
AvailableInstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: availableInstanceCount
description: The number of available instances.
FirstSlotStartTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: firstSlotStartTime
description: The time period for the first schedule to start.
HourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: hourlyPrice
description: The hourly price for a single instance.
InstanceType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceType
description: 'The instance type. You can specify one of the C3, C4, M4, or R3 instance types.'
MaxTermDurationInDays:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: maxTermDurationInDays
description: The maximum term. The only possible value is 365 days.
MinTermDurationInDays:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: minTermDurationInDays
description: The minimum term. The only possible value is 365 days.
NetworkPlatform:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkPlatform
description: The network platform.
Platform:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: platform
description: The platform (Linux/UNIX or Windows).
PurchaseToken:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: purchaseToken
description: The purchase token. This token expires in two hours.
Recurrence:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceRecurrence'
- xml:
name: recurrence
description: The schedule recurrence.
SlotDurationInHours:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: slotDurationInHours
description: The number of hours in the schedule.
TotalScheduledInstanceHours:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: totalScheduledInstanceHours
description: The total number of hours for a single instance for the entire term.
description: Describes a schedule that is available for your Scheduled Instances.
ScheduledInstancesEbs:
type: object
properties:
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the volume is deleted on instance termination.
Encrypted:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.
Iops:
allOf:
- $ref: '#/components/schemas/Integer'
- description: 'The number of I/O operations per second (IOPS) to provision for an io1 or io2 volume, with a maximum ratio of 50 IOPS/GiB for io1, and 500 IOPS/GiB for io2. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on instances built on the Nitro System. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS volume types in the Amazon EC2 User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1 and io2) volumes.
The size of the volume, in GiB.
Default: If you''re creating the volume from a snapshot and don''t specify a volume size, the default is the snapshot size.
' VolumeType: allOf: - $ref: '#/components/schemas/String' - description: 'The volume type. gp2 for General Purpose SSD, io1 or io2 for Provisioned IOPS SSD, Throughput Optimized HDD for st1, Cold HDD for sc1, or standard for Magnetic.
Default: gp2
/dev/sdh or xvdh).'
Ebs:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesEbs'
- description: Parameters used to set up EBS volumes automatically when the instance is launched.
NoDevice:
allOf:
- $ref: '#/components/schemas/String'
- description: 'To omit the device from the block device mapping, specify an empty string.'
VirtualName:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.
' description: Describes a block device mapping for a Scheduled Instance. ScheduledInstancesIpv6Address: type: object properties: Ipv6Address: allOf: - $ref: '#/components/schemas/Ipv6Address' - description: The IPv6 address. description: Describes an IPv6 address. ScheduledInstancesIpv6AddressList: type: array items: allOf: - $ref: '#/components/schemas/ScheduledInstancesIpv6Address' - xml: name: Ipv6Address ScheduledInstancesNetworkInterface: type: object properties: AssociatePublicIpAddress: allOf: - $ref: '#/components/schemas/Boolean' - description: 'Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value istrue.'
DeleteOnTermination:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: Indicates whether to delete the interface when the instance is terminated.
Description:
allOf:
- $ref: '#/components/schemas/String'
- description: The description.
DeviceIndex:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The index of the device for the network interface attachment.
Groups:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesSecurityGroupIdSet'
- xml:
name: Group
description: The IDs of the security groups.
Ipv6AddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.
Ipv6Addresses:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesIpv6AddressList'
- xml:
name: Ipv6Address
description: The specific IPv6 addresses from the subnet range.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- description: The ID of the network interface.
PrivateIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- description: The IPv4 address of the network interface within the subnet.
PrivateIpAddressConfigs:
allOf:
- $ref: '#/components/schemas/PrivateIpAddressConfigSet'
- xml:
name: PrivateIpAddressConfig
description: The private IPv4 addresses.
SecondaryPrivateIpAddressCount:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The number of secondary private IPv4 addresses.
SubnetId:
allOf:
- $ref: '#/components/schemas/SubnetId'
- description: The ID of the subnet.
description: Describes a network interface for a Scheduled Instance.
SearchLocalGatewayRoutesRequest:
type: object
required:
- LocalGatewayRouteTableId
title: SearchLocalGatewayRoutesRequest
properties:
LocalGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/LocalGatewayRoutetableId'
- description: The ID of the local gateway route table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route.
type - The route type.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
SearchTransitGatewayMulticastGroupsRequest:
type: object
required:
- TransitGatewayMulticastDomainId
title: SearchTransitGatewayMulticastGroupsRequest
properties:
TransitGatewayMulticastDomainId:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastDomainId'
- description: The ID of the transit gateway multicast domain.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
group-ip-address - The IP address of the transit gateway multicast group.
is-group-member - The resource is a group member. Valid values are true | false.
is-group-source - The resource is a group source. Valid values are true | false.
member-type - The member type. Valid values are igmp | static.
resource-id - The ID of the resource.
resource-type - The type of resource. Valid values are vpc | vpn | direct-connect-gateway | tgw-peering.
source-type - The source type. Valid values are igmp | static.
subnet-id - The ID of the subnet.
transit-gateway-attachment-id - The id of the transit gateway attachment.
nextToken value.'
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token for the next page of results.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayMulticastGroupList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulticastGroup'
- xml:
name: item
SearchTransitGatewayRoutesRequest:
type: object
required:
- TransitGatewayRouteTableId
- Filters
title: SearchTransitGatewayRoutesRequest
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- description: The ID of the transit gateway route table.
Filters:
allOf:
- $ref: '#/components/schemas/FilterList'
- xml:
name: Filter
description: 'One or more filters. The possible values are:
attachment.transit-gateway-attachment-id- The id of the transit gateway attachment.
attachment.resource-id - The resource id of the transit gateway attachment.
attachment.resource-type - The attachment resource type. Valid values are vpc | vpn | direct-connect-gateway | peering | connect.
prefix-list-id - The ID of the prefix list.
route-search.exact-match - The exact match of the specified filter.
route-search.longest-prefix-match - The longest prefix that matches the route.
route-search.subnet-of-match - The routes with a subnet that match the specified CIDR filter.
route-search.supernet-of-match - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
state - The state of the route (active | blackhole).
type - The type of route (propagated | static).
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TransitGatewayRouteList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRoute'
- xml:
name: item
SecurityGroup:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupDescription
description: A description of the security group.
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupName
description: The name of the security group.
IpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- xml:
name: ipPermissions
description: The inbound rules associated with the security group.
OwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ownerId
description: The Amazon Web Services account ID of the owner of the security group.
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the security group.
IpPermissionsEgress:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- xml:
name: ipPermissionsEgress
description: The outbound rules associated with the security group.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the security group.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC for the security group.
description: Describes a security group.
SecurityGroupReference:
type: object
properties:
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of your security group.
ReferencingVpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: referencingVpcId
description: The ID of the VPC with the referencing security group.
VpcPeeringConnectionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcPeeringConnectionId
description: The ID of the VPC peering connection.
description: Describes a VPC with a security group that references your security group.
SecurityGroupRuleId:
type: string
SecurityGroupRule:
type: object
properties:
SecurityGroupRuleId:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleId'
- xml:
name: securityGroupRuleId
description: The ID of the security group rule.
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- xml:
name: groupId
description: The ID of the security group.
GroupOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupOwnerId
description: 'The ID of the Amazon Web Services account that owns the security group. '
IsEgress:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: isEgress
description: Indicates whether the security group rule is an outbound rule.
IpProtocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ipProtocol
description: 'The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
The IP protocol name (tcp, udp, icmp, icmpv6) or number (see Protocol Numbers).
Use -1 to specify all protocols.
Describes a security group rule.
You must specify exactly one of the following parameters, based on the rule type:
CidrIpv4
CidrIpv6
PrefixListId
ReferencedGroupId
When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use CidrIpv4 to specify a new IPv4 address range.
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceTypeDetailSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/ServiceTypeDetail'
- xml:
name: item
ServiceState:
type: string
enum:
- Pending
- Available
- Deleting
- Deleted
- Failed
SupportedIpAddressTypes:
type: array
items:
allOf:
- $ref: '#/components/schemas/ServiceConnectivityType'
- xml:
name: item
minItems: 0
maxItems: 2
ServiceConnectivityType:
type: string
enum:
- ipv4
- ipv6
ServiceDetail:
type: object
properties:
ServiceName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceName
description: The name of the service.
ServiceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: serviceId
description: The ID of the endpoint service.
ServiceType:
allOf:
- $ref: '#/components/schemas/ServiceTypeDetailSet'
- xml:
name: serviceType
description: The type of service.
AvailabilityZones:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: availabilityZoneSet
description: The Availability Zones in which the service is available.
Owner:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: owner
description: The Amazon Web Services account ID of the service owner.
BaseEndpointDnsNames:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: baseEndpointDnsNameSet
description: The DNS names for the service.
PrivateDnsName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: privateDnsName
description: The private DNS name for the service.
PrivateDnsNames:
allOf:
- $ref: '#/components/schemas/PrivateDnsDetailsSet'
- xml:
name: privateDnsNameSet
description: The private DNS names assigned to the VPC endpoint service.
VpcEndpointPolicySupported:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: vpcEndpointPolicySupported
description: Indicates whether the service supports endpoint policies.
AcceptanceRequired:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: acceptanceRequired
description: Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.
ManagesVpcEndpoints:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: managesVpcEndpoints
description: Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.
PayerResponsibility:
allOf:
- $ref: '#/components/schemas/PayerResponsibility'
- xml:
name: payerResponsibility
description: The payer responsibility.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags assigned to the service.
PrivateDnsNameVerificationState:
allOf:
- $ref: '#/components/schemas/DnsNameState'
- xml:
name: privateDnsNameVerificationState
description: The verification state of the VPC endpoint service.
Consumers of the endpoint service cannot use the private name when the state is not verified.
standard indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. archive indicates that the snapshot is currently archived and that it must be restored before it can be used.
LastTieringStartTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: lastTieringStartTime
description: The date and time when the last archive or restore process was started.
LastTieringProgress:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: lastTieringProgress
description: 'The progress of the last archive or restore process, as a percentage.'
LastTieringOperationStatus:
allOf:
- $ref: '#/components/schemas/TieringOperationStatus'
- xml:
name: lastTieringOperationStatus
description: The status of the last archive or restore process.
LastTieringOperationStatusDetail:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: lastTieringOperationStatusDetail
description: A message describing the status of the last archive or restore process.
ArchivalCompleteTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: archivalCompleteTime
description: The date and time when the last archive process was completed.
RestoreExpiryTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: restoreExpiryTime
description: Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived.
description: Provides information about a snapshot's storage tier.
SpotCapacityRebalance:
type: object
properties:
ReplacementStrategy:
allOf:
- $ref: '#/components/schemas/ReplacementStrategy'
- xml:
name: replacementStrategy
description: 'The replacement strategy to use. Only available for fleets of type maintain.
launch - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.
launch-before-terminate - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in TerminationDelay), terminates the instances that received a rebalance notification.
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.
Required when ReplacementStrategy is set to launch-before-terminate.
Not valid when ReplacementStrategy is set to launch.
Valid values: Minimum value of 120 seconds. Maximum value of 7200 seconds.
Enables monitoring for the instance.
Default: false
error. After all requests are placed, the status is pending_fulfillment. If the size of the fleet is equal to or greater than its target capacity, the status is fulfilled. If the size of the fleet is decreased, the status is pending_termination while Spot Instances are terminating.'
CreateTime:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: createTime
description: The creation date and time of the request.
SpotFleetRequestConfig:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestConfigData'
- xml:
name: spotFleetRequestConfig
description: The configuration of the Spot Fleet request.
SpotFleetRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotFleetRequestId
description: The ID of the Spot Fleet request.
SpotFleetRequestState:
allOf:
- $ref: '#/components/schemas/BatchState'
- xml:
name: spotFleetRequestState
description: The state of the Spot Fleet request.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for a Spot Fleet resource.
description: Describes a Spot Fleet request.
SpotFleetTagSpecification:
type: object
properties:
ResourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- xml:
name: resourceType
description: 'The type of resource. Currently, the only resource type that is supported is instance. To tag the Spot Fleet request on creation, use the TagSpecifications parameter in SpotFleetRequestConfigData .'
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tag
description: The tags.
description: The tags for a Spot Fleet resource.
SpotInstanceState:
type: string
enum:
- open
- active
- closed
- cancelled
- failed
- disabled
SpotInstanceStatus:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: 'The status code. For a list of status codes, see Spot request status codes in the Amazon EC2 User Guide for Linux Instances.'
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The description for the status code.
UpdateTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: updateTime
description: 'The date and time of the most recent status update, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
description: Describes the status of a Spot Instance request.
SpotInstanceRequest:
type: object
properties:
ActualBlockHourlyPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: actualBlockHourlyPrice
description: Deprecated.
AvailabilityZoneGroup:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZoneGroup
description: 'The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.'
BlockDurationMinutes:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: blockDurationMinutes
description: Deprecated.
CreateTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: createTime
description: 'The date and time when the Spot Instance request was created, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).'
Fault:
allOf:
- $ref: '#/components/schemas/SpotInstanceStateFault'
- xml:
name: fault
description: 'The fault codes for the Spot Instance request, if any.'
InstanceId:
allOf:
- $ref: '#/components/schemas/InstanceId'
- xml:
name: instanceId
description: 'The instance ID, if an instance has been launched to fulfill the Spot Instance request.'
LaunchGroup:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: launchGroup
description: The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
LaunchSpecification:
allOf:
- $ref: '#/components/schemas/LaunchSpecification'
- xml:
name: launchSpecification
description: Additional information for launching instances.
LaunchedAvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: launchedAvailabilityZone
description: The Availability Zone in which the request is launched.
ProductDescription:
allOf:
- $ref: '#/components/schemas/RIProductDescription'
- xml:
name: productDescription
description: The product description associated with the Spot Instance.
SpotInstanceRequestId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotInstanceRequestId
description: The ID of the Spot Instance request.
SpotPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotPrice
description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The end date of the request, in UTC format (YYYY-MM-DDTHH:MM:SSZ).
For a persistent request, the request remains active until the validUntil date and time is reached. Otherwise, the request remains active until you cancel it.
For a one-time request, the request remains active until all instances launch, the request is canceled, or the validUntil date and time is reached. By default, the request is valid for 7 days from the date the request was created.
1 to 10. A score of 10 indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of 1 indicates that your Spot request is not likely to succeed. '
description: The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the capacity-optimized allocation strategy is used and that all of the Availability Zones in the Region can be used.
SpotPrice:
type: object
properties:
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone.
InstanceType:
allOf:
- $ref: '#/components/schemas/InstanceType'
- xml:
name: instanceType
description: The instance type.
ProductDescription:
allOf:
- $ref: '#/components/schemas/RIProductDescription'
- xml:
name: productDescription
description: A general description of the AMI.
SpotPrice:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: spotPrice
description: 'The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
tcp, udp, and icmp) or number (see Protocol Numbers).'
IpRanges:
allOf:
- $ref: '#/components/schemas/IpRanges'
- xml:
name: ipRanges
description: The IP ranges. Not applicable for stale security group rules.
PrefixListIds:
allOf:
- $ref: '#/components/schemas/PrefixListIdSet'
- xml:
name: prefixListIds
description: The prefix list IDs. Not applicable for stale security group rules.
ToPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: toPort
description: 'The end of the port range for the TCP and UDP protocols, or an ICMP type number. A value of -1 indicates all ICMP types. '
UserIdGroupPairs:
allOf:
- $ref: '#/components/schemas/UserIdGroupPairSet'
- xml:
name: groups
description: 'The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.'
description: Describes a stale rule in a security group.
StaleIpPermissionSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/StaleIpPermission'
- xml:
name: item
StaleSecurityGroup:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of the security group.
GroupId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupId
description: The ID of the security group.
GroupName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupName
description: The name of the security group.
StaleIpPermissions:
allOf:
- $ref: '#/components/schemas/StaleIpPermissionSet'
- xml:
name: staleIpPermissions
description: Information about the stale inbound rules in the security group.
StaleIpPermissionsEgress:
allOf:
- $ref: '#/components/schemas/StaleIpPermissionSet'
- xml:
name: staleIpPermissionsEgress
description: Information about the stale outbound rules in the security group.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC for the security group.
description: Describes a stale security group (a security group that contains stale rules).
StartInstancesRequest:
type: object
required:
- InstanceIds
title: StartInstancesRequest
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdStringList'
- xml:
name: InstanceId
description: The IDs of the instances.
AdditionalInfo:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: additionalInfo
description: Reserved.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
StartNetworkInsightsAccessScopeAnalysisRequest:
type: object
required:
- NetworkInsightsAccessScopeId
- ClientToken
title: StartNetworkInsightsAccessScopeAnalysisRequest
properties:
NetworkInsightsAccessScopeId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsAccessScopeId'
- description: The ID of the Network Access Scope.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
StartNetworkInsightsAnalysisRequest:
type: object
required:
- NetworkInsightsPathId
- ClientToken
title: StartNetworkInsightsAnalysisRequest
properties:
NetworkInsightsPathId:
allOf:
- $ref: '#/components/schemas/NetworkInsightsPathId'
- description: The ID of the path.
AdditionalAccounts:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: AdditionalAccount
description: The member accounts that contain resources that the path can traverse.
FilterInArns:
allOf:
- $ref: '#/components/schemas/ArnList'
- xml:
name: FilterInArn
description: The Amazon Resource Names (ARN) of the resources that the path must traverse.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TagSpecifications:
allOf:
- $ref: '#/components/schemas/TagSpecificationList'
- xml:
name: TagSpecification
description: The tags to apply.
ClientToken:
allOf:
- $ref: '#/components/schemas/String'
- description: 'Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.'
StartVpcEndpointServicePrivateDnsVerificationRequest:
type: object
required:
- ServiceId
title: StartVpcEndpointServicePrivateDnsVerificationRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
ServiceId:
allOf:
- $ref: '#/components/schemas/VpcEndpointServiceId'
- description: The ID of the endpoint service.
State:
type: string
enum:
- PendingAcceptance
- Pending
- Available
- Deleting
- Deleted
- Rejected
- Failed
- Expired
StopInstancesRequest:
type: object
required:
- InstanceIds
title: StopInstancesRequest
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdStringList'
- xml:
name: InstanceId
description: The IDs of the instances.
Hibernate:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the Amazon EC2 User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
Force:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: force
description: 'Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances.
Default: false
InProgress, Completed, or Failed).'
StoreTaskFailureReason:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: storeTaskFailureReason
description: 'If the tasks fails, the reason for the failure is returned. If the task succeeds, null is returned.'
description: 'The information about the AMI store task, including the progress of the task.'
SubnetState:
type: string
enum:
- pending
- available
SubnetIpv6CidrBlockAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
- xml:
name: item
TransitGatewayMulitcastDomainAssociationState:
type: string
enum:
- pendingAcceptance
- associating
- associated
- disassociating
- disassociated
- rejected
- failed
SubnetAssociation:
type: object
properties:
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetId
description: The ID of the subnet.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayMulitcastDomainAssociationState'
- xml:
name: state
description: The state of the subnet association.
description: Describes the subnet association with the transit gateway multicast domain.
SubnetAssociationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetAssociation'
- xml:
name: item
SubnetCidrBlockStateCode:
type: string
enum:
- associating
- associated
- disassociating
- disassociated
- failing
- failed
SubnetCidrBlockState:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/SubnetCidrBlockStateCode'
- xml:
name: state
description: The state of a CIDR block.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: 'A message about the status of the CIDR block, if applicable.'
description: Describes the state of a CIDR block.
Subscription:
type: object
properties:
Source:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: source
description: 'The Region or Availability Zone that''s the source for the subscription. For example, us-east-1.'
Destination:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destination
description: 'The Region or Availability Zone that''s the target for the subscription. For example, eu-west-1.'
Metric:
allOf:
- $ref: '#/components/schemas/MetricType'
- xml:
name: metric
description: The metric used for the subscription.
Statistic:
allOf:
- $ref: '#/components/schemas/StatisticType'
- xml:
name: statistic
description: The statistic used for the subscription.
Period:
allOf:
- $ref: '#/components/schemas/PeriodType'
- xml:
name: period
description: The data aggregation time for the subscription.
description: Describes an Infrastructure Performance subscription.
SuccessfulInstanceCreditSpecificationItem:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
description: Describes the burstable performance instance whose credit option for CPU usage was successfully modified.
SuccessfulQueuedPurchaseDeletion:
type: object
properties:
ReservedInstancesId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: reservedInstancesId
description: The ID of the Reserved Instance.
description: Describes a Reserved Instance whose queued purchase was successfully deleted.
SupportedAdditionalProcessorFeature:
type: string
enum:
- amd-sev-snp
TagDescription:
type: object
properties:
Key:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: key
description: The tag key.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/ResourceType'
- xml:
name: resourceType
description: The resource type.
Value:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: value
description: The tag value.
description: Describes a tag.
TargetConfiguration:
type: object
properties:
InstanceCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: instanceCount
description: The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request
OfferingId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: offeringId
description: The ID of the Convertible Reserved Instance offering.
description: Information about the Convertible Reserved Instance offering.
TargetGroup:
type: object
properties:
Arn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: arn
description: The Amazon Resource Name (ARN) of the target group.
description: Describes a load balancer target group.
TargetGroups:
type: array
items:
allOf:
- $ref: '#/components/schemas/TargetGroup'
- xml:
name: item
minItems: 1
maxItems: 5
TargetNetwork:
type: object
properties:
AssociationId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationId
description: The ID of the association.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC in which the target network (subnet) is located.
TargetNetworkId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: targetNetworkId
description: The ID of the subnet specified as the target network.
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: clientVpnEndpointId
description: The ID of the Client VPN endpoint with which the target network is associated.
Status:
allOf:
- $ref: '#/components/schemas/AssociationStatus'
- xml:
name: status
description: The current state of the target network association.
SecurityGroups:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: securityGroups
description: The IDs of the security groups applied to the target network association.
description: Describes a target network associated with a Client VPN endpoint.
TargetReservationValue:
type: object
properties:
ReservationValue:
allOf:
- $ref: '#/components/schemas/ReservationValue'
- xml:
name: reservationValue
description: 'The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.'
TargetConfiguration:
allOf:
- $ref: '#/components/schemas/TargetConfiguration'
- xml:
name: targetConfiguration
description: The configuration of the Convertible Reserved Instances that make up the exchange.
description: The total value of the new Convertible Reserved Instances.
TelemetryStatus:
type: string
enum:
- UP
- DOWN
TerminateClientVpnConnectionsRequest:
type: object
required:
- ClientVpnEndpointId
title: TerminateClientVpnConnectionsRequest
properties:
ClientVpnEndpointId:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointId'
- description: The ID of the Client VPN endpoint to which the client is connected.
ConnectionId:
allOf:
- $ref: '#/components/schemas/String'
- description: The ID of the client connection to be terminated.
Username:
allOf:
- $ref: '#/components/schemas/String'
- description: The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
TerminateConnectionStatusSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/TerminateConnectionStatus'
- xml:
name: item
TerminateConnectionStatus:
type: object
properties:
ConnectionId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: connectionId
description: The ID of the client connection.
PreviousStatus:
allOf:
- $ref: '#/components/schemas/ClientVpnConnectionStatus'
- xml:
name: previousStatus
description: The state of the client connection.
CurrentStatus:
allOf:
- $ref: '#/components/schemas/ClientVpnConnectionStatus'
- xml:
name: currentStatus
description: 'A message about the status of the client connection, if applicable.'
description: Information about a terminated Client VPN endpoint client connection.
TerminateInstancesRequest:
type: object
required:
- InstanceIds
title: TerminateInstancesRequest
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdStringList'
- xml:
name: InstanceId
description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' DryRun: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: dryRun description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.'
ThreadsPerCore:
type: integer
ThreadsPerCoreList:
type: array
items:
allOf:
- $ref: '#/components/schemas/ThreadsPerCore'
- xml:
name: item
ThroughResourcesStatement:
type: object
properties:
ResourceStatement:
allOf:
- $ref: '#/components/schemas/ResourceStatement'
- xml:
name: resourceStatement
description: The resource statement.
description: Describes a through resource statement.
ThroughResourcesStatementRequest:
type: object
properties:
ResourceStatement:
allOf:
- $ref: '#/components/schemas/ResourceStatementRequest'
- description: The resource statement.
description: Describes a through resource statement.
TrafficMirrorFilterRuleList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TrafficMirrorFilterRule'
- xml:
name: item
TrafficMirrorPortRange:
type: object
properties:
FromPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: fromPort
description: The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
ToPort:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: toPort
description: The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.
description: Describes the Traffic Mirror port range.
TrafficMirrorTargetType:
type: string
enum:
- network-interface
- network-load-balancer
- gateway-load-balancer-endpoint
TransitGatewayState:
type: string
enum:
- pending
- available
- modifying
- deleting
- deleted
TransitGatewayOptions:
type: object
properties:
AmazonSideAsn:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: amazonSideAsn
description: A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.
TransitGatewayCidrBlocks:
allOf:
- $ref: '#/components/schemas/ValueStringList'
- xml:
name: transitGatewayCidrBlocks
description: The transit gateway CIDR blocks.
AutoAcceptSharedAttachments:
allOf:
- $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue'
- xml:
name: autoAcceptSharedAttachments
description: Indicates whether attachment requests are automatically accepted.
DefaultRouteTableAssociation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTableAssociationValue'
- xml:
name: defaultRouteTableAssociation
description: Indicates whether resource attachments are automatically associated with the default association route table.
AssociationDefaultRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: associationDefaultRouteTableId
description: The ID of the default association route table.
DefaultRouteTablePropagation:
allOf:
- $ref: '#/components/schemas/DefaultRouteTablePropagationValue'
- xml:
name: defaultRouteTablePropagation
description: Indicates whether resource attachments automatically propagate routes to the default propagation route table.
PropagationDefaultRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: propagationDefaultRouteTableId
description: The ID of the default propagation route table.
VpnEcmpSupport:
allOf:
- $ref: '#/components/schemas/VpnEcmpSupportValue'
- xml:
name: vpnEcmpSupport
description: Indicates whether Equal Cost Multipath Protocol support is enabled.
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- xml:
name: dnsSupport
description: Indicates whether DNS support is enabled.
MulticastSupport:
allOf:
- $ref: '#/components/schemas/MulticastSupportValue'
- xml:
name: multicastSupport
description: Indicates whether multicast is enabled on the transit gateway
description: Describes the options for a transit gateway.
TransitGatewayAttachmentResourceType:
type: string
enum:
- vpc
- vpn
- direct-connect-gateway
- connect
- peering
- tgw-peering
TransitGatewayAssociationState:
type: string
enum:
- associating
- associated
- disassociating
- disassociated
TransitGatewayAttachmentState:
type: string
enum:
- initiating
- initiatingRequest
- pendingAcceptance
- rollingBack
- pending
- available
- modifying
- deleting
- deleted
- failed
- rejected
- rejecting
- failing
TransitGatewayAttachmentAssociation:
type: object
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayRouteTableId
description: The ID of the route table for the transit gateway.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociationState'
- xml:
name: state
description: The state of the association.
description: Describes an association.
TransitGatewayAttachment:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
TransitGatewayId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayId
description: The ID of the transit gateway.
TransitGatewayOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayOwnerId
description: The ID of the Amazon Web Services account that owns the transit gateway.
ResourceOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceOwnerId
description: The ID of the Amazon Web Services account that owns the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentState'
- xml:
name: state
description: The attachment state. Note that the initiating state has been deprecated.
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentAssociation'
- xml:
name: association
description: The association.
CreationTime:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: creationTime
description: The creation time.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: The tags for the attachment.
description: Describes an attachment between a resource and a transit gateway.
TransitGatewayAttachmentBgpConfiguration:
type: object
properties:
TransitGatewayAsn:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: transitGatewayAsn
description: The transit gateway Autonomous System Number (ASN).
PeerAsn:
allOf:
- $ref: '#/components/schemas/Long'
- xml:
name: peerAsn
description: The peer Autonomous System Number (ASN).
TransitGatewayAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAddress
description: The interior BGP peer IP address for the transit gateway.
PeerAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: peerAddress
description: The interior BGP peer IP address for the appliance.
BgpStatus:
allOf:
- $ref: '#/components/schemas/BgpStatus'
- xml:
name: bgpStatus
description: The BGP status.
description: The BGP configuration information.
TransitGatewayAttachmentBgpConfigurationList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfiguration'
- xml:
name: item
TransitGatewayPropagationState:
type: string
enum:
- enabling
- enabled
- disabling
- disabled
TransitGatewayAttachmentPropagation:
type: object
properties:
TransitGatewayRouteTableId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayRouteTableId
description: The ID of the propagation route table.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayPropagationState'
- xml:
name: state
description: The state of the propagation route table.
description: Describes a propagation route table.
TransitGatewayConnectOptions:
type: object
properties:
Protocol:
allOf:
- $ref: '#/components/schemas/ProtocolValue'
- xml:
name: protocol
description: The tunnel protocol.
description: Describes the Connect attachment options.
TransitGatewayConnectPeerState:
type: string
enum:
- pending
- available
- deleting
- deleted
TransitGatewayConnectPeerConfiguration:
type: object
properties:
TransitGatewayAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAddress
description: The Connect peer IP address on the transit gateway side of the tunnel.
PeerAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: peerAddress
description: The Connect peer IP address on the appliance side of the tunnel.
InsideCidrBlocks:
allOf:
- $ref: '#/components/schemas/InsideCidrBlocksStringList'
- xml:
name: insideCidrBlocks
description: The range of interior BGP peer IP addresses.
Protocol:
allOf:
- $ref: '#/components/schemas/ProtocolValue'
- xml:
name: protocol
description: The tunnel protocol.
BgpConfigurations:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentBgpConfigurationList'
- xml:
name: bgpConfigurations
description: The BGP configuration details.
description: Describes the Connect peer details.
TransitGatewayMulticastDomainOptions:
type: object
properties:
Igmpv2Support:
allOf:
- $ref: '#/components/schemas/Igmpv2SupportValue'
- xml:
name: igmpv2Support
description: Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.
StaticSourcesSupport:
allOf:
- $ref: '#/components/schemas/StaticSourcesSupportValue'
- xml:
name: staticSourcesSupport
description: Indicates whether support for statically configuring transit gateway multicast group sources is turned on.
AutoAcceptSharedAssociations:
allOf:
- $ref: '#/components/schemas/AutoAcceptSharedAssociationsValue'
- xml:
name: autoAcceptSharedAssociations
description: Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.
description: Describes the options for a transit gateway multicast domain.
TransitGatewayMulticastDomainState:
type: string
enum:
- pending
- available
- deleting
- deleted
TransitGatewayMulticastDomainAssociation:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the transit gateway attachment.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: 'The type of resource, for example a VPC attachment.'
ResourceOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceOwnerId
description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain association resource.'
Subnet:
allOf:
- $ref: '#/components/schemas/SubnetAssociation'
- xml:
name: subnet
description: The subnet associated with the transit gateway multicast domain.
description: Describes the resources associated with the transit gateway multicast domain.
TransitGatewayMulticastGroup:
type: object
properties:
GroupIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: groupIpAddress
description: The IP address assigned to the transit gateway multicast group.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the transit gateway attachment.
SubnetId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: subnetId
description: The ID of the subnet.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: 'The type of resource, for example a VPC attachment.'
ResourceOwnerId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceOwnerId
description: ' The ID of the Amazon Web Services account that owns the transit gateway multicast domain group resource.'
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: networkInterfaceId
description: The ID of the transit gateway attachment.
GroupMember:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: groupMember
description: Indicates that the resource is a transit gateway multicast group member.
GroupSource:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: groupSource
description: Indicates that the resource is a transit gateway multicast group member.
MemberType:
allOf:
- $ref: '#/components/schemas/MembershipType'
- xml:
name: memberType
description: 'The member type (for example, static).'
SourceType:
allOf:
- $ref: '#/components/schemas/MembershipType'
- xml:
name: sourceType
description: The source type.
description: Describes the transit gateway multicast group resources.
TransitGatewayPeeringAttachmentOptions:
type: object
properties:
DynamicRouting:
allOf:
- $ref: '#/components/schemas/DynamicRoutingValue'
- xml:
name: dynamicRouting
description: Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.
description: Describes dynamic routing for the transit gateway peering attachment.
TransitGatewayPolicyRuleMetaData:
type: object
properties:
MetaDataKey:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: metaDataKey
description: The key name for the transit gateway policy rule meta data tag.
MetaDataValue:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: metaDataValue
description: The value of the key for the transit gateway policy rule meta data tag.
description: Describes the meta data tags associated with a transit gateway policy rule.
TransitGatewayPolicyRule:
type: object
properties:
SourceCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourceCidrBlock
description: The source CIDR block for the transit gateway policy rule.
SourcePortRange:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: sourcePortRange
description: The port range for the transit gateway policy rule. Currently this is set to * (all).
DestinationCidrBlock:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationCidrBlock
description: The destination CIDR block for the transit gateway policy rule.
DestinationPortRange:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: destinationPortRange
description: The port range for the transit gateway policy rule. Currently this is set to * (all).
Protocol:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: protocol
description: The protocol used by the transit gateway policy rule.
MetaData:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyRuleMetaData'
- xml:
name: metaData
description: The meta data tags used for the transit gateway policy rule.
description: Describes a rule associated with a transit gateway policy.
TransitGatewayPolicyTableState:
type: string
enum:
- pending
- available
- deleting
- deleted
TransitGatewayPolicyTableEntry:
type: object
properties:
PolicyRuleNumber:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: policyRuleNumber
description: The rule number for the transit gateway policy table entry.
PolicyRule:
allOf:
- $ref: '#/components/schemas/TransitGatewayPolicyRule'
- xml:
name: policyRule
description: The policy rule associated with the transit gateway policy table.
TargetRouteTableId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableId'
- xml:
name: targetRouteTableId
description: The ID of the target route table.
description: Describes a transit gateway policy table entry
TransitGatewayPrefixListAttachment:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentId'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: The resource type. Note that the tgw-peering resource type has been deprecated.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
description: Describes a transit gateway prefix list attachment.
TransitGatewayPrefixListReferenceState:
type: string
enum:
- pending
- available
- modifying
- deleting
TransitGatewayRouteAttachmentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteAttachment'
- xml:
name: item
TransitGatewayRouteType:
type: string
enum:
- static
- propagated
TransitGatewayRouteState:
type: string
enum:
- pending
- active
- blackhole
- deleting
- deleted
TransitGatewayRouteAttachment:
type: object
properties:
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: 'The resource type. Note that the tgw-peering resource type has been deprecated. '
description: Describes a route attachment.
TransitGatewayRouteTableState:
type: string
enum:
- pending
- available
- deleting
- deleted
TransitGatewayRouteTableAnnouncementDirection:
type: string
enum:
- outgoing
- incoming
TransitGatewayRouteTableAnnouncementState:
type: string
enum:
- available
- pending
- failing
- failed
- deleting
- deleted
TransitGatewayRouteTableAssociation:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: The resource type. Note that the tgw-peering resource type has been deprecated.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociationState'
- xml:
name: state
description: The state of the association.
description: Describes an association between a route table and a resource attachment.
TransitGatewayRouteTablePropagation:
type: object
properties:
TransitGatewayAttachmentId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: transitGatewayAttachmentId
description: The ID of the attachment.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
ResourceType:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
- xml:
name: resourceType
description: The type of resource. Note that the tgw-peering resource type has been deprecated.
State:
allOf:
- $ref: '#/components/schemas/TransitGatewayPropagationState'
- xml:
name: state
description: The state of the resource.
TransitGatewayRouteTableAnnouncementId:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTableAnnouncementId'
- xml:
name: transitGatewayRouteTableAnnouncementId
description: The ID of the transit gateway route table announcement.
description: Describes a route table propagation.
TransitGatewayVpcAttachmentOptions:
type: object
properties:
DnsSupport:
allOf:
- $ref: '#/components/schemas/DnsSupportValue'
- xml:
name: dnsSupport
description: Indicates whether DNS support is enabled.
Ipv6Support:
allOf:
- $ref: '#/components/schemas/Ipv6SupportValue'
- xml:
name: ipv6Support
description: Indicates whether IPv6 support is disabled.
ApplianceModeSupport:
allOf:
- $ref: '#/components/schemas/ApplianceModeSupportValue'
- xml:
name: applianceModeSupport
description: Indicates whether appliance mode support is enabled.
description: Describes the VPC attachment options.
VpnTunnelLogOptions:
type: object
properties:
CloudWatchLogOptions:
allOf:
- $ref: '#/components/schemas/CloudWatchLogOptions'
- xml:
name: cloudWatchLogOptions
description: Options for sending VPN tunnel logs to CloudWatch.
description: Options for logging VPN tunnel activity.
TunnelOption:
type: object
properties:
OutsideIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outsideIpAddress
description: The external IP address of the VPN tunnel.
TunnelInsideCidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: tunnelInsideCidr
description: The range of inside IPv4 addresses for the tunnel.
TunnelInsideIpv6Cidr:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: tunnelInsideIpv6Cidr
description: The range of inside IPv6 addresses for the tunnel.
PreSharedKey:
allOf:
- $ref: '#/components/schemas/preSharedKey'
- xml:
name: preSharedKey
description: The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.
Phase1LifetimeSeconds:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: phase1LifetimeSeconds
description: 'The lifetime for phase 1 of the IKE negotiation, in seconds.'
Phase2LifetimeSeconds:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: phase2LifetimeSeconds
description: 'The lifetime for phase 2 of the IKE negotiation, in seconds.'
RekeyMarginTimeSeconds:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: rekeyMarginTimeSeconds
description: 'The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey.'
RekeyFuzzPercentage:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: rekeyFuzzPercentage
description: The percentage of the rekey window determined by RekeyMarginTimeSeconds during which the rekey time is randomly selected.
ReplayWindowSize:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: replayWindowSize
description: The number of packets in an IKE replay window.
DpdTimeoutSeconds:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: dpdTimeoutSeconds
description: The number of seconds after which a DPD timeout occurs.
DpdTimeoutAction:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: dpdTimeoutAction
description: The action to take after a DPD timeout occurs.
Phase1EncryptionAlgorithms:
allOf:
- $ref: '#/components/schemas/Phase1EncryptionAlgorithmsList'
- xml:
name: phase1EncryptionAlgorithmSet
description: The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.
Phase2EncryptionAlgorithms:
allOf:
- $ref: '#/components/schemas/Phase2EncryptionAlgorithmsList'
- xml:
name: phase2EncryptionAlgorithmSet
description: The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.
Phase1IntegrityAlgorithms:
allOf:
- $ref: '#/components/schemas/Phase1IntegrityAlgorithmsList'
- xml:
name: phase1IntegrityAlgorithmSet
description: The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.
Phase2IntegrityAlgorithms:
allOf:
- $ref: '#/components/schemas/Phase2IntegrityAlgorithmsList'
- xml:
name: phase2IntegrityAlgorithmSet
description: The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.
Phase1DHGroupNumbers:
allOf:
- $ref: '#/components/schemas/Phase1DHGroupNumbersList'
- xml:
name: phase1DHGroupNumberSet
description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.
Phase2DHGroupNumbers:
allOf:
- $ref: '#/components/schemas/Phase2DHGroupNumbersList'
- xml:
name: phase2DHGroupNumberSet
description: The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.
IkeVersions:
allOf:
- $ref: '#/components/schemas/IKEVersionsList'
- xml:
name: ikeVersionSet
description: The IKE versions that are permitted for the VPN tunnel.
StartupAction:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: startupAction
description: The action to take when the establishing the VPN tunnels for a VPN connection.
LogOptions:
allOf:
- $ref: '#/components/schemas/VpnTunnelLogOptions'
- xml:
name: logOptions
description: Options for logging VPN tunnel activity.
EnableTunnelLifecycleControl:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enableTunnelLifecycleControl
description: Status of tunnel endpoint lifecycle control feature.
description: The VPN tunnel options.
TunnelOptionsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/TunnelOption'
- xml:
name: item
UnassignIpv6AddressesRequest:
type: object
required:
- NetworkInterfaceId
title: UnassignIpv6AddressesRequest
properties:
Ipv6Addresses:
allOf:
- $ref: '#/components/schemas/Ipv6AddressList'
- xml:
name: ipv6Addresses
description: The IPv6 addresses to unassign from the network interface.
Ipv6Prefixes:
allOf:
- $ref: '#/components/schemas/IpPrefixList'
- xml:
name: Ipv6Prefix
description: The IPv6 prefixes to unassign from the network interface.
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
UnassignPrivateIpAddressesRequest:
type: object
required:
- NetworkInterfaceId
title: UnassignPrivateIpAddressesRequest
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
PrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/PrivateIpAddressStringList'
- xml:
name: privateIpAddress
description: The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.
Ipv4Prefixes:
allOf:
- $ref: '#/components/schemas/IpPrefixList'
- xml:
name: Ipv4Prefix
description: The IPv4 prefixes to unassign from the network interface.
description: Contains the parameters for UnassignPrivateIpAddresses.
UnassignPrivateNatGatewayAddressRequest:
type: object
required:
- NatGatewayId
- PrivateIpAddresses
title: UnassignPrivateNatGatewayAddressRequest
properties:
NatGatewayId:
allOf:
- $ref: '#/components/schemas/NatGatewayId'
- description: The ID of the NAT gateway.
PrivateIpAddresses:
allOf:
- $ref: '#/components/schemas/IpList'
- xml:
name: PrivateIpAddress
description: The private IPv4 addresses you want to unassign.
MaxDrainDurationSeconds:
allOf:
- $ref: '#/components/schemas/DrainSeconds'
- description: The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
UnmonitorInstancesRequest:
type: object
required:
- InstanceIds
title: UnmonitorInstancesRequest
properties:
InstanceIds:
allOf:
- $ref: '#/components/schemas/InstanceIdStringList'
- xml:
name: InstanceId
description: The IDs of the instances.
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: dryRun
description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
UnsuccessfulInstanceCreditSpecificationErrorCode:
type: string
enum:
- InvalidInstanceID.Malformed
- InvalidInstanceID.NotFound
- IncorrectInstanceState
- InstanceCreditSpecification.NotSupported
UnsuccessfulInstanceCreditSpecificationItemError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationErrorCode'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The applicable error message.
description: Information about the error for the burstable performance instance whose credit option for CPU usage was not modified.
UnsuccessfulInstanceCreditSpecificationItem:
type: object
properties:
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance.
Error:
allOf:
- $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItemError'
- xml:
name: error
description: The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.
description: Describes the burstable performance instance whose credit option for CPU usage was not modified.
UnsuccessfulItemError:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: The error code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The error message accompanying the error code.
description: 'Information about the error that occurred. For more information about errors, see Error codes.'
UnsuccessfulItem:
type: object
properties:
Error:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemError'
- xml:
name: error
description: Information about the error.
ResourceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: resourceId
description: The ID of the resource.
description: Information about items that were not successfully processed in a batch call.
UpdateSecurityGroupRuleDescriptionsEgressRequest:
type: object
title: UpdateSecurityGroupRuleDescriptionsEgressRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
GroupName:
allOf:
- $ref: '#/components/schemas/SecurityGroupName'
- description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name.'
IpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- description: The IP permissions for the security group rule. You must specify either the IP permissions or the description.
SecurityGroupRuleDescriptions:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleDescriptionList'
- xml:
name: SecurityGroupRuleDescription
description: The description for the egress security group rules. You must specify either the description or the IP permissions.
UpdateSecurityGroupRuleDescriptionsIngressRequest:
type: object
title: UpdateSecurityGroupRuleDescriptionsIngressRequest
properties:
DryRun:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.'
GroupId:
allOf:
- $ref: '#/components/schemas/SecurityGroupId'
- description: 'The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.'
GroupName:
allOf:
- $ref: '#/components/schemas/SecurityGroupName'
- description: '[Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.'
IpPermissions:
allOf:
- $ref: '#/components/schemas/IpPermissionList'
- description: The IP permissions for the security group rule. You must specify either IP permissions or a description.
SecurityGroupRuleDescriptions:
allOf:
- $ref: '#/components/schemas/SecurityGroupRuleDescriptionList'
- xml:
name: SecurityGroupRuleDescription
description: The description for the ingress security group rules. You must specify either a description or IP permissions.
UsageClassType:
type: string
enum:
- spot
- on-demand
UserIdGroupPair:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: 'A description for the security group rule that references this user ID group pair.
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=;{}!$*
' GroupId: allOf: - $ref: '#/components/schemas/String' - xml: name: groupId description: The ID of the security group. GroupName: allOf: - $ref: '#/components/schemas/String' - xml: name: groupName description: '[Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID.
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.
' PeeringStatus: allOf: - $ref: '#/components/schemas/String' - xml: name: peeringStatus description: 'The status of a VPC peering connection, if applicable.' UserId: allOf: - $ref: '#/components/schemas/String' - xml: name: userId description: 'The ID of an Amazon Web Services account.
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.
' VpcId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcId description: 'The ID of the VPC for the referenced security group, if applicable.' VpcPeeringConnectionId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcPeeringConnectionId description: 'The ID of the VPC peering connection, if applicable.' description: Describes a security group and Amazon Web Services account ID pair. VCpuCount: type: integer VerifiedAccessEndpointLoadBalancerOptions: type: object properties: Protocol: allOf: - $ref: '#/components/schemas/VerifiedAccessEndpointProtocol' - xml: name: protocol description: The IP protocol. Port: allOf: - $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber' - xml: name: port description: The IP port number. LoadBalancerArn: allOf: - $ref: '#/components/schemas/String' - xml: name: loadBalancerArn description: The ARN of the load balancer. SubnetIds: allOf: - $ref: '#/components/schemas/VerifiedAccessEndpointSubnetIdList' - xml: name: subnetIdSet description: The IDs of the subnets. description: Describes a load balancer when creating an Amazon Web Services Verified Access endpoint using theload-balancer type.
VerifiedAccessEndpointEniOptions:
type: object
properties:
NetworkInterfaceId:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceId'
- xml:
name: networkInterfaceId
description: The ID of the network interface.
Protocol:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointProtocol'
- xml:
name: protocol
description: The IP protocol.
Port:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointPortNumber'
- xml:
name: port
description: The IP port number.
description: Options for a network-interface type endpoint.
VerifiedAccessEndpointStatus:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/VerifiedAccessEndpointStatusCode'
- xml:
name: code
description: The status code of the Verified Access endpoint.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The status message of the Verified Access endpoint.
description: Describes the status of a Verified Access endpoint.
VerifiedAccessEndpointSubnetIdList:
type: array
items:
allOf:
- $ref: '#/components/schemas/SubnetId'
- xml:
name: item
VerifiedAccessEndpointStatusCode:
type: string
enum:
- pending
- active
- updating
- deleting
- deleted
VerifiedAccessTrustProviderCondensedList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VerifiedAccessTrustProviderCondensed'
- xml:
name: item
VerifiedAccessLogs:
type: object
properties:
S3:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogS3Destination'
- xml:
name: s3
description: Amazon S3 logging options.
CloudWatchLogs:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogCloudWatchLogsDestination'
- xml:
name: cloudWatchLogs
description: CloudWatch Logs logging destination.
KinesisDataFirehose:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogKinesisDataFirehoseDestination'
- xml:
name: kinesisDataFirehose
description: Kinesis logging destination.
LogVersion:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: logVersion
description: ' Describes current setting for the logging version. '
IncludeTrustContext:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: includeTrustContext
description: ' Describes current setting for including trust data into the logs. '
description: Describes the options for Verified Access logs.
VerifiedAccessLogDeliveryStatus:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogDeliveryStatusCode'
- xml:
name: code
description: The status code.
Message:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: message
description: The status message.
description: Describes a log delivery status.
VerifiedAccessLogCloudWatchLogsDestination:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enabled
description: Indicates whether logging is enabled.
DeliveryStatus:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogDeliveryStatus'
- xml:
name: deliveryStatus
description: The delivery status for access logs.
LogGroup:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: logGroup
description: The ID of the CloudWatch Logs log group.
description: Options for CloudWatch Logs as a logging destination.
VerifiedAccessLogDeliveryStatusCode:
type: string
enum:
- success
- failed
VerifiedAccessLogKinesisDataFirehoseDestination:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enabled
description: Indicates whether logging is enabled.
DeliveryStatus:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogDeliveryStatus'
- xml:
name: deliveryStatus
description: The delivery status.
DeliveryStream:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: deliveryStream
description: The ID of the delivery stream.
description: Options for Kinesis as a logging destination.
VerifiedAccessLogS3Destination:
type: object
properties:
Enabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: enabled
description: Indicates whether logging is enabled.
DeliveryStatus:
allOf:
- $ref: '#/components/schemas/VerifiedAccessLogDeliveryStatus'
- xml:
name: deliveryStatus
description: The delivery status.
BucketName:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: bucketName
description: The bucket name.
Prefix:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: prefix
description: The bucket prefix.
BucketOwner:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: bucketOwner
description: The Amazon Web Services account number that owns the bucket.
description: Options for Amazon S3 as a logging destination.
VerifiedAccessTrustProviderCondensed:
type: object
properties:
VerifiedAccessTrustProviderId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: verifiedAccessTrustProviderId
description: The ID of the trust provider.
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: The description of trust provider.
TrustProviderType:
allOf:
- $ref: '#/components/schemas/TrustProviderType'
- xml:
name: trustProviderType
description: The type of trust provider (user- or device-based).
UserTrustProviderType:
allOf:
- $ref: '#/components/schemas/UserTrustProviderType'
- xml:
name: userTrustProviderType
description: The type of user-based trust provider.
DeviceTrustProviderType:
allOf:
- $ref: '#/components/schemas/DeviceTrustProviderType'
- xml:
name: deviceTrustProviderType
description: The type of device-based trust provider.
description: Condensed information about a trust provider.
VgwTelemetry:
type: object
properties:
AcceptedRouteCount:
allOf:
- $ref: '#/components/schemas/Integer'
- xml:
name: acceptedRouteCount
description: The number of accepted routes.
LastStatusChange:
allOf:
- $ref: '#/components/schemas/DateTime'
- xml:
name: lastStatusChange
description: The date and time of the last change in status.
OutsideIpAddress:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outsideIpAddress
description: The Internet-routable IP address of the virtual private gateway's outside interface.
Status:
allOf:
- $ref: '#/components/schemas/TelemetryStatus'
- xml:
name: status
description: The status of the VPN tunnel.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: 'If an error occurs, a description of the error.'
CertificateArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: certificateArn
description: The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.
description: Describes telemetry for a VPN tunnel.
VgwTelemetryList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VgwTelemetry'
- xml:
name: item
VolumeAttachmentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeAttachment'
- xml:
name: item
VolumeState:
type: string
enum:
- creating
- available
- in-use
- deleting
- deleted
- error
VolumeAttachmentState:
type: string
enum:
- attaching
- attached
- detaching
- detached
- busy
VolumeModificationState:
type: string
enum:
- modifying
- optimizing
- completed
- failed
VolumeStatusAction:
type: object
properties:
Code:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: code
description: 'The code identifying the operation, for example, enable-volume-io.'
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the operation.
EventId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventId
description: The ID of the event associated with this operation.
EventType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventType
description: The event type associated with this operation.
description: Describes a volume status operation code.
VolumeStatusActionsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeStatusAction'
- xml:
name: item
VolumeStatusAttachmentStatus:
type: object
properties:
IoPerformance:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: ioPerformance
description: The maximum IOPS supported by the attached instance.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the attached instance.
description: Information about the instances to which the volume is attached.
VolumeStatusAttachmentStatusList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeStatusAttachmentStatus'
- xml:
name: item
VolumeStatusName:
type: string
enum:
- io-enabled
- io-performance
VolumeStatusDetails:
type: object
properties:
Name:
allOf:
- $ref: '#/components/schemas/VolumeStatusName'
- xml:
name: name
description: The name of the volume status.
Status:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: status
description: The intended status of the volume status.
description: Describes a volume status.
VolumeStatusDetailsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeStatusDetails'
- xml:
name: item
VolumeStatusEvent:
type: object
properties:
Description:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: description
description: A description of the event.
EventId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventId
description: The ID of this event.
EventType:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: eventType
description: The type of this event.
NotAfter:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: notAfter
description: The latest end time of the event.
NotBefore:
allOf:
- $ref: '#/components/schemas/MillisecondDateTime'
- xml:
name: notBefore
description: The earliest start time of the event.
InstanceId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: instanceId
description: The ID of the instance associated with the event.
description: Describes a volume status event.
VolumeStatusEventsList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VolumeStatusEvent'
- xml:
name: item
VolumeStatusInfoStatus:
type: string
enum:
- ok
- impaired
- insufficient-data
VolumeStatusInfo:
type: object
properties:
Details:
allOf:
- $ref: '#/components/schemas/VolumeStatusDetailsList'
- xml:
name: details
description: The details of the volume status.
Status:
allOf:
- $ref: '#/components/schemas/VolumeStatusInfoStatus'
- xml:
name: status
description: The status of the volume.
description: Describes the status of a volume.
VolumeStatusItem:
type: object
properties:
Actions:
allOf:
- $ref: '#/components/schemas/VolumeStatusActionsList'
- xml:
name: actionsSet
description: The details of the operation.
AvailabilityZone:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: availabilityZone
description: The Availability Zone of the volume.
OutpostArn:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: outpostArn
description: The Amazon Resource Name (ARN) of the Outpost.
Events:
allOf:
- $ref: '#/components/schemas/VolumeStatusEventsList'
- xml:
name: eventsSet
description: A list of events associated with the volume.
VolumeId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: volumeId
description: The volume ID.
VolumeStatus:
allOf:
- $ref: '#/components/schemas/VolumeStatusInfo'
- xml:
name: volumeStatus
description: The volume status.
AttachmentStatuses:
allOf:
- $ref: '#/components/schemas/VolumeStatusAttachmentStatusList'
- xml:
name: attachmentStatuses
description: Information about the instances to which the volume is attached.
description: Describes the volume status.
VpcState:
type: string
enum:
- pending
- available
VpcIpv6CidrBlockAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- xml:
name: item
VpcCidrBlockAssociationSet:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockAssociation'
- xml:
name: item
VpcAttachmentList:
type: array
items:
allOf:
- $ref: '#/components/schemas/VpcAttachment'
- xml:
name: item
VpcCidrBlockState:
type: object
properties:
State:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockStateCode'
- xml:
name: state
description: The state of the CIDR block.
StatusMessage:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: statusMessage
description: 'A message about the status of the CIDR block, if applicable.'
description: Describes the state of a CIDR block.
VpcCidrBlockStateCode:
type: string
enum:
- associating
- associated
- disassociating
- disassociated
- failing
- failed
VpcClassicLink:
type: object
properties:
ClassicLinkEnabled:
allOf:
- $ref: '#/components/schemas/Boolean'
- xml:
name: classicLinkEnabled
description: Indicates whether the VPC is enabled for ClassicLink.
Tags:
allOf:
- $ref: '#/components/schemas/TagList'
- xml:
name: tagSet
description: Any tags assigned to the VPC.
VpcId:
allOf:
- $ref: '#/components/schemas/String'
- xml:
name: vpcId
description: The ID of the VPC.
description: Deprecated.
Describes whether a VPC is enabled for ClassicLink.
VpcEndpointConnection: type: object properties: ServiceId: allOf: - $ref: '#/components/schemas/String' - xml: name: serviceId description: The ID of the service to which the endpoint is connected. VpcEndpointId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcEndpointId description: The ID of the VPC endpoint. VpcEndpointOwner: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcEndpointOwner description: The ID of the Amazon Web Services account that owns the VPC endpoint. VpcEndpointState: allOf: - $ref: '#/components/schemas/State' - xml: name: vpcEndpointState description: The state of the VPC endpoint. CreationTimestamp: allOf: - $ref: '#/components/schemas/MillisecondDateTime' - xml: name: creationTimestamp description: The date and time that the VPC endpoint was created. DnsEntries: allOf: - $ref: '#/components/schemas/DnsEntrySet' - xml: name: dnsEntrySet description: The DNS entries for the VPC endpoint. NetworkLoadBalancerArns: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: networkLoadBalancerArnSet description: The Amazon Resource Names (ARNs) of the network load balancers for the service. GatewayLoadBalancerArns: allOf: - $ref: '#/components/schemas/ValueStringList' - xml: name: gatewayLoadBalancerArnSet description: The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service. IpAddressType: allOf: - $ref: '#/components/schemas/IpAddressType' - xml: name: ipAddressType description: The IP address type for the endpoint. VpcEndpointConnectionId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcEndpointConnectionId description: The ID of the VPC endpoint connection. Tags: allOf: - $ref: '#/components/schemas/TagList' - xml: name: tagSet description: The tags. description: Describes a VPC endpoint connection to a service. VpcPeeringConnectionVpcInfo: type: object properties: CidrBlock: allOf: - $ref: '#/components/schemas/String' - xml: name: cidrBlock description: The IPv4 CIDR block for the VPC. Ipv6CidrBlockSet: allOf: - $ref: '#/components/schemas/Ipv6CidrBlockSet' - xml: name: ipv6CidrBlockSet description: The IPv6 CIDR block for the VPC. CidrBlockSet: allOf: - $ref: '#/components/schemas/CidrBlockSet' - xml: name: cidrBlockSet description: Information about the IPv4 CIDR blocks for the VPC. OwnerId: allOf: - $ref: '#/components/schemas/String' - xml: name: ownerId description: The ID of the Amazon Web Services account that owns the VPC. PeeringOptions: allOf: - $ref: '#/components/schemas/VpcPeeringConnectionOptionsDescription' - xml: name: peeringOptions description: Information about the VPC peering connection options for the accepter or requester VPC. VpcId: allOf: - $ref: '#/components/schemas/String' - xml: name: vpcId description: The ID of the VPC. Region: allOf: - $ref: '#/components/schemas/String' - xml: name: region description: The Region in which the VPC is located. description: Describes a VPC in a VPC peering connection. VpcPeeringConnectionStateReason: type: object properties: Code: allOf: - $ref: '#/components/schemas/VpcPeeringConnectionStateReasonCode' - xml: name: code description: The status of the VPC peering connection. Message: allOf: - $ref: '#/components/schemas/String' - xml: name: message description: 'A message that provides more information about the status, if applicable.' description: Describes the status of a VPC peering connection. VpcPeeringConnectionOptionsDescription: type: object properties: AllowDnsResolutionFromRemoteVpc: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: allowDnsResolutionFromRemoteVpc description: Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC. AllowEgressFromLocalClassicLinkToRemoteVpc: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: allowEgressFromLocalClassicLinkToRemoteVpc description: Deprecated. AllowEgressFromLocalVpcToRemoteClassicLink: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: allowEgressFromLocalVpcToRemoteClassicLink description: Deprecated. description: Describes the VPC peering connection options. VpcPeeringConnectionStateReasonCode: type: string enum: - initiating-request - pending-acceptance - active - deleted - rejected - failed - expired - provisioning - deleting customerGatewayConfiguration: type: string format: password VpnState: type: string enum: - pending - available - deleting - deleted VpnConnectionOptions: type: object properties: EnableAcceleration: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: enableAcceleration description: Indicates whether acceleration is enabled for the VPN connection. StaticRoutesOnly: allOf: - $ref: '#/components/schemas/Boolean' - xml: name: staticRoutesOnly description: Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP. LocalIpv4NetworkCidr: allOf: - $ref: '#/components/schemas/String' - xml: name: localIpv4NetworkCidr description: The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. RemoteIpv4NetworkCidr: allOf: - $ref: '#/components/schemas/String' - xml: name: remoteIpv4NetworkCidr description: The IPv4 CIDR on the Amazon Web Services side of the VPN connection. LocalIpv6NetworkCidr: allOf: - $ref: '#/components/schemas/String' - xml: name: localIpv6NetworkCidr description: The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. RemoteIpv6NetworkCidr: allOf: - $ref: '#/components/schemas/String' - xml: name: remoteIpv6NetworkCidr description: The IPv6 CIDR on the Amazon Web Services side of the VPN connection. OutsideIpAddressType: allOf: - $ref: '#/components/schemas/String' - xml: name: outsideIpAddressType description: 'The type of IPv4 address assigned to the outside interface of the customer gateway.
Valid values: PrivateIpv4 | PublicIpv4
Default: PublicIpv4
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.
Constraints: A size /30 CIDR block from the 169.254.0.0/16 range. The following CIDR blocks are reserved and cannot be used:
169.254.0.0/30
169.254.1.0/30
169.254.2.0/30
169.254.3.0/30
169.254.4.0/30
169.254.5.0/30
169.254.169.252/30
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.
Constraints: A size /126 CIDR block from the local fd00::/8 range.
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (_). Must be between 8 and 64 characters in length and cannot start with zero (0).
' Phase1LifetimeSeconds: allOf: - $ref: '#/components/schemas/Integer' - description: 'The lifetime for phase 1 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 28,800.
Default: 28800
The lifetime for phase 2 of the IKE negotiation, in seconds.
Constraints: A value between 900 and 3,600. The value must be less than the value for Phase1LifetimeSeconds.
Default: 3600
The margin time, in seconds, before the phase 2 lifetime expires, during which the Amazon Web Services side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for RekeyFuzzPercentage.
Constraints: A value between 60 and half of Phase2LifetimeSeconds.
Default: 540
The percentage of the rekey window (determined by RekeyMarginTimeSeconds) during which the rekey time is randomly selected.
Constraints: A value between 0 and 100.
Default: 100
The number of packets in an IKE replay window.
Constraints: A value between 64 and 2048.
Default: 1024
The number of seconds after which a DPD timeout occurs.
Constraints: A value greater than or equal to 30.
Default: 30
The action to take after DPD timeout occurs. Specify restart to restart the IKE initiation. Specify clear to end the IKE session.
Valid Values: clear | none | restart
Default: clear
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: AES128 | AES256 | AES128-GCM-16 | AES256-GCM-16
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: SHA1 | SHA2-256 | SHA2-384 | SHA2-512
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.
Valid values: 2 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.
Valid values: 2 | 5 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24
The IKE versions that are permitted for the VPN tunnel.
Valid values: ikev1 | ikev2
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify start for Amazon Web Services to initiate the IKE negotiation.
Valid Values: add | start
Default: add
DryRunOperation. Otherwise, it is UnauthorizedOperation.'
security:
- hmac: []