Amazon Elastic Compute Cloud (Amazon EC2) provides secure and resizable computing capacity in the AWS cloud. Using Amazon EC2 eliminates the need to invest in hardware up front, so you can develop and deploy applications faster.
To learn more about Amazon EC2, Amazon EBS, and Amazon VPC, see the following resources:
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ReservedInstanceId
in: query
description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: TargetConfiguration
in: query
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult'
- description: The result of the exchange and whether it was successful.
deprecated: false
post:
summary: POST AcceptReservedInstancesExchangeQuote
description: Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
operationId: POSTAcceptReservedInstancesExchangeQuote
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ReservedInstanceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ReservedInstanceId:
type: array
items:
type: string
description: The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value.
TargetConfiguration:
type: array
items:
type: string
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/AcceptReservedInstancesExchangeQuoteResult'
- description: The result of the exchange and whether it was successful.
deprecated: false
/#Action=AcceptTransitGatewayVpcAttachment:
get:
summary: 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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action2'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AcceptTransitGatewayVpcAttachmentResult'
deprecated: false
post:
summary: 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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AcceptTransitGatewayVpcAttachmentResult'
deprecated: false
/#Action=AcceptVpcEndpointConnections:
get:
summary: GET AcceptVpcEndpointConnections
description: Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
operationId: GETAcceptVpcEndpointConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The ID of the endpoint service.
required: true
style: form
explode: true
schema:
type: string
- name: VpcEndpointId
in: query
description: The IDs of one or more interface VPC endpoints.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action4'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AcceptVpcEndpointConnectionsResult'
deprecated: false
post:
summary: POST AcceptVpcEndpointConnections
description: Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
operationId: POSTAcceptVpcEndpointConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action4'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ServiceId
- VpcEndpointId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the endpoint service.
VpcEndpointId:
type: array
items:
type: string
description: The IDs of one or more interface VPC endpoints.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AcceptVpcEndpointConnectionsResult'
deprecated: false
/#Action=AcceptVpcPeeringConnection:
get:
summary: 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.
operationId: GETAcceptVpcPeeringConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
description: The ID of the VPC peering connection. You must specify this parameter in the request.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action6'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AcceptVpcPeeringConnectionResult'
deprecated: false
post:
summary: 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.
operationId: POSTAcceptVpcPeeringConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action6' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
VpcPeeringConnectionId:
type: string
description: The ID of the VPC peering connection. You must specify this parameter in the request.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AcceptVpcPeeringConnectionResult'
deprecated: false
/#Action=AdvertiseByoipCidr:
get:
summary: GET AdvertiseByoipCidr
description: Advertises an IPv4 address range that is provisioned for use with your AWS 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 AWS. To minimize down time, you can configure your AWS 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 AWS.
It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
operationId: GETAdvertiseByoipCidr parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Cidr in: query description: The IPv4 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. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action8'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AdvertiseByoipCidrResult'
deprecated: false
post:
summary: POST AdvertiseByoipCidr
description: Advertises an IPv4 address range that is provisioned for use with your AWS 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 AWS. To minimize down time, you can configure your AWS 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 AWS.
It can take a few minutes before traffic to the specified addresses starts routing to AWS because of BGP propagation delays.
To stop advertising the BYOIP CIDR, use WithdrawByoipCidr.
operationId: POSTAdvertiseByoipCidr parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action8' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Cidr type: object properties: Cidr: type: string description: The IPv4 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: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AdvertiseByoipCidrResult'
deprecated: false
/#Action=AllocateAddress:
get:
summary: GET AllocateAddress
description: Allocates an Elastic IP address to your AWS 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 AWS account.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS 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.
[EC2-VPC] 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 AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
operationId: GETAllocateAddress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Domain in: query description: 'Set to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
' style: form explode: true schema: allOf: - $ref: '#/components/schemas/DomainType' - description: 'Set to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
' - name: Address in: query description: '[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.' style: form explode: true schema: type: string - name: PublicIpv4Pool in: query 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 theAddress parameter instead.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action10'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AllocateAddressResult'
deprecated: false
post:
summary: POST AllocateAddress
description: Allocates an Elastic IP address to your AWS 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 AWS account.
You can allocate an Elastic IP address from an address pool owned by AWS or from an address pool created from a public IPv4 address range that you have brought to AWS for use with your AWS 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.
[EC2-VPC] 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 AWS account. You cannot recover an Elastic IP address for EC2-Classic. To attempt to recover an Elastic IP address that you released, specify it in this operation.
An Elastic IP address is for use either in the EC2-Classic platform or in a VPC. By default, you can allocate 5 Elastic IP addresses for EC2-Classic per Region and 5 Elastic IP addresses for EC2-VPC per Region.
For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTAllocateAddress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action10' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Domain: allOf: - $ref: '#/components/schemas/Domain1' - description: 'Set to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
' Address: type: string description: '[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool.' PublicIpv4Pool: type: string 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 theAddress parameter instead.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AllocateAddressResult'
deprecated: false
/#Action=AllocateHosts:
get:
summary: GET AllocateHosts
description: Allocates a Dedicated Host to your account. At a minimum, specify the instance size type, Availability Zone, and quantity of hosts to allocate.
operationId: GETAllocateHosts
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: AutoPlacement
in: query
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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.
Default: on
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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.
Default: on
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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.
Default: on
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action14'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult'
deprecated: false
post:
summary: 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.
operationId: POSTApplySecurityGroupsToClientVpnTargetNetwork
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action14'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
- VpcId
- SecurityGroupId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
VpcId:
type: string
description: The ID of the VPC in which the associated target network is located.
SecurityGroupId:
type: array
items:
type: string
description: The IDs of the security groups to apply to the associated target network. Up to 5 security groups can be applied to an associated target network.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ApplySecurityGroupsToClientVpnTargetNetworkResult'
deprecated: false
/#Action=AssignIpv6Addresses:
get:
summary: 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.
operationId: GETAssignIpv6Addresses
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Ipv6AddressCount
in: query
description: The number of IPv6 addresses to assign 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.
style: form
explode: true
schema:
type: integer
format: int32
- name: Ipv6Addresses
in: query
description: One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
style: form
explode: true
schema:
type: array
items:
type: string
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action16'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssignIpv6AddressesResult'
deprecated: false
post:
summary: 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.
operationId: POSTAssignIpv6Addresses
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action16'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkInterfaceId
type: object
properties:
Ipv6AddressCount:
type: integer
description: The number of IPv6 addresses to assign 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.
format: int32
Ipv6Addresses:
type: array
items:
type: string
description: One or more specific IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses.
NetworkInterfaceId:
type: string
description: The ID of the network interface.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssignIpv6AddressesResult'
deprecated: false
/#Action=AssignPrivateIpAddresses:
get:
summary: 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.
One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
style: form explode: true schema: type: array items: type: string - name: SecondaryPrivateIpAddressCount in: query 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. style: form explode: true schema: type: integer format: int32 - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action18' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: {} deprecated: false post: summary: 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.
One or more IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses.
If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range.
SecondaryPrivateIpAddressCount: type: integer 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. format: int32 required: false responses: '200': description: Success headers: {} content: {} deprecated: false /#Action=AssociateAddress: get: summary: GET AssociateAddress description:Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only 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.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
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.
style: form
explode: true
schema:
type: boolean
- name: NetworkInterfaceId
in: query
description: [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
style: form explode: true schema: type: string - name: PrivateIpAddress in: query description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action20' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/AssociateAddressResult' deprecated: false post: summary: POST AssociateAddress description:Associates an Elastic IP address with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
[EC2-Classic, VPC in an EC2-VPC-only 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.
[VPC in an EC2-Classic account] If you don't specify a private IP address, the Elastic IP address is associated with the primary IP address. If the Elastic IP address is already associated with a different instance or a network interface, you get an error unless you allow reassociation. You cannot associate an Elastic IP address with an instance or network interface that has an existing Elastic IP address.
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.
NetworkInterfaceId:
type: string
description: [EC2-VPC] The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID.
For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both.
PrivateIpAddress: type: string description: '[EC2-VPC] The primary or secondary private IP address to associate with the Elastic IP address. If no private IP address is specified, the Elastic IP address is associated with the primary private IP address.' required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/AssociateAddressResult' deprecated: false /#Action=AssociateClientVpnTargetNetwork: get: summary: GET 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. operationId: GETAssociateClientVpnTargetNetwork parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientVpnEndpointId in: query description: The ID of the Client VPN endpoint. required: true style: form explode: true schema: type: string - name: SubnetId in: query description: The ID of the subnet to associate with the Client VPN endpoint. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action22'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult'
deprecated: false
post:
summary: 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.
operationId: POSTAssociateClientVpnTargetNetwork
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action22'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
- SubnetId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
SubnetId:
type: string
description: The ID of the subnet to associate with the Client VPN endpoint.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateClientVpnTargetNetworkResult'
deprecated: false
/#Action=AssociateDhcpOptions:
get:
summary: 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 Virtual Private Cloud User Guide.
operationId: GETAssociateDhcpOptions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DhcpOptionsId in: query description: The ID of the DHCP options set, ordefault to associate no DHCP options with the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action24'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 Virtual Private Cloud User Guide.
operationId: POSTAssociateDhcpOptions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action24' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - DhcpOptionsId - VpcId type: object properties: DhcpOptionsId: type: string description: The ID of the DHCP options set, ordefault to associate no DHCP options with the VPC.
VpcId:
type: string
description: The ID of the VPC.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=AssociateIamInstanceProfile:
get:
summary: GET AssociateIamInstanceProfile
description: Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
operationId: GETAssociateIamInstanceProfile
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: IamInstanceProfile.Arn
in: query
description: >-
Describes an IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
style: form
explode: true
schema:
type: string
- name: IamInstanceProfile.Name
in: query
description: >-
Describes an IAM instance profile.
The name of the instance profile.
style: form
explode: true
schema:
type: string
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action26'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateIamInstanceProfileResult'
deprecated: false
post:
summary: POST AssociateIamInstanceProfile
description: Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
operationId: POSTAssociateIamInstanceProfile
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action26'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InstanceId
type: object
properties:
IamInstanceProfile.Arn:
type: string
description: >-
Describes an IAM instance profile.
The Amazon Resource Name (ARN) of the instance profile.
IamInstanceProfile.Name:
type: string
description: >-
Describes an IAM instance profile.
The name of the instance profile.
InstanceId:
type: string
description: The ID of the instance.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateIamInstanceProfileResult'
deprecated: false
/#Action=AssociateRouteTable:
get:
summary: GET AssociateRouteTable
description: Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet 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 from the subnet later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
operationId: GETAssociateRouteTable parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: RouteTableId
in: query
description: The ID of the route table.
required: true
style: form
explode: true
schema:
type: string
- name: SubnetId
in: query
description: The ID of the subnet.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action28'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateRouteTableResult'
deprecated: false
post:
summary: POST AssociateRouteTable
description: Associates a subnet with a route table. The subnet and route table must be in the same VPC. This association causes traffic originating from the subnet 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 from the subnet later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
operationId: POSTAssociateRouteTable parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action28' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - RouteTableId - SubnetId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
RouteTableId:
type: string
description: The ID of the route table.
SubnetId:
type: string
description: The ID of the subnet.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateRouteTableResult'
deprecated: false
/#Action=AssociateSubnetCidrBlock:
get:
summary: 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.
operationId: GETAssociateSubnetCidrBlock
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Ipv6CidrBlock
in: query
description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.
required: true
style: form
explode: true
schema:
type: string
- name: SubnetId
in: query
description: The ID of your subnet.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action30'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateSubnetCidrBlockResult'
deprecated: false
post:
summary: 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.
operationId: POSTAssociateSubnetCidrBlock
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action30'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Ipv6CidrBlock
- SubnetId
type: object
properties:
Ipv6CidrBlock:
type: string
description: The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length.
SubnetId:
type: string
description: The ID of your subnet.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateSubnetCidrBlockResult'
deprecated: false
/#Action=AssociateTransitGatewayRouteTable:
get:
summary: GET AssociateTransitGatewayRouteTable
description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
operationId: GETAssociateTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the transit gateway route table.
required: true
style: form
explode: true
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action32'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult'
deprecated: false
post:
summary: POST AssociateTransitGatewayRouteTable
description: Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
operationId: POSTAssociateTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action32'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AssociateTransitGatewayRouteTableResult'
deprecated: false
/#Action=AssociateVpcCidrBlock:
get:
summary: GET AssociateVpcCidrBlock
description: Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, or you can associate an Amazon-provided IPv6 CIDR block. The IPv6 CIDR block size is fixed at /56.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.
operationId: GETAssociateVpcCidrBlock parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AmazonProvidedIpv6CidrBlock in: query 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. style: form explode: true schema: type: boolean - name: CidrBlock in: query description: An IPv4 CIDR block to associate with the VPC. style: form explode: true schema: type: string - name: VpcId in: query description: The ID of the VPC. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action34' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/AssociateVpcCidrBlockResult' deprecated: false post: summary: POST AssociateVpcCidrBlock description:Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, or you can associate an Amazon-provided IPv6 CIDR block. The IPv6 CIDR block size is fixed at /56.
For more information about associating CIDR blocks with your VPC and applicable restrictions, see VPC and Subnet Sizing in the Amazon Virtual Private Cloud User Guide.
operationId: POSTAssociateVpcCidrBlock parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action34' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpcId type: object properties: AmazonProvidedIpv6CidrBlock: type: boolean 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: type: string description: An IPv4 CIDR block to associate with the VPC. VpcId: type: string description: The ID of the VPC. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/AssociateVpcCidrBlockResult' deprecated: false /#Action=AttachClassicLinkVpc: get: summary: GET AttachClassicLinkVpc description:Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's 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.
operationId: GETAttachClassicLinkVpc parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: SecurityGroupId
in: query
description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: InstanceId
in: query
description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
required: true
style: form
explode: true
schema:
type: string
- name: VpcId
in: query
description: The ID of a ClassicLink-enabled VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action36'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AttachClassicLinkVpcResult'
deprecated: false
post:
summary: POST AttachClassicLinkVpc
description: Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC's 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.
operationId: POSTAttachClassicLinkVpc parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action36' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - SecurityGroupId - InstanceId - VpcId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
SecurityGroupId:
type: array
items:
type: string
description: The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC.
InstanceId:
type: string
description: The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC.
VpcId:
type: string
description: The ID of a ClassicLink-enabled VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AttachClassicLinkVpcResult'
deprecated: false
/#Action=AttachInternetGateway:
get:
summary: GET AttachInternetGateway
description: Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
operationId: GETAttachInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InternetGatewayId
in: query
description: The ID of the internet gateway.
required: true
style: form
explode: true
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action38'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST AttachInternetGateway
description: Attaches an internet gateway to a VPC, enabling connectivity between the internet and the VPC. For more information about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
operationId: POSTAttachInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action38'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InternetGatewayId
- VpcId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the internet gateway.
VpcId:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=AttachNetworkInterface:
get:
summary: GET AttachNetworkInterface
description: Attaches a network interface to an instance.
operationId: GETAttachNetworkInterface
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DeviceIndex
in: query
description: The index of the device for the network interface attachment.
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action40'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/AttachNetworkInterfaceResult'
- description: Contains the output of AttachNetworkInterface.
deprecated: false
post:
summary: POST AttachNetworkInterface
description: Attaches a network interface to an instance.
operationId: POSTAttachNetworkInterface
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action40'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- DeviceIndex
- InstanceId
- NetworkInterfaceId
type: object
properties:
DeviceIndex:
type: integer
description: The index of the device for the network interface attachment.
format: int32
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the instance.
NetworkInterfaceId:
type: string
description: The ID of the network interface.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/AttachNetworkInterfaceResult'
- description: Contains the output of AttachNetworkInterface.
deprecated: false
/#Action=AttachVolume:
get:
summary: 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 may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.
If a volume has an AWS Marketplace product code:
The volume can be attached only to a stopped instance.
AWS 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 about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
operationId: GETAttachVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Device in: query description: The device name (for example,/dev/sdh or xvdh).
required: true
style: form
explode: true
schema:
type: string
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: VolumeId
in: query
description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action42'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/VolumeAttachment'
- description: Describes volume attachment details.
deprecated: false
post:
summary: 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 may only be attached to instances that support Amazon EBS encryption. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
For a list of supported device names, see Attaching an EBS Volume to an Instance. Any device names that aren't reserved for instance store volumes can be used for EBS volumes. For more information, see Amazon EC2 Instance Store in the Amazon Elastic Compute Cloud User Guide.
If a volume has an AWS Marketplace product code:
The volume can be attached only to a stopped instance.
AWS 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 about EBS volumes, see Attaching Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTAttachVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action42' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Device - InstanceId - VolumeId type: object properties: Device: type: string description: The device name (for example,/dev/sdh or xvdh).
InstanceId:
type: string
description: The ID of the instance.
VolumeId:
type: string
description: The ID of the EBS volume. The volume and instance must be within the same Availability Zone.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/VolumeAttachment'
- description: Describes volume attachment details.
deprecated: false
/#Action=AttachVpnGateway:
get:
summary: 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: GETAttachVpnGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: VpcId in: query description: The ID of the VPC. required: true style: form explode: true schema: type: string - name: VpnGatewayId in: query description: The ID of the virtual private gateway. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action44'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/AttachVpnGatewayResult'
- description: Contains the output of AttachVpnGateway.
deprecated: false
post:
summary: 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: POSTAttachVpnGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action44' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpcId - VpnGatewayId type: object properties: VpcId: type: string description: The ID of the VPC. VpnGatewayId: type: string description: The ID of the virtual private gateway. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/AttachVpnGatewayResult'
- description: Contains the output of AttachVpnGateway.
deprecated: false
/#Action=AuthorizeClientVpnIngress:
get:
summary: 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 AWS or on-premises networks.
operationId: GETAuthorizeClientVpnIngress
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint.
required: true
style: form
explode: true
schema:
type: string
- name: TargetNetworkCidr
in: query
description: The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
required: true
style: form
explode: true
schema:
type: string
- name: AccessGroupId
in: query
description: The ID of the Active Directory group to grant access.
style: form
explode: true
schema:
type: string
- name: AuthorizeAllGroups
in: query
description: Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.
style: form
explode: true
schema:
type: boolean
- name: Description
in: query
description: A brief description of the authorization rule.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action46'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AuthorizeClientVpnIngressResult'
deprecated: false
post:
summary: 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 AWS or on-premises networks.
operationId: POSTAuthorizeClientVpnIngress
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action46'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
- TargetNetworkCidr
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
TargetNetworkCidr:
type: string
description: The IPv4 address range, in CIDR notation, of the network for which access is being authorized.
AccessGroupId:
type: string
description: The ID of the Active Directory group to grant access.
AuthorizeAllGroups:
type: boolean
description: Indicates whether to grant access to all clients. Use true to grant all clients who successfully establish a VPN connection access to the network.
Description:
type: string
description: A brief description of the authorization rule.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/AuthorizeClientVpnIngressResult'
deprecated: false
/#Action=AuthorizeSecurityGroupEgress:
get:
summary: GET AuthorizeSecurityGroupEgress
description: [VPC only] Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC.
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 more information about VPC security group limits, see Amazon VPC Limits.
operationId: GETAuthorizeSecurityGroupEgress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupId
in: query
description: The ID of the security group.
required: true
style: form
explode: true
schema:
type: string
- name: IpPermissions
in: query
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: CidrIp
in: query
description: Not supported. Use a set of IP permissions to specify the CIDR.
style: form
explode: true
schema:
type: string
- name: FromPort
in: query
description: Not supported. Use a set of IP permissions to specify the port.
style: form
explode: true
schema:
type: integer
format: int32
- name: IpProtocol
in: query
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
style: form
explode: true
schema:
type: string
- name: ToPort
in: query
description: Not supported. Use a set of IP permissions to specify the port.
style: form
explode: true
schema:
type: integer
format: int32
- name: SourceSecurityGroupName
in: query
description: Not supported. Use a set of IP permissions to specify a destination security group.
style: form
explode: true
schema:
type: string
- name: SourceSecurityGroupOwnerId
in: query
description: Not supported. Use a set of IP permissions to specify a destination security group.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action48'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST AuthorizeSecurityGroupEgress
description: [VPC only] Adds the specified egress rules to a security group for use with a VPC.
An outbound rule permits instances to send traffic to the specified destination IPv4 or IPv6 CIDR address ranges, or to the specified destination security groups for the same VPC.
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 more information about VPC security group limits, see Amazon VPC Limits.
operationId: POSTAuthorizeSecurityGroupEgress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action48' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - GroupId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
GroupId:
type: string
description: The ID of the security group.
IpPermissions:
type: array
items:
type: string
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.
CidrIp:
type: string
description: Not supported. Use a set of IP permissions to specify the CIDR.
FromPort:
type: integer
description: Not supported. Use a set of IP permissions to specify the port.
format: int32
IpProtocol:
type: string
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
ToPort:
type: integer
description: Not supported. Use a set of IP permissions to specify the port.
format: int32
SourceSecurityGroupName:
type: string
description: Not supported. Use a set of IP permissions to specify a destination security group.
SourceSecurityGroupOwnerId:
type: string
description: Not supported. Use a set of IP permissions to specify a destination security group.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=AuthorizeSecurityGroupIngress:
get:
summary: GET AuthorizeSecurityGroupIngress
description: Adds the specified ingress rules to a security group.
An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from the specified destination security groups.
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 limits, see Amazon VPC Limits.
operationId: GETAuthorizeSecurityGroupIngress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CidrIp in: query 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.
style: form explode: true schema: type: string - name: FromPort in: query description:The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
style: form explode: true schema: type: integer format: int32 - name: GroupId in: query 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. style: form explode: true schema: type: string - name: GroupName in: query description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' style: form explode: true schema: type: string - name: IpPermissions in: query description: The sets of IP permissions. style: form explode: true schema: type: array items: type: string - name: IpProtocol in: query description:The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
style: form explode: true schema: type: string - name: SourceSecurityGroupName in: query description: "[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC." style: form explode: true schema: type: string - name: SourceSecurityGroupOwnerId in: query description: "[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead." style: form explode: true schema: type: string - name: ToPort in: query description:The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
style: form explode: true schema: type: integer format: int32 - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action50'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST AuthorizeSecurityGroupIngress
description: Adds the specified ingress rules to a security group.
An inbound rule permits instances to receive traffic from the specified destination IPv4 or IPv6 CIDR address ranges, or from the specified destination security groups.
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 limits, see Amazon VPC Limits.
operationId: POSTAuthorizeSecurityGroupIngress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action50' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: CidrIp: type: 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: type: integer description:The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use -1 to specify all types. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
format: int32 GroupId: type: string 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: type: string description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.' IpPermissions: type: array items: type: string description: The sets of IP permissions. IpProtocol: type: string description:The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). To specify icmpv6, use a set of IP permissions.
[VPC only] Use -1 to specify all protocols. If you specify -1 or a protocol other than tcp, udp, or icmp, traffic on all ports is allowed, regardless of any ports you specify.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
SourceSecurityGroupName: type: string description: "[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead. For EC2-VPC, the source security group must be in the same VPC." SourceSecurityGroupOwnerId: type: string description: "[nondefault VPC] The AWS account ID for the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. Creates rules that grant full ICMP, UDP, and TCP access. To create a rule with a specific IP protocol and port range, use a set of IP permissions instead." ToPort: type: integer description:The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all codes. If you specify all ICMP types, you must specify all codes.
Alternatively, use a set of IP permissions to specify multiple rules and a description for the rule.
format: int32 DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=BundleInstance:
get:
summary: 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
' required: true style: form explode: true schema: type: string - name: Storage.S3 in: query description: >- Describes the storage location for an instance store-backed AMI. An Amazon S3 storage location. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action52'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/BundleInstanceResult'
- description: Contains the output of BundleInstance.
deprecated: false
post:
summary: 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.
The ID of the instance to bundle.
Type: String
Default: None
Required: Yes
' Storage.S3: type: string description: >- Describes the storage location for an instance store-backed AMI. An Amazon S3 storage location. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/BundleInstanceResult'
- description: Contains the output of BundleInstance.
deprecated: false
/#Action=CancelBundleTask:
get:
summary: GET CancelBundleTask
description: Cancels a bundling operation for an instance store-backed Windows instance.
operationId: GETCancelBundleTask
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: BundleId
in: query
description: The ID of the bundle task.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action54'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelBundleTaskResult'
- description: Contains the output of CancelBundleTask.
deprecated: false
post:
summary: POST CancelBundleTask
description: Cancels a bundling operation for an instance store-backed Windows instance.
operationId: POSTCancelBundleTask
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action54'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- BundleId
type: object
properties:
BundleId:
type: string
description: The ID of the bundle task.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelBundleTaskResult'
- description: Contains the output of CancelBundleTask.
deprecated: false
/#Action=CancelCapacityReservation:
get:
summary: 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.
operationId: GETCancelCapacityReservation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CapacityReservationId in: query description: The ID of the Capacity Reservation to be cancelled. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action56'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CancelCapacityReservationResult'
deprecated: false
post:
summary: 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.
operationId: POSTCancelCapacityReservation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action56' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - CapacityReservationId type: object properties: CapacityReservationId: type: string description: The ID of the Capacity Reservation to be cancelled. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CancelCapacityReservationResult'
deprecated: false
/#Action=CancelConversionTask:
get:
summary: GET 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.
operationId: GETCancelConversionTask parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ConversionTaskId in: query description: The ID of the conversion task. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ReasonMessage
in: query
description: The reason for canceling the conversion task.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action58'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTCancelConversionTask parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action58' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ConversionTaskId type: object properties: ConversionTaskId: type: string description: The ID of the conversion task. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
ReasonMessage:
type: string
description: The reason for canceling the conversion task.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=CancelExportTask:
get:
summary: 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.
operationId: GETCancelExportTask
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ExportTaskId
in: query
description: The ID of the export task. This is the ID returned by CreateInstanceExportTask.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action60'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTCancelExportTask
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action60'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ExportTaskId
type: object
properties:
ExportTaskId:
type: string
description: The ID of the export task. This is the ID returned by CreateInstanceExportTask.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=CancelImportTask:
get:
summary: GET CancelImportTask
description: Cancels an in-process import virtual machine or import snapshot task.
operationId: GETCancelImportTask
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: CancelReason
in: query
description: The reason for canceling the task.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ImportTaskId
in: query
description: The ID of the import image or import snapshot task to be canceled.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action62'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelImportTaskResult'
- description: Contains the output for CancelImportTask.
deprecated: false
post:
summary: POST CancelImportTask
description: Cancels an in-process import virtual machine or import snapshot task.
operationId: POSTCancelImportTask
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action62'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
CancelReason:
type: string
description: The reason for canceling the task.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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
description: The ID of the import image or import snapshot task to be canceled.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelImportTaskResult'
- description: Contains the output for CancelImportTask.
deprecated: false
/#Action=CancelReservedInstancesListing:
get:
summary: GET CancelReservedInstancesListing
description: Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCancelReservedInstancesListing parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ReservedInstancesListingId in: query description: The ID of the Reserved Instance listing. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action64' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/CancelReservedInstancesListingResult' - description: Contains the output of CancelReservedInstancesListing. deprecated: false post: summary: POST CancelReservedInstancesListing description:Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace.
For more information, see Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCancelReservedInstancesListing parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action64' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ReservedInstancesListingId type: object properties: ReservedInstancesListingId: type: string description: The ID of the Reserved Instance listing. required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/CancelReservedInstancesListingResult' - description: Contains the output of CancelReservedInstancesListing. deprecated: false /#Action=CancelSpotFleetRequests: get: summary: GET CancelSpotFleetRequests description:Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you 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.
style: form
explode: true
schema:
type: boolean
- name: SpotFleetRequestId
in: query
description: The IDs of the Spot Fleet requests.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: TerminateInstances
in: query
description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
required: true
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action66'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelSpotFleetRequestsResponse'
- description: Contains the output of CancelSpotFleetRequests.
deprecated: false
post:
summary: POST CancelSpotFleetRequests
description: Cancels the specified Spot Fleet requests.
After you cancel a Spot Fleet request, the Spot Fleet launches no new Spot Instances. You must specify whether the Spot Fleet should also terminate its Spot Instances. If you 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.
SpotFleetRequestId:
type: array
items:
type: string
description: The IDs of the Spot Fleet requests.
TerminateInstances:
type: boolean
description: Indicates whether to terminate instances for a Spot Fleet request if it is canceled successfully.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelSpotFleetRequestsResponse'
- description: Contains the output of CancelSpotFleetRequests.
deprecated: false
/#Action=CancelSpotInstanceRequests:
get:
summary: GET 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.
style: form
explode: true
schema:
type: boolean
- name: SpotInstanceRequestId
in: query
description: One or more Spot Instance request IDs.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action68'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelSpotInstanceRequestsResult'
- description: Contains the output of CancelSpotInstanceRequests.
deprecated: false
post:
summary: 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.
SpotInstanceRequestId:
type: array
items:
type: string
description: One or more Spot Instance request IDs.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CancelSpotInstanceRequestsResult'
- description: Contains the output of CancelSpotInstanceRequests.
deprecated: false
/#Action=ConfirmProductInstance:
get:
summary: GET 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.
operationId: GETConfirmProductInstance
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: ProductCode
in: query
description: The product code. This must be a product code that you own.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action70'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ConfirmProductInstanceResult'
deprecated: false
post:
summary: 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.
operationId: POSTConfirmProductInstance
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action70'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InstanceId
- ProductCode
type: object
properties:
InstanceId:
type: string
description: The ID of the instance.
ProductCode:
type: string
description: The product code. This must be a product code that you own.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ConfirmProductInstanceResult'
deprecated: false
/#Action=CopyFpgaImage:
get:
summary: GET CopyFpgaImage
description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
operationId: GETCopyFpgaImage
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: SourceFpgaImageId
in: query
description: The ID of the source AFI.
required: true
style: form
explode: true
schema:
type: string
- name: Description
in: query
description: The description for the new AFI.
style: form
explode: true
schema:
type: string
- name: Name
in: query
description: The name for the new AFI. The default is the name of the source AFI.
style: form
explode: true
schema:
type: string
- name: SourceRegion
in: query
description: The Region that contains the source AFI.
required: true
style: form
explode: true
schema:
type: string
- name: ClientToken
in: query
description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action72'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CopyFpgaImageResult'
deprecated: false
post:
summary: POST CopyFpgaImage
description: Copies the specified Amazon FPGA Image (AFI) to the current Region.
operationId: POSTCopyFpgaImage
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action72'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- SourceFpgaImageId
- SourceRegion
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the source AFI.
Description:
type: string
description: The description for the new AFI.
Name:
type: string
description: The name for the new AFI. The default is the name of the source AFI.
SourceRegion:
type: string
description: The Region that contains the source AFI.
ClientToken:
type: string
description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CopyFpgaImageResult'
deprecated: false
/#Action=CopyImage:
get:
summary: GET CopyImage
description: Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.
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.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCopyImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientToken in: query description: Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. style: form explode: true schema: type: string - name: Description in: query description: A description for the new AMI in the destination Region. style: form explode: true schema: type: string - name: Encrypted in: query 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 CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK usingKmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
type: boolean
- name: KmsKeyId
in: query
description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
' style: form explode: true schema: type: string - name: Name in: query description: The name of the new AMI in the destination Region. required: true style: form explode: true schema: type: string - name: SourceImageId in: query description: The ID of the AMI to copy. required: true style: form explode: true schema: type: string - name: SourceRegion in: query description: The name of the Region that contains the AMI to copy. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action74'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CopyImageResult'
- description: Contains the output of CopyImage.
deprecated: false
post:
summary: POST CopyImage
description: Initiates the copy of an AMI from the specified source Region to the current Region. You specify the destination Region by using its endpoint when making the request.
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.
For more information about the prerequisites and limits when copying an AMI, see Copying an AMI in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCopyImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action74' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Name - SourceImageId - SourceRegion type: object properties: ClientToken: type: string description: Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide. Description: type: string description: A description for the new AMI in the destination Region. Encrypted: type: boolean 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 CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK usingKmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
KmsKeyId:
type: string
description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
' Name: type: string description: The name of the new AMI in the destination Region. SourceImageId: type: string description: The ID of the AMI to copy. SourceRegion: type: string description: The name of the Region that contains the AMI to copy. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CopyImageResult'
- description: Contains the output of CopyImage.
deprecated: false
/#Action=CopySnapshot:
get:
summary: GET CopySnapshot
description: Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.
Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.
To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCopySnapshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Description in: query description: A description for the EBS snapshot. style: form explode: true schema: type: string - name: DestinationRegion in: query 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 AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.
KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
type: boolean
- name: KmsKeyId
in: query
description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action76'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CopySnapshotResult'
- description: Contains the output of CopySnapshot.
deprecated: false
post:
summary: POST CopySnapshot
description: Copies a point-in-time snapshot of an EBS volume and stores it in Amazon S3. You can copy the snapshot within the same Region or from one Region to another. You can use the snapshot to create EBS volumes or Amazon Machine Images (AMIs). The snapshot is copied to the regional endpoint that you send the HTTP request to.
Copies of encrypted EBS snapshots remain encrypted. Copies of unencrypted snapshots remain unencrypted, unless the Encrypted flag is specified during the snapshot copy operation. By default, encrypted snapshot copies use the default AWS Key Management Service (AWS KMS) customer master key (CMK); however, you can specify a non-default CMK with the KmsKeyId parameter.
To copy an encrypted snapshot that has been shared from another account, you must have permissions for the CMK used to encrypt the snapshot.
Snapshots created by copying another snapshot have an arbitrary volume ID that should not be used for any purpose.
For more information, see Copying an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCopySnapshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action76' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - SourceRegion - SourceSnapshotId type: object properties: Description: type: string description: A description for the EBS snapshot. DestinationRegion: type: string 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 AWS CLI, this is specified using the --region parameter or the default Region in your AWS configuration file.
KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
KmsKeyId:
type: string
description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see Query Requests.
The PresignedUrl should use the snapshot source endpoint, the CopySnapshot action, and include the SourceRegion, SourceSnapshotId, and DestinationRegion parameters. The PresignedUrl must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in Authenticating Requests by Using Query Parameters (AWS Signature Version 4) in the Amazon Simple Storage Service API Reference. An invalid or improperly signed PresignedUrl will cause the copy operation to fail asynchronously, and the snapshot will move to an error state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CopySnapshotResult'
- description: Contains the output of CopySnapshot.
deprecated: false
/#Action=CreateCapacityReservation:
get:
summary: 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 Elastic Compute Cloud 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 Limits in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCreateCapacityReservation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientToken in: query 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.
' style: form explode: true schema: type: string - name: InstanceType in: query description: The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. required: true style: form explode: true schema: type: string - name: InstancePlatform in: query description: The type of operating system for which to reserve capacity. required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/CapacityReservationInstancePlatform' - description: The type of operating system for which to reserve capacity. - name: AvailabilityZone in: query description: The Availability Zone in which to create the Capacity Reservation. required: true style: form explode: true schema: type: string - name: Tenancy in: query 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 AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings:
default - The Capacity Reservation is created on hardware that is shared with other AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
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 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
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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action78'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateCapacityReservationResult'
deprecated: false
post:
summary: 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 Elastic Compute Cloud 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 Limits in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCreateCapacityReservation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action78' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceType - InstancePlatform - AvailabilityZone - InstanceCount type: object properties: ClientToken: type: 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.
' InstanceType: type: string description: The instance type for which to reserve capacity. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide. InstancePlatform: allOf: - $ref: '#/components/schemas/InstancePlatform1' - description: The type of operating system for which to reserve capacity. AvailabilityZone: type: string description: The Availability Zone in which to create the Capacity Reservation. Tenancy: allOf: - $ref: '#/components/schemas/Tenancy2' - 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 AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateCapacityReservationResult'
deprecated: false
/#Action=CreateClientVpnEndpoint:
get:
summary: 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.
operationId: GETCreateClientVpnEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientCidrBlock
in: query
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. The CIDR block should be /22 or greater.
required: true
style: form
explode: true
schema:
type: string
- name: ServerCertificateArn
in: query
description: The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.
required: true
style: form
explode: true
schema:
type: string
- name: Authentication
in: query
description: Information about the authentication method to be used to authenticate clients.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: ConnectionLogOptions.Enabled
in: query
description: >-
Describes the client connection logging options for the Client VPN endpoint.
Indicates whether connection logging is enabled.
style: form
explode: true
schema:
type: string
- name: ConnectionLogOptions.CloudwatchLogGroup
in: query
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log group.
style: form
explode: true
schema:
type: string
- name: ConnectionLogOptions.CloudwatchLogStream
in: query
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log stream to which the connection data is published.
style: form
explode: true
schema:
type: string
- name: DnsServers
in: query
description: Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.
style: form
explode: true
schema:
type: array
items:
type: string
- name: TransportProtocol
in: query
description: 'The transport protocol to be used by the VPN session.
Default value: udp
The transport protocol to be used by the VPN session.
Default value: udp
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ClientToken
in: query
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
style: form
explode: true
schema:
type: string
- name: TagSpecification
in: query
description: The tags to apply to the Client VPN endpoint during creation.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action80'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateClientVpnEndpointResult'
deprecated: false
post:
summary: POST 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.
operationId: POSTCreateClientVpnEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action80'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientCidrBlock
- ServerCertificateArn
- Authentication
type: object
properties:
ClientCidrBlock:
type: 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. The CIDR block should be /22 or greater.
ServerCertificateArn:
type: string
description: The ARN of the server certificate. For more information, see the AWS Certificate Manager User Guide.
Authentication:
type: array
items:
type: string
description: Information about the authentication method to be used to authenticate clients.
ConnectionLogOptions.Enabled:
type: string
description: >-
Describes the client connection logging options for the Client VPN endpoint.
Indicates whether connection logging is enabled.
ConnectionLogOptions.CloudwatchLogGroup:
type: string
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log group.
ConnectionLogOptions.CloudwatchLogStream:
type: string
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log stream to which the connection data is published.
DnsServers:
type: array
items:
type: string
description: Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address of the VPC that is to be associated with Client VPN endpoint is used as the DNS server.
TransportProtocol:
allOf:
- $ref: '#/components/schemas/TransportProtocol2'
- description: 'The transport protocol to be used by the VPN session.
Default value: udp
DryRunOperation. Otherwise, it is UnauthorizedOperation.
ClientToken:
type: string
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
TagSpecification:
type: array
items:
type: string
description: The tags to apply to the Client VPN endpoint during creation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateClientVpnEndpointResult'
deprecated: false
/#Action=CreateClientVpnRoute:
get:
summary: GET 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.
operationId: GETCreateClientVpnRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint to which to add the route.
required: true
style: form
explode: true
schema:
type: string
- name: DestinationCidrBlock
in: query
description: The IPv4 address range, in CIDR notation, of the route destination. For example:
To add a route for Internet access, enter 0.0.0.0/0
To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
Route address ranges cannot overlap with the CIDR range specified for client allocation.
required: true style: form explode: true schema: type: string - name: TargetVpcSubnetId in: query description: 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. required: true style: form explode: true schema: type: string - name: Description in: query description: A brief description of the route. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action82'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateClientVpnRouteResult'
deprecated: false
post:
summary: 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.
operationId: POSTCreateClientVpnRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action82'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
- DestinationCidrBlock
- TargetVpcSubnetId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint to which to add the route.
DestinationCidrBlock:
type: string
description: The IPv4 address range, in CIDR notation, of the route destination. For example:
To add a route for Internet access, enter 0.0.0.0/0
To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range
To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range
Route address ranges cannot overlap with the CIDR range specified for client allocation.
TargetVpcSubnetId: type: string description: 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. Description: type: string description: A brief description of the route. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateClientVpnRouteResult'
deprecated: false
/#Action=CreateCustomerGateway:
get:
summary: GET CreateCustomerGateway
description: Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may 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 (in the 64512 - 65534 range).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 Region, and 9059, which is reserved in the eu-west-1 Region.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
" required: true style: form explode: true schema: type: integer format: int32 - name: IpAddress in: query description: The Internet-routable IP address for the customer gateway's outside interface. The address must be static. required: true style: form explode: true schema: type: string - name: Type in: query description: The type of VPN connection that this customer gateway supports (ipsec.1).
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/GatewayType'
- description: The type of VPN connection that this customer gateway supports (ipsec.1).
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action84'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateCustomerGatewayResult'
- description: Contains the output of CreateCustomerGateway.
deprecated: false
post:
summary: POST CreateCustomerGateway
description: Provides information to AWS about your VPN customer gateway device. The customer gateway is the appliance at your end of the VPN connection. (The device on the AWS side of the VPN connection is the virtual private gateway.) You must provide the Internet-routable IP address of the customer gateway's external interface. The IP address must be static and may 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 (in the 64512 - 65534 range).
Amazon EC2 supports all 2-byte ASN numbers in the range of 1 - 65534, with the exception of 7224, which is reserved in the us-east-1 Region, and 9059, which is reserved in the eu-west-1 Region.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
You cannot create more than one customer gateway with the same VPN type, IP address, and BGP ASN parameter values. If you run an identical request more than one time, the first request creates the customer gateway, and subsequent requests return information about the existing customer gateway. The subsequent requests do not create new customer gateway resources.
For devices that support BGP, the customer gateway's BGP ASN.
Default: 65000
" format: int32 IpAddress: type: string description: The Internet-routable IP address for the customer gateway's outside interface. The address must be static. Type: allOf: - $ref: '#/components/schemas/Type1' - description: The type of VPN connection that this customer gateway supports (ipsec.1).
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateCustomerGatewayResult'
- description: Contains the output of CreateCustomerGateway.
deprecated: false
/#Action=CreateDefaultSubnet:
get:
summary: 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 Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.
operationId: GETCreateDefaultSubnet
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: AvailabilityZone
in: query
description: The Availability Zone in which to create the default subnet.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action86'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateDefaultSubnetResult'
deprecated: false
post:
summary: 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 Creating a Default Subnet in the Amazon Virtual Private Cloud User Guide.
operationId: POSTCreateDefaultSubnet
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action86'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- AvailabilityZone
type: object
properties:
AvailabilityZone:
type: string
description: The Availability Zone in which to create the default subnet.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateDefaultSubnetResult'
deprecated: false
/#Action=CreateDefaultVpc:
get:
summary: 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 VPC and Default Subnets in the Amazon Virtual Private Cloud 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.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
operationId: GETCreateDefaultVpc parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action88'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateDefaultVpcResult'
deprecated: false
post:
summary: 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 VPC and Default Subnets in the Amazon Virtual Private Cloud 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.
If your account supports EC2-Classic, you cannot use this action to create a default VPC in a Region that supports EC2-Classic. If you want a default VPC in a Region that supports EC2-Classic, see "I really want a default VPC for my existing EC2 account. Is that possible?" in the Default VPCs FAQ.
operationId: POSTCreateDefaultVpc parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action88' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateDefaultVpcResult'
deprecated: false
/#Action=CreateDhcpOptions:
get:
summary: 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. ITo have your instance to 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, MyCompany.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 Virtual Private Cloud User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action90'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateDhcpOptionsResult'
deprecated: false
post:
summary: 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. ITo have your instance to 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, MyCompany.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 Virtual Private Cloud User Guide.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateDhcpOptionsResult'
deprecated: false
/#Action=CreateEgressOnlyInternetGateway:
get:
summary: GET 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.'
operationId: GETCreateEgressOnlyInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientToken
in: query
description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcId
in: query
description: The ID of the VPC for which to create the egress-only internet gateway.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action92'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult'
deprecated: false
post:
summary: 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.'
operationId: POSTCreateEgressOnlyInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action92'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcId
type: object
properties:
ClientToken:
type: 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:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the VPC for which to create the egress-only internet gateway.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateEgressOnlyInternetGatewayResult'
deprecated: false
/#Action=CreateFleet:
get:
summary: GET CreateFleet
description: Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCreateFleet parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ClientToken
in: query
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
style: form
explode: true
schema:
type: string
- name: SpotOptions.AllocationStrategy
in: query
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.
style: form
explode: true
schema:
type: string
- name: SpotOptions.InstanceInterruptionBehavior
in: query
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
The behavior when a Spot Instance is interrupted. The default is terminate.
style: form
explode: true
schema:
type: string
- name: SpotOptions.InstancePoolsToUseCount
in: query
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
style: form
explode: true
schema:
type: string
- name: SpotOptions.SingleInstanceType
in: query
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
style: form
explode: true
schema:
type: string
- name: SpotOptions.SingleAvailabilityZone
in: query
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
style: form
explode: true
schema:
type: string
- name: SpotOptions.MinTargetCapacity
in: query
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
style: form
explode: true
schema:
type: string
- name: OnDemandOptions.AllocationStrategy
in: query
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.
style: form
explode: true
schema:
type: string
- name: OnDemandOptions.SingleInstanceType
in: query
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
style: form
explode: true
schema:
type: string
- name: OnDemandOptions.SingleAvailabilityZone
in: query
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
style: form
explode: true
schema:
type: string
- name: OnDemandOptions.MinTargetCapacity
in: query
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
style: form
explode: true
schema:
type: string
- name: ExcessCapacityTerminationPolicy
in: query
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.
style: form
explode: true
schema:
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.
- name: LaunchTemplateConfigs
in: query
description: The configuration for the EC2 Fleet.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: TargetCapacitySpecification.TotalTargetCapacity
in: query
description: >-
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.
The number of units to request, filled using DefaultTargetCapacityType.
style: form
explode: true
schema:
type: string
- name: TargetCapacitySpecification.OnDemandTargetCapacity
in: query
description: >-
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.
The number of On-Demand units to request.
style: form
explode: true
schema:
type: string
- name: TargetCapacitySpecification.SpotTargetCapacity
in: query
description: >-
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.
The number of Spot units to request.
style: form
explode: true
schema:
type: string
- name: TargetCapacitySpecification.DefaultTargetCapacityType
in: query
description: >-
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.
The default TotalTargetCapacity, which is either Spot or On-Demand.
style: form
explode: true
schema:
type: string
- name: TerminateInstancesWithExpiration
in: query
description: Indicates whether running instances should be terminated when the EC2 Fleet expires.
style: form
explode: true
schema:
type: boolean
- name: Type
in: query
description: The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/FleetType'
- description: The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
- name: ValidFrom
in: query
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.
style: form
explode: true
schema:
type: string
format: date-time
- name: ValidUntil
in: query
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.
style: form
explode: true
schema:
type: string
format: date-time
- name: ReplaceUnhealthyInstances
in: query
description: Indicates whether EC2 Fleet should replace unhealthy instances.
style: form
explode: true
schema:
type: boolean
- name: TagSpecification
in: query
description: The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action94'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateFleetResult'
deprecated: false
post:
summary: POST CreateFleet
description: Launches an EC2 Fleet.
You can create a single EC2 Fleet that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.
For more information, see Launching an EC2 Fleet in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCreateFleet parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action94' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - LaunchTemplateConfigs type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
SpotOptions.AllocationStrategy:
type: string
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.
SpotOptions.InstanceInterruptionBehavior:
type: string
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
The behavior when a Spot Instance is interrupted. The default is terminate.
SpotOptions.InstancePoolsToUseCount:
type: string
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set to lowest-price. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
SpotOptions.SingleInstanceType:
type: string
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.
SpotOptions.SingleAvailabilityZone:
type: string
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
Indicates that the fleet launches all Spot Instances into a single Availability Zone.
SpotOptions.MinTargetCapacity:
type: string
description: >-
Describes the configuration of Spot Instances in an EC2 Fleet request.
The minimum target capacity for Spot Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
OnDemandOptions.AllocationStrategy:
type: string
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowest-price, EC2 Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first. If you do not specify a value, EC2 Fleet defaults to lowest-price.
OnDemandOptions.SingleInstanceType:
type: string
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.
OnDemandOptions.SingleAvailabilityZone:
type: string
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.
OnDemandOptions.MinTargetCapacity:
type: string
description: >-
The allocation strategy of On-Demand Instances in an EC2 Fleet.
The minimum target capacity for On-Demand Instances in the fleet. If the minimum target capacity is not reached, the fleet launches no instances.
ExcessCapacityTerminationPolicy:
allOf:
- $ref: '#/components/schemas/ExcessCapacityTerminationPolicy2'
- 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.
LaunchTemplateConfigs:
type: array
items:
type: string
description: The configuration for the EC2 Fleet.
TargetCapacitySpecification.TotalTargetCapacity:
type: string
description: >-
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.
The number of units to request, filled using DefaultTargetCapacityType.
TargetCapacitySpecification.OnDemandTargetCapacity:
type: string
description: >-
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.
The number of On-Demand units to request.
TargetCapacitySpecification.SpotTargetCapacity:
type: string
description: >-
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.
The number of Spot units to request.
TargetCapacitySpecification.DefaultTargetCapacityType:
type: string
description: >-
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.
The default TotalTargetCapacity, which is either Spot or On-Demand.
TerminateInstancesWithExpiration:
type: boolean
description: Indicates whether running instances should be terminated when the EC2 Fleet expires.
Type:
allOf:
- $ref: '#/components/schemas/Type3'
- description: The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
ValidFrom:
type: string
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.
format: date-time
ValidUntil:
type: string
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.
format: date-time
ReplaceUnhealthyInstances:
type: boolean
description: Indicates whether EC2 Fleet should replace unhealthy instances.
TagSpecification:
type: array
items:
type: string
description: The key-value pair for tagging the EC2 Fleet request on creation. The value for ResourceType must be fleet, otherwise the fleet request fails. To tag instances at launch, specify the tags in the launch template. For information about tagging after launch, see Tagging Your Resources.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateFleetResult'
deprecated: false
/#Action=CreateFlowLogs:
get:
summary: 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.
operationId: GETCreateFlowLogs parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ClientToken
in: query
description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
style: form
explode: true
schema:
type: string
- name: DeliverLogsPermissionArn
in: query
description: The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
Constraints: Maximum of 1000 resources
' required: true style: form explode: true schema: type: array items: type: string - name: ResourceType in: query description: The type of resource for which to create the flow log. For example, if you specified a VPC ID for theResourceId property, specify VPC for this property.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/FlowLogsResourceType'
- description: The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
- name: TrafficType
in: query
description: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/TrafficType'
- description: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
- name: LogDestinationType
in: query
description: 'Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.
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.
operationId: POSTCreateFlowLogs parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action96' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ResourceId - ResourceType - TrafficType type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: 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:
type: string
description: The ARN for the IAM role that permits Amazon EC2 to publish flow logs to a CloudWatch Logs log group in your account.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
The ID of the subnet, network interface, or VPC for which you want to create a flow log.
Constraints: Maximum of 1000 resources
' ResourceType: allOf: - $ref: '#/components/schemas/ResourceType2' - description: The type of resource for which to create the flow log. For example, if you specified a VPC ID for theResourceId property, specify VPC for this property.
TrafficType:
allOf:
- $ref: '#/components/schemas/TrafficType2'
- description: The type of traffic to log. You can log traffic that the resource accepts or rejects, or all traffic.
LogDestinationType:
allOf:
- $ref: '#/components/schemas/LogDestinationType2'
- description: 'Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
Specifies the destination to which the flow log data is to be published. Flow log data can be published to a CloudWatch Logs log group or an Amazon S3 bucket. The value specified for this parameter depends on the value specified for LogDestinationType.
If LogDestinationType is not specified or cloud-watch-logs, specify the Amazon Resource Name (ARN) of the CloudWatch Logs log group.
If LogDestinationType is s3, specify the ARN of the Amazon S3 bucket. You can also specify a subfolder in the bucket. To specify a subfolder in the bucket, use the following ARN format: bucket_ARN/subfolder_name/. For example, to specify a subfolder named my-logs in a bucket named my-bucket, use the following ARN: arn:aws:s3:::my-bucket/my-logs/. You cannot use AWSLogs as a subfolder name. This is a reserved term.
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 AWS FPGA Hardware Development Kit.
operationId: GETCreateFpgaImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InputStorageLocation.Bucket
in: query
description: >-
Describes a storage location in Amazon S3.
The name of the S3 bucket.
style: form
explode: true
schema:
type: string
- name: InputStorageLocation.Key
in: query
description: >-
Describes a storage location in Amazon S3.
The key.
style: form
explode: true
schema:
type: string
- name: LogsStorageLocation.Bucket
in: query
description: >-
Describes a storage location in Amazon S3.
The name of the S3 bucket.
style: form
explode: true
schema:
type: string
- name: LogsStorageLocation.Key
in: query
description: >-
Describes a storage location in Amazon S3.
The key.
style: form
explode: true
schema:
type: string
- name: Description
in: query
description: A description for the AFI.
style: form
explode: true
schema:
type: string
- name: Name
in: query
description: A name for the AFI.
style: form
explode: true
schema:
type: string
- name: ClientToken
in: query
description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action98'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateFpgaImageResult'
deprecated: false
post:
summary: 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 AWS FPGA Hardware Development Kit.
operationId: POSTCreateFpgaImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action98' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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.Bucket:
type: string
description: >-
Describes a storage location in Amazon S3.
The name of the S3 bucket.
InputStorageLocation.Key:
type: string
description: >-
Describes a storage location in Amazon S3.
The key.
LogsStorageLocation.Bucket:
type: string
description: >-
Describes a storage location in Amazon S3.
The name of the S3 bucket.
LogsStorageLocation.Key:
type: string
description: >-
Describes a storage location in Amazon S3.
The key.
Description:
type: string
description: A description for the AFI.
Name:
type: string
description: A name for the AFI.
ClientToken:
type: string
description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateFpgaImageResult'
deprecated: false
/#Action=CreateImage:
get:
summary: 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 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 Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCreateImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: BlockDeviceMapping in: query description: Tthe 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. style: form explode: true schema: type: array items: type: string - name: Description in: query description: A description for the new image. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: Name
in: query
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(_)
" required: true style: form explode: true schema: type: string - name: NoReboot in: query description: By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed. style: form explode: true schema: type: boolean - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action100' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/CreateImageResult' deprecated: false post: summary: 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 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 Creating Amazon EBS-Backed Linux AMIs in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCreateImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action100' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId - Name type: object properties: BlockDeviceMapping: type: array items: type: string description: Tthe 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: type: string description: A description for the new image. DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The ID of the instance.
Name:
type: string
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: type: boolean description: By default, Amazon EC2 attempts to shut down and reboot the instance before creating the image. If the 'No Reboot' option is set, Amazon EC2 doesn't shut down the instance before creating the image. When this option is used, file system integrity on the created image can't be guaranteed. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/CreateImageResult' deprecated: false /#Action=CreateInstanceExportTask: get: summary: GET CreateInstanceExportTask description:Exports a running or stopped instance to an S3 bucket.
For information about the 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.
operationId: GETCreateInstanceExportTask parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Description in: query description: A description for the conversion task or the resource being exported. The maximum length is 255 bytes. style: form explode: true schema: type: string - name: ExportToS3.ContainerFormat in: query description: >- Describes an instance export task. The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. style: form explode: true schema: type: string - name: ExportToS3.DiskImageFormat in: query description: >- Describes an instance export task. The format for the exported image. style: form explode: true schema: type: string - name: ExportToS3.S3Bucket in: query description: >- Describes an instance export task. The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS accountvm-import-export@amazon.com.
style: form
explode: true
schema:
type: string
- name: ExportToS3.S3Prefix
in: query
description: >-
Describes an instance export task.
The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
style: form
explode: true
schema:
type: string
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: TargetEnvironment
in: query
description: The target virtualization environment.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/ExportEnvironment'
- description: The target virtualization environment.
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action102'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateInstanceExportTaskResult'
- description: Contains the output for CreateInstanceExportTask.
deprecated: false
post:
summary: POST CreateInstanceExportTask
description: Exports a running or stopped instance to an S3 bucket.
For information about the 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.
operationId: POSTCreateInstanceExportTask parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action102' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: Description: type: string description: A description for the conversion task or the resource being exported. The maximum length is 255 bytes. ExportToS3.ContainerFormat: type: string description: >- Describes an instance export task. The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported. ExportToS3.DiskImageFormat: type: string description: >- Describes an instance export task. The format for the exported image. ExportToS3.S3Bucket: type: string description: >- Describes an instance export task. The S3 bucket for the destination image. The destination bucket must exist and grant WRITE and READ_ACP permissions to the AWS accountvm-import-export@amazon.com.
ExportToS3.S3Prefix:
type: string
description: >-
Describes an instance export task.
The image is written to a single object in the S3 bucket at the S3 key s3prefix + exportTaskId + '.' + diskImageFormat.
InstanceId:
type: string
description: The ID of the instance.
TargetEnvironment:
allOf:
- $ref: '#/components/schemas/TargetEnvironment1'
- description: The target virtualization environment.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateInstanceExportTaskResult'
- description: Contains the output for CreateInstanceExportTask.
deprecated: false
/#Action=CreateInternetGateway:
get:
summary: 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 about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
operationId: GETCreateInternetGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action104'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateInternetGatewayResult'
deprecated: false
post:
summary: 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 about your VPC and internet gateway, see the Amazon Virtual Private Cloud User Guide.
operationId: POSTCreateInternetGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action104' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateInternetGatewayResult'
deprecated: false
/#Action=CreateKeyPair:
get:
summary: GET CreateKeyPair
description: Creates a 2048-bit RSA key pair with the specified name. 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. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the 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.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCreateKeyPair parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: KeyName in: query description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action106'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/KeyPair'
- description: Describes a key pair.
deprecated: false
post:
summary: POST CreateKeyPair
description: Creates a 2048-bit RSA key pair with the specified name. 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. If a key with the specified name already exists, Amazon EC2 returns an error.
You can have up to five thousand key pairs per Region.
The key pair returned to you is available only in the 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.
For more information, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCreateKeyPair parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action106' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - KeyName type: object properties: KeyName: type: string description: 'A unique name for the key pair.
Constraints: Up to 255 ASCII characters
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/KeyPair'
- description: Describes a key pair.
deprecated: false
/#Action=CreateLaunchTemplate:
get:
summary: 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.
operationId: GETCreateLaunchTemplate
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ClientToken
in: query
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.
' style: form explode: true schema: type: string - name: LaunchTemplateName in: query description: A name for the launch template. required: true style: form explode: true schema: maxLength: 128 minLength: 3 pattern: '[a-zA-Z0-9\(\)\.\-/_]+' type: string - name: VersionDescription in: query description: A description for the first version of the launch template. style: form explode: true schema: maxLength: 255 type: string - name: LaunchTemplateData.KernelId in: query description: >- The information to include in the launch template.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 block device mapping.
Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
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. To change this attribute to false after launch, use ModifyInstanceAttribute.
style: form
explode: true
schema:
type: string
- name: LaunchTemplateData.InstanceInitiatedShutdownBehavior
in: query
description: >-
The information to include in the launch template.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
style: form
explode: true
schema:
type: string
- name: LaunchTemplateData.LicenseSpecifications
in: query
description: >-
The information to include in the launch template.
The license configurations.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LaunchTemplateData.HibernationOptions
in: query
description: >-
The information to include in the launch template.
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action108'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateLaunchTemplateResult'
deprecated: false
post:
summary: POST 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.
operationId: POSTCreateLaunchTemplate
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action108'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- LaunchTemplateName
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: 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: maxLength: 128 minLength: 3 pattern: '[a-zA-Z0-9\(\)\.\-/_]+' type: string description: A name for the launch template. VersionDescription: maxLength: 255 type: string description: A description for the first version of the launch template. LaunchTemplateData.KernelId: type: string description: >- The information to include in the launch template.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 block device mapping.
Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
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. To change this attribute to false after launch, use ModifyInstanceAttribute.
LaunchTemplateData.InstanceInitiatedShutdownBehavior:
type: string
description: >-
The information to include in the launch template.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
LaunchTemplateData.LicenseSpecifications:
type: array
items:
type: string
description: >-
The information to include in the launch template.
The license configurations.
LaunchTemplateData.HibernationOptions:
type: string
description: >-
The information to include in the launch template.
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateLaunchTemplateResult'
deprecated: false
/#Action=CreateLaunchTemplateVersion:
get:
summary: GET CreateLaunchTemplateVersion
description: Creates a new version for 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.
operationId: GETCreateLaunchTemplateVersion parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ClientToken
in: query
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.
' style: form explode: true schema: type: string - name: LaunchTemplateId in: query description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. style: form explode: true schema: type: string - name: LaunchTemplateName in: query description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. style: form explode: true schema: maxLength: 128 minLength: 3 pattern: '[a-zA-Z0-9\(\)\.\-/_]+' type: string - name: SourceVersion in: query description: The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. style: form explode: true schema: type: string - name: VersionDescription in: query description: A description for the version of the launch template. style: form explode: true schema: maxLength: 255 type: string - name: LaunchTemplateData.KernelId in: query description: >- The information to include in the launch template.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 block device mapping.
Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
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. To change this attribute to false after launch, use ModifyInstanceAttribute.
style: form
explode: true
schema:
type: string
- name: LaunchTemplateData.InstanceInitiatedShutdownBehavior
in: query
description: >-
The information to include in the launch template.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
style: form
explode: true
schema:
type: string
- name: LaunchTemplateData.LicenseSpecifications
in: query
description: >-
The information to include in the launch template.
The license configurations.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LaunchTemplateData.HibernationOptions
in: query
description: >-
The information to include in the launch template.
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action110'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateLaunchTemplateVersionResult'
deprecated: false
post:
summary: POST CreateLaunchTemplateVersion
description: Creates a new version for 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.
operationId: POSTCreateLaunchTemplateVersion parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action110' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: 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: type: string description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. LaunchTemplateName: maxLength: 128 minLength: 3 pattern: '[a-zA-Z0-9\(\)\.\-/_]+' type: string description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. SourceVersion: type: string description: The version number of the launch template version on which to base the new version. The new version inherits the same launch parameters as the source version, except for parameters that you specify in LaunchTemplateData. VersionDescription: maxLength: 255 type: string description: A description for the version of the launch template. LaunchTemplateData.KernelId: type: string description: >- The information to include in the launch template.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 block device mapping.
Supplying both a snapshot ID and an encryption value as arguments for block-device mapping results in an error. This is because only blank volumes can be encrypted on start, and these are not created from a snapshot. If a snapshot is the basis for the volume, it contains data by definition and its encryption status cannot be changed using this action.
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. To change this attribute to false after launch, use ModifyInstanceAttribute.
LaunchTemplateData.InstanceInitiatedShutdownBehavior:
type: string
description: >-
The information to include in the launch template.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
open, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
LaunchTemplateData.LicenseSpecifications:
type: array
items:
type: string
description: >-
The information to include in the launch template.
The license configurations.
LaunchTemplateData.HibernationOptions:
type: string
description: >-
The information to include in the launch template.
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateLaunchTemplateVersionResult'
deprecated: false
/#Action=CreateNatGateway:
get:
summary: GET CreateNatGateway
description: Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide.
operationId: GETCreateNatGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: AllocationId
in: query
description: The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it.
required: true
style: form
explode: true
schema:
type: string
- name: ClientToken
in: query
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.
' style: form explode: true schema: type: string - name: SubnetId in: query description: The subnet in which to create the NAT gateway. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action112' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/CreateNatGatewayResult' deprecated: false post: summary: POST CreateNatGateway description: Creates a NAT gateway in the specified public subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. Internet-bound traffic from a private subnet can be routed to the NAT gateway, therefore enabling instances in the private subnet to connect to the internet. For more information, see NAT Gateways in the Amazon Virtual Private Cloud User Guide. operationId: POSTCreateNatGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action112' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AllocationId - SubnetId type: object properties: AllocationId: type: string description: The allocation ID of an Elastic IP address to associate with the NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it. ClientToken: type: 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.
' SubnetId: type: string description: The subnet in which to create the NAT gateway. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/CreateNatGatewayResult' deprecated: false /#Action=CreateNetworkAcl: get: summary: 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 Virtual Private Cloud User Guide.
operationId: GETCreateNetworkAcl parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action114'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateNetworkAclResult'
deprecated: false
post:
summary: 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 Virtual Private Cloud User Guide.
operationId: POSTCreateNetworkAcl parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action114' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpcId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateNetworkAclResult'
deprecated: false
/#Action=CreateNetworkAclEntry:
get:
summary: 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 Virtual Private Cloud User Guide.
operationId: GETCreateNetworkAclEntry parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CidrBlock in: query description: The IPv4 network range to allow or deny, in CIDR notation (for example172.16.0.0/24).
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Egress
in: query
description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
required: true
style: form
explode: true
schema:
type: boolean
- name: Icmp.Code
in: query
description: >-
Describes the ICMP type and code.
The ICMP code. A value of -1 means all codes for the specified ICMP type.
style: form
explode: true
schema:
type: string
- name: Icmp.Type
in: query
description: >-
Describes the ICMP type and code.
The ICMP type. A value of -1 means all types.
style: form
explode: true
schema:
type: string
- name: Ipv6CidrBlock
in: query
description: The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
style: form
explode: true
schema:
type: string
- name: NetworkAclId
in: query
description: The ID of the network ACL.
required: true
style: form
explode: true
schema:
type: string
- name: PortRange.From
in: query
description: >-
Describes a range of ports.
The first port in the range.
style: form
explode: true
schema:
type: string
- name: PortRange.To
in: query
description: >-
Describes a range of ports.
The last port in the range.
style: form
explode: true
schema:
type: string
- name: Protocol
in: query
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.
required: true
style: form
explode: true
schema:
type: string
- name: RuleAction
in: query
description: Indicates whether to allow or deny the traffic that matches the rule.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/RuleAction'
- description: Indicates whether to allow or deny the traffic that matches the rule.
- name: RuleNumber
in: query
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.
' required: true style: form explode: true schema: type: integer format: int32 - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action116' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: {} deprecated: false post: summary: 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 Virtual Private Cloud User Guide.
operationId: POSTCreateNetworkAclEntry parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action116' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Egress - NetworkAclId - Protocol - RuleAction - RuleNumber type: object properties: CidrBlock: type: string description: The IPv4 network range to allow or deny, in CIDR notation (for example172.16.0.0/24).
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: boolean
description: Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet).
Icmp.Code:
type: string
description: >-
Describes the ICMP type and code.
The ICMP code. A value of -1 means all codes for the specified ICMP type.
Icmp.Type:
type: string
description: >-
Describes the ICMP type and code.
The ICMP type. A value of -1 means all types.
Ipv6CidrBlock:
type: string
description: The IPv6 network range to allow or deny, in CIDR notation (for example 2001:db8:1234:1a00::/64).
NetworkAclId:
type: string
description: The ID of the network ACL.
PortRange.From:
type: string
description: >-
Describes a range of ports.
The first port in the range.
PortRange.To:
type: string
description: >-
Describes a range of ports.
The last port in the range.
Protocol:
type: string
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/RuleAction2'
- description: Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber:
type: integer
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.
' format: int32 required: false responses: '200': description: Success headers: {} content: {} deprecated: false /#Action=CreateNetworkInterface: get: summary: GET CreateNetworkInterface description:Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
operationId: GETCreateNetworkInterface parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Description in: query description: A description for the network interface. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: SecurityGroupId
in: query
description: The IDs of one or more security groups.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Ipv6AddressCount
in: query
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 use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.
style: form
explode: true
schema:
type: integer
format: int32
- name: Ipv6Addresses
in: query
description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
style: form
explode: true
schema:
type: array
items:
type: string
- name: PrivateIpAddress
in: query
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 in privateIpAddresses as primary (only one IP address can be designated as primary).
style: form
explode: true
schema:
type: string
- name: PrivateIpAddresses
in: query
description: One or more private IPv4 addresses.
style: form
explode: true
schema:
type: array
items:
type: string
- name: SecondaryPrivateIpAddressCount
in: query
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.
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.
style: form explode: true schema: type: integer format: int32 - name: InterfaceType in: query description:Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA ENI, omit this parameter.
style: form explode: true schema: allOf: - $ref: '#/components/schemas/NetworkInterfaceCreationType' - description:Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA ENI, omit this parameter.
- name: SubnetId in: query description: The ID of the subnet to associate with the network interface. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action118' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/CreateNetworkInterfaceResult' - description: Contains the output of CreateNetworkInterface. deprecated: false post: summary: POST CreateNetworkInterface description:Creates a network interface in the specified subnet.
For more information about network interfaces, see Elastic Network Interfaces in the Amazon Virtual Private Cloud User Guide.
operationId: POSTCreateNetworkInterface parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action118' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - SubnetId type: object properties: Description: type: string description: A description for the network interface. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
SecurityGroupId:
type: array
items:
type: string
description: The IDs of one or more security groups.
Ipv6AddressCount:
type: integer
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 use this option if specifying specific IPv6 addresses. If your subnet has the AssignIpv6AddressOnCreation attribute set to true, you can specify 0 to override this setting.
format: int32
Ipv6Addresses:
type: array
items:
type: string
description: One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.
PrivateIpAddress:
type: string
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 in privateIpAddresses as primary (only one IP address can be designated as primary).
PrivateIpAddresses:
type: array
items:
type: string
description: One or more private IPv4 addresses.
SecondaryPrivateIpAddressCount:
type: integer
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.
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.
format: int32 InterfaceType: allOf: - $ref: '#/components/schemas/InterfaceType1' - description:Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA ENI, omit this parameter.
SubnetId: type: string description: The ID of the subnet to associate with the network interface. required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/CreateNetworkInterfaceResult' - description: Contains the output of CreateNetworkInterface. deprecated: false /#Action=CreateNetworkInterfacePermission: get: summary: GET CreateNetworkInterfacePermission description:Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single AWS account only, and only one account at a time.
operationId: GETCreateNetworkInterfacePermission parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: NetworkInterfaceId in: query description: The ID of the network interface. required: true style: form explode: true schema: type: string - name: AwsAccountId in: query description: The AWS account ID. style: form explode: true schema: type: string - name: AwsService in: query description: The AWS service. Currently not supported. style: form explode: true schema: type: string - name: Permission in: query description: The type of permission to grant. required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/InterfacePermissionType' - description: The type of permission to grant. - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action120'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult'
- description: Contains the output of CreateNetworkInterfacePermission.
deprecated: false
post:
summary: POST CreateNetworkInterfacePermission
description: Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account.
You can grant permission to a single AWS account only, and only one account at a time.
operationId: POSTCreateNetworkInterfacePermission parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action120' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - NetworkInterfaceId - Permission type: object properties: NetworkInterfaceId: type: string description: The ID of the network interface. AwsAccountId: type: string description: The AWS account ID. AwsService: type: string description: The AWS service. Currently not supported. Permission: allOf: - $ref: '#/components/schemas/Permission1' - description: The type of permission to grant. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateNetworkInterfacePermissionResult'
- description: Contains the output of CreateNetworkInterfacePermission.
deprecated: false
/#Action=CreatePlacementGroup:
get:
summary: 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 Elastic Compute Cloud User Guide.
operationId: GETCreatePlacementGroup parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupName
in: query
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
' style: form explode: true schema: type: string - name: Strategy in: query description: The placement strategy. style: form explode: true schema: allOf: - $ref: '#/components/schemas/PlacementStrategy' - description: The placement strategy. - name: PartitionCount in: query description: The number of partitions. Valid only when Strategy is set topartition.
style: form
explode: true
schema:
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action122'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST 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 Elastic Compute Cloud User Guide.
operationId: POSTCreatePlacementGroup parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action122' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
GroupName:
type: string
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/Strategy1' - description: The placement strategy. PartitionCount: type: integer description: The number of partitions. Valid only when Strategy is set topartition.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=CreateReservedInstancesListing:
get:
summary: 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 Elastic Compute Cloud User Guide.
operationId: GETCreateReservedInstancesListing parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientToken in: query description: Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency. required: true style: form explode: true schema: type: string - name: InstanceCount in: query 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. required: true style: form explode: true schema: type: integer format: int32 - name: PriceSchedules in: query description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. required: true style: form explode: true schema: type: array items: type: string - name: ReservedInstancesId in: query description: The ID of the active Standard Reserved Instance. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action124' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/CreateReservedInstancesListingResult' - description: Contains the output of CreateReservedInstancesListing. deprecated: false post: summary: 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 Elastic Compute Cloud User Guide.
operationId: POSTCreateReservedInstancesListing parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action124' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ClientToken - InstanceCount - PriceSchedules - ReservedInstancesId type: object properties: ClientToken: type: string description: Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see Ensuring Idempotency. InstanceCount: type: integer 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. format: int32 PriceSchedules: type: array items: type: string description: A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. ReservedInstancesId: type: string description: The ID of the active Standard Reserved Instance. required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/CreateReservedInstancesListingResult' - description: Contains the output of CreateReservedInstancesListing. deprecated: false /#Action=CreateRoute: get: summary: GET CreateRoute description: 'Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.
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 Virtual Private Cloud User Guide.
' operationId: GETCreateRoute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DestinationCidrBlock in: query description: The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. style: form explode: true schema: type: string - name: DestinationIpv6CidrBlock in: query description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EgressOnlyInternetGatewayId
in: query
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
style: form
explode: true
schema:
type: string
- name: GatewayId
in: query
description: The ID of an internet gateway or virtual private gateway attached to your VPC.
style: form
explode: true
schema:
type: string
- name: InstanceId
in: query
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.
style: form
explode: true
schema:
type: string
- name: NatGatewayId
in: query
description: '[IPv4 traffic only] The ID of a NAT gateway.'
style: form
explode: true
schema:
type: string
- name: TransitGatewayId
in: query
description: The ID of a transit gateway.
style: form
explode: true
schema:
type: string
- name: NetworkInterfaceId
in: query
description: The ID of a network interface.
style: form
explode: true
schema:
type: string
- name: RouteTableId
in: query
description: The ID of the route table for the route.
required: true
style: form
explode: true
schema:
type: string
- name: VpcPeeringConnectionId
in: query
description: The ID of a VPC peering connection.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action126'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateRouteResult'
deprecated: false
post:
summary: POST CreateRoute
description: 'Creates a route in a route table within a VPC.
You must specify one of the following targets: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.
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 Virtual Private Cloud User Guide.
' operationId: POSTCreateRoute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action126' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - RouteTableId type: object properties: DestinationCidrBlock: type: string description: The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. DestinationIpv6CidrBlock: type: string description: The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
EgressOnlyInternetGatewayId:
type: string
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
GatewayId:
type: string
description: The ID of an internet gateway or virtual private gateway attached to your VPC.
InstanceId:
type: string
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:
type: string
description: '[IPv4 traffic only] The ID of a NAT gateway.'
TransitGatewayId:
type: string
description: The ID of a transit gateway.
NetworkInterfaceId:
type: string
description: The ID of a network interface.
RouteTableId:
type: string
description: The ID of the route table for the route.
VpcPeeringConnectionId:
type: string
description: The ID of a VPC peering connection.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateRouteResult'
deprecated: false
/#Action=CreateRouteTable:
get:
summary: 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 Virtual Private Cloud User Guide.
operationId: GETCreateRouteTable parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action128'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateRouteTableResult'
deprecated: false
post:
summary: 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 Virtual Private Cloud User Guide.
operationId: POSTCreateRouteTable parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action128' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpcId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateRouteTableResult'
deprecated: false
/#Action=CreateSecurityGroup:
get:
summary: 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 have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and 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.
operationId: GETCreateSecurityGroup parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: GroupDescription in: query description: 'A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' required: true style: form explode: true schema: type: string - name: GroupName in: query description: 'The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-.
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' required: true style: form explode: true schema: type: string - name: VpcId in: query description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action130'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateSecurityGroupResult'
deprecated: false
post:
summary: 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 have a security group for use in EC2-Classic with the same name as a security group for use in a VPC. However, you can't have two security groups for use in EC2-Classic with the same name or two security groups for use in a VPC with the same name.
You have a default security group for use in EC2-Classic and 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.
operationId: POSTCreateSecurityGroup parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action130' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - GroupDescription - GroupName type: object properties: GroupDescription: type: string description: 'A description for the security group. This is informational only.
Constraints: Up to 255 characters in length
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' GroupName: type: string description: 'The name of the security group.
Constraints: Up to 255 characters in length. Cannot start with sg-.
Constraints for EC2-Classic: ASCII characters
Constraints for EC2-VPC: a-z, A-Z, 0-9, spaces, and ._-:/()#,@[]+=&;{}!$*
' VpcId: type: string description: '[EC2-VPC] The ID of the VPC. Required for EC2-VPC.' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateSecurityGroupResult'
deprecated: false
/#Action=CreateSnapshot:
get:
summary: 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.
When a snapshot is created, any AWS 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 EBS volume at the time the snapshot command is issued; this may 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.
To create a snapshot for EBS volumes that serve as root devices, you should 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 Tagging 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.
operationId: GETCreateSnapshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Description in: query description: A description for the snapshot. style: form explode: true schema: type: string - name: VolumeId in: query description: The ID of the EBS volume. required: true style: form explode: true schema: type: string - name: TagSpecification in: query description: The tags to apply to the snapshot during creation. style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action132'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/Snapshot'
- description: Describes a snapshot.
deprecated: false
post:
summary: 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.
When a snapshot is created, any AWS 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 EBS volume at the time the snapshot command is issued; this may 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.
To create a snapshot for EBS volumes that serve as root devices, you should 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 Tagging 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.
operationId: POSTCreateSnapshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action132' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VolumeId type: object properties: Description: type: string description: A description for the snapshot. VolumeId: type: string description: The ID of the EBS volume. TagSpecification: type: array items: type: string description: The tags to apply to the snapshot during creation. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/Snapshot'
- description: Describes a snapshot.
deprecated: false
/#Action=CreateSpotDatafeedSubscription:
get:
summary: 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 AWS account. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.
operationId: GETCreateSpotDatafeedSubscription
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Bucket
in: query
description: The Amazon S3 bucket in which to store the Spot Instance data feed.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Prefix
in: query
description: A prefix for the data feed file names.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action134'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult'
- description: Contains the output of CreateSpotDatafeedSubscription.
deprecated: false
post:
summary: 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 AWS account. For more information, see Spot Instance Data Feed in the Amazon EC2 User Guide for Linux Instances.
operationId: POSTCreateSpotDatafeedSubscription
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action134'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Bucket
type: object
properties:
Bucket:
type: string
description: The Amazon S3 bucket in which to store the Spot Instance data feed.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: A prefix for the data feed file names.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateSpotDatafeedSubscriptionResult'
- description: Contains the output of CreateSpotDatafeedSubscription.
deprecated: false
/#Action=CreateSubnet:
get:
summary: GET CreateSubnet
description: Creates a subnet in an existing VPC.
When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).
If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.
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.
If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). 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 about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
operationId: GETCreateSubnet parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AvailabilityZone in: query description: 'The Availability Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.
' style: form explode: true schema: type: string - name: AvailabilityZoneId in: query description: The AZ ID of the subnet. style: form explode: true schema: type: string - name: CidrBlock in: query description: The IPv4 network range for the subnet, in CIDR notation. For example,10.0.0.0/24.
required: true
style: form
explode: true
schema:
type: string
- name: Ipv6CidrBlock
in: query
description: The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
style: form
explode: true
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action136'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateSubnetResult'
deprecated: false
post:
summary: POST CreateSubnet
description: Creates a subnet in an existing VPC.
When you create each subnet, you provide the VPC ID and IPv4 CIDR block for the subnet. After you create a subnet, you can't change its CIDR block. The size of the subnet's IPv4 CIDR block can be the same as a VPC's IPv4 CIDR block, or a subset of a VPC's IPv4 CIDR block. If you create more than one subnet in a VPC, the subnets' CIDR blocks must not overlap. The smallest IPv4 subnet (and VPC) you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses).
If you've associated an IPv6 CIDR block with your VPC, you can create a subnet with an IPv6 CIDR block that uses a /64 prefix length.
AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for use.
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.
If you launch an instance in a VPC using an Amazon EBS-backed AMI, the IP address doesn't change if you stop and restart the instance (unlike a similar instance launched outside a VPC, which gets a new IP address when restarted). 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 about subnets, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
operationId: POSTCreateSubnet parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action136' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - CidrBlock - VpcId type: object properties: AvailabilityZone: type: string description: 'The Availability Zone for the subnet.
Default: AWS selects one for you. If you create more than one subnet in your VPC, we may not necessarily select a different zone for each subnet.
' AvailabilityZoneId: type: string description: The AZ ID of the subnet. CidrBlock: type: string description: The IPv4 network range for the subnet, in CIDR notation. For example,10.0.0.0/24.
Ipv6CidrBlock:
type: string
description: The IPv6 network range for the subnet, in CIDR notation. The subnet size must use a /64 prefix length.
VpcId:
type: string
description: The ID of the VPC.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateSubnetResult'
deprecated: false
/#Action=CreateTags:
get:
summary: GET CreateTags
description: Adds or overwrites the specified tags for the specified Amazon EC2 resource or resources. 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 Tagging Your 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.
operationId: GETCreateTags parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ResourceId
in: query
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' required: true style: form explode: true schema: type: array items: type: string - name: Tag in: query 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.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action138'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST CreateTags
description: Adds or overwrites the specified tags for the specified Amazon EC2 resource or resources. 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 Tagging Your 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.
operationId: POSTCreateTags parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action138' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ResourceId - Tag type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: array
items:
type: string
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' Tag: type: array items: type: string 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.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=CreateTransitGateway:
get:
summary: 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.
operationId: GETCreateTransitGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Description in: query description: A description of the transit gateway. style: form explode: true schema: type: string - name: Options.AmazonSideAsn in: query description: >- Describes the options for a transit gateway. 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. style: form explode: true schema: type: string - name: Options.AutoAcceptSharedAttachments in: query description: >- Describes the options for a transit gateway. Enable or disable automatic acceptance of attachment requests. The default isdisable.
style: form
explode: true
schema:
type: string
- name: Options.DefaultRouteTableAssociation
in: query
description: >-
Describes the options for a transit gateway.
Enable or disable automatic association with the default association route table. The default is enable.
style: form
explode: true
schema:
type: string
- name: Options.DefaultRouteTablePropagation
in: query
description: >-
Describes the options for a transit gateway.
Enable or disable automatic propagation of routes to the default propagation route table. The default is enable.
style: form
explode: true
schema:
type: string
- name: Options.VpnEcmpSupport
in: query
description: >-
Describes the options for a transit gateway.
Enable or disable Equal Cost Multipath Protocol support.
style: form
explode: true
schema:
type: string
- name: Options.DnsSupport
in: query
description: >-
Describes the options for a transit gateway.
Enable or disable DNS support.
style: form
explode: true
schema:
type: string
- name: TagSpecification
in: query
description: The tags to apply to the transit gateway.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action140'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayResult'
deprecated: false
post:
summary: 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.
operationId: POSTCreateTransitGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action140' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Description: type: string description: A description of the transit gateway. Options.AmazonSideAsn: type: string description: >- Describes the options for a transit gateway. 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. Options.AutoAcceptSharedAttachments: type: string description: >- Describes the options for a transit gateway. Enable or disable automatic acceptance of attachment requests. The default isdisable.
Options.DefaultRouteTableAssociation:
type: string
description: >-
Describes the options for a transit gateway.
Enable or disable automatic association with the default association route table. The default is enable.
Options.DefaultRouteTablePropagation:
type: string
description: >-
Describes the options for a transit gateway.
Enable or disable automatic propagation of routes to the default propagation route table. The default is enable.
Options.VpnEcmpSupport:
type: string
description: >-
Describes the options for a transit gateway.
Enable or disable Equal Cost Multipath Protocol support.
Options.DnsSupport:
type: string
description: >-
Describes the options for a transit gateway.
Enable or disable DNS support.
TagSpecification:
type: array
items:
type: string
description: The tags to apply to the transit gateway.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayResult'
deprecated: false
/#Action=CreateTransitGatewayRoute:
get:
summary: GET CreateTransitGatewayRoute
description: Creates a static route for the specified transit gateway route table.
operationId: GETCreateTransitGatewayRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DestinationCidrBlock
in: query
description: The CIDR range used for destination matches. Routing decisions are based on the most specific match.
required: true
style: form
explode: true
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the transit gateway route table.
required: true
style: form
explode: true
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
style: form
explode: true
schema:
type: string
- name: Blackhole
in: query
description: Indicates whether to drop traffic that matches this route.
style: form
explode: true
schema:
type: boolean
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action142'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteResult'
deprecated: false
post:
summary: POST CreateTransitGatewayRoute
description: Creates a static route for the specified transit gateway route table.
operationId: POSTCreateTransitGatewayRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action142'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- DestinationCidrBlock
- TransitGatewayRouteTableId
type: object
properties:
DestinationCidrBlock:
type: string
description: The CIDR range used for destination matches. Routing decisions are based on the most specific match.
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
Blackhole:
type: boolean
description: Indicates whether to drop traffic that matches this route.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteResult'
deprecated: false
/#Action=CreateTransitGatewayRouteTable:
get:
summary: GET CreateTransitGatewayRouteTable
description: Creates a route table for the specified transit gateway.
operationId: GETCreateTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayId
in: query
description: The ID of the transit gateway.
required: true
style: form
explode: true
schema:
type: string
- name: TagSpecifications
in: query
description: The tags to apply to the transit gateway route table.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action144'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
deprecated: false
post:
summary: POST CreateTransitGatewayRouteTable
description: Creates a route table for the specified transit gateway.
operationId: POSTCreateTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action144'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayId
type: object
properties:
TransitGatewayId:
type: string
description: The ID of the transit gateway.
TagSpecifications:
type: array
items:
type: string
description: The tags to apply to the transit gateway route table.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayRouteTableResult'
deprecated: false
/#Action=CreateTransitGatewayVpcAttachment:
get:
summary: 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.
operationId: GETCreateTransitGatewayVpcAttachment parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: TransitGatewayId in: query description: The ID of the transit gateway. required: true style: form explode: true schema: type: string - name: VpcId in: query description: The ID of the VPC. required: true style: form explode: true schema: type: string - name: SubnetIds in: query 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. required: true style: form explode: true schema: type: array items: type: string - name: Options.DnsSupport in: query description: >- Describes the options for a VPC attachment. Enable or disable DNS support. The default isenable.
style: form
explode: true
schema:
type: string
- name: Options.Ipv6Support
in: query
description: >-
Describes the options for a VPC attachment.
Enable or disable IPv6 support. The default is enable.
style: form
explode: true
schema:
type: string
- name: TagSpecifications
in: query
description: The tags to apply to the VPC attachment.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action146'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult'
deprecated: false
post:
summary: 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.
operationId: POSTCreateTransitGatewayVpcAttachment parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action146' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - TransitGatewayId - VpcId - SubnetIds type: object properties: TransitGatewayId: type: string description: The ID of the transit gateway. VpcId: type: string description: The ID of the VPC. SubnetIds: type: array items: type: string 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.DnsSupport: type: string description: >- Describes the options for a VPC attachment. Enable or disable DNS support. The default isenable.
Options.Ipv6Support:
type: string
description: >-
Describes the options for a VPC attachment.
Enable or disable IPv6 support. The default is enable.
TagSpecifications:
type: array
items:
type: string
description: The tags to apply to the VPC attachment.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateTransitGatewayVpcAttachmentResult'
deprecated: false
/#Action=CreateVolume:
get:
summary: GET CreateVolume
description: Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only 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 Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
operationId: GETCreateVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AvailabilityZone in: query description: The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you. required: true style: form explode: true schema: type: string - name: Encrypted in: query description: Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. style: form explode: true schema: type: boolean - name: Iops in: query description:The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
style: form explode: true schema: type: integer format: int32 - name: KmsKeyId in: query description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
The size of the volume, in GiBs.
Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
At least one of Size or SnapshotId are required.
The snapshot from which to create the volume.
At least one of Size or SnapshotId are required.
The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: TagSpecification
in: query
description: The tags to apply to the volume during creation.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action148'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/Volume'
- description: Describes a volume.
deprecated: false
post:
summary: POST CreateVolume
description: Creates an EBS volume that can be attached to an instance in the same Availability Zone. The volume is created in the regional endpoint that you send the HTTP request to. For more information see Regions and Endpoints.
You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume.
You can create encrypted volumes with the Encrypted parameter. Encrypted volumes may only 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 Tagging Your Amazon EC2 Resources in the Amazon Elastic Compute Cloud User Guide.
For more information, see Creating an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTCreateVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action148' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AvailabilityZone type: object properties: AvailabilityZone: type: string description: The Availability Zone in which to create the volume. Use DescribeAvailabilityZones to list the Availability Zones that are currently available to you. Encrypted: type: boolean description: Specifies whether the volume should be encrypted. Encrypted Amazon EBS volumes may only be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are automatically encrypted. There is no way to create an encrypted volume from an unencrypted snapshot or vice versa. If your AMI uses encrypted volumes, you can only launch it on supported instance types. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide. Iops: type: integer description:The number of I/O operations per second (IOPS) to provision for the volume, with a maximum ratio of 50 IOPS/GiB. Range is 100 to 64,000 IOPS for volumes in most Regions. Maximum IOPS of 64,000 is guaranteed only on Nitro-based instances. Other instance families guarantee performance up to 32,000 IOPS. For more information, see Amazon EBS Volume Types in the Amazon Elastic Compute Cloud User Guide.
This parameter is valid only for Provisioned IOPS SSD (io1) volumes.
format: int32 KmsKeyId: type: string description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted volume. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. The action will eventually fail.
The size of the volume, in GiBs.
Constraints: 1-16,384 for gp2, 4-16,384 for io1, 500-16,384 for st1, 500-16,384 for sc1, and 1-1,024 for standard. If you specify a snapshot, the volume size must be equal to or larger than the snapshot size.
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.
At least one of Size or SnapshotId are required.
The snapshot from which to create the volume.
At least one of Size or SnapshotId are required.
The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
TagSpecification:
type: array
items:
type: string
description: The tags to apply to the volume during creation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/Volume'
- description: Describes a volume.
deprecated: false
/#Action=CreateVpc:
get:
summary: GET CreateVpc
description: Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC.
By default, each instance 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 Options Sets in the Amazon Virtual Private Cloud 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 Elastic Compute Cloud User Guide.
operationId: GETCreateVpc parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CidrBlock in: query description: The IPv4 network range for the VPC, in CIDR notation. For example,10.0.0.0/16.
required: true
style: form
explode: true
schema:
type: string
- name: AmazonProvidedIpv6CidrBlock
in: query
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.
style: form
explode: true
schema:
type: boolean
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceTenancy
in: query
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 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
Creates a VPC with the specified IPv4 CIDR block. The smallest VPC you can create uses a /28 netmask (16 IPv4 addresses), and the largest uses a /16 netmask (65,536 IPv4 addresses). For more information about how large to make your VPC, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
You can optionally request an Amazon-provided IPv6 CIDR block for the VPC. The IPv6 CIDR block uses a /56 prefix length, and is allocated from Amazon's pool of IPv6 addresses. You cannot choose the IPv6 range for your VPC.
By default, each instance 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 Options Sets in the Amazon Virtual Private Cloud 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 Elastic Compute Cloud User Guide.
operationId: POSTCreateVpc parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action150' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - CidrBlock type: object properties: CidrBlock: type: string description: The IPv4 network range for the VPC, in CIDR notation. For example,10.0.0.0/16.
AmazonProvidedIpv6CidrBlock:
type: boolean
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.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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/InstanceTenancy1'
- 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
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.
Use DescribeVpcEndpointServices to get a list of supported services.
operationId: GETCreateVpcEndpoint parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcEndpointType
in: query
description: 'The type of endpoint.
Default: Gateway
' style: form explode: true schema: allOf: - $ref: '#/components/schemas/VpcEndpointType' - description: 'The type of endpoint.
Default: Gateway
' - name: VpcId in: query description: The ID of the VPC in which the endpoint will be used. required: true style: form explode: true schema: type: string - name: ServiceName in: query description: The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider. required: true style: form explode: true schema: type: string - name: PolicyDocument in: query description: 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. style: form explode: true schema: type: string - name: RouteTableId in: query description: (Gateway endpoint) One or more route table IDs. style: form explode: true schema: type: array items: type: string - name: SubnetId in: query description: (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface. style: form explode: true schema: type: array items: type: string - name: SecurityGroupId in: query description: (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface. style: form explode: true schema: type: array items: type: string - name: ClientToken in: query description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. style: form explode: true schema: type: string - name: PrivateDnsEnabled in: query description: '(Interface endpoint) Indicate 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: false
Creates a VPC endpoint for a specified service. An endpoint enables you to create a private connection between your VPC and the service. The service may be provided by AWS, an AWS Marketplace partner, or another AWS account. For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
A gateway endpoint serves as a target for a route in your route table for traffic destined for the AWS service. You can specify an endpoint policy to attach to the endpoint that will control access to the service from your VPC. You can also specify the VPC route tables that use the endpoint.
An interface endpoint is a network interface in your subnet that serves as an endpoint for communicating with the specified service. You can specify the subnets in which to create an endpoint, and the security groups to associate with the endpoint network interface.
Use DescribeVpcEndpointServices to get a list of supported services.
operationId: POSTCreateVpcEndpoint parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action152' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpcId - ServiceName type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
VpcEndpointType:
allOf:
- $ref: '#/components/schemas/VpcEndpointType2'
- description: 'The type of endpoint.
Default: Gateway
' VpcId: type: string description: The ID of the VPC in which the endpoint will be used. ServiceName: type: string description: The service name. To get a list of available services, use the DescribeVpcEndpointServices request, or get the name from the service provider. PolicyDocument: type: string description: 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. RouteTableId: type: array items: type: string description: (Gateway endpoint) One or more route table IDs. SubnetId: type: array items: type: string description: (Interface endpoint) The ID of one or more subnets in which to create an endpoint network interface. SecurityGroupId: type: array items: type: string description: (Interface endpoint) The ID of one or more security groups to associate with the endpoint network interface. ClientToken: type: string description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. PrivateDnsEnabled: type: boolean description: '(Interface endpoint) Indicate 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: false
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.
operationId: GETCreateVpcEndpointConnectionNotification parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The ID of the endpoint service.
style: form
explode: true
schema:
type: string
- name: VpcEndpointId
in: query
description: The ID of the endpoint.
style: form
explode: true
schema:
type: string
- name: ConnectionNotificationArn
in: query
description: The ARN of the SNS topic for the notifications.
required: true
style: form
explode: true
schema:
type: string
- name: ConnectionEvents
in: query
description: One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: ClientToken
in: query
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action154'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult'
deprecated: false
post:
summary: 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.
operationId: POSTCreateVpcEndpointConnectionNotification parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action154' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ConnectionNotificationArn - ConnectionEvents type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The ID of the endpoint service.
VpcEndpointId:
type: string
description: The ID of the endpoint.
ConnectionNotificationArn:
type: string
description: The ARN of the SNS topic for the notifications.
ConnectionEvents:
type: array
items:
type: string
description: One or more endpoint events for which to receive notifications. Valid values are Accept, Connect, Delete, and Reject.
ClientToken:
type: string
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateVpcEndpointConnectionNotificationResult'
deprecated: false
/#Action=CreateVpcEndpointServiceConfiguration:
get:
summary: GET CreateVpcEndpointServiceConfiguration
description: Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service.
To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.
operationId: GETCreateVpcEndpointServiceConfiguration parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: AcceptanceRequired
in: query
description: Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.
style: form
explode: true
schema:
type: boolean
- name: NetworkLoadBalancerArn
in: query
description: The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: ClientToken
in: query
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action156'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult'
deprecated: false
post:
summary: POST CreateVpcEndpointServiceConfiguration
description: Creates a VPC endpoint service configuration to which service consumers (AWS accounts, IAM users, and IAM roles) can connect. Service consumers can create an interface VPC endpoint to connect to your service.
To create an endpoint service configuration, you must first create a Network Load Balancer for your service. For more information, see VPC Endpoint Services in the Amazon Virtual Private Cloud User Guide.
operationId: POSTCreateVpcEndpointServiceConfiguration parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action156' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - NetworkLoadBalancerArn type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
AcceptanceRequired:
type: boolean
description: Indicate whether requests from service consumers to create an endpoint to your service must be accepted. To accept a request, use AcceptVpcEndpointConnections.
NetworkLoadBalancerArn:
type: array
items:
type: string
description: The Amazon Resource Names (ARNs) of one or more Network Load Balancers for your service.
ClientToken:
type: string
description: Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/CreateVpcEndpointServiceConfigurationResult'
deprecated: false
/#Action=CreateVpcPeeringConnection:
get:
summary: 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 AWS 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.
style: form
explode: true
schema:
type: boolean
- name: PeerOwnerId
in: query
description: 'The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
' style: form explode: true schema: type: string - name: PeerVpcId in: query description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. style: form explode: true schema: type: string - name: VpcId in: query description: The ID of the requester VPC. You must specify this parameter in the request. style: form explode: true schema: type: string - name: PeerRegion in: query 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.
' style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action158' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/CreateVpcPeeringConnectionResult' deprecated: false post: summary: 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 AWS 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.
PeerOwnerId:
type: string
description: 'The AWS account ID of the owner of the accepter VPC.
Default: Your AWS account ID
' PeerVpcId: type: string description: The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. VpcId: type: string description: The ID of the requester VPC. You must specify this parameter in the request. PeerRegion: type: 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.
' required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/CreateVpcPeeringConnectionResult' deprecated: false /#Action=CreateVpnConnection: get: summary: GET CreateVpnConnection description:Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only 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.
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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: GETCreateVpnConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CustomerGatewayId in: query description: The ID of the customer gateway. required: true style: form explode: true schema: type: string - name: Type in: query description: The type of VPN connection (ipsec.1).
required: true
style: form
explode: true
schema:
type: string
- name: VpnGatewayId
in: query
description: The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
style: form
explode: true
schema:
type: string
- name: TransitGatewayId
in: query
description: The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Options.StaticRoutesOnly
in: query
description: >-
Describes VPN connection options.
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
Creates a VPN connection between an existing virtual private gateway and a VPN customer gateway. The only 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.
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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: POSTCreateVpnConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action160' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - CustomerGatewayId - Type type: object properties: CustomerGatewayId: type: string description: The ID of the customer gateway. Type: type: string description: The type of VPN connection (ipsec.1).
VpnGatewayId:
type: string
description: The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway.
TransitGatewayId:
type: string
description: The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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.StaticRoutesOnly:
type: string
description: >-
Describes VPN connection options.
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
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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: GETCreateVpnConnectionRoute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DestinationCidrBlock in: query description: The CIDR block associated with the local subnet of the customer network. required: true style: form explode: true schema: type: string - name: VpnConnectionId in: query description: The ID of the VPN connection. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action162' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: {} deprecated: false post: summary: 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: POSTCreateVpnConnectionRoute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action162' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - DestinationCidrBlock - VpnConnectionId type: object properties: DestinationCidrBlock: type: string description: The CIDR block associated with the local subnet of the customer network. VpnConnectionId: type: string description: The ID of the VPN connection. required: false responses: '200': description: Success headers: {} content: {} deprecated: false /#Action=CreateVpnGateway: get: summary: 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: GETCreateVpnGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AvailabilityZone in: query description: The Availability Zone for the virtual private gateway. style: form explode: true schema: type: string - name: Type in: query description: The type of VPN connection this virtual private gateway supports. required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/GatewayType' - description: The type of VPN connection this virtual private gateway supports. - name: AmazonSideAsn in: query 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
" style: form explode: true schema: type: integer format: int32 - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action164'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateVpnGatewayResult'
- description: Contains the output of CreateVpnGateway.
deprecated: false
post:
summary: 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 AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: POSTCreateVpnGateway parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action164' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Type type: object properties: AvailabilityZone: type: string description: The Availability Zone for the virtual private gateway. Type: allOf: - $ref: '#/components/schemas/Type5' - description: The type of VPN connection this virtual private gateway supports. AmazonSideAsn: type: integer 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
" format: int32 DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/CreateVpnGatewayResult'
- description: Contains the output of CreateVpnGateway.
deprecated: false
/#Action=DeleteClientVpnEndpoint:
get:
summary: GET DeleteClientVpnEndpoint
description: Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
operationId: GETDeleteClientVpnEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN to be deleted.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action166'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteClientVpnEndpointResult'
deprecated: false
post:
summary: POST DeleteClientVpnEndpoint
description: Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint.
operationId: POSTDeleteClientVpnEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action166'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN to be deleted.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteClientVpnEndpointResult'
deprecated: false
/#Action=DeleteClientVpnRoute:
get:
summary: 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.
operationId: GETDeleteClientVpnRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint from which the route is to be deleted.
required: true
style: form
explode: true
schema:
type: string
- name: TargetVpcSubnetId
in: query
description: The ID of the target subnet used by the route.
style: form
explode: true
schema:
type: string
- name: DestinationCidrBlock
in: query
description: The IPv4 address range, in CIDR notation, of the route to be deleted.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action168'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteClientVpnRouteResult'
deprecated: false
post:
summary: 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.
operationId: POSTDeleteClientVpnRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action168'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
- DestinationCidrBlock
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint from which the route is to be deleted.
TargetVpcSubnetId:
type: string
description: The ID of the target subnet used by the route.
DestinationCidrBlock:
type: string
description: The IPv4 address range, in CIDR notation, of the route to be deleted.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteClientVpnRouteResult'
deprecated: false
/#Action=DeleteCustomerGateway:
get:
summary: GET DeleteCustomerGateway
description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
operationId: GETDeleteCustomerGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: CustomerGatewayId
in: query
description: The ID of the customer gateway.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action170'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteCustomerGateway
description: Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway.
operationId: POSTDeleteCustomerGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action170'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- CustomerGatewayId
type: object
properties:
CustomerGatewayId:
type: string
description: The ID of the customer gateway.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteDhcpOptions:
get:
summary: 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.
operationId: GETDeleteDhcpOptions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DhcpOptionsId
in: query
description: The ID of the DHCP options set.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action172'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTDeleteDhcpOptions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action172'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- DhcpOptionsId
type: object
properties:
DhcpOptionsId:
type: string
description: The ID of the DHCP options set.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteEgressOnlyInternetGateway:
get:
summary: GET DeleteEgressOnlyInternetGateway
description: Deletes an egress-only internet gateway.
operationId: GETDeleteEgressOnlyInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EgressOnlyInternetGatewayId
in: query
description: The ID of the egress-only internet gateway.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action174'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
deprecated: false
post:
summary: POST DeleteEgressOnlyInternetGateway
description: Deletes an egress-only internet gateway.
operationId: POSTDeleteEgressOnlyInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action174'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- EgressOnlyInternetGatewayId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the egress-only internet gateway.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteEgressOnlyInternetGatewayResult'
deprecated: false
/#Action=DeleteFleets:
get:
summary: GET DeleteFleets
description: Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances. You must specify whether an EC2 Fleet should also terminate its instances. If you 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: FleetId
in: query
description: The IDs of the EC2 Fleets.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: TerminateInstances
in: query
description: Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.
required: true
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action176'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteFleetsResult'
deprecated: false
post:
summary: POST DeleteFleets
description: Deletes the specified EC2 Fleet.
After you delete an EC2 Fleet, it launches no new instances. You must specify whether an EC2 Fleet should also terminate its instances. If you 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
FleetId:
type: array
items:
type: string
description: The IDs of the EC2 Fleets.
TerminateInstances:
type: boolean
description: Indicates whether to terminate instances for an EC2 Fleet if it is deleted successfully.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteFleetsResult'
deprecated: false
/#Action=DeleteFlowLogs:
get:
summary: GET DeleteFlowLogs
description: Deletes one or more flow logs.
operationId: GETDeleteFlowLogs
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: FlowLogId
in: query
description: One or more flow log IDs.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action178'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteFlowLogsResult'
deprecated: false
post:
summary: POST DeleteFlowLogs
description: Deletes one or more flow logs.
operationId: POSTDeleteFlowLogs
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action178'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- FlowLogId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: One or more flow log IDs.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteFlowLogsResult'
deprecated: false
/#Action=DeleteFpgaImage:
get:
summary: GET DeleteFpgaImage
description: Deletes the specified Amazon FPGA Image (AFI).
operationId: GETDeleteFpgaImage
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: FpgaImageId
in: query
description: The ID of the AFI.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action180'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteFpgaImageResult'
deprecated: false
post:
summary: POST DeleteFpgaImage
description: Deletes the specified Amazon FPGA Image (AFI).
operationId: POSTDeleteFpgaImage
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action180'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- FpgaImageId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the AFI.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteFpgaImageResult'
deprecated: false
/#Action=DeleteInternetGateway:
get:
summary: GET DeleteInternetGateway
description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
operationId: GETDeleteInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InternetGatewayId
in: query
description: The ID of the internet gateway.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action182'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteInternetGateway
description: Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it.
operationId: POSTDeleteInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action182'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InternetGatewayId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the internet gateway.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteKeyPair:
get:
summary: GET DeleteKeyPair
description: Deletes the specified key pair, by removing the public key from Amazon EC2.
operationId: GETDeleteKeyPair
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: KeyName
in: query
description: The name of the key pair.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action184'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteKeyPair
description: Deletes the specified key pair, by removing the public key from Amazon EC2.
operationId: POSTDeleteKeyPair
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action184'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- KeyName
type: object
properties:
KeyName:
type: string
description: The name of the key pair.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteLaunchTemplate:
get:
summary: GET DeleteLaunchTemplate
description: Deletes a launch template. Deleting a launch template deletes all of its versions.
operationId: GETDeleteLaunchTemplate
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: LaunchTemplateId
in: query
description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
style: form
explode: true
schema:
type: string
- name: LaunchTemplateName
in: query
description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
style: form
explode: true
schema:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action186'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteLaunchTemplateResult'
deprecated: false
post:
summary: POST DeleteLaunchTemplate
description: Deletes a launch template. Deleting a launch template deletes all of its versions.
operationId: POSTDeleteLaunchTemplate
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action186'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteLaunchTemplateResult'
deprecated: false
/#Action=DeleteLaunchTemplateVersions:
get:
summary: GET DeleteLaunchTemplateVersions
description: Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
operationId: GETDeleteLaunchTemplateVersions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: LaunchTemplateId
in: query
description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
style: form
explode: true
schema:
type: string
- name: LaunchTemplateName
in: query
description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
style: form
explode: true
schema:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
- name: LaunchTemplateVersion
in: query
description: The version numbers of one or more launch template versions to delete.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action188'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult'
deprecated: false
post:
summary: POST DeleteLaunchTemplateVersions
description: Deletes one or more versions of a launch template. You cannot delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using DeleteLaunchTemplate.
operationId: POSTDeleteLaunchTemplateVersions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action188'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- LaunchTemplateVersion
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
LaunchTemplateVersion:
type: array
items:
type: string
description: The version numbers of one or more launch template versions to delete.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteLaunchTemplateVersionsResult'
deprecated: false
/#Action=DeleteNatGateway:
get:
summary: GET DeleteNatGateway
description: Deletes the specified NAT gateway. Deleting a 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.
operationId: GETDeleteNatGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: NatGatewayId
in: query
description: The ID of the NAT gateway.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action190'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteNatGatewayResult'
deprecated: false
post:
summary: POST DeleteNatGateway
description: Deletes the specified NAT gateway. Deleting a 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.
operationId: POSTDeleteNatGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action190'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NatGatewayId
type: object
properties:
NatGatewayId:
type: string
description: The ID of the NAT gateway.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteNatGatewayResult'
deprecated: false
/#Action=DeleteNetworkAcl:
get:
summary: 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.
operationId: GETDeleteNetworkAcl
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NetworkAclId
in: query
description: The ID of the network ACL.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action192'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTDeleteNetworkAcl
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action192'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkAclId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the network ACL.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteNetworkAclEntry:
get:
summary: GET DeleteNetworkAclEntry
description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
operationId: GETDeleteNetworkAclEntry
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Egress
in: query
description: Indicates whether the rule is an egress rule.
required: true
style: form
explode: true
schema:
type: boolean
- name: NetworkAclId
in: query
description: The ID of the network ACL.
required: true
style: form
explode: true
schema:
type: string
- name: RuleNumber
in: query
description: The rule number of the entry to delete.
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action194'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteNetworkAclEntry
description: Deletes the specified ingress or egress entry (rule) from the specified network ACL.
operationId: POSTDeleteNetworkAclEntry
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action194'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Egress
- NetworkAclId
- RuleNumber
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: boolean
description: Indicates whether the rule is an egress rule.
NetworkAclId:
type: string
description: The ID of the network ACL.
RuleNumber:
type: integer
description: The rule number of the entry to delete.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteNetworkInterface:
get:
summary: GET DeleteNetworkInterface
description: Deletes the specified network interface. You must detach the network interface before you can delete it.
operationId: GETDeleteNetworkInterface
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action196'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteNetworkInterface
description: Deletes the specified network interface. You must detach the network interface before you can delete it.
operationId: POSTDeleteNetworkInterface
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action196'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkInterfaceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the network interface.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteNetworkInterfacePermission:
get:
summary: 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.
operationId: GETDeleteNetworkInterfacePermission
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: NetworkInterfacePermissionId
in: query
description: The ID of the network interface permission.
required: true
style: form
explode: true
schema:
type: string
- name: Force
in: query
description: Specify true to remove the permission even if the network interface is attached to an instance.
style: form
explode: true
schema:
type: boolean
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action198'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
- description: Contains the output for DeleteNetworkInterfacePermission.
deprecated: false
post:
summary: 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.
operationId: POSTDeleteNetworkInterfacePermission
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action198'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkInterfacePermissionId
type: object
properties:
NetworkInterfacePermissionId:
type: string
description: The ID of the network interface permission.
Force:
type: boolean
description: Specify true to remove the permission even if the network interface is attached to an instance.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DeleteNetworkInterfacePermissionResult'
- description: Contains the output for DeleteNetworkInterfacePermission.
deprecated: false
/#Action=DeletePlacementGroup:
get:
summary: 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 Elastic Compute Cloud User Guide.
operationId: GETDeletePlacementGroup
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupName
in: query
description: The name of the placement group.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action200'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 Elastic Compute Cloud User Guide.
operationId: POSTDeletePlacementGroup
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action200'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- GroupName
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The name of the placement group.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteRoute:
get:
summary: GET DeleteRoute
description: Deletes the specified route from the specified route table.
operationId: GETDeleteRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DestinationCidrBlock
in: query
description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
style: form
explode: true
schema:
type: string
- name: DestinationIpv6CidrBlock
in: query
description: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: RouteTableId
in: query
description: The ID of the route table.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action202'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteRoute
description: Deletes the specified route from the specified route table.
operationId: POSTDeleteRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action202'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- RouteTableId
type: object
properties:
DestinationCidrBlock:
type: string
description: The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
DestinationIpv6CidrBlock:
type: string
description: The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the route table.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteRouteTable:
get:
summary: 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.
operationId: GETDeleteRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: RouteTableId
in: query
description: The ID of the route table.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action204'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTDeleteRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action204'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- RouteTableId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the route table.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteSecurityGroup:
get:
summary: GET DeleteSecurityGroup
description: Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action206'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteSecurityGroup
description: Deletes a security group.
If you attempt to delete a security group that is associated with an instance, or is referenced by another security group, the operation fails with InvalidGroup.InUse in EC2-Classic or DependencyViolation in EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteSnapshot:
get:
summary: GET 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 Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDeleteSnapshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: SnapshotId in: query description: The ID of the EBS snapshot. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action208'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 Deleting an Amazon EBS Snapshot in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDeleteSnapshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action208' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - SnapshotId type: object properties: SnapshotId: type: string description: The ID of the EBS snapshot. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteSpotDatafeedSubscription:
get:
summary: GET DeleteSpotDatafeedSubscription
description: Deletes the data feed for Spot Instances.
operationId: GETDeleteSpotDatafeedSubscription
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action210'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteSpotDatafeedSubscription
description: Deletes the data feed for Spot Instances.
operationId: POSTDeleteSpotDatafeedSubscription
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action210'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteSubnet:
get:
summary: GET DeleteSubnet
description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
operationId: GETDeleteSubnet
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: SubnetId
in: query
description: The ID of the subnet.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action212'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteSubnet
description: Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet.
operationId: POSTDeleteSubnet
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action212'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- SubnetId
type: object
properties:
SubnetId:
type: string
description: The ID of the subnet.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteTags:
get:
summary: 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 Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDeleteTags parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ResourceId
in: query
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' required: true style: form explode: true schema: type: array items: type: string - name: Tag in: query 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 AWS-generated tags (tags that have the aws: prefix).
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 Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDeleteTags parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action214' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ResourceId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: array
items:
type: string
description: 'The IDs of the resources, separated by spaces.
Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches.
' Tag: type: array items: type: string 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 AWS-generated tags (tags that have the aws: prefix).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action216'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayResult'
deprecated: false
post:
summary: POST DeleteTransitGateway
description: Deletes the specified transit gateway.
operationId: POSTDeleteTransitGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action216'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayId
type: object
properties:
TransitGatewayId:
type: string
description: The ID of the transit gateway.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayResult'
deprecated: false
/#Action=DeleteTransitGatewayRoute:
get:
summary: GET DeleteTransitGatewayRoute
description: Deletes the specified route from the specified transit gateway route table.
operationId: GETDeleteTransitGatewayRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the transit gateway route table.
required: true
style: form
explode: true
schema:
type: string
- name: DestinationCidrBlock
in: query
description: The CIDR range for the route. This must match the CIDR for the route exactly.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action218'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
deprecated: false
post:
summary: POST DeleteTransitGatewayRoute
description: Deletes the specified route from the specified transit gateway route table.
operationId: POSTDeleteTransitGatewayRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action218'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
- DestinationCidrBlock
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
DestinationCidrBlock:
type: string
description: The CIDR range for the route. This must match the CIDR for the route exactly.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteResult'
deprecated: false
/#Action=DeleteTransitGatewayRouteTable:
get:
summary: 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.
operationId: GETDeleteTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the transit gateway route table.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action220'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
deprecated: false
post:
summary: 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.
operationId: POSTDeleteTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action220'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayRouteTableResult'
deprecated: false
/#Action=DeleteTransitGatewayVpcAttachment:
get:
summary: GET DeleteTransitGatewayVpcAttachment
description: Deletes the specified VPC attachment.
operationId: GETDeleteTransitGatewayVpcAttachment
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action222'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
deprecated: false
post:
summary: POST DeleteTransitGatewayVpcAttachment
description: Deletes the specified VPC attachment.
operationId: POSTDeleteTransitGatewayVpcAttachment
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action222'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteTransitGatewayVpcAttachmentResult'
deprecated: false
/#Action=DeleteVolume:
get:
summary: 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 Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDeleteVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: VolumeId in: query description: The ID of the volume. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action224'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 Deleting an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDeleteVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action224' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VolumeId type: object properties: VolumeId: type: string description: The ID of the volume. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteVpc:
get:
summary: 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.
operationId: GETDeleteVpc
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action226'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTDeleteVpc
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action226'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcId
type: object
properties:
VpcId:
type: string
description: The ID of the VPC.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteVpcEndpointConnectionNotifications:
get:
summary: GET DeleteVpcEndpointConnectionNotifications
description: Deletes one or more VPC endpoint connection notifications.
operationId: GETDeleteVpcEndpointConnectionNotifications
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ConnectionNotificationId
in: query
description: One or more notification IDs.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action228'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
deprecated: false
post:
summary: POST DeleteVpcEndpointConnectionNotifications
description: Deletes one or more VPC endpoint connection notifications.
operationId: POSTDeleteVpcEndpointConnectionNotifications
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action228'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ConnectionNotificationId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: One or more notification IDs.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteVpcEndpointConnectionNotificationsResult'
deprecated: false
/#Action=DeleteVpcEndpointServiceConfigurations:
get:
summary: GET DeleteVpcEndpointServiceConfigurations
description: Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.
operationId: GETDeleteVpcEndpointServiceConfigurations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The IDs of one or more services.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action230'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
deprecated: false
post:
summary: POST DeleteVpcEndpointServiceConfigurations
description: Deletes one or more VPC endpoint service configurations in your account. Before you delete the endpoint service configuration, you must reject any Available or PendingAcceptance interface endpoint connections that are attached to the service.
operationId: POSTDeleteVpcEndpointServiceConfigurations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action230'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ServiceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: The IDs of one or more services.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteVpcEndpointServiceConfigurationsResult'
deprecated: false
/#Action=DeleteVpcEndpoints:
get:
summary: GET DeleteVpcEndpoints
description: Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes the endpoint network interfaces.
operationId: GETDeleteVpcEndpoints
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcEndpointId
in: query
description: One or more VPC endpoint IDs.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action232'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DeleteVpcEndpointsResult'
- description: Contains the output of DeleteVpcEndpoints.
deprecated: false
post:
summary: POST DeleteVpcEndpoints
description: Deletes one or more specified VPC endpoints. Deleting a gateway endpoint also deletes the endpoint routes in the route tables that were associated with the endpoint. Deleting an interface endpoint deletes the endpoint network interfaces.
operationId: POSTDeleteVpcEndpoints
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action232'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcEndpointId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: One or more VPC endpoint IDs.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DeleteVpcEndpointsResult'
- description: Contains the output of DeleteVpcEndpoints.
deprecated: false
/#Action=DeleteVpcPeeringConnection:
get:
summary: 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 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.
operationId: GETDeleteVpcPeeringConnection
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
description: The ID of the VPC peering connection.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action234'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
deprecated: false
post:
summary: 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.
operationId: POSTDeleteVpcPeeringConnection
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action234'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcPeeringConnectionId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the VPC peering connection.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeleteVpcPeeringConnectionResult'
deprecated: false
/#Action=DeleteVpnConnection:
get:
summary: 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 using the new configuration information returned with the new VPN connection ID.
operationId: GETDeleteVpnConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: VpnConnectionId in: query description: The ID of the VPN connection. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action236'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 using the new configuration information returned with the new VPN connection ID.
operationId: POSTDeleteVpnConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action236' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpnConnectionId type: object properties: VpnConnectionId: type: string description: The ID of the VPN connection. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteVpnConnectionRoute:
get:
summary: 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.
operationId: GETDeleteVpnConnectionRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DestinationCidrBlock
in: query
description: The CIDR block associated with the local subnet of the customer network.
required: true
style: form
explode: true
schema:
type: string
- name: VpnConnectionId
in: query
description: The ID of the VPN connection.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action238'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTDeleteVpnConnectionRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action238'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- DestinationCidrBlock
- VpnConnectionId
type: object
properties:
DestinationCidrBlock:
type: string
description: The CIDR block associated with the local subnet of the customer network.
VpnConnectionId:
type: string
description: The ID of the VPN connection.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeleteVpnGateway:
get:
summary: GET DeleteVpnGateway
description: Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. 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.
operationId: GETDeleteVpnGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: VpnGatewayId
in: query
description: The ID of the virtual private gateway.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action240'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeleteVpnGateway
description: Deletes the specified virtual private gateway. We recommend that before you delete a virtual private gateway, you detach it from the VPC and delete the VPN connection. 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.
operationId: POSTDeleteVpnGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action240'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpnGatewayId
type: object
properties:
VpnGatewayId:
type: string
description: The ID of the virtual private gateway.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DeprovisionByoipCidr:
get:
summary: GET DeprovisionByoipCidr
description: Releases the specified address range that you provisioned for use with your AWS 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.
operationId: GETDeprovisionByoipCidr parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Cidr in: query description: The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action242'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeprovisionByoipCidrResult'
deprecated: false
post:
summary: POST DeprovisionByoipCidr
description: Releases the specified address range that you provisioned for use with your AWS 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.
operationId: POSTDeprovisionByoipCidr parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action242' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Cidr type: object properties: Cidr: type: string description: The public IPv4 address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DeprovisionByoipCidrResult'
deprecated: false
/#Action=DeregisterImage:
get:
summary: GET DeregisterImage
description: Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, 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.
operationId: GETDeregisterImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ImageId in: query description: The ID of the AMI. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action244'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DeregisterImage
description: Deregisters the specified AMI. After you deregister an AMI, it can't be used to launch new instances; however, 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.
operationId: POSTDeregisterImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action244' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ImageId type: object properties: ImageId: type: string description: The ID of the AMI. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DescribeAccountAttributes:
get:
summary: GET DescribeAccountAttributes
description: 'Describes attributes of your AWS account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: The maximum number of On-Demand Instances that you can run.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action246'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAccountAttributesResult'
deprecated: false
post:
summary: POST DescribeAccountAttributes
description: 'Describes attributes of your AWS account. The following are the supported account attributes:
supported-platforms: Indicates whether your account can launch instances into EC2-Classic and EC2-VPC, or only into EC2-VPC.
default-vpc: The ID of the default VPC for your account, or none.
max-instances: The maximum number of On-Demand Instances that you can run.
vpc-max-security-groups-per-interface: The maximum number of security groups that you can assign to a network interface.
max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-Classic.
vpc-max-elastic-ips: The maximum number of Elastic IP addresses that you can allocate for use with EC2-VPC.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAccountAttributesResult'
deprecated: false
/#Action=DescribeAddresses:
get:
summary: GET DescribeAddresses
description: Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeAddresses parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
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.
' style: form explode: true schema: type: array items: type: string - name: AllocationId in: query description: '[EC2-VPC] Information about the allocation IDs.' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action248'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAddressesResult'
deprecated: false
post:
summary: POST DescribeAddresses
description: Describes the specified Elastic IP addresses or all of your Elastic IP addresses.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeAddresses parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action248' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:One or more filters. Filter names and values are case-sensitive.
allocation-id - [EC2-VPC] The allocation ID for the address.
association-id - [EC2-VPC] The association ID for the address.
domain - Indicates whether the address is for use in EC2-Classic (standard) or in a VPC (vpc).
instance-id - The ID of the instance the address is associated with, if any.
network-interface-id - [EC2-VPC] The ID of the network interface that the address is associated with, if any.
network-interface-owner-id - The AWS account ID of the owner.
private-ip-address - [EC2-VPC] The private IP address associated with the Elastic IP address.
public-ip - The Elastic IP address.
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.
' AllocationId: type: array items: type: string description: '[EC2-VPC] Information about the allocation IDs.' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAddressesResult'
deprecated: false
/#Action=DescribeAggregateIdFormat:
get:
summary: 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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action250'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAggregateIdFormatResult'
deprecated: false
post:
summary: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAggregateIdFormatResult'
deprecated: false
/#Action=DescribeAvailabilityZones:
get:
summary: GET DescribeAvailabilityZones
description: Describes the Availability Zones that are available to you. The results include zones only for the Region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeAvailabilityZones parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:The filters.
message - Information about the Availability Zone.
region-name - The name of the Region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone (available | information | impaired | unavailable).
zone-id - The ID of the Availability Zone (for example, use1-az1).
zone-name - The name of the Availability Zone (for example, us-east-1a).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action252'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAvailabilityZonesResult'
deprecated: false
post:
summary: POST DescribeAvailabilityZones
description: Describes the Availability Zones that are available to you. The results include zones only for the Region you're currently using. If there is an event impacting an Availability Zone, you can use this request to view the state and any provided message for that Availability Zone.
For more information, see Regions and Availability Zones in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeAvailabilityZones parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action252' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:The filters.
message - Information about the Availability Zone.
region-name - The name of the Region for the Availability Zone (for example, us-east-1).
state - The state of the Availability Zone (available | information | impaired | unavailable).
zone-id - The ID of the Availability Zone (for example, use1-az1).
zone-name - The name of the Availability Zone (for example, us-east-1a).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeAvailabilityZonesResult'
deprecated: false
/#Action=DescribeBundleTasks:
get:
summary: 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.
' style: form explode: true schema: type: array items: type: string - name: Filter in: query 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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action254'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeBundleTasksResult'
deprecated: false
post:
summary: 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.
The bundle task IDs.
Default: Describes all your bundle tasks.
' Filter: type: array items: type: string 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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeBundleTasksResult'
deprecated: false
/#Action=DescribeByoipCidrs:
get:
summary: GET 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.
operationId: GETDescribeByoipCidrs parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
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.
required: true
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action256'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeByoipCidrsResult'
deprecated: false
post:
summary: 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.
operationId: POSTDescribeByoipCidrs parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action256' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - MaxResults type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
maximum: 255
minimum: 5
type: 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.
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token for the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeByoipCidrsResult'
deprecated: false
/#Action=DescribeCapacityReservations:
get:
summary: GET DescribeCapacityReservations
description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.
operationId: GETDescribeCapacityReservations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: CapacityReservationId
in: query
description: The ID of the Capacity Reservation.
style: form
explode: true
schema:
type: array
items:
type: string
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 1000
minimum: 1
type: integer
format: int32
- name: Filter
in: query
description: One or more filters.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action258'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeCapacityReservationsResult'
deprecated: false
post:
summary: POST DescribeCapacityReservations
description: Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using.
operationId: POSTDescribeCapacityReservations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action258'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
CapacityReservationId:
type: array
items:
type: string
description: The ID of the Capacity Reservation.
NextToken:
type: string
description: The token to retrieve the next page of results.
MaxResults:
maximum: 1000
minimum: 1
type: integer
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.
format: int32
Filter:
type: array
items:
type: string
description: One or more filters.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeCapacityReservationsResult'
deprecated: false
/#Action=DescribeClassicLinkInstances:
get:
summary: GET DescribeClassicLinkInstances
description: 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.
operationId: GETDescribeClassicLinkInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Filter
in: query
description: One or more filters.
group-id - The ID of a VPC security group that's associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
vpc-id - The ID of the VPC that the instance is linked to.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
Constraint: If the value is greater than 1000, we return only 1000 items.
' style: form explode: true schema: type: integer format: int32 - name: NextToken in: query description: The token for the next page of results. style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action260' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' deprecated: false post: summary: POST DescribeClassicLinkInstances description: 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. operationId: POSTDescribeClassicLinkInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action260' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:One or more filters.
group-id - The ID of a VPC security group that's associated with the instance.
instance-id - The ID of the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC to which the instance is linked.
vpc-id - The ID of the VPC that the instance is linked to.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
InstanceId:
type: array
items:
type: string
description: One or more instance IDs. Must be instances linked to a VPC through ClassicLink.
MaxResults:
type: 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.
Constraint: If the value is greater than 1000, we return only 1000 items.
' format: int32 NextToken: type: string description: The token for the next page of results. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DescribeClassicLinkInstancesResult' deprecated: false /#Action=DescribeClientVpnAuthorizationRules: get: summary: GET DescribeClientVpnAuthorizationRules description: Describes the authorization rules for a specified Client VPN endpoint. operationId: GETDescribeClientVpnAuthorizationRules parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientVpnEndpointId in: query description: The ID of the Client VPN endpoint. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: Filter
in: query
description: One or more filters. Filter names and values are case-sensitive.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action262'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesResult'
deprecated: false
post:
summary: POST DescribeClientVpnAuthorizationRules
description: Describes the authorization rules for a specified Client VPN endpoint.
operationId: POSTDescribeClientVpnAuthorizationRules
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action262'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
maxLength: 1024
minLength: 1
type: string
description: The token to retrieve the next page of results.
Filter:
type: array
items:
type: string
description: One or more filters. Filter names and values are case-sensitive.
MaxResults:
maximum: 255
minimum: 5
type: integer
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.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnAuthorizationRulesResult'
deprecated: false
/#Action=DescribeClientVpnConnections:
get:
summary: GET DescribeClientVpnConnections
description: Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
operationId: GETDescribeClientVpnConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: One or more filters. Filter names and values are case-sensitive.
style: form
explode: true
schema:
type: array
items:
type: string
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action264'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnConnectionsResult'
deprecated: false
post:
summary: POST DescribeClientVpnConnections
description: Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint.
operationId: POSTDescribeClientVpnConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action264'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
Filter:
type: array
items:
type: string
description: One or more filters. Filter names and values are case-sensitive.
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token to retrieve the next page of results.
MaxResults:
maximum: 255
minimum: 5
type: integer
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.
format: int32
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnConnectionsResult'
deprecated: false
/#Action=DescribeClientVpnEndpoints:
get:
summary: GET DescribeClientVpnEndpoints
description: Describes one or more Client VPN endpoints in the account.
operationId: GETDescribeClientVpnEndpoints
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: Filter
in: query
description: One or more filters. Filter names and values are case-sensitive.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action266'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
deprecated: false
post:
summary: POST DescribeClientVpnEndpoints
description: Describes one or more Client VPN endpoints in the account.
operationId: POSTDescribeClientVpnEndpoints
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action266'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
ClientVpnEndpointId:
type: array
items:
type: string
description: The ID of the Client VPN endpoint.
MaxResults:
maximum: 255
minimum: 5
type: integer
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.
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token to retrieve the next page of results.
Filter:
type: array
items:
type: string
description: One or more filters. Filter names and values are case-sensitive.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnEndpointsResult'
deprecated: false
/#Action=DescribeClientVpnRoutes:
get:
summary: GET DescribeClientVpnRoutes
description: Describes the routes for the specified Client VPN endpoint.
operationId: GETDescribeClientVpnRoutes
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: One or more filters. Filter names and values are case-sensitive.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action268'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnRoutesResult'
deprecated: false
post:
summary: POST DescribeClientVpnRoutes
description: Describes the routes for the specified Client VPN endpoint.
operationId: POSTDescribeClientVpnRoutes
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action268'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
Filter:
type: array
items:
type: string
description: One or more filters. Filter names and values are case-sensitive.
MaxResults:
maximum: 255
minimum: 5
type: integer
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.
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token to retrieve the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnRoutesResult'
deprecated: false
/#Action=DescribeClientVpnTargetNetworks:
get:
summary: GET DescribeClientVpnTargetNetworks
description: Describes the target networks associated with the specified Client VPN endpoint.
operationId: GETDescribeClientVpnTargetNetworks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint.
required: true
style: form
explode: true
schema:
type: string
- name: AssociationIds
in: query
description: The IDs of the target network associations.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: Filter
in: query
description: One or more filters. Filter names and values are case-sensitive.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action270'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
deprecated: false
post:
summary: POST DescribeClientVpnTargetNetworks
description: Describes the target networks associated with the specified Client VPN endpoint.
operationId: POSTDescribeClientVpnTargetNetworks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action270'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
AssociationIds:
type: array
items:
type: string
description: The IDs of the target network associations.
MaxResults:
maximum: 255
minimum: 5
type: integer
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.
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token to retrieve the next page of results.
Filter:
type: array
items:
type: string
description: One or more filters. Filter names and values are case-sensitive.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeClientVpnTargetNetworksResult'
deprecated: false
/#Action=DescribeConversionTasks:
get:
summary: 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.
operationId: GETDescribeConversionTasks parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ConversionTaskId in: query description: The conversion task IDs. style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action272'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeConversionTasksResult'
- description: Contains the output for DescribeConversionTasks.
deprecated: false
post:
summary: 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.
operationId: POSTDescribeConversionTasks parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action272' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: ConversionTaskId: type: array items: type: string description: The conversion task IDs. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeConversionTasksResult'
- description: Contains the output for DescribeConversionTasks.
deprecated: false
/#Action=DescribeCustomerGateways:
get:
summary: GET DescribeCustomerGateways
description: Describes one or more of your VPN customer gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: GETDescribeCustomerGateways parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CustomerGatewayId in: query description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' style: form explode: true schema: type: array items: type: string - name: Filter in: query 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's Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action274'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeCustomerGatewaysResult'
- description: Contains the output of DescribeCustomerGateways.
deprecated: false
post:
summary: POST DescribeCustomerGateways
description: Describes one or more of your VPN customer gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: POSTDescribeCustomerGateways parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action274' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: CustomerGatewayId: type: array items: type: string description: 'One or more customer gateway IDs.
Default: Describes all your customer gateways.
' Filter: type: array items: type: string 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's Internet-routable external interface.
state - The state of the customer gateway (pending | available | deleting | deleted).
type - The type of customer gateway. Currently, the only supported type is ipsec.1.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeCustomerGatewaysResult'
- description: Contains the output of DescribeCustomerGateways.
deprecated: false
/#Action=DescribeDhcpOptions:
get:
summary: GET DescribeDhcpOptions
description: Describes one or more of your DHCP options sets.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
operationId: GETDescribeDhcpOptions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DhcpOptionsId in: query description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' style: form explode: true schema: type: array items: type: string - name: Filter in: query description:One or more filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the AWS account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action276'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeDhcpOptionsResult'
deprecated: false
post:
summary: POST DescribeDhcpOptions
description: Describes one or more of your DHCP options sets.
For more information, see DHCP Options Sets in the Amazon Virtual Private Cloud User Guide.
operationId: POSTDescribeDhcpOptions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action276' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DhcpOptionsId: type: array items: type: string description: 'The IDs of one or more DHCP options sets.
Default: Describes all your DHCP options sets.
' Filter: type: array items: type: string description:One or more filters.
dhcp-options-id - The ID of a DHCP options set.
key - The key for one of the options (for example, domain-name).
value - The value for one of the options.
owner-id - The ID of the AWS account that owns the DHCP options set.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
NextToken:
type: string
description: The token for the next page of results.
MaxResults:
maximum: 1000
minimum: 5
type: 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.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeDhcpOptionsResult'
deprecated: false
/#Action=DescribeEgressOnlyInternetGateways:
get:
summary: GET DescribeEgressOnlyInternetGateways
description: Describes one or more of your egress-only internet gateways.
operationId: GETDescribeEgressOnlyInternetGateways
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EgressOnlyInternetGatewayId
in: query
description: One or more egress-only internet gateway IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action278'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult'
deprecated: false
post:
summary: POST DescribeEgressOnlyInternetGateways
description: Describes one or more of your egress-only internet gateways.
operationId: POSTDescribeEgressOnlyInternetGateways
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action278'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: One or more egress-only internet gateway IDs.
MaxResults:
type: 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.
format: int32
NextToken:
type: string
description: The token for the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeEgressOnlyInternetGatewaysResult'
deprecated: false
/#Action=DescribeElasticGpus:
get:
summary: GET DescribeElasticGpus
description: Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.
operationId: GETDescribeElasticGpus
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ElasticGpuId
in: query
description: The Elastic Graphics accelerator IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
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.
style: form
explode: true
schema:
maximum: 1000
minimum: 10
type: integer
format: int32
- name: NextToken
in: query
description: The token to request the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action280'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeElasticGpusResult'
deprecated: false
post:
summary: POST DescribeElasticGpus
description: Describes the Elastic Graphics accelerator associated with your instances. For more information about Elastic Graphics, see Amazon Elastic Graphics.
operationId: POSTDescribeElasticGpus
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action280'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
ElasticGpuId:
type: array
items:
type: string
description: The Elastic Graphics accelerator IDs.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter:
type: array
items:
type: string
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.
format: int32
NextToken:
type: string
description: The token to request the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeElasticGpusResult'
deprecated: false
/#Action=DescribeExportTasks:
get:
summary: GET DescribeExportTasks
description: Describes the specified export tasks or all your export tasks.
operationId: GETDescribeExportTasks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ExportTaskId
in: query
description: The export task IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action282'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeExportTasksResult'
- description: Contains the output for DescribeExportTasks.
deprecated: false
post:
summary: POST DescribeExportTasks
description: Describes the specified export tasks or all your export tasks.
operationId: POSTDescribeExportTasks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action282'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
ExportTaskId:
type: array
items:
type: string
description: The export task IDs.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeExportTasksResult'
- description: Contains the output for DescribeExportTasks.
deprecated: false
/#Action=DescribeFleetHistory:
get:
summary: GET DescribeFleetHistory
description: Describes the events for the specified EC2 Fleet during the specified time.
operationId: GETDescribeFleetHistory
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EventType
in: query
description: The type of events to describe. By default, all events are described.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/FleetEventType'
- description: The type of events to describe. By default, all events are described.
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: FleetId
in: query
description: The ID of the EC2 Fleet.
required: true
style: form
explode: true
schema:
type: string
- name: StartTime
in: query
description: The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
required: true
style: form
explode: true
schema:
type: string
format: date-time
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action284'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeFleetHistoryResult'
deprecated: false
post:
summary: POST DescribeFleetHistory
description: Describes the events for the specified EC2 Fleet during the specified time.
operationId: POSTDescribeFleetHistory
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action284'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- FleetId
- StartTime
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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/EventType2'
- description: The type of events to describe. By default, all events are described.
MaxResults:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
FleetId:
type: string
description: The ID of the EC2 Fleet.
StartTime:
type: string
description: The start date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
format: date-time
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeFleetHistoryResult'
deprecated: false
/#Action=DescribeFleetInstances:
get:
summary: GET DescribeFleetInstances
description: Describes the running instances for the specified EC2 Fleet.
operationId: GETDescribeFleetInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: FleetId
in: query
description: The ID of the EC2 Fleet.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: The filters.
instance-type - The instance type.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
MaxResults:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
FleetId:
type: string
description: The ID of the EC2 Fleet.
Filter:
type: array
items:
type: string
description: The filters.
instance-type - The instance type.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: FleetId
in: query
description: The ID of the EC2 Fleets.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: 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.
MaxResults:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
FleetId:
type: array
items:
type: string
description: The ID of the EC2 Fleets.
Filter:
type: array
items:
type: string
description: 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.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
description: One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and S3.
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
nextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action290'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeFlowLogsResult'
deprecated: false
post:
summary: POST DescribeFlowLogs
description: Describes one or more flow logs. To view the information in your flow logs (the log streams for the network interfaces), you must use the CloudWatch Logs console or the CloudWatch Logs API.
operationId: POSTDescribeFlowLogs
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action290'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter:
type: array
items:
type: string
description: One or more filters.
deliver-log-status - The status of the logs delivery (SUCCESS | FAILED).
log-destination-type - The type of destination to which the flow log publishes data. Possible destination types include cloud-watch-logs and S3.
flow-log-id - The ID of the flow log.
log-group-name - The name of the log group.
resource-id - The ID of the VPC, subnet, or network interface.
traffic-type - The type of traffic (ACCEPT | REJECT | ALL).
nextToken value.
format: int32
NextToken:
type: string
description: The token for the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeFlowLogsResult'
deprecated: false
/#Action=DescribeFpgaImageAttribute:
get:
summary: GET DescribeFpgaImageAttribute
description: Describes the specified attribute of the specified Amazon FPGA Image (AFI).
operationId: GETDescribeFpgaImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: FpgaImageId
in: query
description: The ID of the AFI.
required: true
style: form
explode: true
schema:
type: string
- name: Attribute
in: query
description: The AFI attribute.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/FpgaImageAttributeName'
- description: The AFI attribute.
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action292'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeFpgaImageAttributeResult'
deprecated: false
post:
summary: POST DescribeFpgaImageAttribute
description: Describes the specified attribute of the specified Amazon FPGA Image (AFI).
operationId: POSTDescribeFpgaImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action292'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- FpgaImageId
- Attribute
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the AFI.
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute1'
- description: The AFI attribute.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeFpgaImageAttributeResult'
deprecated: false
/#Action=DescribeFpgaImages:
get:
summary: 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 AWS accounts for which you have load permissions.
operationId: GETDescribeFpgaImages
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: FpgaImageId
in: query
description: The AFI IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Owner
in: query
description: Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
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 AWS account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the AWS Shell that was used to create the bitstream.
state - The state of the AFI (pending | failed | available | unavailable).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
FpgaImageId:
type: array
items:
type: string
description: The AFI IDs.
Owner:
type: array
items:
type: string
description: Filters the AFI by owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace).
Filter:
type: array
items:
type: string
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 AWS account ID of the AFI owner.
product-code - The product code.
shell-version - The version of the AWS Shell that was used to create the bitstream.
state - The state of the AFI (pending | failed | available | unavailable).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
update-time - The time of the most recent update.
Describes the Dedicated Host reservations that are available to purchase.
The results describe all the Dedicated Host reservation offerings, including offerings that may 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 Overview in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeHostReservationOfferings parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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.
style: form
explode: true
schema:
maximum: 500
minimum: 5
type: integer
format: int32
- name: MinDuration
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to use to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: OfferingId
in: query
description: The ID of the reservation offering.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action296'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeHostReservationOfferingsResult'
deprecated: false
post:
summary: POST DescribeHostReservationOfferings
description: Describes the Dedicated Host reservations that are available to purchase.
The results describe all the Dedicated Host reservation offerings, including offerings that may 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 Overview in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeHostReservationOfferings parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action296' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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.
format: int32
MinDuration:
type: 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.
format: int32
NextToken:
type: string
description: The token to use to retrieve the next page of results.
OfferingId:
type: string
description: The ID of the reservation offering.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeHostReservationOfferingsResult'
deprecated: false
/#Action=DescribeHostReservations:
get:
summary: GET DescribeHostReservations
description: Describes reservations that are associated with Dedicated Hosts in your account.
operationId: GETDescribeHostReservations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Filter
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to use to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action298'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeHostReservationsResult'
deprecated: false
post:
summary: POST DescribeHostReservations
description: Describes reservations that are associated with Dedicated Hosts in your account.
operationId: POSTDescribeHostReservations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action298'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
Filter:
type: array
items:
type: string
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.
format: int32
NextToken:
type: string
description: The token to use to retrieve the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeHostReservationsResult'
deprecated: false
/#Action=DescribeHosts:
get:
summary: 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.
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action300'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeHostsResult'
deprecated: false
post:
summary: 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.
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.
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.
format: int32
NextToken:
type: string
description: The token to retrieve the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeHostsResult'
deprecated: false
/#Action=DescribeIamInstanceProfileAssociations:
get:
summary: GET DescribeIamInstanceProfileAssociations
description: Describes your IAM instance profile associations.
operationId: GETDescribeIamInstanceProfileAssociations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: AssociationId
in: query
description: The IAM instance profile associations.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating | disassociated).
NextToken value.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token to request the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action302'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsResult'
deprecated: false
post:
summary: POST DescribeIamInstanceProfileAssociations
description: Describes your IAM instance profile associations.
operationId: POSTDescribeIamInstanceProfileAssociations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action302'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
AssociationId:
type: array
items:
type: string
description: The IAM instance profile associations.
Filter:
type: array
items:
type: string
description: The filters.
instance-id - The ID of the instance.
state - The state of the association (associating | associated | disassociating | disassociated).
NextToken value.
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token to request the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeIamInstanceProfileAssociationsResult'
deprecated: false
/#Action=DescribeIdFormat:
get:
summary: GET 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 AWS 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'
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action304'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeIdFormatResult'
deprecated: false
post:
summary: 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 AWS 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'
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeIdFormatResult'
deprecated: false
/#Action=DescribeIdentityIdFormat:
get:
summary: GET 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.
' operationId: GETDescribeIdentityIdFormat parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: PrincipalArn in: query description: The ARN of the principal, which can be an IAM role, IAM user, or the root user. required: true style: form explode: true schema: type: string - name: Resource in: query 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'
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action306'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeIdentityIdFormatResult'
deprecated: false
post:
summary: 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.
' operationId: POSTDescribeIdentityIdFormat parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action306' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - PrincipalArn type: object properties: PrincipalArn: type: string description: The ARN of the principal, which can be an IAM role, IAM user, or the root user. Resource: type: 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 | 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'
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeIdentityIdFormatResult'
deprecated: false
/#Action=DescribeImageAttribute:
get:
summary: GET DescribeImageAttribute
description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
operationId: GETDescribeImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Attribute
in: query
description: 'The AMI attribute.
Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.
The AMI attribute.
Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action308'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/ImageAttribute'
- description: Describes an image attribute.
deprecated: false
post:
summary: POST DescribeImageAttribute
description: Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.
operationId: POSTDescribeImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action308'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Attribute
- ImageId
type: object
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute3'
- description: 'The AMI attribute.
Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/ImageAttribute'
- description: Describes an image attribute.
deprecated: false
/#Action=DescribeImages:
get:
summary: 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 AWS 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 results in an error indicating that the AMI ID cannot be found.
operationId: GETDescribeImages parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ExecutableBy in: query description: Scopes the images by users with explicit launch permissions. Specify an AWS account ID,self (the sender of the request), or all (public AMIs).
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: The filters.
architecture - The image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.
block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
owner-id - The AWS account ID of the image owner.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' style: form explode: true schema: type: array items: type: string - name: Owner in: query description: Filters the images by the owner. Specify an AWS account ID,self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action310'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeImagesResult'
deprecated: false
post:
summary: 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 AWS 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 results in an error indicating that the AMI ID cannot be found.
operationId: POSTDescribeImages parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action310' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: ExecutableBy: type: array items: type: string description: Scopes the images by users with explicit launch permissions. Specify an AWS account ID,self (the sender of the request), or all (public AMIs).
Filter:
type: array
items:
type: string
description: The filters.
architecture - The image architecture (i386 | x86_64).
block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.
block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.
block-device-mapping.volume-type - The volume type of the EBS volume (gp2 | io1 | st1 | sc1 | standard).
block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted.
description - The description of the image (provided during image creation).
ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.
hypervisor - The hypervisor type (ovm | xen).
image-id - The ID of the image.
image-type - The image type (machine | kernel | ramdisk).
is-public - A Boolean that indicates whether the image is public.
kernel-id - The kernel ID.
manifest-location - The location of the image manifest.
name - The name of the AMI (provided during image creation).
owner-alias - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
owner-id - The AWS account ID of the image owner.
platform - The platform. To only list Windows-based AMIs, use windows.
product-code - The product code.
product-code.type - The type of the product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
state - The state of the image (available | pending | failed).
state-reason-code - The reason code for the state change.
state-reason-message - The message for the state change.
sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
virtualization-type - The virtualization type (paravirtual | hvm).
The image IDs.
Default: Describes all images available to you.
' Owner: type: array items: type: string description: Filters the images by the owner. Specify an AWS account ID,self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeImagesResult'
deprecated: false
/#Action=DescribeImportImageTasks:
get:
summary: GET DescribeImportImageTasks
description: Displays details about an import virtual machine or import snapshot tasks that are already created.
operationId: GETDescribeImportImageTasks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filters
in: query
description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.'
style: form
explode: true
schema:
type: array
items:
type: string
- name: ImportTaskId
in: query
description: A list of import image task IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: A token that indicates the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action312'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeImportImageTasksResult'
- description: Contains the output for DescribeImportImageTasks.
deprecated: false
post:
summary: POST DescribeImportImageTasks
description: Displays details about an import virtual machine or import snapshot tasks that are already created.
operationId: POSTDescribeImportImageTasks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action312'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: 'Filter tasks using the task-state filter and one of the following values: active, completed, deleting, deleted.'
ImportTaskId:
type: array
items:
type: string
description: A list of import image task IDs.
MaxResults:
type: 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.
format: int32
NextToken:
type: string
description: A token that indicates the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeImportImageTasksResult'
- description: Contains the output for DescribeImportImageTasks.
deprecated: false
/#Action=DescribeImportSnapshotTasks:
get:
summary: GET DescribeImportSnapshotTasks
description: Describes your import snapshot tasks.
operationId: GETDescribeImportSnapshotTasks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filters
in: query
description: The filters.
style: form
explode: true
schema:
type: array
items:
type: string
- name: ImportTaskId
in: query
description: A list of import snapshot task IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: A token that indicates the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action314'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
- description: Contains the output for DescribeImportSnapshotTasks.
deprecated: false
post:
summary: POST DescribeImportSnapshotTasks
description: Describes your import snapshot tasks.
operationId: POSTDescribeImportSnapshotTasks
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action314'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: The filters.
ImportTaskId:
type: array
items:
type: string
description: A list of import snapshot task IDs.
MaxResults:
type: 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.
format: int32
NextToken:
type: string
description: A token that indicates the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeImportSnapshotTasksResult'
- description: Contains the output for DescribeImportSnapshotTasks.
deprecated: false
/#Action=DescribeInstanceAttribute:
get:
summary: 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 '
operationId: GETDescribeInstanceAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Attribute
in: query
description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action316'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/InstanceAttribute'
- description: Describes an instance attribute.
deprecated: false
post:
summary: 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 '
operationId: POSTDescribeInstanceAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action316'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Attribute
- InstanceId
type: object
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute5'
- description: 'The instance attribute.
Note: The enaSupport attribute is not supported at this time.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
InstanceId:
type: string
description: The ID of the instance.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/InstanceAttribute'
- description: Describes an instance attribute.
deprecated: false
/#Action=DescribeInstanceCreditSpecifications:
get:
summary: GET DescribeInstanceCreditSpecifications
description: Describes the credit option for CPU usage of the specified T2 or T3 instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns T2 and T3 instances with the unlimited credit option, as well as instances that were previously configured as T2 or T3 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 T2 or T3 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 Elastic Compute Cloud User Guide.
operationId: GETDescribeInstanceCreditSpecifications parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
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.
' style: form explode: true schema: type: array items: type: string - name: MaxResults in: query description: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action318'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult'
deprecated: false
post:
summary: POST DescribeInstanceCreditSpecifications
description: Describes the credit option for CPU usage of the specified T2 or T3 instances. The credit options are standard and unlimited.
If you do not specify an instance ID, Amazon EC2 returns T2 and T3 instances with the unlimited credit option, as well as instances that were previously configured as T2 or T3 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 T2 or T3 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 Elastic Compute Cloud User Guide.
operationId: POSTDescribeInstanceCreditSpecifications parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action318' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: array
items:
type: string
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: maximum: 1000 minimum: 5 type: integer description: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
format: int32
NextToken:
type: string
description: The token to retrieve the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeInstanceCreditSpecificationsResult'
deprecated: false
/#Action=DescribeInstanceStatus:
get:
summary: 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 Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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 Elastic Compute Cloud 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.
' style: form explode: true schema: type: array items: type: string - name: MaxResults in: query description: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: IncludeAllInstances
in: query
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 Troubleshooting Instances with Failed Status Checks in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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 Elastic Compute Cloud 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.
' MaxResults: type: integer description: The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
format: int32
NextToken:
type: string
description: The token to retrieve the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
IncludeAllInstances:
type: boolean
description: 'When true, includes the health status for all instances. When false, includes the health status for running instances only.
Default: false
Describes the specified instances or all of your instances.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. 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 returned results.
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.
operationId: GETDescribeInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description: "The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen).
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.
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
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. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to request the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action322'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeInstancesResult'
deprecated: false
post:
summary: POST DescribeInstances
description: Describes the specified instances or all of your instances.
If you specify one or more instance IDs, Amazon EC2 returns information for those instances. If you do not specify instance IDs, Amazon EC2 returns information for all relevant instances. 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 returned results.
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.
operationId: POSTDescribeInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action322' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description: "The filters.
affinity - The affinity setting for an instance running on a Dedicated Host (default | host).
architecture - The instance architecture (i386 | x86_64).
availability-zone - The Availability Zone of the instance.
block-device-mapping.attach-time - The attach time for an EBS volume mapped to the instance, for example, 2010-09-15T17:15:20.000Z.
block-device-mapping.delete-on-termination - A Boolean that indicates whether the EBS volume is deleted on instance termination.
block-device-mapping.device-name - The device name specified in the block device mapping (for example, /dev/sdh or xvdh).
block-device-mapping.status - The status for the EBS volume (attaching | attached | detaching | detached).
block-device-mapping.volume-id - The volume ID of the EBS volume.
client-token - The idempotency token you provided when you launched the instance.
dns-name - The public DNS name of the instance.
group-id - The ID of the security group for the instance. EC2-Classic only.
group-name - The name of the security group for the instance. EC2-Classic only.
hibernation-options.configured - A Boolean that indicates whether the instance is enabled for hibernation. A value of true means that the instance is enabled for hibernation.
host-id - The ID of the Dedicated Host on which the instance is running, if applicable.
hypervisor - The hypervisor type of the instance (ovm | xen).
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.
monitoring-state - Indicates whether detailed monitoring is enabled (disabled | enabled).
network-interface.addresses.private-ip-address - The private IPv4 address associated with the network interface.
network-interface.addresses.primary - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address.
network-interface.addresses.association.public-ip - The ID of the association of an Elastic IP address (IPv4) with a network interface.
network-interface.addresses.association.ip-owner-id - The owner ID of the private IPv4 address associated with the network interface.
network-interface.association.public-ip - The address of the Elastic IP address (IPv4) bound to the network interface.
network-interface.association.ip-owner-id - The owner of the Elastic IP address (IPv4) associated with the network interface.
network-interface.association.allocation-id - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface.
network-interface.association.association-id - The association ID returned when the network interface was associated with an IPv4 address.
network-interface.attachment.attachment-id - The ID of the interface attachment.
network-interface.attachment.instance-id - The ID of the instance to which the network interface is attached.
network-interface.attachment.instance-owner-id - The owner ID of the instance to which the network interface is attached.
network-interface.attachment.device-index - The device index to which the network interface is attached.
network-interface.attachment.status - The status of the attachment (attaching | attached | detaching | detached).
network-interface.attachment.attach-time - The time that the network interface was attached to an instance.
network-interface.attachment.delete-on-termination - Specifies whether the attachment is deleted when an instance is terminated.
network-interface.availability-zone - The Availability Zone for the network interface.
network-interface.description - The description of the network interface.
network-interface.group-id - The ID of a security group associated with the network interface.
network-interface.group-name - The name of a security group associated with the network interface.
network-interface.ipv6-addresses.ipv6-address - The IPv6 address associated with the network interface.
network-interface.mac-address - The MAC address of the network interface.
network-interface.network-interface-id - The ID of the network interface.
network-interface.owner-id - The ID of the owner of the network interface.
network-interface.private-dns-name - The private DNS name of the network interface.
network-interface.requester-id - The requester ID for the network interface.
network-interface.requester-managed - Indicates whether the network interface is being managed by AWS.
network-interface.status - The status of the network interface (available) | in-use).
network-interface.source-dest-check - Whether the network interface performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
network-interface.subnet-id - The ID of the subnet for the network interface.
network-interface.vpc-id - The ID of the VPC for the network interface.
owner-id - The AWS account ID of the instance owner.
placement-group-name - The name of the placement group for the instance.
placement-partition-number - The partition in which the instance is located.
platform - The platform. To list only Windows instances, use windows.
private-dns-name - The private IPv4 DNS name of the instance.
private-ip-address - The private IPv4 address of the instance.
product-code - The product code associated with the AMI used to launch the instance.
product-code.type - The type of product code (devpay | marketplace).
ramdisk-id - The RAM disk ID.
reason - The reason for the current state of the instance (for example, shows \"User Initiated [date]\" when you stop or terminate the instance). Similar to the state-reason-code filter.
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
reservation-id - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID.
root-device-name - The device name of the root device volume (for example, /dev/sda1).
root-device-type - The type of the root device volume (ebs | instance-store).
source-dest-check - Indicates whether the instance performs source/destination checking. A value of true means that checking is enabled, and false means that checking is disabled. The value must be false for the instance to perform network address translation (NAT) in your VPC.
spot-instance-request-id - The ID of the Spot Instance request.
state-reason-code - The reason code for the state change.
state-reason-message - A message that describes the state change.
subnet-id - The ID of the subnet for the instance.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
tenancy - The tenancy of an instance (dedicated | default | host).
virtualization-type - The virtualization type of the instance (paravirtual | hvm).
vpc-id - The ID of the VPC that the instance is running in.
The instance IDs.
Default: Describes all your instances.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: 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. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
format: int32
NextToken:
type: string
description: The token to request the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeInstancesResult'
deprecated: false
/#Action=DescribeInternetGateways:
get:
summary: GET DescribeInternetGateways
description: Describes one or more of your internet gateways.
operationId: GETDescribeInternetGateways
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Filter
in: query
description: One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the AWS account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InternetGatewayId
in: query
description: 'One or more internet gateway IDs.
Default: Describes all your internet gateways.
' style: form explode: true schema: type: array items: type: string - name: NextToken in: query description: The token for the next page of results. style: form explode: true schema: type: string - name: MaxResults in: query description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action324'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeInternetGatewaysResult'
deprecated: false
post:
summary: POST DescribeInternetGateways
description: Describes one or more of your internet gateways.
operationId: POSTDescribeInternetGateways
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action324'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
Filter:
type: array
items:
type: string
description: One or more filters.
attachment.state - The current state of the attachment between the gateway and the VPC (available). Present only if a VPC is attached.
attachment.vpc-id - The ID of an attached VPC.
internet-gateway-id - The ID of the Internet gateway.
owner-id - The ID of the AWS account that owns the internet gateway.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
InternetGatewayId:
type: array
items:
type: string
description: 'One or more internet gateway IDs.
Default: Describes all your internet gateways.
' NextToken: type: string description: The token for the next page of results. MaxResults: maximum: 1000 minimum: 5 type: integer description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeInternetGatewaysResult'
deprecated: false
/#Action=DescribeKeyPairs:
get:
summary: GET DescribeKeyPairs
description: Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeKeyPairs parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:The filters.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
The key pair names.
Default: Describes all your key pairs.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action326'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeKeyPairsResult'
deprecated: false
post:
summary: POST DescribeKeyPairs
description: Describes the specified key pairs or all of your key pairs.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeKeyPairs parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action326' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:The filters.
fingerprint - The fingerprint of the key pair.
key-name - The name of the key pair.
The key pair names.
Default: Describes all your key pairs.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeKeyPairsResult'
deprecated: false
/#Action=DescribeLaunchTemplateVersions:
get:
summary: 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.
operationId: GETDescribeLaunchTemplateVersions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: LaunchTemplateId
in: query
description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
style: form
explode: true
schema:
type: string
- name: LaunchTemplateName
in: query
description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
style: form
explode: true
schema:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
- name: LaunchTemplateVersion
in: query
description: One or more versions of the launch template.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MinVersion
in: query
description: The version number after which to describe launch template versions.
style: form
explode: true
schema:
type: string
- name: MaxVersion
in: query
description: The version number up to which to describe launch template versions.
style: form
explode: true
schema:
type: string
- name: NextToken
in: query
description: The token to request the next page of results.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
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. This value can be between 1 and 200.
style: form
explode: true
schema:
type: integer
format: int32
- name: Filter
in: query
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.
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
ram-disk-id - The RAM disk ID.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
LaunchTemplateId:
type: string
description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request.
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
description: The name of the launch template. You must specify either the launch template ID or launch template name in the request.
LaunchTemplateVersion:
type: array
items:
type: string
description: One or more versions of the launch template.
MinVersion:
type: string
description: The version number after which to describe launch template versions.
MaxVersion:
type: string
description: The version number up to which to describe launch template versions.
NextToken:
type: string
description: The token to request the next page of results.
MaxResults:
type: 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. This value can be between 1 and 200.
format: int32
Filter:
type: array
items:
type: string
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.
iam-instance-profile - The ARN of the IAM instance profile.
image-id - The ID of the AMI.
instance-type - The instance type.
is-default-version - A boolean that indicates whether the launch template version is the default version.
kernel-id - The kernel ID.
ram-disk-id - The RAM disk ID.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: LaunchTemplateId
in: query
description: One or more launch template IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LaunchTemplateName
in: query
description: One or more launch template names.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
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.
style: form
explode: true
schema:
maximum: 200
minimum: 1
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action330'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeLaunchTemplatesResult'
deprecated: false
post:
summary: POST DescribeLaunchTemplates
description: Describes one or more launch templates.
operationId: POSTDescribeLaunchTemplates
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action330'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: One or more launch template IDs.
LaunchTemplateName:
type: array
items:
type: string
description: One or more launch template names.
Filter:
type: array
items:
type: string
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.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeLaunchTemplatesResult'
deprecated: false
/#Action=DescribeMovingAddresses:
get:
summary: GET DescribeMovingAddresses
description: Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account.
operationId: GETDescribeMovingAddresses
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Filter
in: query
description: One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
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.
' style: form explode: true schema: type: integer format: int32 - name: NextToken in: query description: The token for the next page of results. style: form explode: true schema: type: string - name: PublicIp in: query description: One or more Elastic IP addresses. style: form explode: true schema: type: array items: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action332' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DescribeMovingAddressesResult' deprecated: false post: summary: POST DescribeMovingAddresses description: Describes your Elastic IP addresses that are being moved to the EC2-VPC platform, or that are being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. operationId: POSTDescribeMovingAddresses parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action332' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:One or more filters.
moving-status - The status of the Elastic IP address (MovingToVpc | RestoringToClassic).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
MaxResults:
type: integer
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.
' format: int32 NextToken: type: string description: The token for the next page of results. PublicIp: type: array items: type: string description: One or more Elastic IP addresses. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DescribeMovingAddressesResult' deprecated: false /#Action=DescribeNatGateways: get: summary: GET DescribeNatGateways description: Describes one or more of your NAT gateways. operationId: GETDescribeNatGateways parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:One or more filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
nextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NatGatewayId
in: query
description: One or more NAT gateway IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action334'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeNatGatewaysResult'
deprecated: false
post:
summary: POST DescribeNatGateways
description: Describes one or more of your NAT gateways.
operationId: POSTDescribeNatGateways
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action334'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
Filter:
type: array
items:
type: string
description: One or more filters.
nat-gateway-id - The ID of the NAT gateway.
state - The state of the NAT gateway (pending | failed | available | deleting | deleted).
subnet-id - The ID of the subnet in which the NAT gateway resides.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC in which the NAT gateway resides.
nextToken value.
format: int32
NatGatewayId:
type: array
items:
type: string
description: One or more NAT gateway IDs.
NextToken:
type: string
description: The token for the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeNatGatewaysResult'
deprecated: false
/#Action=DescribeNetworkAcls:
get:
summary: GET DescribeNetworkAcls
description: Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
operationId: GETDescribeNetworkAcls parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the AWS account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NetworkAclId
in: query
description: 'One or more network ACL IDs.
Default: Describes all your network ACLs.
' style: form explode: true schema: type: array items: type: string - name: NextToken in: query description: The token for the next page of results. style: form explode: true schema: type: string - name: MaxResults in: query description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action336'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeNetworkAclsResult'
deprecated: false
post:
summary: POST DescribeNetworkAcls
description: Describes one or more of your network ACLs.
For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
operationId: POSTDescribeNetworkAcls parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action336' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:One or more filters.
association.association-id - The ID of an association ID for the ACL.
association.network-acl-id - The ID of the network ACL involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
default - Indicates whether the ACL is the default network ACL for the VPC.
entry.cidr - The IPv4 CIDR range specified in the entry.
entry.icmp.code - The ICMP code specified in the entry, if any.
entry.icmp.type - The ICMP type specified in the entry, if any.
entry.ipv6-cidr - The IPv6 CIDR range specified in the entry.
entry.port-range.from - The start of the port range specified in the entry.
entry.port-range.to - The end of the port range specified in the entry.
entry.protocol - The protocol specified in the entry (tcp | udp | icmp or a protocol number).
entry.rule-action - Allows or denies the matching traffic (allow | deny).
entry.rule-number - The number of an entry (in other words, rule) in the set of ACL entries.
network-acl-id - The ID of the network ACL.
owner-id - The ID of the AWS account that owns the network ACL.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network ACL.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
NetworkAclId:
type: array
items:
type: string
description: 'One or more network ACL IDs.
Default: Describes all your network ACLs.
' NextToken: type: string description: The token for the next page of results. MaxResults: maximum: 1000 minimum: 5 type: integer description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeNetworkAclsResult'
deprecated: false
/#Action=DescribeNetworkInterfaceAttribute:
get:
summary: GET DescribeNetworkInterfaceAttribute
description: Describes a network interface attribute. You can specify only one attribute at a time.
operationId: GETDescribeNetworkInterfaceAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Attribute
in: query
description: The attribute of the network interface. This parameter is required.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttribute'
- description: The attribute of the network interface. This parameter is required.
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action338'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
- description: Contains the output of DescribeNetworkInterfaceAttribute.
deprecated: false
post:
summary: POST DescribeNetworkInterfaceAttribute
description: Describes a network interface attribute. You can specify only one attribute at a time.
operationId: POSTDescribeNetworkInterfaceAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action338'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkInterfaceId
type: object
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute7'
- description: The attribute of the network interface. This parameter is required.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the network interface.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeNetworkInterfaceAttributeResult'
- description: Contains the output of DescribeNetworkInterfaceAttribute.
deprecated: false
/#Action=DescribeNetworkInterfacePermissions:
get:
summary: GET DescribeNetworkInterfacePermissions
description: 'Describes the permissions for your network interfaces. '
operationId: GETDescribeNetworkInterfacePermissions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: NetworkInterfacePermissionId
in: query
description: One or more network interface permission IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
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 AWS account ID.
network-interface-permission.aws-service - The AWS service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
NextToken value. If this parameter is not specified, up to 50 results are returned by default.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action340'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
- description: Contains the output for DescribeNetworkInterfacePermissions.
deprecated: false
post:
summary: POST DescribeNetworkInterfacePermissions
description: 'Describes the permissions for your network interfaces. '
operationId: POSTDescribeNetworkInterfacePermissions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action340'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
NetworkInterfacePermissionId:
type: array
items:
type: string
description: One or more network interface permission IDs.
Filter:
type: array
items:
type: string
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 AWS account ID.
network-interface-permission.aws-service - The AWS service.
network-interface-permission.permission - The type of permission (INSTANCE-ATTACH | EIP-ASSOCIATE).
NextToken value. If this parameter is not specified, up to 50 results are returned by default.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeNetworkInterfacePermissionsResult'
- description: Contains the output for DescribeNetworkInterfacePermissions.
deprecated: false
/#Action=DescribeNetworkInterfaces:
get:
summary: GET DescribeNetworkInterfaces
description: Describes one or more of your network interfaces.
operationId: GETDescribeNetworkInterfaces
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Filter
in: query
description: 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.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NetworkInterfaceId
in: query
description: 'One or more network interface IDs.
Default: Describes all your network interfaces.
' style: form explode: true schema: type: array items: type: string - name: NextToken in: query description: The token to retrieve the next page of results. style: form explode: true schema: type: string - name: MaxResults in: query description: 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. style: form explode: true schema: maximum: 1000 minimum: 5 type: integer format: int32 - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action342' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/DescribeNetworkInterfacesResult' - description: Contains the output of DescribeNetworkInterfaces. deprecated: false post: summary: POST DescribeNetworkInterfaces description: Describes one or more of your network interfaces. operationId: POSTDescribeNetworkInterfaces parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action342' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description: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.nat-gateway-id - The ID of the NAT gateway to which the network interface is attached.
attachment.status - The status of the attachment (attaching | attached | detaching | detached).
availability-zone - The Availability Zone of the network interface.
description - The description of the network interface.
group-id - The ID of a security group associated with the network interface.
group-name - The name of a security group associated with the network interface.
ipv6-addresses.ipv6-address - An IPv6 address associated with the network interface.
mac-address - The MAC address of the network interface.
network-interface-id - The ID of the network interface.
owner-id - The AWS account ID of the network interface owner.
private-ip-address - The private IPv4 address or addresses of the network interface.
private-dns-name - The private DNS name of the network interface (IPv4).
requester-id - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on).
requester-managed - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on).
source-dest-check - Indicates whether the network interface performs source/destination checking. A value of true means checking is enabled, and false means checking is disabled. The value must be false for the network interface to perform network address translation (NAT) in your VPC.
status - The status of the network interface. If the network interface is not attached to an instance, the status is available; if a network interface is attached to an instance the status is in-use.
subnet-id - The ID of the subnet for the network interface.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the network interface.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
NetworkInterfaceId:
type: array
items:
type: string
description: 'One or more network interface IDs.
Default: Describes all your network interfaces.
' NextToken: type: string description: The token to retrieve the next page of results. MaxResults: maximum: 1000 minimum: 5 type: integer description: 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. format: int32 required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/DescribeNetworkInterfacesResult' - description: Contains the output of DescribeNetworkInterfaces. deprecated: false /#Action=DescribePlacementGroups: get: summary: GET DescribePlacementGroups description: Describes the specified placement groups or all of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. operationId: GETDescribePlacementGroups parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:The filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupName
in: query
description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' style: form explode: true schema: type: array items: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action344' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DescribePlacementGroupsResult' deprecated: false post: summary: POST DescribePlacementGroups description: Describes the specified placement groups or all of your placement groups. For more information, see Placement Groups in the Amazon Elastic Compute Cloud User Guide. operationId: POSTDescribePlacementGroups parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action344' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:The filters.
group-name - The name of the placement group.
state - The state of the placement group (pending | available | deleting | deleted).
strategy - The strategy of the placement group (cluster | spread | partition).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
GroupName:
type: array
items:
type: string
description: 'The names of the placement groups.
Default: Describes all your placement groups, or only those otherwise specified.
' required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DescribePlacementGroupsResult' deprecated: false /#Action=DescribePrefixLists: get: summary: GET DescribePrefixLists description: Describes available AWS 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. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint. Currently, the services that support this action are Amazon S3 and Amazon DynamoDB. operationId: GETDescribePrefixLists parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: PrefixListId
in: query
description: One or more prefix list IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action346'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribePrefixListsResult'
deprecated: false
post:
summary: POST DescribePrefixLists
description: Describes available AWS 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. A prefix list ID is required for creating an outbound security group rule that allows traffic from a VPC to access an AWS service through a gateway VPC endpoint. Currently, the services that support this action are Amazon S3 and Amazon DynamoDB.
operationId: POSTDescribePrefixLists
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action346'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter:
type: array
items:
type: string
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.
format: int32
NextToken:
type: string
description: The token for the next page of results.
PrefixListId:
type: array
items:
type: string
description: One or more prefix list IDs.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribePrefixListsResult'
deprecated: false
/#Action=DescribePrincipalIdFormat:
get:
summary: 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.
style: form
explode: true
schema:
type: boolean
- name: Resource
in: query
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'
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to request the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action348'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribePrincipalIdFormatResult'
deprecated: false
post:
summary: 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
Resource:
type: array
items:
type: 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 | 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:
type: 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.
format: int32
NextToken:
type: string
description: The token to request the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribePrincipalIdFormatResult'
deprecated: false
/#Action=DescribePublicIpv4Pools:
get:
summary: GET DescribePublicIpv4Pools
description: Describes the specified IPv4 address pools.
operationId: GETDescribePublicIpv4Pools
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: PoolId
in: query
description: The IDs of the address pools.
style: form
explode: true
schema:
type: array
items:
type: string
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 10
minimum: 1
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action350'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribePublicIpv4PoolsResult'
deprecated: false
post:
summary: POST DescribePublicIpv4Pools
description: Describes the specified IPv4 address pools.
operationId: POSTDescribePublicIpv4Pools
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action350'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
PoolId:
type: array
items:
type: string
description: The IDs of the address pools.
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token for the next page of results.
MaxResults:
maximum: 10
minimum: 1
type: 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.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribePublicIpv4PoolsResult'
deprecated: false
/#Action=DescribeRegions:
get:
summary: GET DescribeRegions
description: Describes the Regions that are currently available to you. The API returns a list of all the Regions, including Regions that are disabled for your account. For information about enabling Regions for your account, see Enabling and Disabling Regions in the AWS Billing and Cost Management User Guide.
For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.
operationId: GETDescribeRegions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action352'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeRegionsResult'
deprecated: false
post:
summary: POST DescribeRegions
description: Describes the Regions that are currently available to you. The API returns a list of all the Regions, including Regions that are disabled for your account. For information about enabling Regions for your account, see Enabling and Disabling Regions in the AWS Billing and Cost Management User Guide.
For a list of the Regions supported by Amazon EC2, see Regions and Endpoints.
operationId: POSTDescribeRegions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action352' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:The filters.
endpoint - The endpoint of the Region (for example, ec2.us-east-1.amazonaws.com).
region-name - The name of the Region (for example, us-east-1).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeRegionsResult'
deprecated: false
/#Action=DescribeReservedInstances:
get:
summary: 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 Elastic Compute Cloud User Guide.
operationId: GETDescribeReservedInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: OfferingType
in: query
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.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/OfferingTypeValues'
- 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.
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action354'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeReservedInstancesResult'
- description: Contains the output for DescribeReservedInstances.
deprecated: false
post:
summary: 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 Elastic Compute Cloud User Guide.
operationId: POSTDescribeReservedInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action354' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC)).
reserved-instances-id - The ID of the Reserved Instance.
start - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z).
state - The state of the Reserved Instance (payment-pending | active | payment-failed | retired).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
One or more Reserved Instance IDs.
Default: Describes all your Reserved Instances, or only those otherwise specified.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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/OfferingType1'
- 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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeReservedInstancesResult'
- description: Contains the output for DescribeReservedInstances.
deprecated: false
/#Action=DescribeReservedInstancesListings:
get:
summary: 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 Elastic Compute Cloud User Guide.
operationId: GETDescribeReservedInstancesListings parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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 Elastic Compute Cloud User Guide.
operationId: POSTDescribeReservedInstancesListings parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action356' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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 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 Elastic Compute Cloud User Guide.
operationId: GETDescribeReservedInstancesModifications parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
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 Elastic Compute Cloud User Guide.
operationId: POSTDescribeReservedInstancesModifications parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action358' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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.
modification-result.target-configuration.platform - The network platform of the new Reserved Instances (EC2-Classic | EC2-VPC).
reserved-instances-id - The ID of the Reserved Instances modified.
reserved-instances-modification-id - The ID of the modification request.
status - The status of the Reserved Instances modification request (processing | fulfilled | failed).
status-message - The reason for the status.
update-date - The time when the modification request was last updated.
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 Elastic Compute Cloud User Guide.
operationId: GETDescribeReservedInstancesOfferings parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AvailabilityZone in: query description: The Availability Zone in which the Reserved Instance can be used. style: form explode: true schema: type: string - name: Filter in: query 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 AWS and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/InstanceType'
- description: The instance type that the reservation will cover (for example, m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
- name: MaxDuration
in: query
description: 'The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
' style: form explode: true schema: type: integer format: int32 - name: MaxInstanceCount in: query description: 'The maximum number of instances to filter when searching for offerings.
Default: 20
' style: form explode: true schema: type: integer format: int32 - name: MinDuration in: query description: 'The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
' style: form explode: true schema: type: integer format: int32 - name: OfferingClass in: query description: The offering class of the Reserved Instance. Can bestandard or convertible.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/OfferingClassType'
- description: The offering class of the Reserved Instance. Can be standard or convertible.
- name: ProductDescription
in: query
description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
style: form
explode: true
schema:
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.
- name: ReservedInstancesOfferingId
in: query
description: One or more Reserved Instances offering IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceTenancy
in: query
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 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
' style: form explode: true schema: type: integer format: int32 - name: NextToken in: query description: The token to retrieve the next page of results. style: form explode: true schema: type: string - name: OfferingType in: query 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.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/OfferingTypeValues'
- 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.
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action360'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult'
- description: Contains the output of DescribeReservedInstancesOfferings.
deprecated: false
post:
summary: 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 Elastic Compute Cloud User Guide.
operationId: POSTDescribeReservedInstancesOfferings parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action360' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: AvailabilityZone: type: string description: The Availability Zone in which the Reserved Instance can be used. Filter: type: array items: type: string 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 AWS and the Reserved Instance Marketplace are listed.
product-description - The Reserved Instance product platform description. Instances that include (Amazon VPC) in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX | Linux/UNIX (Amazon VPC) | SUSE Linux | SUSE Linux (Amazon VPC) | Red Hat Enterprise Linux | Red Hat Enterprise Linux (Amazon VPC) | Windows | Windows (Amazon VPC) | Windows with SQL Server Standard | Windows with SQL Server Standard (Amazon VPC) | Windows with SQL Server Web | Windows with SQL Server Web (Amazon VPC) | Windows with SQL Server Enterprise | Windows with SQL Server Enterprise (Amazon VPC))
reserved-instances-offering-id - The Reserved Instances offering ID.
scope - The scope of the Reserved Instance (Availability Zone or Region).
usage-price - The usage price of the Reserved Instance, per hour (for example, 0.84).
m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
MaxDuration:
type: integer
description: 'The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
' format: int32 MaxInstanceCount: type: integer description: 'The maximum number of instances to filter when searching for offerings.
Default: 20
' format: int32 MinDuration: type: integer description: 'The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
' format: int32 OfferingClass: allOf: - $ref: '#/components/schemas/OfferingClass3' - description: The offering class of the Reserved Instance. Can bestandard or convertible.
ProductDescription:
allOf:
- $ref: '#/components/schemas/ProductDescription1'
- description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
ReservedInstancesOfferingId:
type: array
items:
type: string
description: One or more Reserved Instances offering IDs.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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/InstanceTenancy3'
- 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
' format: int32 NextToken: type: string description: The token to retrieve the next page of results. OfferingType: allOf: - $ref: '#/components/schemas/OfferingType1' - 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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeReservedInstancesOfferingsResult'
- description: Contains the output of DescribeReservedInstancesOfferings.
deprecated: false
/#Action=DescribeRouteTables:
get:
summary: 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 Virtual Private Cloud User Guide.
operationId: GETDescribeRouteTables parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the AWS account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of a transit gateway.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: RouteTableId
in: query
description: 'One or more route table IDs.
Default: Describes all your route tables.
' style: form explode: true schema: type: array items: type: string - name: NextToken in: query description: The token for the next page of results. style: form explode: true schema: type: string - name: MaxResults in: query description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
style: form
explode: true
schema:
maximum: 100
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action362'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeRouteTablesResult'
- description: Contains the output of DescribeRouteTables.
deprecated: false
post:
summary: 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 Virtual Private Cloud User Guide.
operationId: POSTDescribeRouteTables parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action362' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:One or more filters.
association.route-table-association-id - The ID of an association ID for the route table.
association.route-table-id - The ID of the route table involved in the association.
association.subnet-id - The ID of the subnet involved in the association.
association.main - Indicates whether the route table is the main route table for the VPC (true | false). Route tables that do not have an association ID are not returned in the response.
owner-id - The ID of the AWS account that owns the route table.
route-table-id - The ID of the route table.
route.destination-cidr-block - The IPv4 CIDR range specified in a route in the table.
route.destination-ipv6-cidr-block - The IPv6 CIDR range specified in a route in the route table.
route.destination-prefix-list-id - The ID (prefix) of the AWS service specified in a route in the table.
route.egress-only-internet-gateway-id - The ID of an egress-only Internet gateway specified in a route in the route table.
route.gateway-id - The ID of a gateway specified in a route in the table.
route.instance-id - The ID of an instance specified in a route in the table.
route.nat-gateway-id - The ID of a NAT gateway.
route.transit-gateway-id - The ID of a transit gateway.
route.origin - Describes how the route was created. CreateRouteTable indicates that the route was automatically created when the route table was created; CreateRoute indicates that the route was manually added to the route table; EnableVgwRoutePropagation indicates that the route was propagated by route propagation.
route.state - The state of a route in the route table (active | blackhole). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on).
route.vpc-peering-connection-id - The ID of a VPC peering connection specified in a route in the table.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
transit-gateway-id - The ID of a transit gateway.
vpc-id - The ID of the VPC for the route table.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
RouteTableId:
type: array
items:
type: string
description: 'One or more route table IDs.
Default: Describes all your route tables.
' NextToken: type: string description: The token for the next page of results. MaxResults: maximum: 100 minimum: 5 type: integer description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeRouteTablesResult'
- description: Contains the output of DescribeRouteTables.
deprecated: false
/#Action=DescribeScheduledInstanceAvailability:
get:
summary: 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.
operationId: GETDescribeScheduledInstanceAvailability parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
description: The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: MaxSlotDurationInHours
in: query
description: The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.
style: form
explode: true
schema:
type: integer
format: int32
- name: MinSlotDurationInHours
in: query
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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: Recurrence.Frequency
in: query
description: >-
Describes the recurring schedule for a Scheduled Instance.
The frequency (Daily, Weekly, or Monthly).
style: form
explode: true
schema:
type: string
- name: Recurrence.Interval
in: query
description: >-
Describes the recurring schedule for a Scheduled Instance.
The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
style: form
explode: true
schema:
type: string
- name: Recurrence.OccurrenceDays
in: query
description: >-
Describes the recurring schedule for a Scheduled Instance.
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Recurrence.OccurrenceRelativeToEnd
in: query
description: >-
Describes the recurring schedule for a Scheduled Instance.
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.
style: form
explode: true
schema:
type: string
- name: Recurrence.OccurrenceUnit
in: query
description: >-
Describes the recurring schedule for a Scheduled Instance.
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.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action364'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult'
- description: Contains the output of DescribeScheduledInstanceAvailability.
deprecated: false
post:
summary: 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.
operationId: POSTDescribeScheduledInstanceAvailability parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action364' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: array
items:
type: string
description: The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.
format: int32
MaxSlotDurationInHours:
type: integer
description: The maximum available duration, in hours. This value must be greater than MinSlotDurationInHours and less than 1,720.
format: int32
MinSlotDurationInHours:
type: 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.
format: int32
NextToken:
type: string
description: The token for the next set of results.
Recurrence.Frequency:
type: string
description: >-
Describes the recurring schedule for a Scheduled Instance.
The frequency (Daily, Weekly, or Monthly).
Recurrence.Interval:
type: string
description: >-
Describes the recurring schedule for a Scheduled Instance.
The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.
Recurrence.OccurrenceDays:
type: array
items:
type: string
description: >-
Describes the recurring schedule for a Scheduled Instance.
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.
Recurrence.OccurrenceRelativeToEnd:
type: string
description: >-
Describes the recurring schedule for a Scheduled Instance.
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.
Recurrence.OccurrenceUnit:
type: string
description: >-
Describes the recurring schedule for a Scheduled Instance.
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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeScheduledInstanceAvailabilityResult'
- description: Contains the output of DescribeScheduledInstanceAvailability.
deprecated: false
/#Action=DescribeScheduledInstances:
get:
summary: GET DescribeScheduledInstances
description: Describes the specified Scheduled Instances or all your Scheduled Instances.
operationId: GETDescribeScheduledInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
description: The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: ScheduledInstanceId
in: query
description: The Scheduled Instance IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: SlotStartTimeRange.EarliestTime
in: query
description: >-
Describes the time period for a Scheduled Instance to start its first schedule.
The earliest date and time, in UTC, for the Scheduled Instance to start.
style: form
explode: true
schema:
type: string
- name: SlotStartTimeRange.LatestTime
in: query
description: >-
Describes the time period for a Scheduled Instance to start its first schedule.
The latest date and time, in UTC, for the Scheduled Instance to start.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action366'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeScheduledInstancesResult'
- description: Contains the output of DescribeScheduledInstances.
deprecated: false
post:
summary: POST DescribeScheduledInstances
description: Describes the specified Scheduled Instances or all your Scheduled Instances.
operationId: POSTDescribeScheduledInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action366'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter:
type: array
items:
type: string
description: The filters.
availability-zone - The Availability Zone (for example, us-west-2a).
instance-type - The instance type (for example, c4.large).
network-platform - The network platform (EC2-Classic or EC2-VPC).
platform - The platform (Linux/UNIX or Windows).
NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
ScheduledInstanceId:
type: array
items:
type: string
description: The Scheduled Instance IDs.
SlotStartTimeRange.EarliestTime:
type: string
description: >-
Describes the time period for a Scheduled Instance to start its first schedule.
The earliest date and time, in UTC, for the Scheduled Instance to start.
SlotStartTimeRange.LatestTime:
type: string
description: >-
Describes the time period for a Scheduled Instance to start its first schedule.
The latest date and time, in UTC, for the Scheduled Instance to start.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeScheduledInstancesResult'
- description: Contains the output of DescribeScheduledInstances.
deprecated: false
/#Action=DescribeSecurityGroupReferences:
get:
summary: GET DescribeSecurityGroupReferences
description: "[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request."
operationId: GETDescribeSecurityGroupReferences
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupId
in: query
description: The IDs of the security groups in your account.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action368'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
deprecated: false
post:
summary: POST DescribeSecurityGroupReferences
description: "[VPC only] Describes the VPCs on the other side of a VPC peering connection that are referencing the security groups you've specified in this request."
operationId: POSTDescribeSecurityGroupReferences
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action368'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- GroupId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: The IDs of the security groups in your account.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSecurityGroupReferencesResult'
deprecated: false
/#Action=DescribeSecurityGroups:
get:
summary: GET DescribeSecurityGroups
description: Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. 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.
operationId: GETDescribeSecurityGroups parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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 has been 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 (prefix) of the AWS service 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 or a protocol number).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that has been 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 (prefix) of the AWS service from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.
owner-id - The AWS account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
' style: form explode: true schema: type: array items: type: string - name: GroupName in: query description: '[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all your security groups.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NextToken
in: query
description: The token to request the next page of results.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action370'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSecurityGroupsResult'
deprecated: false
post:
summary: POST DescribeSecurityGroups
description: Describes the specified security groups or all of your security groups.
A security group is for use with instances either in the EC2-Classic platform or in a specific VPC. 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.
operationId: POSTDescribeSecurityGroups parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action370' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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 has been 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 (prefix) of the AWS service 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 or a protocol number).
egress.ip-permission.to-port - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
egress.ip-permission.user-id - The ID of an AWS account that has been referenced in an outbound security group rule.
group-id - The ID of the security group.
group-name - The name of the security group.
ip-permission.cidr - An IPv4 CIDR block for an inbound security group rule.
ip-permission.from-port - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number.
ip-permission.group-id - The ID of a security group that has been referenced in an inbound security group rule.
ip-permission.group-name - The name of a security group that has been 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 (prefix) of the AWS service from which a security group rule allows inbound access.
ip-permission.protocol - The IP protocol for an inbound security group rule (tcp | udp | icmp or a protocol number).
ip-permission.to-port - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code.
ip-permission.user-id - The ID of an AWS account that has been referenced in an inbound security group rule.
owner-id - The AWS account ID of the owner of the security group.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC specified when the security group was created.
The IDs of the security groups. Required for security groups in a nondefault VPC.
Default: Describes all your security groups.
' GroupName: type: array items: type: string description: '[EC2-Classic and default VPC only] The names of the security groups. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, use the group-name filter to describe security groups by name.
Default: Describes all your security groups.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The token to request the next page of results.
MaxResults:
maximum: 1000
minimum: 5
type: integer
description: The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned NextToken value. This value can be between 5 and 1000. If this parameter is not specified, then all results are returned.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSecurityGroupsResult'
deprecated: false
/#Action=DescribeSnapshotAttribute:
get:
summary: 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.
operationId: GETDescribeSnapshotAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Attribute in: query description: The snapshot attribute you would like to view. required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/SnapshotAttributeName' - description: The snapshot attribute you would like to view. - name: SnapshotId in: query description: The ID of the EBS snapshot. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action372'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSnapshotAttributeResult'
- description: Contains the output of DescribeSnapshotAttribute.
deprecated: false
post:
summary: 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.
operationId: POSTDescribeSnapshotAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action372' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Attribute - SnapshotId type: object properties: Attribute: allOf: - $ref: '#/components/schemas/Attribute9' - description: The snapshot attribute you would like to view. SnapshotId: type: string description: The ID of the EBS snapshot. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSnapshotAttributeResult'
- description: Contains the output of DescribeSnapshotAttribute.
deprecated: false
/#Action=DescribeSnapshots:
get:
summary: 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 AWS 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 AWS accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
implicit: An AWS account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS 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 AWS 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 AWS 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, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
' operationId: GETDescribeSnapshots parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
style: form
explode: true
schema:
type: string
- name: Owner
in: query
description: Describes the snapshots owned by these owners.
style: form
explode: true
schema:
type: array
items:
type: string
- name: RestorableBy
in: query
description: The IDs of the AWS accounts that can create volumes from the snapshot.
style: form
explode: true
schema:
type: array
items:
type: string
- name: SnapshotId
in: query
description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action374'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSnapshotsResult'
deprecated: false
post:
summary: 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 AWS 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 AWS accounts have create volume permissions for these snapshots.
explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
implicit: An AWS account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS 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 AWS 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 AWS 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, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
' operationId: POSTDescribeSnapshots parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action374' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:The filters.
description - A description of the snapshot.
encrypted - Indicates whether the snapshot is encrypted (true | false)
owner-alias - Value from an Amazon-maintained list (amazon | self | all | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
owner-id - The ID of the AWS account that owns the snapshot.
progress - The progress of the snapshot, as a percentage (for example, 80%).
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (pending | completed | error).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.
format: int32
NextToken:
type: string
description: The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
Owner:
type: array
items:
type: string
description: Describes the snapshots owned by these owners.
RestorableBy:
type: array
items:
type: string
description: The IDs of the AWS accounts that can create volumes from the snapshot.
SnapshotId:
type: array
items:
type: string
description: 'The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSnapshotsResult'
deprecated: false
/#Action=DescribeSpotDatafeedSubscription:
get:
summary: 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.
operationId: GETDescribeSpotDatafeedSubscription
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action376'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult'
- description: Contains the output of DescribeSpotDatafeedSubscription.
deprecated: false
post:
summary: 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.
operationId: POSTDescribeSpotDatafeedSubscription
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action376'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotDatafeedSubscriptionResult'
- description: Contains the output of DescribeSpotDatafeedSubscription.
deprecated: false
/#Action=DescribeSpotFleetInstances:
get:
summary: GET DescribeSpotFleetInstances
description: Describes the running instances for the specified Spot Fleet.
operationId: GETDescribeSpotFleetInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestId
in: query
description: The ID of the Spot Fleet request.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action378'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
- description: Contains the output of DescribeSpotFleetInstances.
deprecated: false
post:
summary: POST DescribeSpotFleetInstances
description: Describes the running instances for the specified Spot Fleet.
operationId: POSTDescribeSpotFleetInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action378'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- SpotFleetRequestId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
SpotFleetRequestId:
type: string
description: The ID of the Spot Fleet request.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetInstancesResponse'
- description: Contains the output of DescribeSpotFleetInstances.
deprecated: false
/#Action=DescribeSpotFleetRequestHistory:
get:
summary: 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.
operationId: GETDescribeSpotFleetRequestHistory parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EventType
in: query
description: The type of events to describe. By default, all events are described.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/EventType'
- description: The type of events to describe. By default, all events are described.
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestId
in: query
description: The ID of the Spot Fleet request.
required: true
style: form
explode: true
schema:
type: string
- name: StartTime
in: query
description: The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
required: true
style: form
explode: true
schema:
type: string
format: date-time
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action380'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse'
- description: Contains the output of DescribeSpotFleetRequestHistory.
deprecated: false
post:
summary: 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.
operationId: POSTDescribeSpotFleetRequestHistory parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action380' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - SpotFleetRequestId - StartTime type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
EventType:
allOf:
- $ref: '#/components/schemas/EventType4'
- description: The type of events to describe. By default, all events are described.
MaxResults:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
SpotFleetRequestId:
type: string
description: The ID of the Spot Fleet request.
StartTime:
type: string
description: The starting date and time for the events, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
format: date-time
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetRequestHistoryResponse'
- description: Contains the output of DescribeSpotFleetRequestHistory.
deprecated: false
/#Action=DescribeSpotFleetRequests:
get:
summary: GET DescribeSpotFleetRequests
description: Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
operationId: GETDescribeSpotFleetRequests parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestId
in: query
description: The IDs of the Spot Fleet requests.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action382'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse'
- description: Contains the output of DescribeSpotFleetRequests.
deprecated: false
post:
summary: POST DescribeSpotFleetRequests
description: Describes your Spot Fleet requests.
Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated.
operationId: POSTDescribeSpotFleetRequests parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action382' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
SpotFleetRequestId:
type: array
items:
type: string
description: The IDs of the Spot Fleet requests.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotFleetRequestsResponse'
- description: Contains the output of DescribeSpotFleetRequests.
deprecated: false
/#Action=DescribeSpotInstanceRequests:
get:
summary: 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 results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
operationId: GETDescribeSpotInstanceRequests parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description: 'One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 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.
style: form
explode: true
schema:
type: boolean
- name: SpotInstanceRequestId
in: query
description: One or more Spot Instance request IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: NextToken
in: query
description: The token to request the next set of results. This value is null when there are no more results to return.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action384'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult'
- description: Contains the output of DescribeSpotInstanceRequests.
deprecated: false
post:
summary: 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 results returned. This paginates the output, which makes the list more manageable and returns the results faster. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSpotInstanceRequests request to retrieve the remaining results.
Spot Instance requests are deleted four hours after they are canceled and their instances are terminated.
operationId: POSTDescribeSpotInstanceRequests parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action384' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description: 'One or more filters.
availability-zone-group - The Availability Zone group.
create-time - The time stamp when the Spot Instance request was created.
fault-code - The fault code related to the request.
fault-message - The fault message related to the request.
instance-id - The ID of the instance that fulfilled the request.
launch-group - The Spot Instance launch group.
launch.block-device-mapping.delete-on-termination - Indicates whether the EBS volume is deleted on instance termination.
launch.block-device-mapping.device-name - The device name for the volume in the block device mapping (for example, /dev/sdh or xvdh).
launch.block-device-mapping.snapshot-id - The ID of the snapshot for the EBS volume.
launch.block-device-mapping.volume-size - The size of the EBS volume, in GiB.
launch.block-device-mapping.volume-type - The type of EBS volume: gp2 for General Purpose SSD, io1 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.
SpotInstanceRequestId:
type: array
items:
type: string
description: One or more Spot Instance request IDs.
NextToken:
type: string
description: The token to request the next set of results. This value is null when there are no more results to return.
MaxResults:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 5 and 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotInstanceRequestsResult'
- description: Contains the output of DescribeSpotInstanceRequests.
deprecated: false
/#Action=DescribeSpotPriceHistory:
get:
summary: 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, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.
operationId: GETDescribeSpotPriceHistory parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (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.
style: form
explode: true
schema:
type: boolean
- name: EndTime
in: query
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).
style: form
explode: true
schema:
type: string
format: date-time
- name: InstanceType
in: query
description: Filters the results by the specified instance types.
style: form
explode: true
schema:
type: array
items:
type: string
- name: MaxResults
in: query
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of results.
style: form
explode: true
schema:
type: string
- name: ProductDescription
in: query
description: Filters the results by the specified basic product descriptions.
style: form
explode: true
schema:
type: array
items:
type: string
- name: StartTime
in: query
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).
style: form
explode: true
schema:
type: string
format: date-time
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action386'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotPriceHistoryResult'
- description: Contains the output of DescribeSpotPriceHistory.
deprecated: false
post:
summary: 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, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.
operationId: POSTDescribeSpotPriceHistory parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action386' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:One or more filters.
availability-zone - The Availability Zone for which prices should be returned.
instance-type - The type of instance (for example, m3.medium).
product-description - The product description for the Spot price (Linux/UNIX | SUSE Linux | Windows | Linux/UNIX (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:
type: string
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).
format: date-time
InstanceType:
type: array
items:
type: string
description: Filters the results by the specified instance types.
MaxResults:
type: integer
description: The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned NextToken value.
format: int32
NextToken:
type: string
description: The token for the next set of results.
ProductDescription:
type: array
items:
type: string
description: Filters the results by the specified basic product descriptions.
StartTime:
type: string
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).
format: date-time
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeSpotPriceHistoryResult'
- description: Contains the output of DescribeSpotPriceHistory.
deprecated: false
/#Action=DescribeStaleSecurityGroups:
get:
summary: GET DescribeStaleSecurityGroups
description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.'
operationId: GETDescribeStaleSecurityGroups
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
description: 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.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next set of items to return. (You received this token from a prior call.)
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action388'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeStaleSecurityGroupsResult'
deprecated: false
post:
summary: POST DescribeStaleSecurityGroups
description: '[VPC only] Describes the stale security group rules for security groups in a specified VPC. Rules are stale when they reference a deleted security group in a peer VPC, or a security group in a peer VPC for which the VPC peering connection has been deleted.'
operationId: POSTDescribeStaleSecurityGroups
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action388'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
maximum: 255
minimum: 5
type: integer
description: 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.
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token for the next set of items to return. (You received this token from a prior call.)
VpcId:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeStaleSecurityGroupsResult'
deprecated: false
/#Action=DescribeSubnets:
get:
summary: GET DescribeSubnets
description: Describes one or more of your subnets.
For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
operationId: GETDescribeSubnets parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:One or more filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
owner-id - The ID of the AWS account that owns the subnet.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
One or more subnet IDs.
Default: Describes all your subnets.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action390'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSubnetsResult'
deprecated: false
post:
summary: POST DescribeSubnets
description: Describes one or more of your subnets.
For more information, see Your VPC and Subnets in the Amazon Virtual Private Cloud User Guide.
operationId: POSTDescribeSubnets parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action390' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string description:One or more filters.
availability-zone - The Availability Zone for the subnet. You can also use availabilityZone as the filter name.
availability-zone-id - The ID of the Availability Zone for the subnet. You can also use availabilityZoneId as the filter name.
available-ip-address-count - The number of IPv4 addresses in the subnet that are available.
cidr-block - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use cidr or cidrBlock as the filter names.
default-for-az - Indicates whether this is the default subnet for the Availability Zone. You can also use defaultForAz as the filter name.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.association-id - An association ID for an IPv6 CIDR block associated with the subnet.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the subnet.
owner-id - The ID of the AWS account that owns the subnet.
state - The state of the subnet (pending | available).
subnet-arn - The Amazon Resource Name (ARN) of the subnet.
subnet-id - The ID of the subnet.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC for the subnet.
One or more subnet IDs.
Default: Describes all your subnets.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The token for the next page of results.
MaxResults:
maximum: 1000
minimum: 5
type: 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.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeSubnetsResult'
deprecated: false
/#Action=DescribeTags:
get:
summary: GET DescribeTags
description: Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeTags parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
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 | image | instance | host-reservation | internet-gateway | launch-template | natgateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | 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.
NextToken value.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action392'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTagsResult'
deprecated: false
post:
summary: POST DescribeTags
description: Describes the specified tags for your EC2 resources.
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeTags parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action392' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: array
items:
type: string
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 | image | instance | host-reservation | internet-gateway | launch-template | natgateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | 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.
NextToken value.
format: int32
NextToken:
type: string
description: The token to retrieve the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTagsResult'
deprecated: false
/#Action=DescribeTransitGatewayAttachments:
get:
summary: 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.
operationId: GETDescribeTransitGatewayAttachments
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayAttachmentIds
in: query
description: The IDs of the attachments.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
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 AWS account that owns the resource.
resource-type - The resource type (vpc | vpn).
state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.
nextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action394'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
deprecated: false
post:
summary: 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.
operationId: POSTDescribeTransitGatewayAttachments
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action394'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
TransitGatewayAttachmentIds:
type: array
items:
type: string
description: The IDs of the attachments.
Filter:
type: array
items:
type: string
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 AWS account that owns the resource.
resource-type - The resource type (vpc | vpn).
state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-attachment-id - The ID of the attachment.
transit-gateway-id - The ID of the transit gateway.
transit-gateway-owner-id - The ID of the AWS account that owns the transit gateway.
nextToken value.
format: int32
NextToken:
type: string
description: The token for the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewayAttachmentsResult'
deprecated: false
/#Action=DescribeTransitGatewayRouteTables:
get:
summary: 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.
operationId: GETDescribeTransitGatewayRouteTables
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableIds
in: query
description: The IDs of the transit gateway route tables.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
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 attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action396'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
deprecated: false
post:
summary: 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.
operationId: POSTDescribeTransitGatewayRouteTables
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action396'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
TransitGatewayRouteTableIds:
type: array
items:
type: string
description: The IDs of the transit gateway route tables.
Filter:
type: array
items:
type: string
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 attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-id - The ID of the transit gateway.
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.
format: int32
NextToken:
type: string
description: The token for the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewayRouteTablesResult'
deprecated: false
/#Action=DescribeTransitGatewayVpcAttachments:
get:
summary: GET DescribeTransitGatewayVpcAttachments
description: Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
operationId: GETDescribeTransitGatewayVpcAttachments
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayAttachmentIds
in: query
description: The IDs of the attachments.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: One or more filters. The possible values are:
state - The state of the attachment (available | deleted | deleting | failed | 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.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action398'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
deprecated: false
post:
summary: POST DescribeTransitGatewayVpcAttachments
description: Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results.
operationId: POSTDescribeTransitGatewayVpcAttachments
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action398'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
TransitGatewayAttachmentIds:
type: array
items:
type: string
description: The IDs of the attachments.
Filter:
type: array
items:
type: string
description: One or more filters. The possible values are:
state - The state of the attachment (available | deleted | deleting | failed | 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.
format: int32
NextToken:
type: string
description: The token for the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewayVpcAttachmentsResult'
deprecated: false
/#Action=DescribeTransitGateways:
get:
summary: GET DescribeTransitGateways
description: Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
operationId: GETDescribeTransitGateways
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayIds
in: query
description: The IDs of the transit gateways.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
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 AWS account that owns the transit gateway.
state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-id - The ID of the transit gateway.
nextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action400'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewaysResult'
deprecated: false
post:
summary: POST DescribeTransitGateways
description: Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results.
operationId: POSTDescribeTransitGateways
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action400'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
TransitGatewayIds:
type: array
items:
type: string
description: The IDs of the transit gateways.
Filter:
type: array
items:
type: string
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 AWS account that owns the transit gateway.
state - The state of the attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-id - The ID of the transit gateway.
nextToken value.
format: int32
NextToken:
type: string
description: The token for the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeTransitGatewaysResult'
deprecated: false
/#Action=DescribeVolumeAttribute:
get:
summary: 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.
operationId: GETDescribeVolumeAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Attribute in: query description: The attribute of the volume. This parameter is required. required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/VolumeAttributeName' - description: The attribute of the volume. This parameter is required. - name: VolumeId in: query description: The ID of the volume. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action402'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeVolumeAttributeResult'
- description: Contains the output of DescribeVolumeAttribute.
deprecated: false
post:
summary: 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.
operationId: POSTDescribeVolumeAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action402' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Attribute - VolumeId type: object properties: Attribute: allOf: - $ref: '#/components/schemas/Attribute11' - description: The attribute of the volume. This parameter is required. VolumeId: type: string description: The ID of the volume. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeVolumeAttributeResult'
- description: Contains the output of DescribeVolumeAttribute.
deprecated: false
/#Action=DescribeVolumeStatus:
get:
summary: 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 may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the Status of Your Volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and may 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 may have inconsistent data.
Actions: Reflect the actions you may 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).
DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
style: form
explode: true
schema:
type: string
- name: VolumeId
in: query
description: 'The IDs of the volumes.
Default: Describes all your volumes.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action404'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVolumeStatusResult'
deprecated: false
post:
summary: 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 may still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see Monitoring the Status of Your Volumes in the Amazon Elastic Compute Cloud User Guide.
Events: Reflect the cause of a volume status and may 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 may have inconsistent data.
Actions: Reflect the actions you may 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).
DescribeVolumeStatus in paginated output. When this parameter is used, the request only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another request with the returned NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, then DescribeVolumeStatus returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
format: int32
NextToken:
type: string
description: The NextToken value to include in a future DescribeVolumeStatus request. When the results of the request exceed MaxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.
VolumeId:
type: array
items:
type: string
description: 'The IDs of the volumes.
Default: Describes all your volumes.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVolumeStatusResult'
deprecated: false
/#Action=DescribeVolumes:
get:
summary: GET DescribeVolumes
description: Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeVolumes parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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)
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: MaxResults
in: query
description: The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action406'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVolumesResult'
deprecated: false
post:
summary: POST DescribeVolumes
description: Describes the specified EBS volumes or all of your EBS volumes.
If you are describing a long list of volumes, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeVolumes request to retrieve the remaining results.
For more information about EBS volumes, see Amazon EBS Volumes in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeVolumes parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action406' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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)
size - The size of the volume, in GiB.
snapshot-id - The snapshot from which the volume was created.
status - The status 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. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
MaxResults:
type: integer
description: The maximum number of volume results returned by DescribeVolumes in paginated output. When this parameter is used, DescribeVolumes only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeVolumes request with the returned NextToken value. This value can be between 5 and 500; if MaxResults is given a value larger than 500, only 500 results are returned. If this parameter is not used, then DescribeVolumes returns all results. You cannot specify this parameter and the volume IDs parameter in the same request.
format: int32
NextToken:
type: string
description: The NextToken value returned from a previous paginated DescribeVolumes request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVolumesResult'
deprecated: false
/#Action=DescribeVolumesModifications:
get:
summary: GET DescribeVolumesModifications
description: Reports the current modification status of EBS volumes.
Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null.
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 Monitoring Volume Modifications" in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeVolumesModifications parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VolumeId
in: query
description: The IDs of the volumes for which in-progress modifications will be described.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: 'The filters. Supported filters: volume-id, modification-state, target-size, target-iops, target-volume-type, original-size, original-iops, original-volume-type, start-time.'
style: form
explode: true
schema:
type: array
items:
type: string
- name: NextToken
in: query
description: The nextToken value returned by a previous paginated request.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
description: The maximum number of results (up to a limit of 500) to be returned in a paginated request.
style: form
explode: true
schema:
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action408'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVolumesModificationsResult'
deprecated: false
post:
summary: POST DescribeVolumesModifications
description: Reports the current modification status of EBS volumes.
Current-generation EBS volumes support modification of attributes including type, size, and (for io1 volumes) IOPS provisioning while either attached to or detached from an instance. Following an action from the API or the console to modify a volume, the status of the modification may be modifying, optimizing, completed, or failed. If a volume has never been modified, then certain elements of the returned VolumeModification objects are null.
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 Monitoring Volume Modifications" in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeVolumesModifications parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action408' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
VolumeId:
type: array
items:
type: string
description: The IDs of the volumes for which in-progress modifications will be described.
Filter:
type: array
items:
type: string
description: 'The filters. Supported filters: volume-id, modification-state, target-size, target-iops, target-volume-type, original-size, original-iops, original-volume-type, start-time.'
NextToken:
type: string
description: The nextToken value returned by a previous paginated request.
MaxResults:
type: integer
description: The maximum number of results (up to a limit of 500) to be returned in a paginated request.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVolumesModificationsResult'
deprecated: false
/#Action=DescribeVpcAttribute:
get:
summary: GET DescribeVpcAttribute
description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
operationId: GETDescribeVpcAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Attribute
in: query
description: The VPC attribute.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/VpcAttributeName'
- description: The VPC attribute.
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action410'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcAttributeResult'
deprecated: false
post:
summary: POST DescribeVpcAttribute
description: Describes the specified attribute of the specified VPC. You can specify only one attribute at a time.
operationId: POSTDescribeVpcAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action410'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Attribute
- VpcId
type: object
properties:
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute13'
- description: The VPC attribute.
VpcId:
type: string
description: The ID of the VPC.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcAttributeResult'
deprecated: false
/#Action=DescribeVpcClassicLink:
get:
summary: GET DescribeVpcClassicLink
description: Describes the ClassicLink status of one or more VPCs.
operationId: GETDescribeVpcClassicLink
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Filter
in: query
description: One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcId
in: query
description: One or more VPCs for which you want to describe the ClassicLink status.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action412'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcClassicLinkResult'
deprecated: false
post:
summary: POST DescribeVpcClassicLink
description: Describes the ClassicLink status of one or more VPCs.
operationId: POSTDescribeVpcClassicLink
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action412'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
Filter:
type: array
items:
type: string
description: One or more filters.
is-classic-link-enabled - Whether the VPC is enabled for ClassicLink (true | false).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
VpcId:
type: array
items:
type: string
description: One or more VPCs for which you want to describe the ClassicLink status.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcClassicLinkResult'
deprecated: false
/#Action=DescribeVpcClassicLinkDnsSupport:
get:
summary: GET DescribeVpcClassicLinkDnsSupport
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDescribeVpcClassicLinkDnsSupport
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 255
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
maxLength: 1024
minLength: 1
type: string
- name: VpcIds
in: query
description: One or more VPC IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action414'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult'
deprecated: false
post:
summary: POST DescribeVpcClassicLinkDnsSupport
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDescribeVpcClassicLinkDnsSupport
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action414'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
MaxResults:
maximum: 255
minimum: 5
type: 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.
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
description: The token for the next page of results.
VpcIds:
type: array
items:
type: string
description: One or more VPC IDs.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcClassicLinkDnsSupportResult'
deprecated: false
/#Action=DescribeVpcEndpointConnectionNotifications:
get:
summary: GET DescribeVpcEndpointConnectionNotifications
description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
operationId: GETDescribeVpcEndpointConnectionNotifications
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ConnectionNotificationId
in: query
description: The ID of the notification.
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: One or more filters.
connection-notification-arn - The ARN of 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.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to request the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action416'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
deprecated: false
post:
summary: POST DescribeVpcEndpointConnectionNotifications
description: Describes the connection notifications for VPC endpoints and VPC endpoint services.
operationId: POSTDescribeVpcEndpointConnectionNotifications
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action416'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the notification.
Filter:
type: array
items:
type: string
description: One or more filters.
connection-notification-arn - The ARN of 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.
format: int32
NextToken:
type: string
description: The token to request the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionNotificationsResult'
deprecated: false
/#Action=DescribeVpcEndpointConnections:
get:
summary: GET DescribeVpcEndpointConnections
description: Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
operationId: GETDescribeVpcEndpointConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Filter
in: query
description: One or more filters.
service-id - The ID of the service.
vpc-endpoint-owner - The AWS account number of the owner of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action418'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
deprecated: false
post:
summary: POST DescribeVpcEndpointConnections
description: Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance.
operationId: POSTDescribeVpcEndpointConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action418'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
Filter:
type: array
items:
type: string
description: One or more filters.
service-id - The ID of the service.
vpc-endpoint-owner - The AWS account number of the owner of the endpoint.
vpc-endpoint-state - The state of the endpoint (pendingAcceptance | pending | available | deleting | deleted | rejected | failed).
vpc-endpoint-id - The ID of the endpoint.
NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
format: int32
NextToken:
type: string
description: The token to retrieve the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointConnectionsResult'
deprecated: false
/#Action=DescribeVpcEndpointServiceConfigurations:
get:
summary: GET DescribeVpcEndpointServiceConfigurations
description: Describes the VPC endpoint service configurations in your account (your services).
operationId: GETDescribeVpcEndpointServiceConfigurations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The IDs of one or more services.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: One or more filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action420'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
deprecated: false
post:
summary: POST DescribeVpcEndpointServiceConfigurations
description: Describes the VPC endpoint service configurations in your account (your services).
operationId: POSTDescribeVpcEndpointServiceConfigurations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action420'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: array
items:
type: string
description: The IDs of one or more services.
Filter:
type: array
items:
type: string
description: One or more filters.
service-name - The name of the service.
service-id - The ID of the service.
service-state - The state of the service (Pending | Available | Deleting | Deleted | Failed).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
NextToken value. This value can be between 5 and 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
format: int32
NextToken:
type: string
description: The token to retrieve the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServiceConfigurationsResult'
deprecated: false
/#Action=DescribeVpcEndpointServicePermissions:
get:
summary: GET DescribeVpcEndpointServicePermissions
description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
operationId: GETDescribeVpcEndpointServicePermissions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The ID of the service.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: One or more 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 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
style: form
explode: true
schema:
type: integer
format: int32
- name: NextToken
in: query
description: The token to retrieve the next page of results.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action422'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
deprecated: false
post:
summary: POST DescribeVpcEndpointServicePermissions
description: Describes the principals (service consumers) that are permitted to discover your VPC endpoint service.
operationId: POSTDescribeVpcEndpointServicePermissions
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action422'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ServiceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the service.
Filter:
type: array
items:
type: string
description: One or more 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 1000; if MaxResults is given a value larger than 1000, only 1000 results are returned.
format: int32
NextToken:
type: string
description: The token to retrieve the next page of results.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcEndpointServicePermissionsResult'
deprecated: false
/#Action=DescribeVpcEndpointServices:
get:
summary: GET DescribeVpcEndpointServices
description: Describes available services to which you can create a VPC endpoint.
operationId: GETDescribeVpcEndpointServices
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceName
in: query
description: One or more service names.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: 'One or more filters.
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.
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 1000, we return only 1000 items.
' style: form explode: true schema: type: integer format: int32 - name: NextToken in: query description: The token for the next set of items to return. (You received this token from a prior call.) style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action424' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/DescribeVpcEndpointServicesResult' - description: Contains the output of DescribeVpcEndpointServices. deprecated: false post: summary: POST DescribeVpcEndpointServices description: Describes available services to which you can create a VPC endpoint. operationId: POSTDescribeVpcEndpointServices parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action424' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
ServiceName:
type: array
items:
type: string
description: One or more service names.
Filter:
type: array
items:
type: string
description: 'One or more filters.
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.
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 1000, we return only 1000 items.
' format: int32 NextToken: type: string description: The token for the next set of items to return. (You received this token from a prior call.) required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/DescribeVpcEndpointServicesResult' - description: Contains the output of DescribeVpcEndpointServices. deprecated: false /#Action=DescribeVpcEndpoints: get: summary: GET DescribeVpcEndpoints description: Describes one or more of your VPC endpoints. operationId: GETDescribeVpcEndpoints parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcEndpointId
in: query
description: One or more endpoint IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Filter
in: query
description: 'One or more filters.
service-name: The name of the service.
vpc-id: The ID of the VPC in which the endpoint resides.
vpc-endpoint-id: The ID of the endpoint.
vpc-endpoint-state: The state of the endpoint. (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.
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 1000, we return only 1000 items.
' style: form explode: true schema: type: integer format: int32 - name: NextToken in: query description: The token for the next set of items to return. (You received this token from a prior call.) style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action426' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/DescribeVpcEndpointsResult' - description: Contains the output of DescribeVpcEndpoints. deprecated: false post: summary: POST DescribeVpcEndpoints description: Describes one or more of your VPC endpoints. operationId: POSTDescribeVpcEndpoints parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action426' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
VpcEndpointId:
type: array
items:
type: string
description: One or more endpoint IDs.
Filter:
type: array
items:
type: string
description: 'One or more filters.
service-name: The name of the service.
vpc-id: The ID of the VPC in which the endpoint resides.
vpc-endpoint-id: The ID of the endpoint.
vpc-endpoint-state: The state of the endpoint. (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.
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 1000, we return only 1000 items.
' format: int32 NextToken: type: string description: The token for the next set of items to return. (You received this token from a prior call.) required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/DescribeVpcEndpointsResult' - description: Contains the output of DescribeVpcEndpoints. deprecated: false /#Action=DescribeVpcPeeringConnections: get: summary: GET DescribeVpcPeeringConnections description: Describes one or more of your VPC peering connections. operationId: GETDescribeVpcPeeringConnections parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query description:One or more filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
description: 'One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
' style: form explode: true schema: type: array items: type: string - name: NextToken in: query description: The token for the next page of results. style: form explode: true schema: type: string - name: MaxResults in: query description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action428'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult'
deprecated: false
post:
summary: POST DescribeVpcPeeringConnections
description: Describes one or more of your VPC peering connections.
operationId: POSTDescribeVpcPeeringConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action428'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
Filter:
type: array
items:
type: string
description: One or more filters.
accepter-vpc-info.cidr-block - The IPv4 CIDR block of the accepter VPC.
accepter-vpc-info.owner-id - The AWS account ID of the owner of the accepter VPC.
accepter-vpc-info.vpc-id - The ID of the accepter VPC.
expiration-time - The expiration date and time for the VPC peering connection.
requester-vpc-info.cidr-block - The IPv4 CIDR block of the requester's VPC.
requester-vpc-info.owner-id - The AWS account ID of the owner of the requester VPC.
requester-vpc-info.vpc-id - The ID of the requester VPC.
status-code - The status of the VPC peering connection (pending-acceptance | failed | expired | provisioning | active | deleting | deleted | rejected).
status-message - A message that provides more information about the status of the VPC peering connection, if applicable.
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-peering-connection-id - The ID of the VPC peering connection.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
VpcPeeringConnectionId:
type: array
items:
type: string
description: 'One or more VPC peering connection IDs.
Default: Describes all your VPC peering connections.
' NextToken: type: string description: The token for the next page of results. MaxResults: maximum: 1000 minimum: 5 type: integer description: The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returnednextToken value.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcPeeringConnectionsResult'
deprecated: false
/#Action=DescribeVpcs:
get:
summary: GET DescribeVpcs
description: Describes one or more of your VPCs.
operationId: GETDescribeVpcs
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Filter
in: query
description: One or more filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
isDefault - Indicates whether the VPC is the default VPC.
owner-id - The ID of the AWS account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
One or more VPC IDs.
Default: Describes all your VPCs.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: MaxResults
in: query
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.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action430'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcsResult'
deprecated: false
post:
summary: POST DescribeVpcs
description: Describes one or more of your VPCs.
operationId: POSTDescribeVpcs
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action430'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
Filter:
type: array
items:
type: string
description: One or more filters.
cidr - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, /28).
cidr-block-association.cidr-block - An IPv4 CIDR block associated with the VPC.
cidr-block-association.association-id - The association ID for an IPv4 CIDR block associated with the VPC.
cidr-block-association.state - The state of an IPv4 CIDR block associated with the VPC.
dhcp-options-id - The ID of a set of DHCP options.
ipv6-cidr-block-association.ipv6-cidr-block - An IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.association-id - The association ID for an IPv6 CIDR block associated with the VPC.
ipv6-cidr-block-association.state - The state of an IPv6 CIDR block associated with the VPC.
isDefault - Indicates whether the VPC is the default VPC.
owner-id - The ID of the AWS account that owns the VPC.
state - The state of the VPC (pending | available).
tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.
tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.
vpc-id - The ID of the VPC.
One or more VPC IDs.
Default: Describes all your VPCs.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The token for the next page of results.
MaxResults:
maximum: 1000
minimum: 5
type: 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.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DescribeVpcsResult'
deprecated: false
/#Action=DescribeVpnConnections:
get:
summary: GET DescribeVpnConnections
description: Describes one or more of your VPN connections.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: GETDescribeVpnConnections parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action432'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeVpnConnectionsResult'
- description: Contains the output of DescribeVpnConnections.
deprecated: false
post:
summary: POST DescribeVpnConnections
description: Describes one or more of your VPN connections.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: POSTDescribeVpnConnections parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action432' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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.
One or more VPN connection IDs.
Default: Describes your VPN connections.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeVpnConnectionsResult'
- description: Contains the output of DescribeVpnConnections.
deprecated: false
/#Action=DescribeVpnGateways:
get:
summary: GET DescribeVpnGateways
description: Describes one or more of your virtual private gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: GETDescribeVpnGateways parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Filter in: query 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.
' style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action434'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeVpnGatewaysResult'
- description: Contains the output of DescribeVpnGateways.
deprecated: false
post:
summary: POST DescribeVpnGateways
description: Describes one or more of your virtual private gateways.
For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.
operationId: POSTDescribeVpnGateways parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action434' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: Filter: type: array items: type: string 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: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/DescribeVpnGatewaysResult'
- description: Contains the output of DescribeVpnGateways.
deprecated: false
/#Action=DetachClassicLinkVpc:
get:
summary: GET DetachClassicLinkVpc
description: 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.
operationId: GETDetachClassicLinkVpc
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance to unlink from the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC to which the instance is linked.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action436'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DetachClassicLinkVpcResult'
deprecated: false
post:
summary: POST DetachClassicLinkVpc
description: 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.
operationId: POSTDetachClassicLinkVpc
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action436'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InstanceId
- VpcId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the instance to unlink from the VPC.
VpcId:
type: string
description: The ID of the VPC to which the instance is linked.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DetachClassicLinkVpcResult'
deprecated: false
/#Action=DetachInternetGateway:
get:
summary: 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.
operationId: GETDetachInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InternetGatewayId
in: query
description: The ID of the internet gateway.
required: true
style: form
explode: true
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action438'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTDetachInternetGateway
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action438'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InternetGatewayId
- VpcId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the internet gateway.
VpcId:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DetachNetworkInterface:
get:
summary: GET DetachNetworkInterface
description: Detaches a network interface from an instance.
operationId: GETDetachNetworkInterface
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: AttachmentId
in: query
description: The ID of the attachment.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Force
in: query
description: Specifies whether to force a detachment.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action440'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DetachNetworkInterface
description: Detaches a network interface from an instance.
operationId: POSTDetachNetworkInterface
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action440'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- AttachmentId
type: object
properties:
AttachmentId:
type: string
description: The ID of the attachment.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: boolean
description: Specifies whether to force a detachment.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DetachVolume:
get:
summary: 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 AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDetachVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Device in: query description: The device name. style: form explode: true schema: type: string - name: Force in: query 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. style: form explode: true schema: type: boolean - name: InstanceId in: query description: The ID of the instance. style: form explode: true schema: type: string - name: VolumeId in: query description: The ID of the volume. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action442'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/VolumeAttachment'
- description: Describes volume attachment details.
deprecated: false
post:
summary: 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 AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance.
For more information, see Detaching an Amazon EBS Volume in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDetachVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action442' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VolumeId type: object properties: Device: type: string description: The device name. Force: type: 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: type: string description: The ID of the instance. VolumeId: type: string description: The ID of the volume. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/VolumeAttachment'
- description: Describes volume attachment details.
deprecated: false
/#Action=DetachVpnGateway:
get:
summary: 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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action444'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DisableTransitGatewayRouteTablePropagation:
get:
summary: GET DisableTransitGatewayRouteTablePropagation
description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
operationId: GETDisableTransitGatewayRouteTablePropagation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the propagation route table.
required: true
style: form
explode: true
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action446'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
deprecated: false
post:
summary: POST DisableTransitGatewayRouteTablePropagation
description: Disables the specified resource attachment from propagating routes to the specified propagation route table.
operationId: POSTDisableTransitGatewayRouteTablePropagation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action446'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the propagation route table.
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisableTransitGatewayRouteTablePropagationResult'
deprecated: false
/#Action=DisableVgwRoutePropagation:
get:
summary: GET DisableVgwRoutePropagation
description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
operationId: GETDisableVgwRoutePropagation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: GatewayId
in: query
description: The ID of the virtual private gateway.
required: true
style: form
explode: true
schema:
type: string
- name: RouteTableId
in: query
description: The ID of the route table.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action448'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DisableVgwRoutePropagation
description: Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC.
operationId: POSTDisableVgwRoutePropagation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action448'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- GatewayId
- RouteTableId
type: object
properties:
GatewayId:
type: string
description: The ID of the virtual private gateway.
RouteTableId:
type: string
description: The ID of the route table.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DisableVpcClassicLink:
get:
summary: GET DisableVpcClassicLink
description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
operationId: GETDisableVpcClassicLink
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action450'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisableVpcClassicLinkResult'
deprecated: false
post:
summary: POST DisableVpcClassicLink
description: Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it.
operationId: POSTDisableVpcClassicLink
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action450'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisableVpcClassicLinkResult'
deprecated: false
/#Action=DisableVpcClassicLinkDnsSupport:
get:
summary: GET DisableVpcClassicLinkDnsSupport
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: GETDisableVpcClassicLinkDnsSupport
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action452'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult'
deprecated: false
post:
summary: POST DisableVpcClassicLinkDnsSupport
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTDisableVpcClassicLinkDnsSupport
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action452'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
VpcId:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisableVpcClassicLinkDnsSupportResult'
deprecated: false
/#Action=DisassociateAddress:
get:
summary: GET DisassociateAddress
description: Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
operationId: GETDisassociateAddress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AssociationId in: query description: '[EC2-VPC] The association ID. Required for EC2-VPC.' style: form explode: true schema: type: string - name: PublicIp in: query description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action454'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DisassociateAddress
description: Disassociates an Elastic IP address from the instance or network interface it's associated with.
An Elastic IP address is for use in either the EC2-Classic platform or in a VPC. For more information, see Elastic IP Addresses in the Amazon Elastic Compute Cloud User Guide.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error.
operationId: POSTDisassociateAddress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action454' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: AssociationId: type: string description: '[EC2-VPC] The association ID. Required for EC2-VPC.' PublicIp: type: string description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DisassociateClientVpnTargetNetwork:
get:
summary: 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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action456'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisassociateClientVpnTargetNetworkResult'
deprecated: false
post:
summary: 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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisassociateClientVpnTargetNetworkResult'
deprecated: false
/#Action=DisassociateIamInstanceProfile:
get:
summary: GET DisassociateIamInstanceProfile
description: Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
operationId: GETDisassociateIamInstanceProfile parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AssociationId in: query description: The ID of the IAM instance profile association. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action458' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' deprecated: false post: summary: POST DisassociateIamInstanceProfile description:Disassociates an IAM instance profile from a running or stopped instance.
Use DescribeIamInstanceProfileAssociations to get the association ID.
operationId: POSTDisassociateIamInstanceProfile parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action458' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AssociationId type: object properties: AssociationId: type: string description: The ID of the IAM instance profile association. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DisassociateIamInstanceProfileResult' deprecated: false /#Action=DisassociateRouteTable: get: summary: GET DisassociateRouteTable description:Disassociates a subnet 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 Virtual Private Cloud User Guide.
operationId: GETDisassociateRouteTable parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AssociationId in: query description: The association ID representing the current association between the route table and subnet. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action460'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST DisassociateRouteTable
description: Disassociates a subnet 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 Virtual Private Cloud User Guide.
operationId: POSTDisassociateRouteTable parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action460' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AssociationId type: object properties: AssociationId: type: string description: The association ID representing the current association between the route table and subnet. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=DisassociateSubnetCidrBlock:
get:
summary: 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. '
operationId: GETDisassociateSubnetCidrBlock
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: AssociationId
in: query
description: The association ID for the CIDR block.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action462'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisassociateSubnetCidrBlockResult'
deprecated: false
post:
summary: 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. '
operationId: POSTDisassociateSubnetCidrBlock
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action462'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- AssociationId
type: object
properties:
AssociationId:
type: string
description: The association ID for the CIDR block.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisassociateSubnetCidrBlockResult'
deprecated: false
/#Action=DisassociateTransitGatewayRouteTable:
get:
summary: GET DisassociateTransitGatewayRouteTable
description: Disassociates a resource attachment from a transit gateway route table.
operationId: GETDisassociateTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the transit gateway route table.
required: true
style: form
explode: true
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action464'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
deprecated: false
post:
summary: POST DisassociateTransitGatewayRouteTable
description: Disassociates a resource attachment from a transit gateway route table.
operationId: POSTDisassociateTransitGatewayRouteTable
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action464'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/DisassociateTransitGatewayRouteTableResult'
deprecated: false
/#Action=DisassociateVpcCidrBlock:
get:
summary: 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).
operationId: GETDisassociateVpcCidrBlock parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AssociationId in: query description: The association ID for the CIDR block. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action466' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' deprecated: false post: summary: 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).
operationId: POSTDisassociateVpcCidrBlock parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action466' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AssociationId type: object properties: AssociationId: type: string description: The association ID for the CIDR block. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/DisassociateVpcCidrBlockResult' deprecated: false /#Action=EnableTransitGatewayRouteTablePropagation: get: summary: GET EnableTransitGatewayRouteTablePropagation description: Enables the specified attachment to propagate routes to the specified propagation route table. operationId: GETEnableTransitGatewayRouteTablePropagation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: TransitGatewayRouteTableId in: query description: The ID of the propagation route table. required: true style: form explode: true schema: type: string - name: TransitGatewayAttachmentId in: query description: The ID of the attachment. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action468'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
deprecated: false
post:
summary: POST EnableTransitGatewayRouteTablePropagation
description: Enables the specified attachment to propagate routes to the specified propagation route table.
operationId: POSTEnableTransitGatewayRouteTablePropagation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action468'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the propagation route table.
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/EnableTransitGatewayRouteTablePropagationResult'
deprecated: false
/#Action=EnableVgwRoutePropagation:
get:
summary: GET EnableVgwRoutePropagation
description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
operationId: GETEnableVgwRoutePropagation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: GatewayId
in: query
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.
required: true
style: form
explode: true
schema:
type: string
- name: RouteTableId
in: query
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.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action470'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST EnableVgwRoutePropagation
description: Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC.
operationId: POSTEnableVgwRoutePropagation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action470'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- GatewayId
- RouteTableId
type: object
properties:
GatewayId:
type: string
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:
type: string
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.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=EnableVolumeIO:
get:
summary: 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.
operationId: GETEnableVolumeIO
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VolumeId
in: query
description: The ID of the volume.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action472'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTEnableVolumeIO
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action472'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VolumeId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the volume.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=EnableVpcClassicLink:
get:
summary: GET EnableVpcClassicLink
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: GETEnableVpcClassicLink
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action474'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/EnableVpcClassicLinkResult'
deprecated: false
post:
summary: POST EnableVpcClassicLink
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTEnableVpcClassicLink
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action474'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/EnableVpcClassicLinkResult'
deprecated: false
/#Action=EnableVpcClassicLinkDnsSupport:
get:
summary: GET EnableVpcClassicLinkDnsSupport
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: GETEnableVpcClassicLinkDnsSupport
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action476'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult'
deprecated: false
post:
summary: POST EnableVpcClassicLinkDnsSupport
description: 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. For more information, see ClassicLink in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTEnableVpcClassicLinkDnsSupport
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action476'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
type: object
properties:
VpcId:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/EnableVpcClassicLinkDnsSupportResult'
deprecated: false
/#Action=ExportClientVpnClientCertificateRevocationList:
get:
summary: GET ExportClientVpnClientCertificateRevocationList
description: Downloads the client certificate revocation list for the specified Client VPN endpoint.
operationId: GETExportClientVpnClientCertificateRevocationList
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action478'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult'
deprecated: false
post:
summary: POST ExportClientVpnClientCertificateRevocationList
description: Downloads the client certificate revocation list for the specified Client VPN endpoint.
operationId: POSTExportClientVpnClientCertificateRevocationList
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action478'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ExportClientVpnClientCertificateRevocationListResult'
deprecated: false
/#Action=ExportClientVpnClientConfiguration:
get:
summary: 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.
operationId: GETExportClientVpnClientConfiguration
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action480'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
deprecated: false
post:
summary: 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.
operationId: POSTExportClientVpnClientConfiguration
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action480'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ExportClientVpnClientConfigurationResult'
deprecated: false
/#Action=ExportTransitGatewayRoutes:
get:
summary: 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.
operationId: GETExportTransitGatewayRoutes
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the route table.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
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 attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of roue (active | blackhole).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action482'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ExportTransitGatewayRoutesResult'
deprecated: false
post:
summary: 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.
operationId: POSTExportTransitGatewayRoutes
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action482'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
- S3Bucket
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the route table.
Filter:
type: array
items:
type: string
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 attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
transit-gateway-route-destination-cidr-block - The CIDR range.
type - The type of roue (active | blackhole).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ExportTransitGatewayRoutesResult'
deprecated: false
/#Action=GetConsoleOutput:
get:
summary: 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 Elastic Compute Cloud User Guide.
operationId: GETGetConsoleOutput parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceId in: query description: The ID of the instance. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Latest
in: query
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 Elastic Compute Cloud User Guide.
operationId: POSTGetConsoleOutput parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action484' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: InstanceId: type: string description: The ID of the instance. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
Latest:
type: boolean
description: 'When enabled, retrieves the latest console output for the instance.
Default: disabled (false)
Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
operationId: GETGetConsoleScreenshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: WakeUp
in: query
description: When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action486'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetConsoleScreenshotResult'
deprecated: false
post:
summary: POST GetConsoleScreenshot
description: Retrieve a JPG-format screenshot of a running instance to help with troubleshooting.
The returned content is Base64-encoded.
operationId: POSTGetConsoleScreenshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action486' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The ID of the instance.
WakeUp:
type: boolean
description: When set to true, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetConsoleScreenshotResult'
deprecated: false
/#Action=GetHostReservationPurchasePreview:
get:
summary: 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.
operationId: GETGetHostReservationPurchasePreview parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: HostIdSet in: query description: The IDs of the Dedicated Hosts with which the reservation is associated. required: true style: form explode: true schema: type: array items: type: string - name: OfferingId in: query description: The offering ID of the reservation. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action488' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' deprecated: false post: summary: 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.
operationId: POSTGetHostReservationPurchasePreview parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action488' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - HostIdSet - OfferingId type: object properties: HostIdSet: type: array items: type: string description: The IDs of the Dedicated Hosts with which the reservation is associated. OfferingId: type: string description: The offering ID of the reservation. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/GetHostReservationPurchasePreviewResult' deprecated: false /#Action=GetLaunchTemplateData: get: summary: GET GetLaunchTemplateData description: Retrieves the configuration data of the specified instance. You can use this data to create a launch template. operationId: GETGetLaunchTemplateData parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action490'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetLaunchTemplateDataResult'
deprecated: false
post:
summary: POST GetLaunchTemplateData
description: Retrieves the configuration data of the specified instance. You can use this data to create a launch template.
operationId: POSTGetLaunchTemplateData
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action490'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InstanceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the instance.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetLaunchTemplateDataResult'
deprecated: false
/#Action=GetPasswordData:
get:
summary: 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 Elastic Compute Cloud 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.
operationId: GETGetPasswordData parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceId in: query description: The ID of the Windows instance. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action492'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetPasswordDataResult'
deprecated: false
post:
summary: 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 Elastic Compute Cloud 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.
operationId: POSTGetPasswordData parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action492' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: InstanceId: type: string description: The ID of the Windows instance. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetPasswordDataResult'
deprecated: false
/#Action=GetReservedInstancesExchangeQuote:
get:
summary: 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.
operationId: GETGetReservedInstancesExchangeQuote
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ReservedInstanceId
in: query
description: The IDs of the Convertible Reserved Instances to exchange.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: TargetConfiguration
in: query
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action494'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult'
- description: Contains the output of GetReservedInstancesExchangeQuote.
deprecated: false
post:
summary: 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.
operationId: POSTGetReservedInstancesExchangeQuote
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action494'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ReservedInstanceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
ReservedInstanceId:
type: array
items:
type: string
description: The IDs of the Convertible Reserved Instances to exchange.
TargetConfiguration:
type: array
items:
type: string
description: The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/GetReservedInstancesExchangeQuoteResult'
- description: Contains the output of GetReservedInstancesExchangeQuote.
deprecated: false
/#Action=GetTransitGatewayAttachmentPropagations:
get:
summary: GET GetTransitGatewayAttachmentPropagations
description: Lists the route tables to which the specified resource attachment propagates routes.
operationId: GETGetTransitGatewayAttachmentPropagations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action496'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
deprecated: false
post:
summary: POST GetTransitGatewayAttachmentPropagations
description: Lists the route tables to which the specified resource attachment propagates routes.
operationId: POSTGetTransitGatewayAttachmentPropagations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action496'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
Filter:
type: array
items:
type: string
description: One or more filters. The possible values are:
transit-gateway-route-table-id - The ID of the transit gateway route table.
nextToken value.
format: int32
NextToken:
type: string
description: The token for the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetTransitGatewayAttachmentPropagationsResult'
deprecated: false
/#Action=GetTransitGatewayRouteTableAssociations:
get:
summary: GET GetTransitGatewayRouteTableAssociations
description: Gets information about the associations for the specified transit gateway route table.
operationId: GETGetTransitGatewayRouteTableAssociations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the transit gateway route table.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type (vpc | vpn).
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action498'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
deprecated: false
post:
summary: POST GetTransitGatewayRouteTableAssociations
description: Gets information about the associations for the specified transit gateway route table.
operationId: POSTGetTransitGatewayRouteTableAssociations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action498'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
Filter:
type: array
items:
type: string
description: One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type (vpc | vpn).
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.
format: int32
NextToken:
type: string
description: The token for the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTableAssociationsResult'
deprecated: false
/#Action=GetTransitGatewayRouteTablePropagations:
get:
summary: GET GetTransitGatewayRouteTablePropagations
description: Gets information about the route table propagations for the specified transit gateway route table.
operationId: GETGetTransitGatewayRouteTablePropagations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the transit gateway route table.
required: true
style: form
explode: true
schema:
type: string
- name: Filter
in: query
description: One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type (vpc | vpn).
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.
style: form
explode: true
schema:
maximum: 1000
minimum: 5
type: integer
format: int32
- name: NextToken
in: query
description: The token for the next page of results.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action500'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
deprecated: false
post:
summary: POST GetTransitGatewayRouteTablePropagations
description: Gets information about the route table propagations for the specified transit gateway route table.
operationId: POSTGetTransitGatewayRouteTablePropagations
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action500'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
Filter:
type: array
items:
type: string
description: One or more filters. The possible values are:
resource-id - The ID of the resource.
resource-type - The resource type (vpc | vpn).
transit-gateway-attachment-id - The ID of the attachment.
nextToken value.
format: int32
NextToken:
type: string
description: The token for the next page of results.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/GetTransitGatewayRouteTablePropagationsResult'
deprecated: false
/#Action=ImportClientVpnClientCertificateRevocationList:
get:
summary: 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.
operationId: GETImportClientVpnClientCertificateRevocationList parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientVpnEndpointId in: query description: The ID of the Client VPN endpoint to which the client certificate revocation list applies. required: true style: form explode: true schema: type: string - name: CertificateRevocationList in: query description: The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action502'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult'
deprecated: false
post:
summary: 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.
operationId: POSTImportClientVpnClientCertificateRevocationList parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action502' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ClientVpnEndpointId - CertificateRevocationList type: object properties: ClientVpnEndpointId: type: string description: The ID of the Client VPN endpoint to which the client certificate revocation list applies. CertificateRevocationList: type: string description: The client certificate revocation list file. For more information, see Generate a Client Certificate Revocation List in the AWS Client VPN Administrator Guide. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ImportClientVpnClientCertificateRevocationListResult'
deprecated: false
/#Action=ImportImage:
get:
summary: GET ImportImage
description: Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). For more information, see Importing a VM as an Image Using VM Import/Export in the VM Import/Export User Guide.
operationId: GETImportImage
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Architecture
in: query
description: 'The architecture of the virtual machine.
Valid values: i386 | x86_64
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Encrypted
in: query
description: Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
type: boolean
- name: Hypervisor
in: query
description: 'The target hypervisor platform.
Valid values: xen
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
' style: form explode: true schema: type: string - name: LicenseType in: query description: 'The license type to be used for the Amazon Machine Image (AMI) after importing.
Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
Valid values include:
Auto - Detects the source-system operating system (OS) and applies the appropriate license.
AWS - Replaces the source-system license with an AWS license, if appropriate.
BYOL - Retains the source-system license, if appropriate.
Default value: Auto
The operating system of the virtual machine.
Valid values: Windows | Linux
The architecture of the virtual machine.
Valid values: i386 | x86_64
DryRunOperation. Otherwise, it is UnauthorizedOperation.
Encrypted:
type: boolean
description: Specifies whether the destination AMI of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
Hypervisor:
type: string
description: 'The target hypervisor platform.
Valid values: xen
An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the AMI is being copied to.
' LicenseType: type: string description: 'The license type to be used for the Amazon Machine Image (AMI) after importing.
Note: You may only use BYOL if you have existing licenses with rights to use these licenses in a third party cloud like AWS. For more information, see Prerequisites in the VM Import/Export User Guide.
Valid values include:
Auto - Detects the source-system operating system (OS) and applies the appropriate license.
AWS - Replaces the source-system license with an AWS license, if appropriate.
BYOL - Retains the source-system license, if appropriate.
Default value: Auto
The operating system of the virtual machine.
Valid values: Windows | Linux
Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
For information about the import manifest referenced by this API action, see VM Import Manifest.
operationId: GETImportInstance parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Description in: query description: A description for the instance being imported. style: form explode: true schema: type: string - name: DiskImage in: query description: The disk image. style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: LaunchSpecification.AdditionalInfo
in: query
description: >-
Describes the launch specification for VM import.
Reserved.
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.Architecture
in: query
description: >-
Describes the launch specification for VM import.
The architecture of the instance.
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.GroupIds
in: query
description: >-
Describes the launch specification for VM import.
The security group IDs.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LaunchSpecification.GroupNames
in: query
description: >-
Describes the launch specification for VM import.
The security group names.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LaunchSpecification.InstanceInitiatedShutdownBehavior
in: query
description: >-
Describes the launch specification for VM import.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.InstanceType
in: query
description: >-
Describes the launch specification for VM import.
The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.Monitoring
in: query
description: >-
Describes the launch specification for VM import.
Indicates whether monitoring is enabled.
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.Placement
in: query
description: >-
Describes the launch specification for VM import.
The placement information for the instance.
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.PrivateIpAddress
in: query
description: >-
Describes the launch specification for VM import.
[EC2-VPC] An available IP address from the IP address range of the subnet.
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.SubnetId
in: query
description: >-
Describes the launch specification for VM import.
[EC2-VPC] The ID of the subnet in which to launch the instance.
style: form
explode: true
schema:
type: string
- name: LaunchSpecification.UserData
in: query
description: >-
Describes the launch specification for VM import.
The Base64-encoded user data to make available to the instance.
style: form
explode: true
schema:
type: string
- name: Platform
in: query
description: The instance operating system.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/PlatformValues'
- description: The instance operating system.
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action506'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/ImportInstanceResult'
- description: Contains the output for ImportInstance.
deprecated: false
post:
summary: POST ImportInstance
description: Creates an import instance task using metadata from the specified disk image. ImportInstance only supports single-volume VMs. To import multi-volume VMs, use ImportImage. For more information, see Importing a Virtual Machine Using the Amazon EC2 CLI.
For information about the import manifest referenced by this API action, see VM Import Manifest.
operationId: POSTImportInstance parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action506' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Platform type: object properties: Description: type: string description: A description for the instance being imported. DiskImage: type: array items: type: string description: The disk image. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
LaunchSpecification.AdditionalInfo:
type: string
description: >-
Describes the launch specification for VM import.
Reserved.
LaunchSpecification.Architecture:
type: string
description: >-
Describes the launch specification for VM import.
The architecture of the instance.
LaunchSpecification.GroupIds:
type: array
items:
type: string
description: >-
Describes the launch specification for VM import.
The security group IDs.
LaunchSpecification.GroupNames:
type: array
items:
type: string
description: >-
Describes the launch specification for VM import.
The security group names.
LaunchSpecification.InstanceInitiatedShutdownBehavior:
type: string
description: >-
Describes the launch specification for VM import.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
LaunchSpecification.InstanceType:
type: string
description: >-
Describes the launch specification for VM import.
The instance type. For more information about the instance types that you can import, see Instance Types in the VM Import/Export User Guide.
LaunchSpecification.Monitoring:
type: string
description: >-
Describes the launch specification for VM import.
Indicates whether monitoring is enabled.
LaunchSpecification.Placement:
type: string
description: >-
Describes the launch specification for VM import.
The placement information for the instance.
LaunchSpecification.PrivateIpAddress:
type: string
description: >-
Describes the launch specification for VM import.
[EC2-VPC] An available IP address from the IP address range of the subnet.
LaunchSpecification.SubnetId:
type: string
description: >-
Describes the launch specification for VM import.
[EC2-VPC] The ID of the subnet in which to launch the instance.
LaunchSpecification.UserData:
type: string
description: >-
Describes the launch specification for VM import.
The Base64-encoded user data to make available to the instance.
Platform:
allOf:
- $ref: '#/components/schemas/Platform1'
- description: The instance operating system.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/ImportInstanceResult'
- description: Contains the output for ImportInstance.
deprecated: false
/#Action=ImportKeyPair:
get:
summary: GET ImportKeyPair
description: Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
operationId: GETImportKeyPair parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: KeyName
in: query
description: A unique name for the key pair.
required: true
style: form
explode: true
schema:
type: string
- name: PublicKeyMaterial
in: query
description: The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action508'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ImportKeyPairResult'
deprecated: false
post:
summary: POST ImportKeyPair
description: Imports the public key from an RSA key pair that you created with a third-party tool. Compare this with CreateKeyPair, in which AWS creates the key pair and gives the keys to you (AWS keeps a copy of the public key). With ImportKeyPair, you create the key pair and give AWS just the public key. The private key is never transferred between you and AWS.
For more information about key pairs, see Key Pairs in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTImportKeyPair parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action508' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - KeyName - PublicKeyMaterial type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
KeyName:
type: string
description: A unique name for the key pair.
PublicKeyMaterial:
type: string
description: The public key. For API calls, the text must be base64-encoded. For command line tools, base64 encoding is performed for you.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ImportKeyPairResult'
deprecated: false
/#Action=ImportSnapshot:
get:
summary: GET ImportSnapshot
description: Imports a disk into an EBS snapshot.
operationId: GETImportSnapshot
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientData.Comment
in: query
description: >-
Describes the client-specific data.
A user-defined comment about the disk upload.
style: form
explode: true
schema:
type: string
- name: ClientData.UploadEnd
in: query
description: >-
Describes the client-specific data.
The time that the disk upload ends.
style: form
explode: true
schema:
type: string
- name: ClientData.UploadSize
in: query
description: >-
Describes the client-specific data.
The size of the uploaded disk image, in GiB.
style: form
explode: true
schema:
type: string
- name: ClientData.UploadStart
in: query
description: >-
Describes the client-specific data.
The time that the disk upload starts.
style: form
explode: true
schema:
type: string
- name: ClientToken
in: query
description: Token to enable idempotency for VM import requests.
style: form
explode: true
schema:
type: string
- name: Description
in: query
description: The description string for the import snapshot task.
style: form
explode: true
schema:
type: string
- name: DiskContainer.Description
in: query
description: >-
The disk container object for the import snapshot request.
The description of the disk image being imported.
style: form
explode: true
schema:
type: string
- name: DiskContainer.Format
in: query
description: >-
The disk container object for the import snapshot request.
The format of the disk image being imported.
Valid values: VHD | VMDK
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Encrypted
in: query
description: Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
type: boolean
- name: KmsKeyId
in: query
description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
' style: form explode: true schema: type: string - name: RoleName in: query description: The name of the role to use when not using the default role, 'vmimport'. style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action510' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ImportSnapshotResult' - description: Contains the output for ImportSnapshot. deprecated: false post: summary: POST ImportSnapshot description: Imports a disk into an EBS snapshot. operationId: POSTImportSnapshot parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action510' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: ClientData.Comment: type: string description: >- Describes the client-specific data. A user-defined comment about the disk upload. ClientData.UploadEnd: type: string description: >- Describes the client-specific data. The time that the disk upload ends. ClientData.UploadSize: type: string description: >- Describes the client-specific data. The size of the uploaded disk image, in GiB. ClientData.UploadStart: type: string description: >- Describes the client-specific data. The time that the disk upload starts. ClientToken: type: string description: Token to enable idempotency for VM import requests. Description: type: string description: The description string for the import snapshot task. DiskContainer.Description: type: string description: >- The disk container object for the import snapshot request. The description of the disk image being imported. DiskContainer.Format: type: string description: >- The disk container object for the import snapshot request.The format of the disk image being imported.
Valid values: VHD | VMDK
DryRunOperation. Otherwise, it is UnauthorizedOperation.
Encrypted:
type: boolean
description: Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
KmsKeyId:
type: string
description: 'An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.
The CMK identifier may be provided in any of the following formats:
Key ID
Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef.
ARN using key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
AWS parses KmsKeyId asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.
The specified CMK must exist in the Region that the snapshot is being copied to.
' RoleName: type: string description: The name of the role to use when not using the default role, 'vmimport'. required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ImportSnapshotResult' - description: Contains the output for ImportSnapshot. deprecated: false /#Action=ImportVolume: get: summary: GET ImportVolume description:Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.
For information about the import manifest referenced by this API action, see VM Import Manifest.
operationId: GETImportVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AvailabilityZone in: query description: The Availability Zone for the resulting EBS volume. required: true style: form explode: true schema: type: string - name: Description in: query description: A description of the volume. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Image.Bytes
in: query
description: >-
Describes a disk image.
The size of the disk image, in GiB.
style: form
explode: true
schema:
type: string
- name: Image.Format
in: query
description: >-
Describes a disk image.
The disk image format.
style: form
explode: true
schema:
type: string
- name: Image.ImportManifestUrl
in: query
description: >-
Describes a disk image.
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.
style: form explode: true schema: type: string - name: Volume.Size in: query description: >- Describes an EBS volume. The size of the volume, in GiB. style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action512' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ImportVolumeResult' - description: Contains the output for ImportVolume. deprecated: false post: summary: POST ImportVolume description:Creates an import volume task using metadata from the specified disk image.For more information, see Importing Disks to Amazon EBS.
For information about the import manifest referenced by this API action, see VM Import Manifest.
operationId: POSTImportVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action512' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AvailabilityZone type: object properties: AvailabilityZone: type: string description: The Availability Zone for the resulting EBS volume. Description: type: string description: A description of the volume. DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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.Bytes:
type: string
description: >-
Describes a disk image.
The size of the disk image, in GiB.
Image.Format:
type: string
description: >-
Describes a disk image.
The disk image format.
Image.ImportManifestUrl:
type: string
description: >-
Describes a disk image.
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.
Volume.Size: type: string description: >- Describes an EBS volume. The size of the volume, in GiB. required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ImportVolumeResult' - description: Contains the output for ImportVolume. deprecated: false /#Action=ModifyCapacityReservation: get: summary: GET 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. operationId: GETModifyCapacityReservation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CapacityReservationId in: query description: The ID of the Capacity Reservation. required: true style: form explode: true schema: type: string - name: InstanceCount in: query description: The number of instances for which to reserve capacity. style: form explode: true schema: type: integer format: int32 - name: EndDate in: query 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.
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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action514'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyCapacityReservationResult'
deprecated: false
post:
summary: 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.
operationId: POSTModifyCapacityReservation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action514'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- CapacityReservationId
type: object
properties:
CapacityReservationId:
type: string
description: The ID of the Capacity Reservation.
InstanceCount:
type: integer
description: The number of instances for which to reserve capacity.
format: int32
EndDate:
type: string
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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyCapacityReservationResult'
deprecated: false
/#Action=ModifyClientVpnEndpoint:
get:
summary: GET ModifyClientVpnEndpoint
description: Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections.
operationId: GETModifyClientVpnEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint to modify.
required: true
style: form
explode: true
schema:
type: string
- name: ServerCertificateArn
in: query
description: The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).
style: form
explode: true
schema:
type: string
- name: ConnectionLogOptions.Enabled
in: query
description: >-
Describes the client connection logging options for the Client VPN endpoint.
Indicates whether connection logging is enabled.
style: form
explode: true
schema:
type: string
- name: ConnectionLogOptions.CloudwatchLogGroup
in: query
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log group.
style: form
explode: true
schema:
type: string
- name: ConnectionLogOptions.CloudwatchLogStream
in: query
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log stream to which the connection data is published.
style: form
explode: true
schema:
type: string
- name: DnsServers.CustomDnsServers
in: query
description: >-
Information about the DNS server to be used.
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: DnsServers.Enabled
in: query
description: >-
Information about the DNS server to be used.
Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
style: form
explode: true
schema:
type: string
- name: Description
in: query
description: A brief description of the Client VPN endpoint.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action516'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyClientVpnEndpointResult'
deprecated: false
post:
summary: POST ModifyClientVpnEndpoint
description: Modifies the specified Client VPN endpoint. You can only modify an endpoint's server certificate information, client connection logging information, DNS server, and description. Modifying the DNS server resets existing client connections.
operationId: POSTModifyClientVpnEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action516'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint to modify.
ServerCertificateArn:
type: string
description: The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM).
ConnectionLogOptions.Enabled:
type: string
description: >-
Describes the client connection logging options for the Client VPN endpoint.
Indicates whether connection logging is enabled.
ConnectionLogOptions.CloudwatchLogGroup:
type: string
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log group.
ConnectionLogOptions.CloudwatchLogStream:
type: string
description: >-
Describes the client connection logging options for the Client VPN endpoint.
The name of the CloudWatch Logs log stream to which the connection data is published.
DnsServers.CustomDnsServers:
type: array
items:
type: string
description: >-
Information about the DNS server to be used.
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.
DnsServers.Enabled:
type: string
description: >-
Information about the DNS server to be used.
Indicates whether DNS servers should be used. Specify False to delete the existing DNS servers.
Description:
type: string
description: A brief description of the Client VPN endpoint.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyClientVpnEndpointResult'
deprecated: false
/#Action=ModifyFleet:
get:
summary: GET ModifyFleet
description: Modifies the specified EC2 Fleet.
While the EC2 Fleet is being modified, it is in the modifying state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ExcessCapacityTerminationPolicy
in: query
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.
style: form
explode: true
schema:
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.
- name: FleetId
in: query
description: The ID of the EC2 Fleet.
required: true
style: form
explode: true
schema:
type: string
- name: TargetCapacitySpecification.TotalTargetCapacity
in: query
description: >-
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.
The number of units to request, filled using DefaultTargetCapacityType.
style: form
explode: true
schema:
type: string
- name: TargetCapacitySpecification.OnDemandTargetCapacity
in: query
description: >-
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.
The number of On-Demand units to request.
style: form
explode: true
schema:
type: string
- name: TargetCapacitySpecification.SpotTargetCapacity
in: query
description: >-
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.
The number of Spot units to request.
style: form
explode: true
schema:
type: string
- name: TargetCapacitySpecification.DefaultTargetCapacityType
in: query
description: >-
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.
The default TotalTargetCapacity, which is either Spot or On-Demand.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action518'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyFleetResult'
deprecated: false
post:
summary: POST ModifyFleet
description: Modifies the specified EC2 Fleet.
While the EC2 Fleet is being modified, it is in the modifying state.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
ExcessCapacityTerminationPolicy:
allOf:
- $ref: '#/components/schemas/ExcessCapacityTerminationPolicy2'
- 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.
FleetId:
type: string
description: The ID of the EC2 Fleet.
TargetCapacitySpecification.TotalTargetCapacity:
type: string
description: >-
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.
The number of units to request, filled using DefaultTargetCapacityType.
TargetCapacitySpecification.OnDemandTargetCapacity:
type: string
description: >-
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.
The number of On-Demand units to request.
TargetCapacitySpecification.SpotTargetCapacity:
type: string
description: >-
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.
The number of Spot units to request.
TargetCapacitySpecification.DefaultTargetCapacityType:
type: string
description: >-
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.
The default TotalTargetCapacity, which is either Spot or On-Demand.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyFleetResult'
deprecated: false
/#Action=ModifyFpgaImageAttribute:
get:
summary: GET ModifyFpgaImageAttribute
description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
operationId: GETModifyFpgaImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: FpgaImageId
in: query
description: The ID of the AFI.
required: true
style: form
explode: true
schema:
type: string
- name: Attribute
in: query
description: The name of the attribute.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/FpgaImageAttributeName'
- description: The name of the attribute.
- name: OperationType
in: query
description: The operation type.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/OperationType'
- description: The operation type.
- name: UserId
in: query
description: The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.
style: form
explode: true
schema:
type: array
items:
type: string
- name: UserGroup
in: query
description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
style: form
explode: true
schema:
type: array
items:
type: string
- name: ProductCode
in: query
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LoadPermission.Add
in: query
description: >-
Describes modifications to the load permissions of an Amazon FPGA image (AFI).
The load permissions to add.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LoadPermission.Remove
in: query
description: >-
Describes modifications to the load permissions of an Amazon FPGA image (AFI).
The load permissions to remove.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Description
in: query
description: A description for the AFI.
style: form
explode: true
schema:
type: string
- name: Name
in: query
description: A name for the AFI.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action520'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyFpgaImageAttributeResult'
deprecated: false
post:
summary: POST ModifyFpgaImageAttribute
description: Modifies the specified attribute of the specified Amazon FPGA Image (AFI).
operationId: POSTModifyFpgaImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action520'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- FpgaImageId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the AFI.
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute15'
- description: The name of the attribute.
OperationType:
allOf:
- $ref: '#/components/schemas/OperationType2'
- description: The operation type.
UserId:
type: array
items:
type: string
description: The AWS account IDs. This parameter is valid only when modifying the loadPermission attribute.
UserGroup:
type: array
items:
type: string
description: The user groups. This parameter is valid only when modifying the loadPermission attribute.
ProductCode:
type: array
items:
type: string
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.Add:
type: array
items:
type: string
description: >-
Describes modifications to the load permissions of an Amazon FPGA image (AFI).
The load permissions to add.
LoadPermission.Remove:
type: array
items:
type: string
description: >-
Describes modifications to the load permissions of an Amazon FPGA image (AFI).
The load permissions to remove.
Description:
type: string
description: A description for the AFI.
Name:
type: string
description: A name for the AFI.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyFpgaImageAttributeResult'
deprecated: false
/#Action=ModifyHosts:
get:
summary: 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.
operationId: GETModifyHosts
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: AutoPlacement
in: query
description: Specify whether to enable or disable auto-placement.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/AutoPlacement'
- description: Specify whether to enable or disable auto-placement.
- name: HostId
in: query
description: The IDs of the Dedicated Hosts to modify.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action522'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyHostsResult'
deprecated: false
post:
summary: 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.
operationId: POSTModifyHosts
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action522'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- AutoPlacement
- HostId
type: object
properties:
AutoPlacement:
allOf:
- $ref: '#/components/schemas/AutoPlacement4'
- description: Specify whether to enable or disable auto-placement.
HostId:
type: array
items:
type: string
description: The IDs of the Dedicated Hosts to modify.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyHostsResult'
deprecated: false
/#Action=ModifyIdFormat:
get:
summary: 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 AWS 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 AWS 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 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.
required: true
style: form
explode: true
schema:
type: string
- name: Resource
in: query
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.
all to modify the ID format for all IAM users, IAM roles, and the root user of the account.
Resource:
type: 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.
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description, LaunchPermission, or ProductCode.
AWS Marketplace product codes cannot be modified. Images with an AWS 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.
' operationId: GETModifyImageAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Attribute in: query description: The name of the attribute to modify. The valid values aredescription, launchPermission, and productCodes.
style: form
explode: true
schema:
type: string
- name: Description.Value
in: query
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
style: form
explode: true
schema:
type: string
- name: ImageId
in: query
description: The ID of the AMI.
required: true
style: form
explode: true
schema:
type: string
- name: LaunchPermission.Add
in: query
description: >-
Describes a launch permission modification.
The AWS account ID to add to the list of launch permissions for the AMI.
style: form
explode: true
schema:
type: array
items:
type: string
- name: LaunchPermission.Remove
in: query
description: >-
Describes a launch permission modification.
The AWS account ID to remove from the list of launch permissions for the AMI.
style: form
explode: true
schema:
type: array
items:
type: string
- name: OperationType
in: query
description: The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/OperationType'
- description: The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
- name: ProductCode
in: query
description: The DevPay product codes. After you add a product code to an AMI, it can't be removed.
style: form
explode: true
schema:
type: array
items:
type: string
- name: UserGroup
in: query
description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
style: form
explode: true
schema:
type: array
items:
type: string
- name: UserId
in: query
description: The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Value
in: query
description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action528'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ModifyImageAttribute
description: 'Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description, LaunchPermission, or ProductCode.
AWS Marketplace product codes cannot be modified. Images with an AWS 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.
' operationId: POSTModifyImageAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action528' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ImageId type: object properties: Attribute: type: string description: The name of the attribute to modify. The valid values aredescription, launchPermission, and productCodes.
Description.Value:
type: string
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
ImageId:
type: string
description: The ID of the AMI.
LaunchPermission.Add:
type: array
items:
type: string
description: >-
Describes a launch permission modification.
The AWS account ID to add to the list of launch permissions for the AMI.
LaunchPermission.Remove:
type: array
items:
type: string
description: >-
Describes a launch permission modification.
The AWS account ID to remove from the list of launch permissions for the AMI.
OperationType:
allOf:
- $ref: '#/components/schemas/OperationType4'
- description: The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
ProductCode:
type: array
items:
type: string
description: The DevPay product codes. After you add a product code to an AMI, it can't be removed.
UserGroup:
type: array
items:
type: string
description: The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
UserId:
type: array
items:
type: string
description: The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
Value:
type: string
description: The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ModifyInstanceAttribute:
get:
summary: 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 in a VPC 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 Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.
' operationId: GETModifyInstanceAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: SourceDestCheck.Value in: query description: >- Describes a value for a resource attribute that is a Boolean value. The attribute value. The valid values aretrue or false.
style: form
explode: true
schema:
type: string
- name: Attribute
in: query
description: The name of the attribute.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/InstanceAttributeName'
- description: The name of the attribute.
- name: BlockDeviceMapping
in: query
description: Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
style: form explode: true schema: type: array items: type: string - name: DisableApiTermination.Value in: query description: >- Describes a value for a resource attribute that is a Boolean value. The attribute value. The valid values aretrue or false.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EbsOptimized.Value
in: query
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
style: form
explode: true
schema:
type: string
- name: EnaSupport.Value
in: query
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
style: form
explode: true
schema:
type: string
- name: GroupId
in: query
description: "[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name."
style: form
explode: true
schema:
type: array
items:
type: string
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: InstanceInitiatedShutdownBehavior.Value
in: query
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
style: form
explode: true
schema:
type: string
- name: InstanceType.Value
in: query
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
style: form
explode: true
schema:
type: string
- name: Kernel.Value
in: query
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
style: form
explode: true
schema:
type: string
- name: Ramdisk.Value
in: query
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
style: form
explode: true
schema:
type: string
- name: SriovNetSupport.Value
in: query
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
style: form
explode: true
schema:
type: string
- name: UserData.Value
in: query
description: Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
style: form
explode: true
schema:
type: string
- name: Value
in: query
description: A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action530'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 in a VPC 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 Modifying Attributes of a Stopped Instance in the Amazon Elastic Compute Cloud User Guide.
' operationId: POSTModifyInstanceAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action530' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: SourceDestCheck.Value: type: string description: >- Describes a value for a resource attribute that is a Boolean value. The attribute value. The valid values aretrue or false.
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute17'
- description: The name of the attribute.
BlockDeviceMapping:
type: array
items:
type: string
description: Modifies the DeleteOnTermination attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for DeleteOnTermination, the default is true and the volume is deleted when the instance is terminated.
To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see Updating the Block Device Mapping when Launching an Instance in the Amazon Elastic Compute Cloud User Guide.
DisableApiTermination.Value: type: string description: >- Describes a value for a resource attribute that is a Boolean value. The attribute value. The valid values aretrue or false.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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.Value:
type: string
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
EnaSupport.Value:
type: string
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
GroupId:
type: array
items:
type: string
description: "[EC2-VPC] Changes the security groups of the instance. You must specify at least one security group, even if it's just the default security group for the VPC. You must specify the security group ID, not the security group name."
InstanceId:
type: string
description: The ID of the instance.
InstanceInitiatedShutdownBehavior.Value:
type: string
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
InstanceType.Value:
type: string
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
Kernel.Value:
type: string
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
Ramdisk.Value:
type: string
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
SriovNetSupport.Value:
type: string
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
UserData.Value:
type: string
description: Changes the instance's user data to the specified value. If you are using an AWS SDK or command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text.
Value:
type: string
description: A new value for the attribute. Use only with the kernel, ramdisk, userData, disableApiTermination, or instanceInitiatedShutdownBehavior attribute.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ModifyInstanceCapacityReservationAttributes:
get:
summary: 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 any open Capacity Reservation with matching attributes, or run On-Demand Instance capacity.
operationId: GETModifyInstanceCapacityReservationAttributes
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: InstanceId
in: query
description: The ID of the instance to be modified.
required: true
style: form
explode: true
schema:
type: string
- name: CapacityReservationSpecification.CapacityReservationPreference
in: query
description: >-
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.
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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action532'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
deprecated: false
post:
summary: 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.
operationId: POSTModifyInstanceCapacityReservationAttributes
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action532'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InstanceId
type: object
properties:
InstanceId:
type: string
description: The ID of the instance to be modified.
CapacityReservationSpecification.CapacityReservationPreference:
type: string
description: >-
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.
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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyInstanceCapacityReservationAttributesResult'
deprecated: false
/#Action=ModifyInstanceCreditSpecification:
get:
summary: GET ModifyInstanceCreditSpecification
description: Modifies the credit option for CPU usage on a running or stopped T2 or T3 instance. The credit options are standard and unlimited.
For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.
operationId: GETModifyInstanceCreditSpecification parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ClientToken
in: query
description: A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
style: form
explode: true
schema:
type: string
- name: InstanceCreditSpecification
in: query
description: Information about the credit option for CPU usage.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action534'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult'
deprecated: false
post:
summary: POST ModifyInstanceCreditSpecification
description: Modifies the credit option for CPU usage on a running or stopped T2 or T3 instance. The credit options are standard and unlimited.
For more information, see Burstable Performance Instances in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTModifyInstanceCreditSpecification parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action534' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceCreditSpecification type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency.
InstanceCreditSpecification:
type: array
items:
type: string
description: Information about the credit option for CPU usage.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyInstanceCreditSpecificationResult'
deprecated: false
/#Action=ModifyInstanceEventStartTime:
get:
summary: GET ModifyInstanceEventStartTime
description: Modifies the start time for a scheduled Amazon EC2 instance event.
operationId: GETModifyInstanceEventStartTime
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance with the scheduled event.
required: true
style: form
explode: true
schema:
type: string
- name: InstanceEventId
in: query
description: The ID of the event whose date and time you are modifying.
required: true
style: form
explode: true
schema:
type: string
- name: NotBefore
in: query
description: The new date and time when the event will take place.
required: true
style: form
explode: true
schema:
type: string
format: date-time
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action536'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyInstanceEventStartTimeResult'
deprecated: false
post:
summary: POST ModifyInstanceEventStartTime
description: Modifies the start time for a scheduled Amazon EC2 instance event.
operationId: POSTModifyInstanceEventStartTime
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action536'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InstanceId
- InstanceEventId
- NotBefore
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the instance with the scheduled event.
InstanceEventId:
type: string
description: The ID of the event whose date and time you are modifying.
NotBefore:
type: string
description: The new date and time when the event will take place.
format: date-time
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyInstanceEventStartTimeResult'
deprecated: false
/#Action=ModifyInstancePlacement:
get:
summary: GET 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 from host to dedicated, or from dedicated to host.
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 ("").
style: form explode: true schema: type: string - name: HostId in: query description: The ID of the Dedicated Host with which to associate the instance. style: form explode: true schema: type: string - name: InstanceId in: query description: The ID of the instance that you are modifying. required: true style: form explode: true schema: type: string - name: Tenancy in: query description: The tenancy for the instance. style: form explode: true schema: allOf: - $ref: '#/components/schemas/HostTenancy' - description: The tenancy for the instance. - name: PartitionNumber in: query description: Reserved for future use. style: form explode: true schema: type: integer format: int32 - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action538' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ModifyInstancePlacementResult' deprecated: false post: summary: 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 from host to dedicated, or from dedicated to host.
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 ("").
HostId: type: string description: The ID of the Dedicated Host with which to associate the instance. InstanceId: type: string description: The ID of the instance that you are modifying. Tenancy: allOf: - $ref: '#/components/schemas/Tenancy4' - description: The tenancy for the instance. PartitionNumber: type: integer description: Reserved for future use. format: int32 required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ModifyInstancePlacementResult' deprecated: false /#Action=ModifyLaunchTemplate: get: summary: 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. operationId: GETModifyLaunchTemplate parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ClientToken
in: query
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.
' style: form explode: true schema: type: string - name: LaunchTemplateId in: query description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. style: form explode: true schema: type: string - name: LaunchTemplateName in: query description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. style: form explode: true schema: maxLength: 128 minLength: 3 pattern: '[a-zA-Z0-9\(\)\.\-/_]+' type: string - name: SetDefaultVersion in: query description: The version number of the launch template to set as the default version. style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action540' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ModifyLaunchTemplateResult' deprecated: false post: summary: POST 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. operationId: POSTModifyLaunchTemplate parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action540' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: 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: type: string description: The ID of the launch template. You must specify either the launch template ID or launch template name in the request. LaunchTemplateName: maxLength: 128 minLength: 3 pattern: '[a-zA-Z0-9\(\)\.\-/_]+' type: string description: The name of the launch template. You must specify either the launch template ID or launch template name in the request. SetDefaultVersion: type: string description: The version number of the launch template to set as the default version. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ModifyLaunchTemplateResult' deprecated: false /#Action=ModifyNetworkInterfaceAttribute: get: summary: 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. operationId: GETModifyNetworkInterfaceAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Attachment.AttachmentId in: query description: >- Describes an attachment change. The ID of the network interface attachment. style: form explode: true schema: type: string - name: Attachment.DeleteOnTermination in: query description: >- Describes an attachment change. Indicates whether the network interface is deleted when the instance is terminated. style: form explode: true schema: type: string - name: Description.Value in: query description: >- Describes a value for a resource attribute that is a String. The attribute value. The value is case-sensitive. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: SecurityGroupId
in: query
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: SourceDestCheck.Value
in: query
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action542'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTModifyNetworkInterfaceAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action542'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkInterfaceId
type: object
properties:
Attachment.AttachmentId:
type: string
description: >-
Describes an attachment change.
The ID of the network interface attachment.
Attachment.DeleteOnTermination:
type: string
description: >-
Describes an attachment change.
Indicates whether the network interface is deleted when the instance is terminated.
Description.Value:
type: string
description: >-
Describes a value for a resource attribute that is a String.
The attribute value. The value is case-sensitive.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
SecurityGroupId:
type: array
items:
type: string
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:
type: string
description: The ID of the network interface.
SourceDestCheck.Value:
type: string
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ModifyReservedInstances:
get:
summary: GET ModifyReservedInstances
description: Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. 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 Elastic Compute Cloud User Guide.
operationId: GETModifyReservedInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ReservedInstancesId in: query description: The IDs of the Reserved Instances to modify. required: true style: form explode: true schema: type: array items: type: string - name: ClientToken in: query description: A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency. style: form explode: true schema: type: string - name: ReservedInstancesConfigurationSetItemType in: query description: The configuration settings for the Reserved Instances to modify. required: true style: form explode: true schema: type: array items: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action544' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ModifyReservedInstancesResult' - description: Contains the output of ModifyReservedInstances. deprecated: false post: summary: POST ModifyReservedInstances description:Modifies the Availability Zone, instance count, instance type, or network platform (EC2-Classic or EC2-VPC) of your Reserved Instances. 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 Elastic Compute Cloud User Guide.
operationId: POSTModifyReservedInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action544' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ReservedInstancesId - ReservedInstancesConfigurationSetItemType type: object properties: ReservedInstancesId: type: array items: type: string description: The IDs of the Reserved Instances to modify. ClientToken: type: string description: A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see Ensuring Idempotency. ReservedInstancesConfigurationSetItemType: type: array items: type: string description: The configuration settings for the Reserved Instances to modify. required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ModifyReservedInstancesResult' - description: Contains the output of ModifyReservedInstances. deprecated: false /#Action=ModifySnapshotAttribute: get: summary: GET ModifySnapshotAttribute description:Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.
Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
operationId: GETModifySnapshotAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Attribute in: query description: The snapshot attribute to modify. Only volume creation permissions can be modified. style: form explode: true schema: allOf: - $ref: '#/components/schemas/SnapshotAttributeName' - description: The snapshot attribute to modify. Only volume creation permissions can be modified. - name: CreateVolumePermission.Add in: query description: >- Describes modifications to the list of create volume permissions for a volume. Adds the specified AWS account ID or group to the list. style: form explode: true schema: type: array items: type: string - name: CreateVolumePermission.Remove in: query description: >- Describes modifications to the list of create volume permissions for a volume. Removes the specified AWS account ID or group from the list. style: form explode: true schema: type: array items: type: string - name: UserGroup in: query description: The group to modify for the snapshot. style: form explode: true schema: type: array items: type: string - name: OperationType in: query description: The type of operation to perform to the attribute. style: form explode: true schema: allOf: - $ref: '#/components/schemas/OperationType' - description: The type of operation to perform to the attribute. - name: SnapshotId in: query description: The ID of the snapshot. required: true style: form explode: true schema: type: string - name: UserId in: query description: The account ID to modify for the snapshot. style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action546'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ModifySnapshotAttribute
description: Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.
Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.
For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTModifySnapshotAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action546' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - SnapshotId type: object properties: Attribute: allOf: - $ref: '#/components/schemas/Attribute19' - description: The snapshot attribute to modify. Only volume creation permissions can be modified. CreateVolumePermission.Add: type: array items: type: string description: >- Describes modifications to the list of create volume permissions for a volume. Adds the specified AWS account ID or group to the list. CreateVolumePermission.Remove: type: array items: type: string description: >- Describes modifications to the list of create volume permissions for a volume. Removes the specified AWS account ID or group from the list. UserGroup: type: array items: type: string description: The group to modify for the snapshot. OperationType: allOf: - $ref: '#/components/schemas/OperationType6' - description: The type of operation to perform to the attribute. SnapshotId: type: string description: The ID of the snapshot. UserId: type: array items: type: string description: The account ID to modify for the snapshot. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ModifySpotFleetRequest:
get:
summary: GET ModifySpotFleetRequest
description: Modifies the specified Spot Fleet request.
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 pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot pools.
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 diversified, the Spot Fleet terminates instances across the Spot 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.
operationId: GETModifySpotFleetRequest parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ExcessCapacityTerminationPolicy in: query description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. style: form explode: true schema: allOf: - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy' - description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. - name: SpotFleetRequestId in: query description: The ID of the Spot Fleet request. required: true style: form explode: true schema: type: string - name: TargetCapacity in: query description: The size of the fleet. style: form explode: true schema: type: integer format: int32 - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action548' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ModifySpotFleetRequestResponse' - description: Contains the output of ModifySpotFleetRequest. deprecated: false post: summary: POST ModifySpotFleetRequest description:Modifies the specified Spot Fleet request.
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 pool with the lowest price. If the allocation strategy is diversified, the Spot Fleet distributes the instances across the Spot pools.
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 diversified, the Spot Fleet terminates instances across the Spot 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.
operationId: POSTModifySpotFleetRequest parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action548' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - SpotFleetRequestId type: object properties: ExcessCapacityTerminationPolicy: allOf: - $ref: '#/components/schemas/ExcessCapacityTerminationPolicy6' - description: Indicates whether running Spot Instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. SpotFleetRequestId: type: string description: The ID of the Spot Fleet request. TargetCapacity: type: integer description: The size of the fleet. format: int32 required: false responses: '200': description: Success headers: {} content: '*/*': schema: allOf: - $ref: '#/components/schemas/ModifySpotFleetRequestResponse' - description: Contains the output of ModifySpotFleetRequest. deprecated: false /#Action=ModifySubnetAttribute: get: summary: GET ModifySubnetAttribute description: Modifies a subnet attribute. You can only modify one attribute at a time. operationId: GETModifySubnetAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AssignIpv6AddressOnCreation.Value in: query description: >- Describes a value for a resource attribute that is a Boolean value. The attribute value. The valid values aretrue or false.
style: form
explode: true
schema:
type: string
- name: MapPublicIpOnLaunch.Value
in: query
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
style: form
explode: true
schema:
type: string
- name: SubnetId
in: query
description: The ID of the subnet.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action550'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ModifySubnetAttribute
description: Modifies a subnet attribute. You can only modify one attribute at a time.
operationId: POSTModifySubnetAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action550'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- SubnetId
type: object
properties:
AssignIpv6AddressOnCreation.Value:
type: string
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
MapPublicIpOnLaunch.Value:
type: string
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
SubnetId:
type: string
description: The ID of the subnet.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ModifyTransitGatewayVpcAttachment:
get:
summary: GET ModifyTransitGatewayVpcAttachment
description: Modifies the specified VPC attachment.
operationId: GETModifyTransitGatewayVpcAttachment
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
required: true
style: form
explode: true
schema:
type: string
- name: AddSubnetIds
in: query
description: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
style: form
explode: true
schema:
type: array
items:
type: string
- name: RemoveSubnetIds
in: query
description: The IDs of one or more subnets to remove.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Options.DnsSupport
in: query
description: >-
Describes the options for a VPC attachment.
Enable or disable DNS support. The default is enable.
style: form
explode: true
schema:
type: string
- name: Options.Ipv6Support
in: query
description: >-
Describes the options for a VPC attachment.
Enable or disable IPv6 support. The default is enable.
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action552'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
deprecated: false
post:
summary: POST ModifyTransitGatewayVpcAttachment
description: Modifies the specified VPC attachment.
operationId: POSTModifyTransitGatewayVpcAttachment
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action552'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
AddSubnetIds:
type: array
items:
type: string
description: The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone.
RemoveSubnetIds:
type: array
items:
type: string
description: The IDs of one or more subnets to remove.
Options.DnsSupport:
type: string
description: >-
Describes the options for a VPC attachment.
Enable or disable DNS support. The default is enable.
Options.Ipv6Support:
type: string
description: >-
Describes the options for a VPC attachment.
Enable or disable IPv6 support. The default is enable.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentResult'
deprecated: false
/#Action=ModifyVolume:
get:
summary: 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 may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.
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 information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending 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 the DescribeVolumesModifications API. For information about tracking status changes using either method, see Monitoring Volume Modifications.
With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux and Modifying the Size, IOPS, or Type of an EBS Volume on Windows.
If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.
operationId: GETModifyVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VolumeId
in: query
description: The ID of the volume.
required: true
style: form
explode: true
schema:
type: string
- name: Size
in: query
description: 'The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see Amazon EBS Volume Types.
Default: If no size is specified, the existing size is retained.
' style: form explode: true schema: type: integer format: int32 - name: VolumeType in: query description: 'The target EBS volume type of the volume.
Default: If no type is specified, the existing type is retained.
' style: form explode: true schema: allOf: - $ref: '#/components/schemas/VolumeType' - description: 'The target EBS volume type of the volume.
Default: If no type is specified, the existing type is retained.
' - name: Iops in: query description: 'The target IOPS rate of the volume.
This is only valid for Provisioned IOPS SSD (io1) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes.
Default: If no IOPS value is specified, the existing value is retained.
' style: form explode: true schema: type: integer format: int32 - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action554' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ModifyVolumeResult' deprecated: false post: summary: 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 may be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying an EBS volume running Linux, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux. For more information about modifying an EBS volume running Windows, see Modifying the Size, IOPS, or Type of an EBS Volume on Windows.
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 information about extending a Linux file system, see Extending a Linux File System. For information about extending a Windows file system, see Extending 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 the DescribeVolumesModifications API. For information about tracking status changes using either method, see Monitoring Volume Modifications.
With previous-generation instance types, resizing an EBS volume may require detaching and reattaching the volume or stopping and restarting the instance. For more information, see Modifying the Size, IOPS, or Type of an EBS Volume on Linux and Modifying the Size, IOPS, or Type of an EBS Volume on Windows.
If you reach the maximum volume modification rate per volume limit, you will need to wait at least six hours before applying further modifications to the affected EBS volume.
operationId: POSTModifyVolume parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action554' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VolumeId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
VolumeId:
type: string
description: The ID of the volume.
Size:
type: integer
description: 'The target size of the volume, in GiB. The target volume size must be greater than or equal to than the existing size of the volume. For information about available EBS volume sizes, see Amazon EBS Volume Types.
Default: If no size is specified, the existing size is retained.
' format: int32 VolumeType: allOf: - $ref: '#/components/schemas/VolumeType4' - description: 'The target EBS volume type of the volume.
Default: If no type is specified, the existing type is retained.
' Iops: type: integer description: 'The target IOPS rate of the volume.
This is only valid for Provisioned IOPS SSD (io1) volumes. For more information, see Provisioned IOPS SSD (io1) Volumes.
Default: If no IOPS value is specified, the existing value is retained.
' format: int32 required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ModifyVolumeResult' deprecated: false /#Action=ModifyVolumeAttribute: get: summary: GET 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.
operationId: GETModifyVolumeAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AutoEnableIO.Value in: query description: >- Describes a value for a resource attribute that is a Boolean value. The attribute value. The valid values aretrue or false.
style: form
explode: true
schema:
type: string
- name: VolumeId
in: query
description: The ID of the volume.
required: true
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action556'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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.
operationId: POSTModifyVolumeAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action556' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VolumeId type: object properties: AutoEnableIO.Value: type: string description: >- Describes a value for a resource attribute that is a Boolean value. The attribute value. The valid values aretrue or false.
VolumeId:
type: string
description: The ID of the volume.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ModifyVpcAttribute:
get:
summary: GET ModifyVpcAttribute
description: Modifies the specified attribute of the specified VPC.
operationId: GETModifyVpcAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: EnableDnsHostnames.Value
in: query
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
style: form
explode: true
schema:
type: string
- name: EnableDnsSupport.Value
in: query
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
style: form
explode: true
schema:
type: string
- name: VpcId
in: query
description: The ID of the VPC.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action558'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ModifyVpcAttribute
description: Modifies the specified attribute of the specified VPC.
operationId: POSTModifyVpcAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action558'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcId
type: object
properties:
EnableDnsHostnames.Value:
type: string
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
EnableDnsSupport.Value:
type: string
description: >-
Describes a value for a resource attribute that is a Boolean value.
The attribute value. The valid values are true or false.
VpcId:
type: string
description: The ID of the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ModifyVpcEndpoint:
get:
summary: GET ModifyVpcEndpoint
description: Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface or gateway). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
operationId: GETModifyVpcEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcEndpointId
in: query
description: The ID of the endpoint.
required: true
style: form
explode: true
schema:
type: string
- name: ResetPolicy
in: query
description: (Gateway endpoint) Specify true to reset the policy document to the default policy. The default policy allows full access to the service.
style: form
explode: true
schema:
type: boolean
- name: PolicyDocument
in: query
description: 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.
style: form
explode: true
schema:
type: string
- name: AddRouteTableId
in: query
description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
style: form
explode: true
schema:
type: array
items:
type: string
- name: RemoveRouteTableId
in: query
description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
style: form
explode: true
schema:
type: array
items:
type: string
- name: AddSubnetId
in: query
description: (Interface endpoint) One or more subnet IDs in which to serve the endpoint.
style: form
explode: true
schema:
type: array
items:
type: string
- name: RemoveSubnetId
in: query
description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
style: form
explode: true
schema:
type: array
items:
type: string
- name: AddSecurityGroupId
in: query
description: (Interface endpoint) One or more security group IDs to associate with the network interface.
style: form
explode: true
schema:
type: array
items:
type: string
- name: RemoveSecurityGroupId
in: query
description: (Interface endpoint) One or more security group IDs to disassociate from the network interface.
style: form
explode: true
schema:
type: array
items:
type: string
- name: PrivateDnsEnabled
in: query
description: (Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action560'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointResult'
deprecated: false
post:
summary: POST ModifyVpcEndpoint
description: Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface or gateway). For more information, see VPC Endpoints in the Amazon Virtual Private Cloud User Guide.
operationId: POSTModifyVpcEndpoint
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action560'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcEndpointId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the endpoint.
ResetPolicy:
type: 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:
type: string
description: 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.
AddRouteTableId:
type: array
items:
type: string
description: (Gateway endpoint) One or more route tables IDs to associate with the endpoint.
RemoveRouteTableId:
type: array
items:
type: string
description: (Gateway endpoint) One or more route table IDs to disassociate from the endpoint.
AddSubnetId:
type: array
items:
type: string
description: (Interface endpoint) One or more subnet IDs in which to serve the endpoint.
RemoveSubnetId:
type: array
items:
type: string
description: (Interface endpoint) One or more subnets IDs in which to remove the endpoint.
AddSecurityGroupId:
type: array
items:
type: string
description: (Interface endpoint) One or more security group IDs to associate with the network interface.
RemoveSecurityGroupId:
type: array
items:
type: string
description: (Interface endpoint) One or more security group IDs to disassociate from the network interface.
PrivateDnsEnabled:
type: boolean
description: (Interface endpoint) Indicate whether a private hosted zone is associated with the VPC.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointResult'
deprecated: false
/#Action=ModifyVpcEndpointConnectionNotification:
get:
summary: 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. '
operationId: GETModifyVpcEndpointConnectionNotification
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ConnectionNotificationId
in: query
description: The ID of the notification.
required: true
style: form
explode: true
schema:
type: string
- name: ConnectionNotificationArn
in: query
description: The ARN for the SNS topic for the notification.
style: form
explode: true
schema:
type: string
- name: ConnectionEvents
in: query
description: One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action562'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
deprecated: false
post:
summary: 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. '
operationId: POSTModifyVpcEndpointConnectionNotification
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action562'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ConnectionNotificationId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the notification.
ConnectionNotificationArn:
type: string
description: The ARN for the SNS topic for the notification.
ConnectionEvents:
type: array
items:
type: string
description: One or more events for the endpoint. Valid values are Accept, Connect, Delete, and Reject.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointConnectionNotificationResult'
deprecated: false
/#Action=ModifyVpcEndpointServiceConfiguration:
get:
summary: GET ModifyVpcEndpointServiceConfiguration
description: Modifies the attributes of your VPC endpoint service configuration. You can change the Network 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.
operationId: GETModifyVpcEndpointServiceConfiguration
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The ID of the service.
required: true
style: form
explode: true
schema:
type: string
- name: AcceptanceRequired
in: query
description: Indicate whether requests to create an endpoint to your service must be accepted.
style: form
explode: true
schema:
type: boolean
- name: AddNetworkLoadBalancerArn
in: query
description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
style: form
explode: true
schema:
type: array
items:
type: string
- name: RemoveNetworkLoadBalancerArn
in: query
description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action564'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult'
deprecated: false
post:
summary: POST ModifyVpcEndpointServiceConfiguration
description: Modifies the attributes of your VPC endpoint service configuration. You can change the Network 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.
operationId: POSTModifyVpcEndpointServiceConfiguration
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action564'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ServiceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the service.
AcceptanceRequired:
type: boolean
description: Indicate whether requests to create an endpoint to your service must be accepted.
AddNetworkLoadBalancerArn:
type: array
items:
type: string
description: The Amazon Resource Names (ARNs) of Network Load Balancers to add to your service configuration.
RemoveNetworkLoadBalancerArn:
type: array
items:
type: string
description: The Amazon Resource Names (ARNs) of Network Load Balancers to remove from your service configuration.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointServiceConfigurationResult'
deprecated: false
/#Action=ModifyVpcEndpointServicePermissions:
get:
summary: GET ModifyVpcEndpointServicePermissions
description: Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) 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.
operationId: GETModifyVpcEndpointServicePermissions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The ID of the service.
required: true
style: form
explode: true
schema:
type: string
- name: AddAllowedPrincipals
in: query
description: The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
style: form
explode: true
schema:
type: array
items:
type: string
- name: RemoveAllowedPrincipals
in: query
description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action566'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult'
deprecated: false
post:
summary: POST ModifyVpcEndpointServicePermissions
description: Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (IAM users, IAM roles, and AWS accounts) 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.
operationId: POSTModifyVpcEndpointServicePermissions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action566' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ServiceId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: string
description: The ID of the service.
AddAllowedPrincipals:
type: array
items:
type: string
description: The Amazon Resource Names (ARN) of one or more principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (*).
RemoveAllowedPrincipals:
type: array
items:
type: string
description: The Amazon Resource Names (ARN) of one or more principals. Permissions are revoked for principals in this list.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcEndpointServicePermissionsResult'
deprecated: false
/#Action=ModifyVpcPeeringConnectionOptions:
get:
summary: GET ModifyVpcPeeringConnectionOptions
description: Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same AWS 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 AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS 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.
operationId: GETModifyVpcPeeringConnectionOptions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AccepterPeeringConnectionOptions.AllowDnsResolutionFromRemoteVpc in: query description: >- The VPC peering connection options. If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. style: form explode: true schema: type: string - name: AccepterPeeringConnectionOptions.AllowEgressFromLocalClassicLinkToRemoteVpc in: query description: >- The VPC peering connection options. If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC. style: form explode: true schema: type: string - name: AccepterPeeringConnectionOptions.AllowEgressFromLocalVpcToRemoteClassicLink in: query description: >- The VPC peering connection options. If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: RequesterPeeringConnectionOptions.AllowDnsResolutionFromRemoteVpc
in: query
description: >-
The VPC peering connection options.
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
style: form
explode: true
schema:
type: string
- name: RequesterPeeringConnectionOptions.AllowEgressFromLocalClassicLinkToRemoteVpc
in: query
description: >-
The VPC peering connection options.
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
style: form
explode: true
schema:
type: string
- name: RequesterPeeringConnectionOptions.AllowEgressFromLocalVpcToRemoteClassicLink
in: query
description: >-
The VPC peering connection options.
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
style: form
explode: true
schema:
type: string
- name: VpcPeeringConnectionId
in: query
description: The ID of the VPC peering connection.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action568'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult'
deprecated: false
post:
summary: POST ModifyVpcPeeringConnectionOptions
description: Modifies the VPC peering connection options on one side of a VPC peering connection. You can do the following:
Enable/disable communication over the peering connection between an EC2-Classic instance that's linked to your VPC (using ClassicLink) and instances in the peer VPC.
Enable/disable communication over the peering connection between instances in your VPC and an EC2-Classic instance that's linked to the peer VPC.
Enable/disable the ability to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
If the peered VPCs are in the same AWS 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 AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS 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.
operationId: POSTModifyVpcPeeringConnectionOptions parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action568' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpcPeeringConnectionId type: object properties: AccepterPeeringConnectionOptions.AllowDnsResolutionFromRemoteVpc: type: string description: >- The VPC peering connection options. If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC. AccepterPeeringConnectionOptions.AllowEgressFromLocalClassicLinkToRemoteVpc: type: string description: >- The VPC peering connection options. If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC. AccepterPeeringConnectionOptions.AllowEgressFromLocalVpcToRemoteClassicLink: type: string description: >- The VPC peering connection options. If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
RequesterPeeringConnectionOptions.AllowDnsResolutionFromRemoteVpc:
type: string
description: >-
The VPC peering connection options.
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.
RequesterPeeringConnectionOptions.AllowEgressFromLocalClassicLinkToRemoteVpc:
type: string
description: >-
The VPC peering connection options.
If true, enables outbound communication from an EC2-Classic instance that's linked to a local VPC using ClassicLink to instances in a peer VPC.
RequesterPeeringConnectionOptions.AllowEgressFromLocalVpcToRemoteClassicLink:
type: string
description: >-
The VPC peering connection options.
If true, enables outbound communication from instances in a local VPC to an EC2-Classic instance that's linked to a peer VPC using ClassicLink.
VpcPeeringConnectionId:
type: string
description: The ID of the VPC peering connection.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcPeeringConnectionOptionsResult'
deprecated: false
/#Action=ModifyVpcTenancy:
get:
summary: 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 Elastic Compute Cloud User Guide.
operationId: GETModifyVpcTenancy parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: VpcId in: query description: The ID of the VPC. required: true style: form explode: true schema: type: string - name: InstanceTenancy in: query description: The instance tenancy attribute for the VPC. required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/VpcTenancy' - description: The instance tenancy attribute for the VPC. - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action570'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcTenancyResult'
deprecated: false
post:
summary: 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 Elastic Compute Cloud User Guide.
operationId: POSTModifyVpcTenancy parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action570' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpcId - InstanceTenancy type: object properties: VpcId: type: string description: The ID of the VPC. InstanceTenancy: allOf: - $ref: '#/components/schemas/InstanceTenancy5' - description: The instance tenancy attribute for the VPC. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpcTenancyResult'
deprecated: false
/#Action=ModifyVpnConnection:
get:
summary: GET ModifyVpnConnection
description: Modifies the target gateway of a AWS Site-to-Site VPN connection. 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 VPN Gateway Target Modification Required VPC Route Table Updates in the AWS 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 AWS 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 AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your s2slong; connection will be temporarily unavailable for approximately 10 minutes while we provision the new endpoints
operationId: GETModifyVpnConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: VpnConnectionId in: query description: The ID of the VPN connection. required: true style: form explode: true schema: type: string - name: TransitGatewayId in: query description: The ID of the transit gateway. style: form explode: true schema: type: string - name: VpnGatewayId in: query description: The ID of the virtual private gateway at the AWS side of the VPN connection. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action572'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpnConnectionResult'
deprecated: false
post:
summary: POST ModifyVpnConnection
description: Modifies the target gateway of a AWS Site-to-Site VPN connection. 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 VPN Gateway Target Modification Required VPC Route Table Updates in the AWS 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 AWS 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 AWS VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your s2slong; connection will be temporarily unavailable for approximately 10 minutes while we provision the new endpoints
operationId: POSTModifyVpnConnection parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action572' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - VpnConnectionId type: object properties: VpnConnectionId: type: string description: The ID of the VPN connection. TransitGatewayId: type: string description: The ID of the transit gateway. VpnGatewayId: type: string description: The ID of the virtual private gateway at the AWS side of the VPN connection. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ModifyVpnConnectionResult'
deprecated: false
/#Action=MonitorInstances:
get:
summary: GET MonitorInstances
description: Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
To disable detailed monitoring, see .
operationId: GETMonitorInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceId in: query description: The IDs of the instances. required: true style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action574'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/MonitorInstancesResult'
deprecated: false
post:
summary: POST MonitorInstances
description: Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
To disable detailed monitoring, see .
operationId: POSTMonitorInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action574' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: InstanceId: type: array items: type: string description: The IDs of the instances. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/MonitorInstancesResult'
deprecated: false
/#Action=MoveAddressToVpc:
get:
summary: GET MoveAddressToVpc
description: '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. '
operationId: GETMoveAddressToVpc
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: PublicIp
in: query
description: The Elastic IP address.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action576'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/MoveAddressToVpcResult'
deprecated: false
post:
summary: POST MoveAddressToVpc
description: '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. '
operationId: POSTMoveAddressToVpc
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action576'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- PublicIp
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The Elastic IP address.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/MoveAddressToVpcResult'
deprecated: false
/#Action=ProvisionByoipCidr:
get:
summary: GET ProvisionByoipCidr
description: Provisions an address range for use with your AWS 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.
AWS 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 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action578'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ProvisionByoipCidrResult'
deprecated: false
post:
summary: POST ProvisionByoipCidr
description: Provisions an address range for use with your AWS 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.
AWS 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 address pool, use AllocateAddress with either the specific address from the address pool or the ID of the address pool.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ProvisionByoipCidrResult'
deprecated: false
/#Action=PurchaseHostReservation:
get:
summary: 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.
operationId: GETPurchaseHostReservation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientToken
in: query
description: Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
style: form
explode: true
schema:
type: string
- name: CurrencyCode
in: query
description: The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
style: form
explode: true
schema:
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.
- name: HostIdSet
in: query
description: The IDs of the Dedicated Hosts with which the reservation will be associated.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: LimitPrice
in: query
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.
style: form
explode: true
schema:
type: string
- name: OfferingId
in: query
description: The ID of the offering.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action580'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/PurchaseHostReservationResult'
deprecated: false
post:
summary: 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.
operationId: POSTPurchaseHostReservation
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action580'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- HostIdSet
- OfferingId
type: object
properties:
ClientToken:
type: string
description: Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
CurrencyCode:
allOf:
- $ref: '#/components/schemas/CurrencyCode1'
- description: The currency in which the totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
HostIdSet:
type: array
items:
type: string
description: The IDs of the Dedicated Hosts with which the reservation will be associated.
LimitPrice:
type: 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:
type: string
description: The ID of the offering.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/PurchaseHostReservationResult'
deprecated: false
/#Action=PurchaseReservedInstancesOffering:
get:
summary: 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.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
operationId: GETPurchaseReservedInstancesOffering parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceCount in: query description: The number of Reserved Instances to purchase. required: true style: form explode: true schema: type: integer format: int32 - name: ReservedInstancesOfferingId in: query description: The ID of the Reserved Instance offering to purchase. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: LimitPrice.Amount
in: query
description: >-
Describes the limit price of a Reserved Instance offering.
Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
style: form
explode: true
schema:
type: string
- name: LimitPrice.CurrencyCode
in: query
description: >-
Describes the limit price of a Reserved Instance offering.
The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action582'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult'
- description: Contains the output of PurchaseReservedInstancesOffering.
deprecated: false
post:
summary: 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.
For more information, see Reserved Instances and Reserved Instance Marketplace in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTPurchaseReservedInstancesOffering parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action582' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceCount - ReservedInstancesOfferingId type: object properties: InstanceCount: type: integer description: The number of Reserved Instances to purchase. format: int32 ReservedInstancesOfferingId: type: string description: The ID of the Reserved Instance offering to purchase. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
LimitPrice.Amount:
type: string
description: >-
Describes the limit price of a Reserved Instance offering.
Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount * price).
LimitPrice.CurrencyCode:
type: string
description: >-
Describes the limit price of a Reserved Instance offering.
The currency in which the limitPrice amount is specified. At this time, the only supported currency is USD.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/PurchaseReservedInstancesOfferingResult'
- description: Contains the output of PurchaseReservedInstancesOffering.
deprecated: false
/#Action=PurchaseScheduledInstances:
get:
summary: GET PurchaseScheduledInstances
description: 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.
operationId: GETPurchaseScheduledInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientToken in: query description: Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: PurchaseRequest
in: query
description: The purchase requests.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action584'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/PurchaseScheduledInstancesResult'
- description: Contains the output of PurchaseScheduledInstances.
deprecated: false
post:
summary: POST PurchaseScheduledInstances
description: 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.
operationId: POSTPurchaseScheduledInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action584' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - PurchaseRequest type: object properties: ClientToken: type: string description: Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
PurchaseRequest:
type: array
items:
type: string
description: The purchase requests.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/PurchaseScheduledInstancesResult'
- description: Contains the output of PurchaseScheduledInstances.
deprecated: false
/#Action=RebootInstances:
get:
summary: 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 four minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.
operationId: GETRebootInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceId in: query description: The instance IDs. required: true style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action586'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 four minutes, Amazon EC2 performs a hard reboot.
For more information about troubleshooting, see Getting Console Output and Rebooting Instances in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTRebootInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action586' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: InstanceId: type: array items: type: string description: The instance IDs. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=RegisterImage:
get:
summary: 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 Creating Your Own AMIs 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.
You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and instances launched from such an AMI are not able to connect to package update infrastructure. If you purchase a Reserved Instance offering for one of these Linux distributions and launch instances using an AMI that does not contain the required billing code, your Reserved Instance is not applied to these instances.
To create an AMI for operating systems that require a billing code, see CreateImage.
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.
operationId: GETRegisterImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ImageLocation in: query description: The full path to your AMI manifest in Amazon S3 storage. style: form explode: true schema: type: string - name: Architecture in: query 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 architecture of the AMI.
Default: For Amazon EBS-backed AMIs, i386. For instance store-backed AMIs, the architecture specified in the manifest file.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EnaSupport
in: query
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.
style: form explode: true schema: type: boolean - name: KernelId in: query description: The ID of the kernel. style: form explode: true schema: type: string - name: Name in: query description: "A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
" required: true style: form explode: true schema: type: string - name: BillingProduct in: query description: The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI. style: form explode: true schema: type: array items: type: string - name: RamdiskId in: query description: The ID of the RAM disk. style: form explode: true schema: type: string - name: RootDeviceName in: query description: The device name of the root device volume (for example,/dev/sda1).
style: form
explode: true
schema:
type: string
- name: SriovNetSupport
in: query
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.
style: form explode: true schema: type: string - name: VirtualizationType in: query description: 'The type of virtualization (hvm | paravirtual).
Default: paravirtual
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 Creating Your Own AMIs 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.
You can also use RegisterImage to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using the block device mapping. For more information, see Launching a Linux Instance from a Backup in the Amazon Elastic Compute Cloud User Guide.
You can't register an image where a secondary (non-root) snapshot has AWS Marketplace product codes.
Some Linux distributions, such as Red Hat Enterprise Linux (RHEL) and SUSE Linux Enterprise Server (SLES), use the EC2 billing product code associated with an AMI to verify the subscription status for package updates. Creating an AMI from an EBS snapshot does not maintain this billing code, and instances launched from such an AMI are not able to connect to package update infrastructure. If you purchase a Reserved Instance offering for one of these Linux distributions and launch instances using an AMI that does not contain the required billing code, your Reserved Instance is not applied to these instances.
To create an AMI for operating systems that require a billing code, see CreateImage.
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.
operationId: POSTRegisterImage parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action588' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Name type: object properties: ImageLocation: type: string description: The full path to your AMI manifest in Amazon S3 storage. Architecture: allOf: - $ref: '#/components/schemas/Architecture1' - 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.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
EnaSupport:
type: boolean
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: type: string description: The ID of the kernel. Name: type: string description: "A name for your AMI.
Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(_)
" BillingProduct: type: array items: type: string description: The billing product codes. Your account must be authorized to specify billing product codes. Otherwise, you can use the AWS Marketplace to bill for the use of an AMI. RamdiskId: type: string description: The ID of the RAM disk. RootDeviceName: type: string description: The device name of the root device volume (for example,/dev/sda1).
SriovNetSupport:
type: string
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: type: string description: 'The type of virtualization (hvm | paravirtual).
Default: paravirtual
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.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action590'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RejectTransitGatewayVpcAttachmentResult'
deprecated: false
post:
summary: 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.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RejectTransitGatewayVpcAttachmentResult'
deprecated: false
/#Action=RejectVpcEndpointConnections:
get:
summary: GET RejectVpcEndpointConnections
description: Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
operationId: GETRejectVpcEndpointConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: ServiceId
in: query
description: The ID of the service.
required: true
style: form
explode: true
schema:
type: string
- name: VpcEndpointId
in: query
description: The IDs of one or more VPC endpoints.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action592'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RejectVpcEndpointConnectionsResult'
deprecated: false
post:
summary: POST RejectVpcEndpointConnections
description: Rejects one or more VPC endpoint connection requests to your VPC endpoint service.
operationId: POSTRejectVpcEndpointConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action592'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ServiceId
- VpcEndpointId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the service.
VpcEndpointId:
type: array
items:
type: string
description: The IDs of one or more VPC endpoints.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RejectVpcEndpointConnectionsResult'
deprecated: false
/#Action=RejectVpcPeeringConnection:
get:
summary: 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.
operationId: GETRejectVpcPeeringConnection
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: VpcPeeringConnectionId
in: query
description: The ID of the VPC peering connection.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action594'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
deprecated: false
post:
summary: 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.
operationId: POSTRejectVpcPeeringConnection
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action594'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- VpcPeeringConnectionId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the VPC peering connection.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RejectVpcPeeringConnectionResult'
deprecated: false
/#Action=ReleaseAddress:
get:
summary: GET ReleaseAddress
description: Releases the specified Elastic IP address.
[EC2-Classic, 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 AWS account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
operationId: GETReleaseAddress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AllocationId in: query description: '[EC2-VPC] The allocation ID. Required for EC2-VPC.' style: form explode: true schema: type: string - name: PublicIp in: query description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action596'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ReleaseAddress
description: Releases the specified Elastic IP address.
[EC2-Classic, 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 AWS account.
[EC2-VPC] After you release an Elastic IP address for use in a VPC, you might be able to recover it. For more information, see AllocateAddress.
operationId: POSTReleaseAddress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action596' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: AllocationId: type: string description: '[EC2-VPC] The allocation ID. Required for EC2-VPC.' PublicIp: type: string description: '[EC2-Classic] The Elastic IP address. Required for EC2-Classic.' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ReleaseHosts:
get:
summary: 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.
operationId: GETReleaseHosts parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: HostId in: query description: The IDs of the Dedicated Hosts to release. required: true style: form explode: true schema: type: array items: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action598' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ReleaseHostsResult' deprecated: false post: summary: 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.
operationId: POSTReleaseHosts parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action598' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - HostId type: object properties: HostId: type: array items: type: string description: The IDs of the Dedicated Hosts to release. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ReleaseHostsResult' deprecated: false /#Action=ReplaceIamInstanceProfileAssociation: get: summary: GET 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.
operationId: GETReplaceIamInstanceProfileAssociation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: IamInstanceProfile.Arn in: query description: >- Describes an IAM instance profile. The Amazon Resource Name (ARN) of the instance profile. style: form explode: true schema: type: string - name: IamInstanceProfile.Name in: query description: >- Describes an IAM instance profile. The name of the instance profile. style: form explode: true schema: type: string - name: AssociationId in: query description: The ID of the existing IAM instance profile association. required: true style: form explode: true schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action600' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' deprecated: false post: summary: 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.
operationId: POSTReplaceIamInstanceProfileAssociation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action600' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AssociationId type: object properties: IamInstanceProfile.Arn: type: string description: >- Describes an IAM instance profile. The Amazon Resource Name (ARN) of the instance profile. IamInstanceProfile.Name: type: string description: >- Describes an IAM instance profile. The name of the instance profile. AssociationId: type: string description: The ID of the existing IAM instance profile association. required: false responses: '200': description: Success headers: {} content: '*/*': schema: $ref: '#/components/schemas/ReplaceIamInstanceProfileAssociationResult' deprecated: false /#Action=ReplaceNetworkAclAssociation: get: summary: 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 Virtual Private Cloud User Guide.
This is an idempotent operation.
operationId: GETReplaceNetworkAclAssociation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AssociationId in: query description: The ID of the current association between the original network ACL and the subnet. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NetworkAclId
in: query
description: The ID of the new network ACL to associate with the subnet.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action602'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ReplaceNetworkAclAssociationResult'
deprecated: false
post:
summary: 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 Virtual Private Cloud User Guide.
This is an idempotent operation.
operationId: POSTReplaceNetworkAclAssociation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action602' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AssociationId - NetworkAclId type: object properties: AssociationId: type: string description: The ID of the current association between the original network ACL and the subnet. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
NetworkAclId:
type: string
description: The ID of the new network ACL to associate with the subnet.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ReplaceNetworkAclAssociationResult'
deprecated: false
/#Action=ReplaceNetworkAclEntry:
get:
summary: GET ReplaceNetworkAclEntry
description: Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
operationId: GETReplaceNetworkAclEntry
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: CidrBlock
in: query
description: The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
style: form
explode: true
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Egress
in: query
description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' required: true style: form explode: true schema: type: boolean - name: Icmp.Code in: query description: >- Describes the ICMP type and code. The ICMP code. A value of -1 means all codes for the specified ICMP type. style: form explode: true schema: type: string - name: Icmp.Type in: query description: >- Describes the ICMP type and code. The ICMP type. A value of -1 means all types. style: form explode: true schema: type: string - name: Ipv6CidrBlock in: query description: The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).
style: form
explode: true
schema:
type: string
- name: NetworkAclId
in: query
description: The ID of the ACL.
required: true
style: form
explode: true
schema:
type: string
- name: PortRange.From
in: query
description: >-
Describes a range of ports.
The first port in the range.
style: form
explode: true
schema:
type: string
- name: PortRange.To
in: query
description: >-
Describes a range of ports.
The last port in the range.
style: form
explode: true
schema:
type: string
- name: Protocol
in: query
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.
required: true
style: form
explode: true
schema:
type: string
- name: RuleAction
in: query
description: Indicates whether to allow or deny the traffic that matches the rule.
required: true
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/RuleAction'
- description: Indicates whether to allow or deny the traffic that matches the rule.
- name: RuleNumber
in: query
description: The rule number of the entry to replace.
required: true
style: form
explode: true
schema:
type: integer
format: int32
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action604'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ReplaceNetworkAclEntry
description: Replaces an entry (rule) in a network ACL. For more information, see Network ACLs in the Amazon Virtual Private Cloud User Guide.
operationId: POSTReplaceNetworkAclEntry
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action604'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Egress
- NetworkAclId
- Protocol
- RuleAction
- RuleNumber
type: object
properties:
CidrBlock:
type: string
description: The IPv4 network range to allow or deny, in CIDR notation (for example 172.16.0.0/24).
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: boolean
description: 'Indicates whether to replace the egress rule.
Default: If no value is specified, we replace the ingress rule.
' Icmp.Code: type: string description: >- Describes the ICMP type and code. The ICMP code. A value of -1 means all codes for the specified ICMP type. Icmp.Type: type: string description: >- Describes the ICMP type and code. The ICMP type. A value of -1 means all types. Ipv6CidrBlock: type: string description: The IPv6 network range to allow or deny, in CIDR notation (for example2001:bd8:1234:1a00::/64).
NetworkAclId:
type: string
description: The ID of the ACL.
PortRange.From:
type: string
description: >-
Describes a range of ports.
The first port in the range.
PortRange.To:
type: string
description: >-
Describes a range of ports.
The last port in the range.
Protocol:
type: string
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/RuleAction2'
- description: Indicates whether to allow or deny the traffic that matches the rule.
RuleNumber:
type: integer
description: The rule number of the entry to replace.
format: int32
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ReplaceRoute:
get:
summary: GET ReplaceRoute
description: 'Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
' operationId: GETReplaceRoute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DestinationCidrBlock in: query 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. style: form explode: true schema: type: string - name: DestinationIpv6CidrBlock in: query 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. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EgressOnlyInternetGatewayId
in: query
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
style: form
explode: true
schema:
type: string
- name: GatewayId
in: query
description: The ID of an internet gateway or virtual private gateway.
style: form
explode: true
schema:
type: string
- name: InstanceId
in: query
description: The ID of a NAT instance in your VPC.
style: form
explode: true
schema:
type: string
- name: NatGatewayId
in: query
description: '[IPv4 traffic only] The ID of a NAT gateway.'
style: form
explode: true
schema:
type: string
- name: TransitGatewayId
in: query
description: The ID of a transit gateway.
style: form
explode: true
schema:
type: string
- name: NetworkInterfaceId
in: query
description: The ID of a network interface.
style: form
explode: true
schema:
type: string
- name: RouteTableId
in: query
description: The ID of the route table.
required: true
style: form
explode: true
schema:
type: string
- name: VpcPeeringConnectionId
in: query
description: The ID of a VPC peering connection.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action606'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ReplaceRoute
description: 'Replaces an existing route within a route table in a VPC. You must provide only one of the following: internet gateway or virtual private gateway, NAT instance, NAT gateway, VPC peering connection, network interface, or egress-only internet gateway.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
' operationId: POSTReplaceRoute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action606' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - RouteTableId type: object properties: DestinationCidrBlock: type: string 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: type: string 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. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
EgressOnlyInternetGatewayId:
type: string
description: '[IPv6 traffic only] The ID of an egress-only internet gateway.'
GatewayId:
type: string
description: The ID of an internet gateway or virtual private gateway.
InstanceId:
type: string
description: The ID of a NAT instance in your VPC.
NatGatewayId:
type: string
description: '[IPv4 traffic only] The ID of a NAT gateway.'
TransitGatewayId:
type: string
description: The ID of a transit gateway.
NetworkInterfaceId:
type: string
description: The ID of a network interface.
RouteTableId:
type: string
description: The ID of the route table.
VpcPeeringConnectionId:
type: string
description: The ID of a VPC peering connection.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ReplaceRouteTableAssociation:
get:
summary: GET ReplaceRouteTableAssociation
description: Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.
operationId: GETReplaceRouteTableAssociation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AssociationId in: query description: The association ID. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: RouteTableId
in: query
description: The ID of the new route table to associate with the subnet.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action608'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ReplaceRouteTableAssociationResult'
deprecated: false
post:
summary: POST ReplaceRouteTableAssociation
description: Changes the route table associated with a given subnet in a VPC. After the operation completes, the subnet uses the routes in the new route table it's associated with. For more information about route tables, see Route Tables in the Amazon Virtual Private Cloud User Guide.
You can also use ReplaceRouteTableAssociation to change which table is the main route table in the VPC. You just specify the main route table's association ID and the route table to be the new main route table.
operationId: POSTReplaceRouteTableAssociation parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action608' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - AssociationId - RouteTableId type: object properties: AssociationId: type: string description: The association ID. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
RouteTableId:
type: string
description: The ID of the new route table to associate with the subnet.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ReplaceRouteTableAssociationResult'
deprecated: false
/#Action=ReplaceTransitGatewayRoute:
get:
summary: GET ReplaceTransitGatewayRoute
description: Replaces the specified route in the specified transit gateway route table.
operationId: GETReplaceTransitGatewayRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DestinationCidrBlock
in: query
description: The CIDR range used for the destination match. Routing decisions are based on the most specific match.
required: true
style: form
explode: true
schema:
type: string
- name: TransitGatewayRouteTableId
in: query
description: The ID of the route table.
required: true
style: form
explode: true
schema:
type: string
- name: TransitGatewayAttachmentId
in: query
description: The ID of the attachment.
style: form
explode: true
schema:
type: string
- name: Blackhole
in: query
description: Indicates whether traffic matching this route is to be dropped.
style: form
explode: true
schema:
type: boolean
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action610'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ReplaceTransitGatewayRouteResult'
deprecated: false
post:
summary: POST ReplaceTransitGatewayRoute
description: Replaces the specified route in the specified transit gateway route table.
operationId: POSTReplaceTransitGatewayRoute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action610'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- DestinationCidrBlock
- TransitGatewayRouteTableId
type: object
properties:
DestinationCidrBlock:
type: string
description: The CIDR range used for the destination match. Routing decisions are based on the most specific match.
TransitGatewayRouteTableId:
type: string
description: The ID of the route table.
TransitGatewayAttachmentId:
type: string
description: The ID of the attachment.
Blackhole:
type: boolean
description: Indicates whether traffic matching this route is to be dropped.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ReplaceTransitGatewayRouteResult'
deprecated: false
/#Action=ReportInstanceStatus:
get:
summary: 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.
operationId: GETReportInstanceStatus parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Description in: query description: Descriptive text about the health state of your instance. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: EndTime
in: query
description: The time at which the reported instance health state ended.
style: form
explode: true
schema:
type: string
format: date-time
- name: InstanceId
in: query
description: The instances.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: ReasonCode
in: query
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.
operationId: POSTReportInstanceStatus parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action612' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId - ReasonCode - Status type: object properties: Description: type: string description: Descriptive text about the health state of your instance. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
EndTime:
type: string
description: The time at which the reported instance health state ended.
format: date-time
InstanceId:
type: array
items:
type: string
description: The instances.
ReasonCode:
type: array
items:
type: string
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]
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 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 Instances. You cannot tag other resource types in a Spot Fleet request because only the instance resource type is supported.
For more information, see Spot Fleet Requests in the Amazon EC2 User Guide for Linux Instances.
operationId: GETRequestSpotFleet parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: SpotFleetRequestConfig.AllocationStrategy
in: query
description: >-
Describes the configuration of a Spot Fleet request.
Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.OnDemandAllocationStrategy
in: query
description: >-
Describes the configuration of a Spot Fleet request.
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.ClientToken
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.ExcessCapacityTerminationPolicy
in: query
description: >-
Describes the configuration of a Spot Fleet request.
Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.FulfilledCapacity
in: query
description: >-
Describes the configuration of a Spot Fleet request.
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.OnDemandFulfilledCapacity
in: query
description: >-
Describes the configuration of a Spot Fleet request.
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.IamFleetRole
in: query
description: >-
Describes the configuration of a Spot Fleet request.
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.LaunchSpecifications
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: SpotFleetRequestConfig.LaunchTemplateConfigs
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: SpotFleetRequestConfig.SpotPrice
in: query
description: >-
Describes the configuration of a Spot Fleet request.
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.TargetCapacity
in: query
description: >-
Describes the configuration of a Spot Fleet request.
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.OnDemandTargetCapacity
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.TerminateInstancesWithExpiration
in: query
description: >-
Describes the configuration of a Spot Fleet request.
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.Type
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.ValidFrom
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.ValidUntil
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.ReplaceUnhealthyInstances
in: query
description: >-
Describes the configuration of a Spot Fleet request.
Indicates whether Spot Fleet should replace unhealthy instances.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.InstanceInterruptionBehavior
in: query
description: >-
Describes the configuration of a Spot Fleet request.
The behavior when a Spot Instance is interrupted. The default is terminate.
style: form
explode: true
schema:
type: string
- name: SpotFleetRequestConfig.LoadBalancersConfig
in: query
description: >-
Describes the configuration of a Spot Fleet request.
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.
style: form explode: true schema: type: string - name: SpotFleetRequestConfig.InstancePoolsToUseCount in: query description: >- Describes the configuration of a Spot Fleet request. The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set tolowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action614'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/RequestSpotFleetResponse'
- description: Contains the output of RequestSpotFleet.
deprecated: false
post:
summary: 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 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 Instances. You cannot tag other resource types in a Spot Fleet request because only the instance resource type is supported.
For more information, see Spot Fleet Requests in the Amazon EC2 User Guide for Linux Instances.
operationId: POSTRequestSpotFleet parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action614' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
SpotFleetRequestConfig.AllocationStrategy:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
Indicates how to allocate the target capacity across the Spot pools specified by the Spot Fleet request. The default is lowestPrice.
SpotFleetRequestConfig.OnDemandAllocationStrategy:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify lowestPrice, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify prioritized, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to lowestPrice.
SpotFleetRequestConfig.ClientToken:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.ExcessCapacityTerminationPolicy:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
Indicates whether running Spot Instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.
SpotFleetRequestConfig.FulfilledCapacity:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.
SpotFleetRequestConfig.OnDemandFulfilledCapacity:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.
SpotFleetRequestConfig.IamFleetRole:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see Spot Fleet Prerequisites in the Amazon EC2 User Guide for Linux Instances. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using CancelSpotFleetRequests or when the Spot Fleet request expires, if you set TerminateInstancesWithExpiration.
SpotFleetRequestConfig.LaunchSpecifications:
type: array
items:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.LaunchTemplateConfigs:
type: array
items:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.SpotPrice:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
The maximum price per unit hour that you are willing to pay for a Spot Instance. The default is the On-Demand price.
SpotFleetRequestConfig.TargetCapacity:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is maintain, you can specify a target capacity of 0 and add capacity later.
SpotFleetRequestConfig.OnDemandTargetCapacity:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.TerminateInstancesWithExpiration:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.
SpotFleetRequestConfig.Type:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.ValidFrom:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.ValidUntil:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.ReplaceUnhealthyInstances:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
Indicates whether Spot Fleet should replace unhealthy instances.
SpotFleetRequestConfig.InstanceInterruptionBehavior:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
The behavior when a Spot Instance is interrupted. The default is terminate.
SpotFleetRequestConfig.LoadBalancersConfig:
type: string
description: >-
Describes the configuration of a Spot Fleet request.
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.
SpotFleetRequestConfig.InstancePoolsToUseCount: type: string description: >- Describes the configuration of a Spot Fleet request. The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot AllocationStrategy is set tolowest-price. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/RequestSpotFleetResponse'
- description: Contains the output of RequestSpotFleet.
deprecated: false
/#Action=RequestSpotInstances:
get:
summary: GET RequestSpotInstances
description: Creates a Spot Instance request.
For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances.
operationId: GETRequestSpotInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: AvailabilityZoneGroup in: query 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.
' style: form explode: true schema: type: string - name: BlockDurationMinutes in: query description:The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
style: form explode: true schema: type: integer format: int32 - name: ClientToken in: query 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. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceCount
in: query
description: 'The maximum number of Spot Instances to launch.
Default: 1
' style: form explode: true schema: type: integer format: int32 - name: LaunchGroup in: query description: 'The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
' style: form explode: true schema: type: string - name: LaunchSpecification.SecurityGroupIds in: query description: >- Describes the launch specification for an instance. One or more security group IDs. style: form explode: true schema: type: array items: type: string - name: LaunchSpecification.SecurityGroups in: query description: >- Describes the launch specification for an instance. One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups. style: form explode: true schema: type: array items: type: string - name: LaunchSpecification.AddressingType in: query description: >- Describes the launch specification for an instance. Deprecated. style: form explode: true schema: type: string - name: LaunchSpecification.BlockDeviceMappings in: query description: >- Describes the launch specification for an instance. One or more 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. style: form explode: true schema: type: array items: type: string - name: LaunchSpecification.EbsOptimized in: query description: >- Describes the launch specification for an instance.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
style: form explode: true schema: type: string - name: LaunchSpecification.NetworkInterfaces in: query description: >- Describes the launch specification for an instance. One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface. style: form explode: true schema: type: array items: type: string - name: LaunchSpecification.Placement in: query description: >- Describes the launch specification for an instance. The placement information for the instance. style: form explode: true schema: type: string - name: LaunchSpecification.RamdiskId in: query description: >- Describes the launch specification for an instance. The ID of the RAM disk. style: form explode: true schema: type: string - name: LaunchSpecification.SubnetId in: query description: >- Describes the launch specification for an instance. The ID of the subnet in which to launch the instance. style: form explode: true schema: type: string - name: LaunchSpecification.UserData in: query description: >- Describes the launch specification for an instance. The Base64-encoded user data for the instance. User data is limited to 16 KB. style: form explode: true schema: type: string - name: SpotPrice in: query description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. style: form explode: true schema: type: string - name: Type in: query description: 'The Spot Instance request type.
Default: one-time
The Spot Instance request type.
Default: one-time
terminate.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/InstanceInterruptionBehavior'
- description: The behavior when a Spot Instance is interrupted. The default is terminate.
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action616'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/RequestSpotInstancesResult'
- description: Contains the output of RequestSpotInstances.
deprecated: false
post:
summary: POST RequestSpotInstances
description: Creates a Spot Instance request.
For more information, see Spot Instance Requests in the Amazon EC2 User Guide for Linux Instances.
operationId: POSTRequestSpotInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action616' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: AvailabilityZoneGroup: type: string 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: type: integer description:The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).
The duration period starts as soon as your Spot Instance receives its instance ID. At the end of the duration period, Amazon EC2 marks the Spot Instance for termination and provides a Spot Instance termination notice, which gives the instance a two-minute warning before it terminates.
You can't specify an Availability Zone group or a launch group if you specify a duration.
format: int32 ClientToken: type: string 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: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: integer
description: 'The maximum number of Spot Instances to launch.
Default: 1
' format: int32 LaunchGroup: type: string description: 'The instance launch group. Launch groups are Spot Instances that launch together and terminate together.
Default: Instances are launched and terminated individually
' LaunchSpecification.SecurityGroupIds: type: array items: type: string description: >- Describes the launch specification for an instance. One or more security group IDs. LaunchSpecification.SecurityGroups: type: array items: type: string description: >- Describes the launch specification for an instance. One or more security groups. When requesting instances in a VPC, you must specify the IDs of the security groups. When requesting instances in EC2-Classic, you can specify the names or the IDs of the security groups. LaunchSpecification.AddressingType: type: string description: >- Describes the launch specification for an instance. Deprecated. LaunchSpecification.BlockDeviceMappings: type: array items: type: string description: >- Describes the launch specification for an instance. One or more 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. LaunchSpecification.EbsOptimized: type: string description: >- Describes the launch specification for an instance.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
LaunchSpecification.NetworkInterfaces: type: array items: type: string description: >- Describes the launch specification for an instance. One or more network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface. LaunchSpecification.Placement: type: string description: >- Describes the launch specification for an instance. The placement information for the instance. LaunchSpecification.RamdiskId: type: string description: >- Describes the launch specification for an instance. The ID of the RAM disk. LaunchSpecification.SubnetId: type: string description: >- Describes the launch specification for an instance. The ID of the subnet in which to launch the instance. LaunchSpecification.UserData: type: string description: >- Describes the launch specification for an instance. The Base64-encoded user data for the instance. User data is limited to 16 KB. SpotPrice: type: string description: The maximum price per hour that you are willing to pay for a Spot Instance. The default is the On-Demand price. Type: allOf: - $ref: '#/components/schemas/Type7' - description: 'The Spot Instance request type.
Default: one-time
terminate.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
allOf:
- $ref: '#/components/schemas/RequestSpotInstancesResult'
- description: Contains the output of RequestSpotInstances.
deprecated: false
/#Action=ResetFpgaImageAttribute:
get:
summary: 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.
operationId: GETResetFpgaImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: FpgaImageId
in: query
description: The ID of the AFI.
required: true
style: form
explode: true
schema:
type: string
- name: Attribute
in: query
description: The attribute.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/ResetFpgaImageAttributeName'
- description: The attribute.
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action618'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ResetFpgaImageAttributeResult'
deprecated: false
post:
summary: 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.
operationId: POSTResetFpgaImageAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action618'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- FpgaImageId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the AFI.
Attribute:
allOf:
- $ref: '#/components/schemas/Attribute21'
- description: The attribute.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/ResetFpgaImageAttributeResult'
deprecated: false
/#Action=ResetImageAttribute:
get:
summary: GET ResetImageAttribute
description: Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action620'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ResetImageAttribute
description: Resets an attribute of an AMI to its default value.
The productCodes attribute can't be reset.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ResetInstanceAttribute:
get:
summary: 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 Virtual Private Cloud User Guide.
The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.
The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceId
in: query
description: The ID of the instance.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action622'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: 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 Virtual Private Cloud User Guide.
The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.
DryRunOperation. Otherwise, it is UnauthorizedOperation.
InstanceId:
type: string
description: The ID of the instance.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ResetNetworkInterfaceAttribute:
get:
summary: GET ResetNetworkInterfaceAttribute
description: Resets a network interface attribute. You can specify only one attribute at a time.
operationId: GETResetNetworkInterfaceAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: SourceDestCheck
in: query
description: The source/destination checking attribute. Resets the value to true.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action624'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ResetNetworkInterfaceAttribute
description: Resets a network interface attribute. You can specify only one attribute at a time.
operationId: POSTResetNetworkInterfaceAttribute
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action624'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkInterfaceId
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The ID of the network interface.
SourceDestCheck:
type: string
description: The source/destination checking attribute. Resets the value to true.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=ResetSnapshotAttribute:
get:
summary: GET ResetSnapshotAttribute
description: Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
operationId: GETResetSnapshotAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Attribute in: query description: The attribute to reset. Currently, only the attribute for permission to create volumes can be reset. required: true style: form explode: true schema: allOf: - $ref: '#/components/schemas/SnapshotAttributeName' - description: The attribute to reset. Currently, only the attribute for permission to create volumes can be reset. - name: SnapshotId in: query description: The ID of the snapshot. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action626'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST ResetSnapshotAttribute
description: Resets permission settings for the specified snapshot.
For more information about modifying snapshot permissions, see Sharing Snapshots in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTResetSnapshotAttribute parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action626' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Attribute - SnapshotId type: object properties: Attribute: allOf: - $ref: '#/components/schemas/Attribute27' - description: The attribute to reset. Currently, only the attribute for permission to create volumes can be reset. SnapshotId: type: string description: The ID of the snapshot. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=RestoreAddressToClassic:
get:
summary: GET RestoreAddressToClassic
description: 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.
operationId: GETRestoreAddressToClassic
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: PublicIp
in: query
description: The Elastic IP address.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action628'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RestoreAddressToClassicResult'
deprecated: false
post:
summary: POST RestoreAddressToClassic
description: 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.
operationId: POSTRestoreAddressToClassic
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action628'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- PublicIp
type: object
properties:
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without 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:
type: string
description: The Elastic IP address.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RestoreAddressToClassicResult'
deprecated: false
/#Action=RevokeClientVpnIngress:
get:
summary: GET RevokeClientVpnIngress
description: 'Removes an ingress authorization rule from a Client VPN endpoint. '
operationId: GETRevokeClientVpnIngress
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: ClientVpnEndpointId
in: query
description: The ID of the Client VPN endpoint with which the authorization rule is associated.
required: true
style: form
explode: true
schema:
type: string
- name: TargetNetworkCidr
in: query
description: The IPv4 address range, in CIDR notation, of the network for which access is being removed.
required: true
style: form
explode: true
schema:
type: string
- name: AccessGroupId
in: query
description: The ID of the Active Directory group for which to revoke access.
style: form
explode: true
schema:
type: string
- name: RevokeAllGroups
in: query
description: Indicates whether access should be revoked for all clients.
style: form
explode: true
schema:
type: boolean
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action630'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RevokeClientVpnIngressResult'
deprecated: false
post:
summary: POST RevokeClientVpnIngress
description: 'Removes an ingress authorization rule from a Client VPN endpoint. '
operationId: POSTRevokeClientVpnIngress
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action630'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
- TargetNetworkCidr
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint with which the authorization rule is associated.
TargetNetworkCidr:
type: string
description: The IPv4 address range, in CIDR notation, of the network for which access is being removed.
AccessGroupId:
type: string
description: The ID of the Active Directory group for which to revoke access.
RevokeAllGroups:
type: boolean
description: Indicates whether access should be revoked for all clients.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/RevokeClientVpnIngressResult'
deprecated: false
/#Action=RevokeSecurityGroupEgress:
get:
summary: GET RevokeSecurityGroupEgress
description: [VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.
Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. 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 have to specify the description to revoke the rule.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
operationId: GETRevokeSecurityGroupEgress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupId
in: query
description: The ID of the security group.
required: true
style: form
explode: true
schema:
type: string
- name: IpPermissions
in: query
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: CidrIp
in: query
description: Not supported. Use a set of IP permissions to specify the CIDR.
style: form
explode: true
schema:
type: string
- name: FromPort
in: query
description: Not supported. Use a set of IP permissions to specify the port.
style: form
explode: true
schema:
type: integer
format: int32
- name: IpProtocol
in: query
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
style: form
explode: true
schema:
type: string
- name: ToPort
in: query
description: Not supported. Use a set of IP permissions to specify the port.
style: form
explode: true
schema:
type: integer
format: int32
- name: SourceSecurityGroupName
in: query
description: Not supported. Use a set of IP permissions to specify a destination security group.
style: form
explode: true
schema:
type: string
- name: SourceSecurityGroupOwnerId
in: query
description: Not supported. Use a set of IP permissions to specify a destination security group.
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action632'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST RevokeSecurityGroupEgress
description: [VPC only] Removes the specified egress rules from a security group for EC2-VPC. This action doesn't apply to security groups for use in EC2-Classic. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.
Each rule consists of the protocol and the IPv4 or IPv6 CIDR range or source security group. 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 have to specify the description to revoke the rule.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
operationId: POSTRevokeSecurityGroupEgress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action632' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - GroupId type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
GroupId:
type: string
description: The ID of the security group.
IpPermissions:
type: array
items:
type: string
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.
CidrIp:
type: string
description: Not supported. Use a set of IP permissions to specify the CIDR.
FromPort:
type: integer
description: Not supported. Use a set of IP permissions to specify the port.
format: int32
IpProtocol:
type: string
description: Not supported. Use a set of IP permissions to specify the protocol name or number.
ToPort:
type: integer
description: Not supported. Use a set of IP permissions to specify the port.
format: int32
SourceSecurityGroupName:
type: string
description: Not supported. Use a set of IP permissions to specify a destination security group.
SourceSecurityGroupOwnerId:
type: string
description: Not supported. Use a set of IP permissions to specify a destination security group.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=RevokeSecurityGroupIngress:
get:
summary: GET RevokeSecurityGroupIngress
description: Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.
[EC2-Classic only] If the values you specify do not match the existing rule's values, no error is returned. Use DescribeSecurityGroups to verify that the rule has been removed.
Each rule consists of the protocol and the CIDR range or source security group. 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 have to specify the description to revoke the rule.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
operationId: GETRevokeSecurityGroupIngress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: CidrIp in: query description: The CIDR IP address range. You can't specify this parameter when specifying a source security group. style: form explode: true schema: type: string - name: FromPort in: query description: The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use-1 to specify all ICMP types.
style: form
explode: true
schema:
type: integer
format: int32
- name: GroupId
in: query
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.
style: form
explode: true
schema:
type: string
- name: GroupName
in: query
description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
style: form
explode: true
schema:
type: string
- name: IpPermissions
in: query
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.
style: form
explode: true
schema:
type: array
items:
type: string
- name: IpProtocol
in: query
description: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
style: form
explode: true
schema:
type: string
- name: SourceSecurityGroupName
in: query
description: "[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead."
style: form
explode: true
schema:
type: string
- name: SourceSecurityGroupOwnerId
in: query
description: "[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead."
style: form
explode: true
schema:
type: string
- name: ToPort
in: query
description: The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
style: form
explode: true
schema:
type: integer
format: int32
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action634'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST RevokeSecurityGroupIngress
description: Removes the specified ingress rules from a security group. To remove a rule, the values that you specify (for example, ports) must match the existing rule's values exactly.
[EC2-Classic only] If the values you specify do not match the existing rule's values, no error is returned. Use DescribeSecurityGroups to verify that the rule has been removed.
Each rule consists of the protocol and the CIDR range or source security group. 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 have to specify the description to revoke the rule.
Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.
operationId: POSTRevokeSecurityGroupIngress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action634' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: type: object properties: CidrIp: type: string description: The CIDR IP address range. You can't specify this parameter when specifying a source security group. FromPort: type: integer description: The start of port range for the TCP and UDP protocols, or an ICMP type number. For the ICMP type number, use-1 to specify all ICMP types.
format: int32
GroupId:
type: string
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:
type: string
description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
IpPermissions:
type: array
items:
type: string
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:
type: string
description: The IP protocol name (tcp, udp, icmp) or number (see Protocol Numbers). Use -1 to specify all.
SourceSecurityGroupName:
type: string
description: "[EC2-Classic, default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. For EC2-VPC, the source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead."
SourceSecurityGroupOwnerId:
type: string
description: "[EC2-Classic] The AWS account ID of the source security group, if the source security group is in a different account. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the IP protocol, the start of the port range, and the end of the port range. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead."
ToPort:
type: integer
description: The end of port range for the TCP and UDP protocols, or an ICMP code number. For the ICMP code number, use -1 to specify all ICMP codes for the ICMP type.
format: int32
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=RunInstances:
get:
summary: 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:
[EC2-VPC] 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.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.
[EC2-VPC] 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 in the Amazon Elastic Compute Cloud User Guide.
For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
operationId: GETRunInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: BlockDeviceMapping in: query 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. style: form explode: true schema: type: array items: type: string - name: ImageId in: query description: The ID of the AMI. An AMI is required to launch an instance and must be specified here or in a launch template. style: form explode: true schema: type: string - name: InstanceType in: query description: 'The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
style: form explode: true schema: type: integer format: int32 - name: Ipv6Address in: query description:[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
style: form explode: true schema: type: array items: type: string - name: KernelId in: query 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 Elastic Compute Cloud 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.
" required: true style: form explode: true schema: type: integer format: int32 - name: MinCount in: query 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.
" required: true style: form explode: true schema: type: integer format: int32 - name: Monitoring.Enabled in: query description: >- Describes the monitoring of an instance. Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. style: form explode: true schema: type: string - name: Placement.AvailabilityZone in: query description: >- Describes the placement of an instance.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.
style: form explode: true schema: type: string - name: Placement.Affinity in: query description: >- Describes the placement of an instance. The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command. style: form explode: true schema: type: string - name: Placement.GroupName in: query description: >- Describes the placement of an instance. The name of the placement group the instance is in. style: form explode: true schema: type: string - name: Placement.PartitionNumber in: query description: >- Describes the placement of an instance. The number of the partition the instance is in. Valid only if the placement group strategy is set topartition.
style: form
explode: true
schema:
type: string
- name: Placement.HostId
in: query
description: >-
Describes the placement of an instance.
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
style: form
explode: true
schema:
type: string
- name: Placement.Tenancy
in: query
description: >-
Describes the placement of an instance.
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
style: form
explode: true
schema:
type: string
- name: Placement.SpreadDomain
in: query
description: >-
Describes the placement of an instance.
Reserved for future use.
style: form
explode: true
schema:
type: string
- name: RamdiskId
in: query
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 AWS Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud 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.
style: form explode: true schema: type: array items: type: string - name: SecurityGroup in: query description: '[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
' style: form explode: true schema: type: array items: type: string - name: SubnetId in: query description:[EC2-VPC] The ID of the subnet to launch the instance into.
You cannot specify this option and the network interfaces option in the same request.
style: form explode: true schema: type: string - name: UserData in: query description: The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB. style: form explode: true schema: type: string - name: AdditionalInfo in: query description: Reserved. style: form explode: true schema: type: string - name: ClientToken in: query description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' style: form explode: true schema: type: string - name: DisableApiTermination in: query 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 to false 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.
style: form
explode: true
schema:
type: boolean
- name: EbsOptimized
in: query
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
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
style: form explode: true schema: type: string - name: ElasticGpuSpecification in: query 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 Elastic Compute Cloud User Guide. style: form explode: true schema: type: array items: type: string - name: ElasticInferenceAccelerator in: query 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. style: form explode: true schema: type: array items: type: string - name: TagSpecification in: query description: The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags. style: form explode: true schema: type: array items: type: string - name: LaunchTemplate.LaunchTemplateId in: query description: >- The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both. The ID of the launch template. style: form explode: true schema: type: string - name: LaunchTemplate.LaunchTemplateName in: query description: >- The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both. The name of the launch template. style: form explode: true schema: type: string - name: LaunchTemplate.Version in: query description: >- The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.The version number of the launch template.
Default: The default version for the launch template.
style: form explode: true schema: type: string - name: InstanceMarketOptions.MarketType in: query description: >- Describes the market (purchasing) option for the instances. The market type. style: form explode: true schema: type: string - name: InstanceMarketOptions.SpotOptions in: query description: >- Describes the market (purchasing) option for the instances. The options for Spot Instances. style: form explode: true schema: type: string - name: CreditSpecification.CpuCredits in: query description: >- The credit option for CPU usage of a T2 or T3 instance. The credit option for CPU usage of a T2 or T3 instance. Valid values arestandard and unlimited.
style: form
explode: true
schema:
type: string
- name: CpuOptions.CoreCount
in: query
description: >-
The CPU options for the instance. Both the core count and threads per core must be specified in the request.
The number of CPU cores for the instance.
style: form
explode: true
schema:
type: string
- name: CpuOptions.ThreadsPerCore
in: query
description: >-
The CPU options for the instance. Both the core count and threads per core must be specified in the request.
The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.
style: form
explode: true
schema:
type: string
- name: CapacityReservationSpecification.CapacityReservationPreference
in: query
description: >-
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.
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.
If you set this parameter to true, your instance is enabled for hibernation.
Default: false
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:
[EC2-VPC] 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.
[EC2-Classic] If don't specify an Availability Zone, we choose one for you.
Some instance types must be launched into a VPC. If you do not have a default VPC, or if you do not specify a subnet ID, the request fails. For more information, see Instance Types Available Only in a VPC.
[EC2-VPC] 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 in the Amazon Elastic Compute Cloud User Guide.
For troubleshooting, see What To Do If An Instance Immediately Terminates, and Troubleshooting Connecting to Your Instance in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTRunInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action636' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - MaxCount - MinCount type: object properties: BlockDeviceMapping: type: array items: type: string 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. ImageId: type: string description: The ID of the AMI. An AMI is required to launch an instance and must be specified here or in a launch template. InstanceType: allOf: - $ref: '#/components/schemas/InstanceType4' - description: 'The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
[EC2-VPC] The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
format: int32 Ipv6Address: type: array items: type: string description:[EC2-VPC] The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.
You cannot specify this option and the network interfaces option in the same request.
KernelId: type: string 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 Elastic Compute Cloud 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.
" format: int32 MinCount: type: 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.
" format: int32 Monitoring.Enabled: type: string description: >- Describes the monitoring of an instance. Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled. Placement.AvailabilityZone: type: string description: >- Describes the placement of an instance.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.
Placement.Affinity: type: string description: >- Describes the placement of an instance. The affinity setting for the instance on the Dedicated Host. This parameter is not supported for the ImportInstance command. Placement.GroupName: type: string description: >- Describes the placement of an instance. The name of the placement group the instance is in. Placement.PartitionNumber: type: string description: >- Describes the placement of an instance. The number of the partition the instance is in. Valid only if the placement group strategy is set topartition.
Placement.HostId:
type: string
description: >-
Describes the placement of an instance.
The ID of the Dedicated Host on which the instance resides. This parameter is not supported for the ImportInstance command.
Placement.Tenancy:
type: string
description: >-
Describes the placement of an instance.
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of dedicated runs on single-tenant hardware. The host tenancy is not supported for the ImportInstance command.
Placement.SpreadDomain:
type: string
description: >-
Describes the placement of an instance.
Reserved for future use.
RamdiskId:
type: string
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 AWS Resource Center and search for the kernel ID.
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see PV-GRUB in the Amazon Elastic Compute Cloud 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.
SecurityGroup: type: array items: type: string description: '[EC2-Classic, default VPC] The names of the security groups. For a nondefault VPC, you must use security group IDs instead.
If you specify a network interface, you must specify any security groups as part of the network interface.
Default: Amazon EC2 uses the default security group.
' SubnetId: type: string description:[EC2-VPC] The ID of the subnet to launch the instance into.
You cannot specify this option and the network interfaces option in the same request.
UserData: type: string description: The user data to make available to the instance. For more information, see Running Commands on Your Linux Instance at Launch (Linux) and Adding User Data (Windows). If you are using a command line tool, base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide base64-encoded text. User data is limited to 16 KB. AdditionalInfo: type: string description: Reserved. ClientToken: type: string description: 'Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see Ensuring Idempotency.
Constraints: Maximum 64 ASCII characters
' DisableApiTermination: type: boolean 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 to false 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:
type: boolean
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
[EC2-VPC] The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.
You cannot specify this option and the network interfaces option in the same request.
ElasticGpuSpecification: type: array items: type: string 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 Elastic Compute Cloud User Guide. ElasticInferenceAccelerator: type: array items: type: string 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. TagSpecification: type: array items: type: string description: The tags to apply to the resources during launch. You can only tag instances and volumes on launch. The specified tags are applied to all instances or volumes that are created during launch. To tag a resource after it has been created, see CreateTags. LaunchTemplate.LaunchTemplateId: type: string description: >- The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both. The ID of the launch template. LaunchTemplate.LaunchTemplateName: type: string description: >- The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both. The name of the launch template. LaunchTemplate.Version: type: string description: >- The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.The version number of the launch template.
Default: The default version for the launch template.
InstanceMarketOptions.MarketType: type: string description: >- Describes the market (purchasing) option for the instances. The market type. InstanceMarketOptions.SpotOptions: type: string description: >- Describes the market (purchasing) option for the instances. The options for Spot Instances. CreditSpecification.CpuCredits: type: string description: >- The credit option for CPU usage of a T2 or T3 instance. The credit option for CPU usage of a T2 or T3 instance. Valid values arestandard and unlimited.
CpuOptions.CoreCount:
type: string
description: >-
The CPU options for the instance. Both the core count and threads per core must be specified in the request.
The number of CPU cores for the instance.
CpuOptions.ThreadsPerCore:
type: string
description: >-
The CPU options for the instance. Both the core count and threads per core must be specified in the request.
The number of threads per CPU core. To disable Intel Hyper-Threading Technology for the instance, specify a value of 1. Otherwise, specify the default value of 2.
CapacityReservationSpecification.CapacityReservationPreference:
type: string
description: >-
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.
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.
If you set this parameter to true, your instance is enabled for hibernation.
Default: false
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 Elastic Compute Cloud User Guide.
operationId: GETRunScheduledInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: ClientToken in: query description: Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: InstanceCount
in: query
description: 'The number of instances.
Default: 1
' style: form explode: true schema: type: integer format: int32 - name: LaunchSpecification.BlockDeviceMappings in: query description: >-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.
Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
Indicates whether 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 Elastic Compute Cloud User Guide.
operationId: POSTRunScheduledInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action638' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - ScheduledInstanceId type: object properties: ClientToken: type: string description: Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring Idempotency. DryRun: type: boolean description: Checks whether you have the required permissions for the action, 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:
type: integer
description: 'The number of instances.
Default: 1
' format: int32 LaunchSpecification.BlockDeviceMappings: type: array items: type: string description: >-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.
Describes the launch specification for a Scheduled Instance.
If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either SubnetId or NetworkInterface.
Indicates whether 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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 (vpc | vpn).
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 attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
type - The type of roue (active | blackhole).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action640'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
deprecated: false
post:
summary: POST SearchTransitGatewayRoutes
description: Searches for routes in the specified transit gateway route table.
operationId: POSTSearchTransitGatewayRoutes
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action640'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- TransitGatewayRouteTableId
- Filter
type: object
properties:
TransitGatewayRouteTableId:
type: string
description: The ID of the transit gateway route table.
Filter:
type: array
items:
type: string
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 (vpc | vpn).
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 attachment (available | deleted | deleting | failed | modifying | pendingAcceptance | pending | rollingBack | rejected | rejecting).
type - The type of roue (active | blackhole).
DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/SearchTransitGatewayRoutesResult'
deprecated: false
/#Action=StartInstances:
get:
summary: 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 Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux 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.
For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.
operationId: GETStartInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceId in: query description: The IDs of the instances. required: true style: form explode: true schema: type: array items: type: string - name: AdditionalInfo in: query description: Reserved. style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action642'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/StartInstancesResult'
deprecated: false
post:
summary: 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 Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux 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.
For more information, see Stopping Instances in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTStartInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action642' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: InstanceId: type: array items: type: string description: The IDs of the instances. AdditionalInfo: type: string description: Reserved. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/StartInstancesResult'
deprecated: false
/#Action=StopInstances:
get:
summary: GET StopInstances
description: Stops an Amazon EBS-backed instance.
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 Elastic Compute Cloud 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 Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't start, stop, or hibernate Spot Instances, and you can't stop or hibernate instance store-backed instances. For information about using hibernation for Spot Instances, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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 Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.
operationId: GETStopInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceId in: query description: The IDs of the instances. required: true style: form explode: true schema: type: array items: type: string - name: Hibernate in: query 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 Elastic Compute Cloud User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Force
in: query
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.
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 Elastic Compute Cloud 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 Windows instance, Amazon EC2 charges you for a full instance hour. If you stop and restart your Windows instance, a new instance hour begins and Amazon EC2 charges you for another full instance hour even if you are still within the same 60-minute period when it was stopped. Every time you start your Linux instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.
You can't start, stop, or hibernate Spot Instances, and you can't stop or hibernate instance store-backed instances. For information about using hibernation for Spot Instances, see Hibernating Interrupted Spot Instances in the Amazon Elastic Compute Cloud 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 Elastic Compute Cloud 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 Troubleshooting Stopping Your Instance in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTStopInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action644' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: InstanceId: type: array items: type: string description: The IDs of the instances. Hibernate: type: 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 Elastic Compute Cloud User Guide.
Default: false
DryRunOperation. Otherwise, it is UnauthorizedOperation.
Force:
type: boolean
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
DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action646'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/TerminateClientVpnConnectionsResult'
deprecated: false
post:
summary: 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.
operationId: POSTTerminateClientVpnConnections
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action646'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
description: The ID of the Client VPN endpoint to which the client is connected.
ConnectionId:
type: string
description: The ID of the client connection to be terminated.
Username:
type: 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:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/TerminateClientVpnConnectionsResult'
deprecated: false
/#Action=TerminateInstances:
get:
summary: 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.
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 Elastic Compute Cloud User Guide.
For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.
operationId: GETTerminateInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: InstanceId in: query description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' required: true style: form explode: true schema: type: array items: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action648'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/TerminateInstancesResult'
deprecated: false
post:
summary: 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.
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 Elastic Compute Cloud User Guide.
For more information about troubleshooting, see Troubleshooting Terminating Your Instance in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTTerminateInstances parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action648' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - InstanceId type: object properties: InstanceId: type: array items: type: string description: 'The IDs of the instances.
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.
' DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/TerminateInstancesResult'
deprecated: false
/#Action=UnassignIpv6Addresses:
get:
summary: GET UnassignIpv6Addresses
description: Unassigns one or more IPv6 addresses from a network interface.
operationId: GETUnassignIpv6Addresses
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Ipv6Addresses
in: query
description: The IPv6 addresses to unassign from the network interface.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action650'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UnassignIpv6AddressesResult'
deprecated: false
post:
summary: POST UnassignIpv6Addresses
description: Unassigns one or more IPv6 addresses from a network interface.
operationId: POSTUnassignIpv6Addresses
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action650'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- Ipv6Addresses
- NetworkInterfaceId
type: object
properties:
Ipv6Addresses:
type: array
items:
type: string
description: The IPv6 addresses to unassign from the network interface.
NetworkInterfaceId:
type: string
description: The ID of the network interface.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UnassignIpv6AddressesResult'
deprecated: false
/#Action=UnassignPrivateIpAddresses:
get:
summary: GET UnassignPrivateIpAddresses
description: Unassigns one or more secondary private IP addresses from a network interface.
operationId: GETUnassignPrivateIpAddresses
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: NetworkInterfaceId
in: query
description: The ID of the network interface.
required: true
style: form
explode: true
schema:
type: string
- name: PrivateIpAddress
in: query
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.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action652'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
post:
summary: POST UnassignPrivateIpAddresses
description: Unassigns one or more secondary private IP addresses from a network interface.
operationId: POSTUnassignPrivateIpAddresses
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action652'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- NetworkInterfaceId
- PrivateIpAddress
type: object
properties:
NetworkInterfaceId:
type: string
description: The ID of the network interface.
PrivateIpAddress:
type: array
items:
type: string
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.
required: false
responses:
'200':
description: Success
headers: {}
content: {}
deprecated: false
/#Action=UnmonitorInstances:
get:
summary: GET UnmonitorInstances
description: Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
operationId: GETUnmonitorInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: InstanceId
in: query
description: The IDs of the instances.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: DryRun
in: query
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action654'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UnmonitorInstancesResult'
deprecated: false
post:
summary: POST UnmonitorInstances
description: Disables detailed monitoring for a running instance. For more information, see Monitoring Your Instances and Volumes in the Amazon Elastic Compute Cloud User Guide.
operationId: POSTUnmonitorInstances
parameters:
- name: X-Amz-Content-Sha256
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Date
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Algorithm
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Credential
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Security-Token
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-Signature
in: header
description: ''
style: simple
schema:
type: string
- name: X-Amz-SignedHeaders
in: header
description: ''
style: simple
schema:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action654'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
requestBody:
content:
application/x-www-form-urlencoded:
encoding: {}
schema:
required:
- InstanceId
type: object
properties:
InstanceId:
type: array
items:
type: string
description: The IDs of the instances.
DryRun:
type: boolean
description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UnmonitorInstancesResult'
deprecated: false
/#Action=UpdateSecurityGroupRuleDescriptionsEgress:
get:
summary: GET UpdateSecurityGroupRuleDescriptionsEgress
description: [VPC only] 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 specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
operationId: GETUpdateSecurityGroupRuleDescriptionsEgress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupId
in: query
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.
style: form
explode: true
schema:
type: string
- name: GroupName
in: query
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.'
style: form
explode: true
schema:
type: string
- name: IpPermissions
in: query
description: The IP permissions for the security group rule.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action656'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
deprecated: false
post:
summary: POST UpdateSecurityGroupRuleDescriptionsEgress
description: [VPC only] 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 specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
operationId: POSTUpdateSecurityGroupRuleDescriptionsEgress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action656' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - IpPermissions type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
GroupId:
type: string
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:
type: string
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.'
IpPermissions:
type: array
items:
type: string
description: The IP permissions for the security group rule.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsEgressResult'
deprecated: false
/#Action=UpdateSecurityGroupRuleDescriptionsIngress:
get:
summary: 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 specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
operationId: GETUpdateSecurityGroupRuleDescriptionsIngress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: GroupId
in: query
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.
style: form
explode: true
schema:
type: string
- name: GroupName
in: query
description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
style: form
explode: true
schema:
type: string
- name: IpPermissions
in: query
description: The IP permissions for the security group rule.
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action658'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
deprecated: false
post:
summary: 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 specify the description as part of the IP permissions structure. You can remove a description for a security group rule by omitting the description parameter in the request.
operationId: POSTUpdateSecurityGroupRuleDescriptionsIngress parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action658' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - IpPermissions type: object properties: DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
GroupId:
type: string
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:
type: string
description: '[EC2-Classic, default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request.'
IpPermissions:
type: array
items:
type: string
description: The IP permissions for the security group rule.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/UpdateSecurityGroupRuleDescriptionsIngressResult'
deprecated: false
/#Action=WithdrawByoipCidr:
get:
summary: GET WithdrawByoipCidr
description: Stops advertising an IPv4 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 AWS because of BGP propagation delays.
operationId: GETWithdrawByoipCidr parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Cidr in: query description: The public IPv4 address range, in CIDR notation. required: true style: form explode: true schema: type: string - name: DryRun in: query description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
style: form
explode: true
schema:
type: boolean
- name: Action
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Action660'
- name: Version
in: query
description: ''
required: true
style: form
explode: true
schema:
$ref: '#/components/schemas/Version'
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/WithdrawByoipCidrResult'
deprecated: false
post:
summary: POST WithdrawByoipCidr
description: Stops advertising an IPv4 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 AWS because of BGP propagation delays.
operationId: POSTWithdrawByoipCidr parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action660' - name: Version in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Version' requestBody: content: application/x-www-form-urlencoded: encoding: {} schema: required: - Cidr type: object properties: Cidr: type: string description: The public IPv4 address range, in CIDR notation. DryRun: type: boolean description: Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation. Otherwise, it is UnauthorizedOperation.
required: false
responses:
'200':
description: Success
headers: {}
content:
'*/*':
schema:
$ref: '#/components/schemas/WithdrawByoipCidrResult'
deprecated: false
components:
schemas:
DescribeVpcsResult:
title: DescribeVpcsResult
type: object
properties:
Vpcs:
type: array
items:
$ref: '#/components/schemas/Vpc'
description: ''
NextToken:
type: string
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
ReservedInstancesModification:
title: ReservedInstancesModification
type: object
properties:
ClientToken:
type: string
CreateDate:
type: string
format: date-time
EffectiveDate:
type: string
format: date-time
ModificationResults:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesModificationResult'
description: ''
ReservedInstancesIds:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesId'
description: ''
ReservedInstancesModificationId:
type: string
Status:
type: string
StatusMessage:
type: string
UpdateDate:
type: string
format: date-time
description: Describes a Reserved Instance modification.
NetworkInterfaceType:
title: NetworkInterfaceType
enum:
- interface
- natGateway
- efa
type: string
DescribeReservedInstancesOfferingsRequest:
title: DescribeReservedInstancesOfferingsRequest
type: object
properties:
AvailabilityZone:
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
IncludeMarketplace:
type: boolean
InstanceType:
$ref: '#/components/schemas/InstanceType'
MaxDuration:
type: integer
format: int32
MaxInstanceCount:
type: integer
format: int32
MinDuration:
type: integer
format: int32
OfferingClass:
$ref: '#/components/schemas/OfferingClassType'
ProductDescription:
$ref: '#/components/schemas/RIProductDescription'
ReservedInstancesOfferingIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
InstanceTenancy:
$ref: '#/components/schemas/Tenancy'
MaxResults:
type: integer
format: int32
NextToken:
type: string
OfferingType:
$ref: '#/components/schemas/OfferingTypeValues'
description: Contains the parameters for DescribeReservedInstancesOfferings.
DescribeFlowLogsRequest:
title: DescribeFlowLogsRequest
type: object
properties:
DryRun:
type: boolean
Filter:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
FlowLogIds:
type: array
items:
type: string
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
TransitGatewayAttachment:
title: TransitGatewayAttachment
type: object
properties:
TransitGatewayAttachmentId:
type: string
TransitGatewayId:
type: string
TransitGatewayOwnerId:
type: string
ResourceOwnerId:
type: string
ResourceType:
$ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
ResourceId:
type: string
State:
$ref: '#/components/schemas/TransitGatewayAttachmentState'
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayAttachmentAssociation'
- description: Describes an association.
CreationTime:
type: string
format: date-time
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes an attachment between a resource and a transit gateway.
VpnStaticRouteSource:
title: VpnStaticRouteSource
enum:
- Static
type: string
AssociateClientVpnTargetNetworkRequest:
title: AssociateClientVpnTargetNetworkRequest
required:
- ClientVpnEndpointId
- SubnetId
type: object
properties:
ClientVpnEndpointId:
type: string
SubnetId:
type: string
DryRun:
type: boolean
DescribeNetworkInterfacesRequest:
title: DescribeNetworkInterfacesRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
NetworkInterfaceIds:
type: array
items:
type: string
description: ''
NextToken:
type: string
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
description: Contains the parameters for DescribeNetworkInterfaces.
NatGatewayAddress:
title: NatGatewayAddress
type: object
properties:
AllocationId:
type: string
NetworkInterfaceId:
type: string
PrivateIp:
type: string
PublicIp:
type: string
description: Describes the IP addresses and network interface associated with a NAT gateway.
CreateInternetGatewayResult:
title: CreateInternetGatewayResult
type: object
properties:
InternetGateway:
allOf:
- $ref: '#/components/schemas/InternetGateway'
- description: Describes an internet gateway.
example:
InternetGateway:
Attachments: []
InternetGatewayId: igw-c0a643a9
Tags: []
OfferingClassType:
title: OfferingClassType
enum:
- standard
- convertible
type: string
DescribeVpcClassicLinkRequest:
title: DescribeVpcClassicLinkRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
VpcIds:
type: array
items:
type: string
description: ''
AccountAttributeName:
title: AccountAttributeName
enum:
- supported-platforms
- default-vpc
type: string
RunInstancesMonitoringEnabled:
title: RunInstancesMonitoringEnabled
required:
- Enabled
type: object
properties:
Enabled:
type: boolean
description: Describes the monitoring of an instance.
ModifyVpcEndpointServiceConfigurationRequest:
title: ModifyVpcEndpointServiceConfigurationRequest
required:
- ServiceId
type: object
properties:
DryRun:
type: boolean
ServiceId:
type: string
AcceptanceRequired:
type: boolean
AddNetworkLoadBalancerArns:
type: array
items:
type: string
description: ''
RemoveNetworkLoadBalancerArns:
type: array
items:
type: string
description: ''
CreateFpgaImageRequest:
title: CreateFpgaImageRequest
required:
- InputStorageLocation
type: object
properties:
DryRun:
type: boolean
InputStorageLocation:
allOf:
- $ref: '#/components/schemas/StorageLocation'
- description: Describes a storage location in Amazon S3.
LogsStorageLocation:
allOf:
- $ref: '#/components/schemas/StorageLocation'
- description: Describes a storage location in Amazon S3.
Description:
type: string
Name:
type: string
ClientToken:
type: string
Status:
title: Status
enum:
- MoveInProgress
- InVpc
- InClassic
type: string
SnapshotDiskContainer:
title: SnapshotDiskContainer
type: object
properties:
Description:
type: string
Format:
type: string
Url:
type: string
UserBucket:
allOf:
- $ref: '#/components/schemas/UserBucket'
- description: Describes the S3 bucket for the disk image.
description: The disk container object for the import snapshot request.
CreateSubnetResult:
title: CreateSubnetResult
type: object
properties:
Subnet:
allOf:
- $ref: '#/components/schemas/Subnet'
- description: Describes a subnet.
example:
Subnet:
AvailabilityZone: us-west-2c
AvailableIpAddressCount: 251
CidrBlock: 10.0.1.0/24
State: pending
SubnetId: subnet-9d4a7b6c
VpcId: vpc-a01106c2
InstanceCapacity:
title: InstanceCapacity
type: object
properties:
AvailableCapacity:
type: integer
format: int32
InstanceType:
type: string
TotalCapacity:
type: integer
format: int32
description: Information about the instance type that the Dedicated Host supports.
CreateVpnConnectionResult:
title: CreateVpnConnectionResult
type: object
properties:
VpnConnection:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- description: Describes a VPN connection.
description: Contains the output of CreateVpnConnection.
CapacityReservation:
title: CapacityReservation
type: object
properties:
CapacityReservationId:
type: string
InstanceType:
type: string
InstancePlatform:
$ref: '#/components/schemas/CapacityReservationInstancePlatform'
AvailabilityZone:
type: string
Tenancy:
$ref: '#/components/schemas/CapacityReservationTenancy'
TotalInstanceCount:
type: integer
format: int32
AvailableInstanceCount:
type: integer
format: int32
EbsOptimized:
type: boolean
EphemeralStorage:
type: boolean
State:
$ref: '#/components/schemas/CapacityReservationState'
EndDate:
type: string
format: date-time
EndDateType:
$ref: '#/components/schemas/EndDateType'
InstanceMatchCriteria:
$ref: '#/components/schemas/InstanceMatchCriteria'
CreateDate:
type: string
format: date-time
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a Capacity Reservation.
InstanceBlockDeviceMappingSpecification:
title: InstanceBlockDeviceMappingSpecification
type: object
properties:
DeviceName:
type: string
Ebs:
allOf:
- $ref: '#/components/schemas/EbsInstanceBlockDeviceSpecification'
- description: Describes information used to set up an EBS volume specified in a block device mapping.
NoDevice:
type: string
VirtualName:
type: string
description: Describes a block device mapping entry.
ConnectionNotification:
title: ConnectionNotification
type: object
properties:
ConnectionNotificationId:
type: string
ServiceId:
type: string
VpcEndpointId:
type: string
ConnectionNotificationType:
$ref: '#/components/schemas/ConnectionNotificationType'
ConnectionNotificationArn:
type: string
ConnectionEvents:
type: array
items:
type: string
description: ''
ConnectionNotificationState:
$ref: '#/components/schemas/ConnectionNotificationState'
description: Describes a connection notification for a VPC endpoint or VPC endpoint service.
MoveAddressToVpcRequest:
title: MoveAddressToVpcRequest
required:
- PublicIp
type: object
properties:
DryRun:
type: boolean
PublicIp:
type: string
PortRange:
title: PortRange
type: object
properties:
From:
type: integer
format: int32
To:
type: integer
format: int32
description: Describes a range of ports.
InternetGatewayAttachment:
title: InternetGatewayAttachment
type: object
properties:
State:
$ref: '#/components/schemas/AttachmentStatus'
VpcId:
type: string
description: Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.
AssignIpv6AddressesRequest:
title: AssignIpv6AddressesRequest
required:
- NetworkInterfaceId
type: object
properties:
Ipv6AddressCount:
type: integer
format: int32
Ipv6Addresses:
type: array
items:
type: string
description: ''
NetworkInterfaceId:
type: string
DescribeBundleTasksRequest:
title: DescribeBundleTasksRequest
type: object
properties:
BundleIds:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
GetReservedInstancesExchangeQuoteRequest:
title: GetReservedInstancesExchangeQuoteRequest
required:
- ReservedInstanceIds
type: object
properties:
DryRun:
type: boolean
ReservedInstanceIds:
type: array
items:
type: string
description: ''
TargetConfigurations:
type: array
items:
$ref: '#/components/schemas/TargetConfigurationRequest'
description: ''
description: Contains the parameters for GetReservedInstanceExchangeQuote.
FleetExcessCapacityTerminationPolicy:
title: FleetExcessCapacityTerminationPolicy
enum:
- no-termination
- termination
type: string
DeleteVpnConnectionRouteRequest:
title: DeleteVpnConnectionRouteRequest
required:
- DestinationCidrBlock
- VpnConnectionId
type: object
properties:
DestinationCidrBlock:
type: string
VpnConnectionId:
type: string
description: Contains the parameters for DeleteVpnConnectionRoute.
DisableTransitGatewayRouteTablePropagationResult:
title: DisableTransitGatewayRouteTablePropagationResult
type: object
properties:
Propagation:
allOf:
- $ref: '#/components/schemas/TransitGatewayPropagation'
- description: Describes route propagation.
SearchTransitGatewayRoutesResult:
title: SearchTransitGatewayRoutesResult
type: object
properties:
Routes:
type: array
items:
$ref: '#/components/schemas/TransitGatewayRoute'
description: ''
AdditionalRoutesAvailable:
type: boolean
OperationType:
title: OperationType
enum:
- add
- remove
type: string
ImageState:
title: ImageState
enum:
- pending
- available
- invalid
- deregistered
- transient
- failed
- error
type: string
ImportVolumeRequest:
title: ImportVolumeRequest
required:
- AvailabilityZone
- Image
- Volume
type: object
properties:
AvailabilityZone:
type: string
Description:
type: string
DryRun:
type: boolean
Image:
allOf:
- $ref: '#/components/schemas/DiskImageDetail'
- description: Describes a disk image.
Volume:
allOf:
- $ref: '#/components/schemas/VolumeDetail'
- description: Describes an EBS volume.
description: Contains the parameters for ImportVolume.
CancelSpotFleetRequestsErrorItem:
title: CancelSpotFleetRequestsErrorItem
type: object
properties:
Error:
allOf:
- $ref: '#/components/schemas/CancelSpotFleetRequestsError'
- description: Describes a Spot Fleet error.
SpotFleetRequestId:
type: string
description: Describes a Spot Fleet request that was not successfully canceled.
ImportImageResult:
title: ImportImageResult
type: object
properties:
Architecture:
type: string
Description:
type: string
Encrypted:
type: boolean
Hypervisor:
type: string
ImageId:
type: string
ImportTaskId:
type: string
KmsKeyId:
type: string
LicenseType:
type: string
Platform:
type: string
Progress:
type: string
SnapshotDetails:
type: array
items:
$ref: '#/components/schemas/SnapshotDetail'
description: ''
Status:
type: string
StatusMessage:
type: string
description: Contains the output for ImportImage.
InstanceHealthStatus:
title: InstanceHealthStatus
enum:
- healthy
- unhealthy
type: string
InstanceCreditSpecificationRequest:
title: InstanceCreditSpecificationRequest
type: object
properties:
InstanceId:
type: string
CpuCredits:
type: string
description: Describes the credit option for CPU usage of a T2 or T3 instance.
LaunchTemplateElasticInferenceAcceleratorResponse:
title: LaunchTemplateElasticInferenceAcceleratorResponse
type: object
properties:
Type:
type: string
description: Describes an elastic inference accelerator.
AssociateDhcpOptionsRequest:
title: AssociateDhcpOptionsRequest
required:
- DhcpOptionsId
- VpcId
type: object
properties:
DhcpOptionsId:
type: string
VpcId:
type: string
DryRun:
type: boolean
SecurityGroupReference:
title: SecurityGroupReference
type: object
properties:
GroupId:
type: string
ReferencingVpcId:
type: string
VpcPeeringConnectionId:
type: string
description: Describes a VPC with a security group that references your security group.
LaunchTemplateIamInstanceProfileSpecificationRequest:
title: LaunchTemplateIamInstanceProfileSpecificationRequest
type: object
properties:
Arn:
type: string
Name:
type: string
description: An IAM instance profile.
UnassignIpv6AddressesRequest:
title: UnassignIpv6AddressesRequest
required:
- Ipv6Addresses
- NetworkInterfaceId
type: object
properties:
Ipv6Addresses:
type: array
items:
type: string
description: ''
NetworkInterfaceId:
type: string
AssociateTransitGatewayRouteTableResult:
title: AssociateTransitGatewayRouteTableResult
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociation'
- description: Describes an association between a resource attachment and a transit gateway route table.
ImportSnapshotTask:
title: ImportSnapshotTask
type: object
properties:
Description:
type: string
ImportTaskId:
type: string
SnapshotTaskDetail:
allOf:
- $ref: '#/components/schemas/SnapshotTaskDetail'
- description: Details about the import snapshot task.
description: Describes an import snapshot task.
InstanceState:
title: InstanceState
type: object
properties:
Code:
type: integer
format: int32
Name:
$ref: '#/components/schemas/InstanceStateName'
description: Describes the current state of an instance.
CreateRouteTableResult:
title: CreateRouteTableResult
type: object
properties:
RouteTable:
allOf:
- $ref: '#/components/schemas/RouteTable'
- description: Describes a route table.
example:
RouteTable:
Associations: []
PropagatingVgws: []
RouteTableId: rtb-22574640
Routes:
- DestinationCidrBlock: 10.0.0.0/16
GatewayId: local
State: active
Tags: []
VpcId: vpc-a01106c2
ElasticGpus:
title: ElasticGpus
type: object
properties:
ElasticGpuId:
type: string
AvailabilityZone:
type: string
ElasticGpuType:
type: string
ElasticGpuHealth:
allOf:
- $ref: '#/components/schemas/ElasticGpuHealth'
- description: Describes the status of an Elastic Graphics accelerator.
ElasticGpuState:
$ref: '#/components/schemas/ElasticGpuState'
InstanceId:
type: string
description: Describes an Elastic Graphics accelerator.
LaunchTemplate:
title: LaunchTemplate
type: object
properties:
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
CreateTime:
type: string
format: date-time
CreatedBy:
type: string
DefaultVersionNumber:
type: integer
format: int32
LatestVersionNumber:
type: integer
format: int32
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a launch template.
CreatePlacementGroupRequest:
title: CreatePlacementGroupRequest
type: object
properties:
DryRun:
type: boolean
GroupName:
type: string
Strategy:
$ref: '#/components/schemas/PlacementStrategy'
PartitionCount:
type: integer
format: int32
AssociationStatusCode:
title: AssociationStatusCode
enum:
- associating
- associated
- association-failed
- disassociating
- disassociated
type: string
VpcCidrBlockState:
title: VpcCidrBlockState
type: object
properties:
State:
$ref: '#/components/schemas/VpcCidrBlockStateCode'
StatusMessage:
type: string
description: Describes the state of a CIDR block.
CreateNetworkAclRequest:
title: CreateNetworkAclRequest
required:
- VpcId
type: object
properties:
DryRun:
type: boolean
VpcId:
type: string
CancelReservedInstancesListingRequest:
title: CancelReservedInstancesListingRequest
required:
- ReservedInstancesListingId
type: object
properties:
ReservedInstancesListingId:
type: string
description: Contains the parameters for CancelReservedInstancesListing.
DeleteFleetError:
title: DeleteFleetError
type: object
properties:
Code:
$ref: '#/components/schemas/DeleteFleetErrorCode'
Message:
type: string
description: Describes an EC2 Fleet error.
DescribeHostsResult:
title: DescribeHostsResult
type: object
properties:
Hosts:
type: array
items:
$ref: '#/components/schemas/Host'
description: ''
NextToken:
type: string
NetworkInterfaceAttachmentChanges:
title: NetworkInterfaceAttachmentChanges
type: object
properties:
AttachmentId:
type: string
DeleteOnTermination:
type: boolean
description: Describes an attachment change.
CreateCapacityReservationResult:
title: CreateCapacityReservationResult
type: object
properties:
CapacityReservation:
allOf:
- $ref: '#/components/schemas/CapacityReservation'
- description: Describes a Capacity Reservation.
PeeringConnectionOptionsRequest:
title: PeeringConnectionOptionsRequest
type: object
properties:
AllowDnsResolutionFromRemoteVpc:
type: boolean
AllowEgressFromLocalClassicLinkToRemoteVpc:
type: boolean
AllowEgressFromLocalVpcToRemoteClassicLink:
type: boolean
description: The VPC peering connection options.
TransitGatewayAttachmentState:
title: TransitGatewayAttachmentState
enum:
- pendingAcceptance
- rollingBack
- pending
- available
- modifying
- deleting
- deleted
- failed
- rejected
- rejecting
- failing
type: string
AssociateRouteTableRequest:
title: AssociateRouteTableRequest
required:
- RouteTableId
- SubnetId
type: object
properties:
DryRun:
type: boolean
RouteTableId:
type: string
SubnetId:
type: string
DeleteVpcEndpointServiceConfigurationsRequest:
title: DeleteVpcEndpointServiceConfigurationsRequest
required:
- ServiceIds
type: object
properties:
DryRun:
type: boolean
ServiceIds:
type: array
items:
type: string
description: ''
TransitGatewayRouteTablePropagation:
title: TransitGatewayRouteTablePropagation
type: object
properties:
TransitGatewayAttachmentId:
type: string
ResourceId:
type: string
ResourceType:
$ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
State:
$ref: '#/components/schemas/TransitGatewayPropagationState'
description: Describes a route table propagation.
AssociateIamInstanceProfileResult:
title: AssociateIamInstanceProfileResult
type: object
properties:
IamInstanceProfileAssociation:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociation'
- description: Describes an association between an IAM instance profile and an instance.
example:
IamInstanceProfileAssociation:
AssociationId: iip-assoc-0e7736511a163c209
IamInstanceProfile:
Arn: arn:aws:iam::123456789012:instance-profile/admin-role
Id: AIPAJBLK7RKJKWDXVHIEC
InstanceId: i-123456789abcde123
State: associating
DescribeMovingAddressesRequest:
title: DescribeMovingAddressesRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
MaxResults:
type: integer
format: int32
NextToken:
type: string
PublicIps:
type: array
items:
type: string
description: ''
HostInstance:
title: HostInstance
type: object
properties:
InstanceId:
type: string
InstanceType:
type: string
description: Describes an instance running on a Dedicated Host.
NetworkAclEntry:
title: NetworkAclEntry
type: object
properties:
CidrBlock:
type: string
Egress:
type: boolean
IcmpTypeCode:
allOf:
- $ref: '#/components/schemas/IcmpTypeCode'
- description: Describes the ICMP type and code.
Ipv6CidrBlock:
type: string
PortRange:
allOf:
- $ref: '#/components/schemas/PortRange'
- description: Describes a range of ports.
Protocol:
type: string
RuleAction:
$ref: '#/components/schemas/RuleAction'
RuleNumber:
type: integer
format: int32
description: Describes an entry in a network ACL.
PeeringConnectionOptions:
title: PeeringConnectionOptions
type: object
properties:
AllowDnsResolutionFromRemoteVpc:
type: boolean
AllowEgressFromLocalClassicLinkToRemoteVpc:
type: boolean
AllowEgressFromLocalVpcToRemoteClassicLink:
type: boolean
description: Describes the VPC peering connection options.
CreateDhcpOptionsRequest:
title: CreateDhcpOptionsRequest
required:
- DhcpConfigurations
type: object
properties:
DhcpConfigurations:
type: array
items:
$ref: '#/components/schemas/NewDhcpConfiguration'
description: ''
DryRun:
type: boolean
UnsuccessfulItem:
title: UnsuccessfulItem
type: object
properties:
Error:
allOf:
- $ref: '#/components/schemas/UnsuccessfulItemError'
- description: Information about the error that occurred. For more information about errors, see Error Codes.
ResourceId:
type: string
description: Information about items that were not successfully processed in a batch call.
DhcpConfiguration:
title: DhcpConfiguration
type: object
properties:
Key:
type: string
Values:
type: array
items:
$ref: '#/components/schemas/AttributeValue'
description: ''
description: Describes a DHCP configuration option.
DiskImage:
title: DiskImage
type: object
properties:
Description:
type: string
Image:
allOf:
- $ref: '#/components/schemas/DiskImageDetail'
- description: Describes a disk image.
Volume:
allOf:
- $ref: '#/components/schemas/VolumeDetail'
- description: Describes an EBS volume.
description: Describes a disk image.
DeleteClientVpnRouteResult:
title: DeleteClientVpnRouteResult
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnRouteStatus'
- description: Describes the state of a Client VPN endpoint route.
SnapshotDetail:
title: SnapshotDetail
type: object
properties:
Description:
type: string
DeviceName:
type: string
DiskImageSize:
type: number
Format:
type: string
Progress:
type: string
SnapshotId:
type: string
Status:
type: string
StatusMessage:
type: string
Url:
type: string
UserBucket:
allOf:
- $ref: '#/components/schemas/UserBucketDetails'
- description: Describes the S3 bucket for the disk image.
description: Describes the snapshot created from the imported disk.
ArchitectureValues:
title: ArchitectureValues
enum:
- i386
- x86_64
- arm64
type: string
SuccessfulInstanceCreditSpecificationItem:
title: SuccessfulInstanceCreditSpecificationItem
type: object
properties:
InstanceId:
type: string
description: Describes the T2 or T3 instance whose credit option for CPU usage was successfully modified.
InstanceStatusDetails:
title: InstanceStatusDetails
type: object
properties:
ImpairedSince:
type: string
format: date-time
Name:
$ref: '#/components/schemas/StatusName'
Status:
$ref: '#/components/schemas/StatusType'
description: Describes the instance status.
DescribeVolumesResult:
title: DescribeVolumesResult
type: object
properties:
Volumes:
type: array
items:
$ref: '#/components/schemas/Volume'
description: ''
NextToken:
type: string
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
HibernationOptionsRequest:
title: HibernationOptionsRequest
type: object
properties:
Configured:
type: boolean
description: Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
ExportClientVpnClientCertificateRevocationListRequest:
title: ExportClientVpnClientCertificateRevocationListRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
DryRun:
type: boolean
ModifyFpgaImageAttributeRequest:
title: ModifyFpgaImageAttributeRequest
required:
- FpgaImageId
type: object
properties:
DryRun:
type: boolean
FpgaImageId:
type: string
Attribute:
$ref: '#/components/schemas/FpgaImageAttributeName'
OperationType:
$ref: '#/components/schemas/OperationType'
UserIds:
type: array
items:
type: string
description: ''
UserGroups:
type: array
items:
type: string
description: ''
ProductCodes:
type: array
items:
type: string
description: ''
LoadPermission:
allOf:
- $ref: '#/components/schemas/LoadPermissionModifications'
- description: Describes modifications to the load permissions of an Amazon FPGA image (AFI).
Description:
type: string
Name:
type: string
CreateDhcpOptionsResult:
title: CreateDhcpOptionsResult
type: object
properties:
DhcpOptions:
allOf:
- $ref: '#/components/schemas/DhcpOptions'
- description: Describes a set of DHCP options.
example:
DhcpOptions:
DhcpConfigurations:
- Key: domain-name-servers
Values:
- Value: 10.2.5.2
- Value: 10.2.5.1
DhcpOptionsId: dopt-d9070ebb
PurchaseRequest:
title: PurchaseRequest
required:
- InstanceCount
- PurchaseToken
type: object
properties:
InstanceCount:
type: integer
format: int32
PurchaseToken:
type: string
description: Describes a request to purchase Scheduled Instances.
AccountAttributeValue:
title: AccountAttributeValue
type: object
properties:
AttributeValue:
type: string
description: Describes a value of an account attribute.
ModifyTransitGatewayVpcAttachmentRequest:
title: ModifyTransitGatewayVpcAttachmentRequest
required:
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayAttachmentId:
type: string
AddSubnetIds:
type: array
items:
type: string
description: ''
RemoveSubnetIds:
type: array
items:
type: string
description: ''
Options:
allOf:
- $ref: '#/components/schemas/ModifyTransitGatewayVpcAttachmentRequestOptions'
- description: Describes the options for a VPC attachment.
DryRun:
type: boolean
DescribeSpotFleetInstancesRequest:
title: DescribeSpotFleetInstancesRequest
required:
- SpotFleetRequestId
type: object
properties:
DryRun:
type: boolean
MaxResults:
type: integer
format: int32
NextToken:
type: string
SpotFleetRequestId:
type: string
description: Contains the parameters for DescribeSpotFleetInstances.
ReservedInstanceReservationValue:
title: ReservedInstanceReservationValue
type: object
properties:
ReservationValue:
allOf:
- $ref: '#/components/schemas/ReservationValue'
- description: The cost associated with the Reserved Instance.
ReservedInstanceId:
type: string
description: The total value of the Convertible Reserved Instance.
InterfacePermissionType:
title: InterfacePermissionType
enum:
- INSTANCE-ATTACH
- EIP-ASSOCIATE
type: string
RequestSpotFleetResponse:
title: RequestSpotFleetResponse
type: object
properties:
SpotFleetRequestId:
type: string
description: Contains the output of RequestSpotFleet.
example:
SpotFleetRequestId: sfr-73fbd2ce-aa30-494c-8788-1cee4EXAMPLE
ScheduledInstanceRecurrence:
title: ScheduledInstanceRecurrence
type: object
properties:
Frequency:
type: string
Interval:
type: integer
format: int32
OccurrenceDaySet:
type: array
items:
type: integer
format: int32
description: ''
OccurrenceRelativeToEnd:
type: boolean
OccurrenceUnit:
type: string
description: Describes the recurring schedule for a Scheduled Instance.
OfferingTypeValues:
title: OfferingTypeValues
enum:
- Heavy Utilization
- Medium Utilization
- Light Utilization
- No Upfront
- Partial Upfront
- All Upfront
type: string
ModifySpotFleetRequestRequest:
title: ModifySpotFleetRequestRequest
required:
- SpotFleetRequestId
type: object
properties:
ExcessCapacityTerminationPolicy:
$ref: '#/components/schemas/ExcessCapacityTerminationPolicy'
SpotFleetRequestId:
type: string
TargetCapacity:
type: integer
format: int32
description: Contains the parameters for ModifySpotFleetRequest.
ServiceConfiguration:
title: ServiceConfiguration
type: object
properties:
ServiceType:
type: array
items:
$ref: '#/components/schemas/ServiceTypeDetail'
description: ''
ServiceId:
type: string
ServiceName:
type: string
ServiceState:
$ref: '#/components/schemas/ServiceState'
AvailabilityZones:
type: array
items:
type: string
description: ''
AcceptanceRequired:
type: boolean
ManagesVpcEndpoints:
type: boolean
NetworkLoadBalancerArns:
type: array
items:
type: string
description: ''
BaseEndpointDnsNames:
type: array
items:
type: string
description: ''
PrivateDnsName:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a service configuration for a VPC endpoint service.
Placement:
title: Placement
type: object
properties:
AvailabilityZone:
type: string
Affinity:
type: string
GroupName:
type: string
PartitionNumber:
type: integer
format: int32
HostId:
type: string
Tenancy:
$ref: '#/components/schemas/Tenancy'
SpreadDomain:
type: string
description: Describes the placement of an instance.
ClientVpnConnectionStatus:
title: ClientVpnConnectionStatus
type: object
properties:
Code:
$ref: '#/components/schemas/ClientVpnConnectionStatusCode'
Message:
type: string
description: Describes the status of a client connection.
LaunchTemplateOverrides:
title: LaunchTemplateOverrides
type: object
properties:
InstanceType:
$ref: '#/components/schemas/InstanceType'
SpotPrice:
type: string
SubnetId:
type: string
AvailabilityZone:
type: string
WeightedCapacity:
type: number
Priority:
type: number
description: Describes overrides for a launch template.
ConversionTask:
title: ConversionTask
type: object
properties:
ConversionTaskId:
type: string
ExpirationTime:
type: string
ImportInstance:
allOf:
- $ref: '#/components/schemas/ImportInstanceTaskDetails'
- description: Describes an import instance task.
ImportVolume:
allOf:
- $ref: '#/components/schemas/ImportVolumeTaskDetails'
- description: Describes an import volume task.
State:
$ref: '#/components/schemas/ConversionTaskState'
StatusMessage:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a conversion task.
ImageDiskContainer:
title: ImageDiskContainer
type: object
properties:
Description:
type: string
DeviceName:
type: string
Format:
type: string
SnapshotId:
type: string
Url:
type: string
UserBucket:
allOf:
- $ref: '#/components/schemas/UserBucket'
- description: Describes the S3 bucket for the disk image.
description: Describes the disk container object for an import image task.
DescribeSpotInstanceRequestsRequest:
title: DescribeSpotInstanceRequestsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
SpotInstanceRequestIds:
type: array
items:
type: string
description: ''
NextToken:
type: string
MaxResults:
type: integer
format: int32
description: Contains the parameters for DescribeSpotInstanceRequests.
DescribeRouteTablesResult:
title: DescribeRouteTablesResult
type: object
properties:
RouteTables:
type: array
items:
$ref: '#/components/schemas/RouteTable'
description: ''
NextToken:
type: string
description: Contains the output of DescribeRouteTables.
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
CreateNetworkInterfacePermissionResult:
title: CreateNetworkInterfacePermissionResult
type: object
properties:
InterfacePermission:
allOf:
- $ref: '#/components/schemas/NetworkInterfacePermission'
- description: Describes a permission for a network interface.
description: Contains the output of CreateNetworkInterfacePermission.
HostReservation:
title: HostReservation
type: object
properties:
Count:
type: integer
format: int32
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
Duration:
type: integer
format: int32
End:
type: string
format: date-time
HostIdSet:
type: array
items:
type: string
description: ''
HostReservationId:
type: string
HourlyPrice:
type: string
InstanceFamily:
type: string
OfferingId:
type: string
PaymentOption:
$ref: '#/components/schemas/PaymentOption'
Start:
type: string
format: date-time
State:
$ref: '#/components/schemas/ReservationState'
UpfrontPrice:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Details about the Dedicated Host Reservation and associated Dedicated Hosts.
AuthorizeSecurityGroupEgressRequest:
title: AuthorizeSecurityGroupEgressRequest
required:
- GroupId
type: object
properties:
DryRun:
type: boolean
GroupId:
type: string
IpPermissions:
type: array
items:
$ref: '#/components/schemas/IpPermission'
description: ''
CidrIp:
type: string
FromPort:
type: integer
format: int32
IpProtocol:
type: string
ToPort:
type: integer
format: int32
SourceSecurityGroupName:
type: string
SourceSecurityGroupOwnerId:
type: string
BundleTask:
title: BundleTask
type: object
properties:
BundleId:
type: string
BundleTaskError:
allOf:
- $ref: '#/components/schemas/BundleTaskError'
- description: Describes an error for BundleInstance.
InstanceId:
type: string
Progress:
type: string
StartTime:
type: string
format: date-time
State:
$ref: '#/components/schemas/BundleTaskState'
Storage:
allOf:
- $ref: '#/components/schemas/Storage'
- description: Describes the storage location for an instance store-backed AMI.
UpdateTime:
type: string
format: date-time
description: Describes a bundle task.
GetPasswordDataRequest:
title: GetPasswordDataRequest
required:
- InstanceId
type: object
properties:
InstanceId:
type: string
DryRun:
type: boolean
DnsEntry:
title: DnsEntry
type: object
properties:
DnsName:
type: string
HostedZoneId:
type: string
description: Describes a DNS entry.
DeleteClientVpnRouteRequest:
title: DeleteClientVpnRouteRequest
required:
- ClientVpnEndpointId
- DestinationCidrBlock
type: object
properties:
ClientVpnEndpointId:
type: string
TargetVpcSubnetId:
type: string
DestinationCidrBlock:
type: string
DryRun:
type: boolean
DeletePlacementGroupRequest:
title: DeletePlacementGroupRequest
required:
- GroupName
type: object
properties:
DryRun:
type: boolean
GroupName:
type: string
VpcEndpointConnection:
title: VpcEndpointConnection
type: object
properties:
ServiceId:
type: string
VpcEndpointId:
type: string
VpcEndpointOwner:
type: string
VpcEndpointState:
$ref: '#/components/schemas/State'
CreationTimestamp:
type: string
format: date-time
description: Describes a VPC endpoint connection to a service.
NetworkInterfaceIpv6Address:
title: NetworkInterfaceIpv6Address
type: object
properties:
Ipv6Address:
type: string
description: Describes an IPv6 address associated with a network interface.
CreateNetworkAclEntryRequest:
title: CreateNetworkAclEntryRequest
required:
- Egress
- NetworkAclId
- Protocol
- RuleAction
- RuleNumber
type: object
properties:
CidrBlock:
type: string
DryRun:
type: boolean
Egress:
type: boolean
IcmpTypeCode:
allOf:
- $ref: '#/components/schemas/IcmpTypeCode'
- description: Describes the ICMP type and code.
Ipv6CidrBlock:
type: string
NetworkAclId:
type: string
PortRange:
allOf:
- $ref: '#/components/schemas/PortRange'
- description: Describes a range of ports.
Protocol:
type: string
RuleAction:
$ref: '#/components/schemas/RuleAction'
RuleNumber:
type: integer
format: int32
InstanceStatusEvent:
title: InstanceStatusEvent
type: object
properties:
InstanceEventId:
type: string
Code:
$ref: '#/components/schemas/EventCode'
Description:
type: string
NotAfter:
type: string
format: date-time
NotBefore:
type: string
format: date-time
NotBeforeDeadline:
type: string
format: date-time
description: Describes a scheduled event for an instance.
ExportClientVpnClientConfigurationResult:
title: ExportClientVpnClientConfigurationResult
type: object
properties:
ClientConfiguration:
type: string
VpcCidrBlockAssociation:
title: VpcCidrBlockAssociation
type: object
properties:
AssociationId:
type: string
CidrBlock:
type: string
CidrBlockState:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockState'
- description: Describes the state of a CIDR block.
description: Describes an IPv4 CIDR block associated with a VPC.
ClassicLinkDnsSupport:
title: ClassicLinkDnsSupport
type: object
properties:
ClassicLinkDnsSupported:
type: boolean
VpcId:
type: string
description: Describes the ClassicLink DNS support status of a VPC.
Storage:
title: Storage
type: object
properties:
S3:
allOf:
- $ref: '#/components/schemas/S3Storage'
- description: Describes the storage parameters for S3 and S3 buckets for an instance store-backed AMI.
description: Describes the storage location for an instance store-backed AMI.
GroupIdentifier:
title: GroupIdentifier
type: object
properties:
GroupName:
type: string
GroupId:
type: string
description: Describes a security group.
EbsInstanceBlockDeviceSpecification:
title: EbsInstanceBlockDeviceSpecification
type: object
properties:
DeleteOnTermination:
type: boolean
VolumeId:
type: string
description: Describes information used to set up an EBS volume specified in a block device mapping.
State:
title: State
enum:
- PendingAcceptance
- Pending
- Available
- Deleting
- Deleted
- Rejected
- Failed
- Expired
type: string
InstanceInterruptionBehavior:
title: InstanceInterruptionBehavior
enum:
- hibernate
- stop
- terminate
type: string
Volume:
title: Volume
type: object
properties:
Attachments:
type: array
items:
$ref: '#/components/schemas/VolumeAttachment'
description: ''
AvailabilityZone:
type: string
CreateTime:
type: string
format: date-time
Encrypted:
type: boolean
KmsKeyId:
type: string
Size:
type: integer
format: int32
SnapshotId:
type: string
State:
$ref: '#/components/schemas/VolumeState'
VolumeId:
type: string
Iops:
type: integer
format: int32
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VolumeType:
$ref: '#/components/schemas/VolumeType'
description: Describes a volume.
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
ExportTaskState:
title: ExportTaskState
enum:
- active
- cancelling
- cancelled
- completed
type: string
Ipv6CidrBlock:
title: Ipv6CidrBlock
type: object
properties:
Ipv6CidrBlock:
type: string
description: Describes an IPv6 CIDR block.
LaunchTemplateHibernationOptionsRequest:
title: LaunchTemplateHibernationOptionsRequest
type: object
properties:
Configured:
type: boolean
description: Indicates whether the instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux.
VpcIpv6CidrBlockAssociation:
title: VpcIpv6CidrBlockAssociation
type: object
properties:
AssociationId:
type: string
Ipv6CidrBlock:
type: string
Ipv6CidrBlockState:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockState'
- description: Describes the state of a CIDR block.
description: Describes an IPv6 CIDR block associated with a VPC.
VolumeAttachment:
title: VolumeAttachment
type: object
properties:
AttachTime:
type: string
format: date-time
Device:
type: string
InstanceId:
type: string
State:
$ref: '#/components/schemas/VolumeAttachmentState'
VolumeId:
type: string
DeleteOnTermination:
type: boolean
description: Describes volume attachment details.
example:
AttachTime: 2014-02-27T19:23:06.000Z
Device: /dev/sdb
InstanceId: i-1234567890abcdef0
State: detaching
VolumeId: vol-049df61146c4d7901
LaunchTemplatePlacementRequest:
title: LaunchTemplatePlacementRequest
type: object
properties:
AvailabilityZone:
type: string
Affinity:
type: string
GroupName:
type: string
HostId:
type: string
Tenancy:
$ref: '#/components/schemas/Tenancy'
SpreadDomain:
type: string
description: Describes the placement of an instance.
ModifyVpcEndpointRequest:
title: ModifyVpcEndpointRequest
required:
- VpcEndpointId
type: object
properties:
DryRun:
type: boolean
VpcEndpointId:
type: string
ResetPolicy:
type: boolean
PolicyDocument:
type: string
AddRouteTableIds:
type: array
items:
type: string
description: ''
RemoveRouteTableIds:
type: array
items:
type: string
description: ''
AddSubnetIds:
type: array
items:
type: string
description: ''
RemoveSubnetIds:
type: array
items:
type: string
description: ''
AddSecurityGroupIds:
type: array
items:
type: string
description: ''
RemoveSecurityGroupIds:
type: array
items:
type: string
description: ''
PrivateDnsEnabled:
type: boolean
description: Contains the parameters for ModifyVpcEndpoint.
ModifyTransitGatewayVpcAttachmentResult:
title: ModifyTransitGatewayVpcAttachmentResult
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- description: Describes a VPC attachment.
DeleteSpotDatafeedSubscriptionRequest:
title: DeleteSpotDatafeedSubscriptionRequest
type: object
properties:
DryRun:
type: boolean
description: Contains the parameters for DeleteSpotDatafeedSubscription.
DescribeLaunchTemplatesResult:
title: DescribeLaunchTemplatesResult
type: object
properties:
LaunchTemplates:
type: array
items:
$ref: '#/components/schemas/LaunchTemplate'
description: ''
NextToken:
type: string
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
Vpc:
title: Vpc
type: object
properties:
CidrBlock:
type: string
DhcpOptionsId:
type: string
State:
$ref: '#/components/schemas/VpcState'
VpcId:
type: string
OwnerId:
type: string
InstanceTenancy:
$ref: '#/components/schemas/Tenancy'
Ipv6CidrBlockAssociationSet:
type: array
items:
$ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
description: ''
CidrBlockAssociationSet:
type: array
items:
$ref: '#/components/schemas/VpcCidrBlockAssociation'
description: ''
IsDefault:
type: boolean
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a VPC.
CreateDefaultSubnetResult:
title: CreateDefaultSubnetResult
type: object
properties:
Subnet:
allOf:
- $ref: '#/components/schemas/Subnet'
- description: Describes a subnet.
IamInstanceProfile:
title: IamInstanceProfile
type: object
properties:
Arn:
type: string
Id:
type: string
description: Describes an IAM instance profile.
ModifyLaunchTemplateRequest:
title: ModifyLaunchTemplateRequest
type: object
properties:
DryRun:
type: boolean
ClientToken:
type: string
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
DefaultVersion:
type: string
TargetConfigurationRequest:
title: TargetConfigurationRequest
required:
- OfferingId
type: object
properties:
InstanceCount:
type: integer
format: int32
OfferingId:
type: string
description: Details about the target configuration.
ModifyInstanceCreditSpecificationRequest:
title: ModifyInstanceCreditSpecificationRequest
required:
- InstanceCreditSpecifications
type: object
properties:
DryRun:
type: boolean
ClientToken:
type: string
InstanceCreditSpecifications:
type: array
items:
$ref: '#/components/schemas/InstanceCreditSpecificationRequest'
description: ''
FleetActivityStatus:
title: FleetActivityStatus
enum:
- error
- pending-fulfillment
- pending-termination
- fulfilled
type: string
LoadPermission:
title: LoadPermission
type: object
properties:
UserId:
type: string
Group:
$ref: '#/components/schemas/PermissionGroup'
description: Describes a load permission.
InstanceMarketOptionsRequest:
title: InstanceMarketOptionsRequest
type: object
properties:
MarketType:
$ref: '#/components/schemas/MarketType'
SpotOptions:
allOf:
- $ref: '#/components/schemas/SpotMarketOptions'
- description: The options for Spot Instances.
description: Describes the market (purchasing) option for the instances.
AdvertiseByoipCidrRequest:
title: AdvertiseByoipCidrRequest
required:
- Cidr
type: object
properties:
Cidr:
type: string
DryRun:
type: boolean
DescribeLaunchTemplatesRequest:
title: DescribeLaunchTemplatesRequest
type: object
properties:
DryRun:
type: boolean
LaunchTemplateIds:
type: array
items:
type: string
description: ''
LaunchTemplateNames:
type: array
items:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
NextToken:
type: string
MaxResults:
maximum: 200
minimum: 1
type: integer
format: int32
scope:
title: scope
enum:
- Availability Zone
- Region
type: string
DnsServersOptionsModifyStructure:
title: DnsServersOptionsModifyStructure
type: object
properties:
CustomDnsServers:
type: array
items:
type: string
description: ''
Enabled:
type: boolean
description: Information about the DNS server to be used.
DeleteLaunchTemplateVersionsResponseSuccessItem:
title: DeleteLaunchTemplateVersionsResponseSuccessItem
type: object
properties:
LaunchTemplateId:
type: string
LaunchTemplateName:
type: string
VersionNumber:
type: integer
format: int32
description: Describes a launch template version that was successfully deleted.
InstancePrivateIpAddress:
title: InstancePrivateIpAddress
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/InstanceNetworkInterfaceAssociation'
- description: Describes association information for an Elastic IP address (IPv4).
Primary:
type: boolean
PrivateDnsName:
type: string
PrivateIpAddress:
type: string
description: Describes a private IPv4 address.
DescribeImageAttributeRequest:
title: DescribeImageAttributeRequest
required:
- Attribute
- ImageId
type: object
properties:
Attribute:
$ref: '#/components/schemas/ImageAttributeName'
ImageId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DescribeImageAttribute.
ResetFpgaImageAttributeResult:
title: ResetFpgaImageAttributeResult
type: object
properties:
Return:
type: boolean
FlowLogsResourceType:
title: FlowLogsResourceType
enum:
- VPC
- Subnet
- NetworkInterface
type: string
PciId:
title: PciId
type: object
properties:
DeviceId:
type: string
VendorId:
type: string
SubsystemId:
type: string
SubsystemVendorId:
type: string
description: Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.
DescribePrefixListsResult:
title: DescribePrefixListsResult
type: object
properties:
NextToken:
type: string
PrefixLists:
type: array
items:
$ref: '#/components/schemas/PrefixList'
description: ''
AutoPlacement:
title: AutoPlacement
enum:
- on
- off
type: string
DeleteSnapshotRequest:
title: DeleteSnapshotRequest
required:
- SnapshotId
type: object
properties:
SnapshotId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DeleteSnapshot.
RegisterImageRequest:
title: RegisterImageRequest
required:
- Name
type: object
properties:
ImageLocation:
type: string
Architecture:
$ref: '#/components/schemas/ArchitectureValues'
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/BlockDeviceMapping'
description: ''
Description:
type: string
DryRun:
type: boolean
EnaSupport:
type: boolean
KernelId:
type: string
Name:
type: string
BillingProducts:
type: array
items:
type: string
description: ''
RamdiskId:
type: string
RootDeviceName:
type: string
SriovNetSupport:
type: string
VirtualizationType:
type: string
description: Contains the parameters for RegisterImage.
DescribePlacementGroupsRequest:
title: DescribePlacementGroupsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
GroupNames:
type: array
items:
type: string
description: ''
TransitGatewayAttachmentPropagation:
title: TransitGatewayAttachmentPropagation
type: object
properties:
TransitGatewayRouteTableId:
type: string
State:
$ref: '#/components/schemas/TransitGatewayPropagationState'
description: Describes a propagation route table.
CopyImageResult:
title: CopyImageResult
type: object
properties:
ImageId:
type: string
description: Contains the output of CopyImage.
example:
ImageId: ami-438bea42
SearchTransitGatewayRoutesRequest:
title: SearchTransitGatewayRoutesRequest
required:
- TransitGatewayRouteTableId
- Filters
type: object
properties:
TransitGatewayRouteTableId:
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
DryRun:
type: boolean
ClientVpnAuthenticationRequest:
title: ClientVpnAuthenticationRequest
type: object
properties:
Type:
$ref: '#/components/schemas/ClientVpnAuthenticationType'
ActiveDirectory:
allOf:
- $ref: '#/components/schemas/DirectoryServiceAuthenticationRequest'
- description: Describes the Active Directory to be used for client authentication.
MutualAuthentication:
allOf:
- $ref: '#/components/schemas/CertificateAuthenticationRequest'
- description: Information about the client certificate to be used for authentication.
description: Describes the authentication method to be used by a Client VPN endpoint. Client VPN supports Active Directory and mutual authentication. For more information, see Authentication in the AWS Client VPN Administrator Guide.
InstanceLifecycleType:
title: InstanceLifecycleType
enum:
- spot
- scheduled
type: string
VpcPeeringConnectionOptionsDescription:
title: VpcPeeringConnectionOptionsDescription
type: object
properties:
AllowDnsResolutionFromRemoteVpc:
type: boolean
AllowEgressFromLocalClassicLinkToRemoteVpc:
type: boolean
AllowEgressFromLocalVpcToRemoteClassicLink:
type: boolean
description: Describes the VPC peering connection options.
CreateFleetInstance:
title: CreateFleetInstance
type: object
properties:
LaunchTemplateAndOverrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- description: Describes a launch template and overrides.
Lifecycle:
$ref: '#/components/schemas/InstanceLifecycle'
InstanceIds:
type: array
items:
type: string
description: ''
InstanceType:
$ref: '#/components/schemas/InstanceType'
Platform:
$ref: '#/components/schemas/PlatformValues'
description: Describes the instances that were launched by the fleet.
AccountAttribute:
title: AccountAttribute
type: object
properties:
AttributeName:
type: string
AttributeValues:
type: array
items:
$ref: '#/components/schemas/AccountAttributeValue'
description: ''
description: Describes an account attribute.
DescribeTransitGatewayRouteTablesResult:
title: DescribeTransitGatewayRouteTablesResult
type: object
properties:
TransitGatewayRouteTables:
type: array
items:
$ref: '#/components/schemas/TransitGatewayRouteTable'
description: ''
NextToken:
type: string
CidrBlock:
title: CidrBlock
type: object
properties:
CidrBlock:
type: string
description: Describes an IPv4 CIDR block.
PlacementGroup:
title: PlacementGroup
type: object
properties:
GroupName:
type: string
State:
$ref: '#/components/schemas/PlacementGroupState'
Strategy:
$ref: '#/components/schemas/PlacementStrategy'
PartitionCount:
type: integer
format: int32
description: Describes a placement group.
TransitGatewayAttachmentAssociation:
title: TransitGatewayAttachmentAssociation
type: object
properties:
TransitGatewayRouteTableId:
type: string
State:
$ref: '#/components/schemas/TransitGatewayAssociationState'
description: Describes an association.
DhcpOptions:
title: DhcpOptions
type: object
properties:
DhcpConfigurations:
type: array
items:
$ref: '#/components/schemas/DhcpConfiguration'
description: ''
DhcpOptionsId:
type: string
OwnerId:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a set of DHCP options.
DescribeInstanceCreditSpecificationsRequest:
title: DescribeInstanceCreditSpecificationsRequest
type: object
properties:
DryRun:
type: boolean
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
InstanceIds:
type: array
items:
type: string
description: ''
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
NextToken:
type: string
ClientVpnRoute:
title: ClientVpnRoute
type: object
properties:
ClientVpnEndpointId:
type: string
DestinationCidr:
type: string
TargetSubnet:
type: string
Type:
type: string
Origin:
type: string
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnRouteStatus'
- description: Describes the state of a Client VPN endpoint route.
Description:
type: string
description: Information about a Client VPN endpoint route.
DescribeFleetsInstances:
title: DescribeFleetsInstances
type: object
properties:
LaunchTemplateAndOverrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- description: Describes a launch template and overrides.
Lifecycle:
$ref: '#/components/schemas/InstanceLifecycle'
InstanceIds:
type: array
items:
type: string
description: ''
InstanceType:
$ref: '#/components/schemas/InstanceType'
Platform:
$ref: '#/components/schemas/PlatformValues'
description: Describes the instances that were launched by the fleet.
CancelCapacityReservationResult:
title: CancelCapacityReservationResult
type: object
properties:
Return:
type: boolean
ConfirmProductInstanceResult:
title: ConfirmProductInstanceResult
type: object
properties:
OwnerId:
type: string
Return:
type: boolean
example:
OwnerId: '123456789012'
BlobAttributeValue:
title: BlobAttributeValue
type: object
properties:
Value:
type: string
ElasticGpuSpecification:
title: ElasticGpuSpecification
required:
- Type
type: object
properties:
Type:
type: string
description: A specification for an Elastic Graphics accelerator.
UserBucket:
title: UserBucket
type: object
properties:
S3Bucket:
type: string
S3Key:
type: string
description: Describes the S3 bucket for the disk image.
FleetStateCode:
title: FleetStateCode
enum:
- submitted
- active
- deleted
- failed
- deleted-running
- deleted-terminating
- modifying
type: string
DeregisterImageRequest:
title: DeregisterImageRequest
required:
- ImageId
type: object
properties:
ImageId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DeregisterImage.
ImportSnapshotRequest:
title: ImportSnapshotRequest
type: object
properties:
ClientData:
allOf:
- $ref: '#/components/schemas/ClientData'
- description: Describes the client-specific data.
ClientToken:
type: string
Description:
type: string
DiskContainer:
allOf:
- $ref: '#/components/schemas/SnapshotDiskContainer'
- description: The disk container object for the import snapshot request.
DryRun:
type: boolean
Encrypted:
type: boolean
KmsKeyId:
type: string
RoleName:
type: string
description: Contains the parameters for ImportSnapshot.
CreateNetworkAclResult:
title: CreateNetworkAclResult
type: object
properties:
NetworkAcl:
allOf:
- $ref: '#/components/schemas/NetworkAcl'
- description: Describes a network ACL.
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
DeprovisionByoipCidrRequest:
title: DeprovisionByoipCidrRequest
required:
- Cidr
type: object
properties:
Cidr:
type: string
DryRun:
type: boolean
DescribeCustomerGatewaysRequest:
title: DescribeCustomerGatewaysRequest
type: object
properties:
CustomerGatewayIds:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
description: Contains the parameters for DescribeCustomerGateways.
DescribeVpcsRequest:
title: DescribeVpcsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
VpcIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
NextToken:
type: string
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
AuthorizeClientVpnIngressRequest:
title: AuthorizeClientVpnIngressRequest
required:
- ClientVpnEndpointId
- TargetNetworkCidr
type: object
properties:
ClientVpnEndpointId:
type: string
TargetNetworkCidr:
type: string
AccessGroupId:
type: string
AuthorizeAllGroups:
type: boolean
Description:
type: string
DryRun:
type: boolean
IpPermission:
title: IpPermission
type: object
properties:
FromPort:
type: integer
format: int32
IpProtocol:
type: string
IpRanges:
type: array
items:
$ref: '#/components/schemas/IpRange'
description: ''
Ipv6Ranges:
type: array
items:
$ref: '#/components/schemas/Ipv6Range'
description: ''
PrefixListIds:
type: array
items:
$ref: '#/components/schemas/PrefixListId'
description: ''
ToPort:
type: integer
format: int32
UserIdGroupPairs:
type: array
items:
$ref: '#/components/schemas/UserIdGroupPair'
description: ''
description: Describes a set of permissions for a security group rule.
IcmpTypeCode:
title: IcmpTypeCode
type: object
properties:
Code:
type: integer
format: int32
Type:
type: integer
format: int32
description: Describes the ICMP type and code.
LaunchTemplateInstanceNetworkInterfaceSpecification:
title: LaunchTemplateInstanceNetworkInterfaceSpecification
type: object
properties:
AssociatePublicIpAddress:
type: boolean
DeleteOnTermination:
type: boolean
Description:
type: string
DeviceIndex:
type: integer
format: int32
Groups:
type: array
items:
type: string
description: ''
InterfaceType:
type: string
Ipv6AddressCount:
type: integer
format: int32
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/InstanceIpv6Address'
description: ''
NetworkInterfaceId:
type: string
PrivateIpAddress:
type: string
PrivateIpAddresses:
type: array
items:
$ref: '#/components/schemas/PrivateIpAddressSpecification'
description: ''
SecondaryPrivateIpAddressCount:
type: integer
format: int32
SubnetId:
type: string
description: Describes a network interface.
UnsuccessfulInstanceCreditSpecificationErrorCode:
title: UnsuccessfulInstanceCreditSpecificationErrorCode
enum:
- InvalidInstanceID.Malformed
- InvalidInstanceID.NotFound
- IncorrectInstanceState
- InstanceCreditSpecification.NotSupported
type: string
SpotInstanceType:
title: SpotInstanceType
enum:
- one-time
- persistent
type: string
ModifyReservedInstancesResult:
title: ModifyReservedInstancesResult
type: object
properties:
ReservedInstancesModificationId:
type: string
description: Contains the output of ModifyReservedInstances.
ClientVpnRouteStatus:
title: ClientVpnRouteStatus
type: object
properties:
Code:
$ref: '#/components/schemas/ClientVpnRouteStatusCode'
Message:
type: string
description: Describes the state of a Client VPN endpoint route.
FpgaImageState:
title: FpgaImageState
type: object
properties:
Code:
$ref: '#/components/schemas/FpgaImageStateCode'
Message:
type: string
description: Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).
ImportInstanceTaskDetails:
title: ImportInstanceTaskDetails
type: object
properties:
Description:
type: string
InstanceId:
type: string
Platform:
$ref: '#/components/schemas/PlatformValues'
Volumes:
type: array
items:
$ref: '#/components/schemas/ImportInstanceVolumeDetailItem'
description: ''
description: Describes an import instance task.
RequestSpotInstancesRequest:
title: RequestSpotInstancesRequest
type: object
properties:
AvailabilityZoneGroup:
type: string
BlockDurationMinutes:
type: integer
format: int32
ClientToken:
type: string
DryRun:
type: boolean
InstanceCount:
type: integer
format: int32
LaunchGroup:
type: string
LaunchSpecification:
allOf:
- $ref: '#/components/schemas/RequestSpotLaunchSpecification'
- description: Describes the launch specification for an instance.
SpotPrice:
type: string
Type:
$ref: '#/components/schemas/SpotInstanceType'
ValidFrom:
type: string
format: date-time
ValidUntil:
type: string
format: date-time
InstanceInterruptionBehavior:
$ref: '#/components/schemas/InstanceInterruptionBehavior'
description: Contains the parameters for RequestSpotInstances.
ListingStatus:
title: ListingStatus
enum:
- active
- pending
- cancelled
- closed
type: string
UpdateSecurityGroupRuleDescriptionsEgressResult:
title: UpdateSecurityGroupRuleDescriptionsEgressResult
type: object
properties:
Return:
type: boolean
example: {}
DeleteKeyPairRequest:
title: DeleteKeyPairRequest
required:
- KeyName
type: object
properties:
KeyName:
type: string
DryRun:
type: boolean
HistoryRecord:
title: HistoryRecord
type: object
properties:
EventInformation:
allOf:
- $ref: '#/components/schemas/EventInformation'
- description: Describes an EC2 Fleet or Spot Fleet event.
EventType:
$ref: '#/components/schemas/EventType'
Timestamp:
type: string
format: date-time
description: Describes an event in the history of the Spot Fleet request.
ResetImageAttributeRequest:
title: ResetImageAttributeRequest
required:
- Attribute
- ImageId
type: object
properties:
Attribute:
enum:
- launchPermission
type: string
ImageId:
type: string
DryRun:
type: boolean
description: Contains the parameters for ResetImageAttribute.
VirtualizationType:
title: VirtualizationType
enum:
- hvm
- paravirtual
type: string
DescribeNatGatewaysResult:
title: DescribeNatGatewaysResult
type: object
properties:
NatGateways:
type: array
items:
$ref: '#/components/schemas/NatGateway'
description: ''
NextToken:
type: string
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
ElasticInferenceAccelerator:
title: ElasticInferenceAccelerator
required:
- Type
type: object
properties:
Type:
type: string
description: Describes an elastic inference accelerator.
SubnetState:
title: SubnetState
enum:
- pending
- available
type: string
ResponseLaunchTemplateData:
title: ResponseLaunchTemplateData
type: object
properties:
KernelId:
type: string
EbsOptimized:
type: boolean
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecification'
- description: Describes an IAM instance profile.
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateBlockDeviceMapping'
description: ''
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecification'
description: ''
ImageId:
type: string
InstanceType:
$ref: '#/components/schemas/InstanceType'
KeyName:
type: string
Monitoring:
allOf:
- $ref: '#/components/schemas/LaunchTemplatesMonitoring'
- description: Describes the monitoring for the instance.
Placement:
allOf:
- $ref: '#/components/schemas/LaunchTemplatePlacement'
- description: Describes the placement of an instance.
RamDiskId:
type: string
DisableApiTermination:
type: boolean
InstanceInitiatedShutdownBehavior:
$ref: '#/components/schemas/ShutdownBehavior'
UserData:
type: string
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateTagSpecification'
description: ''
ElasticGpuSpecifications:
type: array
items:
$ref: '#/components/schemas/ElasticGpuSpecificationResponse'
description: ''
ElasticInferenceAccelerators:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateElasticInferenceAcceleratorResponse'
description: ''
SecurityGroupIds:
type: array
items:
type: string
description: ''
SecurityGroups:
type: array
items:
type: string
description: ''
InstanceMarketOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMarketOptions'
- description: The market (purchasing) option for the instances.
CreditSpecification:
allOf:
- $ref: '#/components/schemas/CreditSpecification'
- description: Describes the credit option for CPU usage of a T2 or T3 instance.
CpuOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateCpuOptions'
- description: The CPU options for the instance.
CapacityReservationSpecification:
allOf:
- $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationResponse'
- description: Information about the Capacity Reservation targeting option.
LicenseSpecifications:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateLicenseConfiguration'
description: ''
HibernationOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateHibernationOptions'
- description: Indicates whether an instance is configured for hibernation.
description: The information for a launch template.
InstanceIpv6Address:
title: InstanceIpv6Address
type: object
properties:
Ipv6Address:
type: string
description: Describes an IPv6 address.
DeleteInternetGatewayRequest:
title: DeleteInternetGatewayRequest
required:
- InternetGatewayId
type: object
properties:
DryRun:
type: boolean
InternetGatewayId:
type: string
CapacityReservationState:
title: CapacityReservationState
enum:
- active
- expired
- cancelled
- pending
- failed
type: string
SubnetIpv6CidrBlockAssociation:
title: SubnetIpv6CidrBlockAssociation
type: object
properties:
AssociationId:
type: string
Ipv6CidrBlock:
type: string
Ipv6CidrBlockState:
allOf:
- $ref: '#/components/schemas/SubnetCidrBlockState'
- description: Describes the state of a CIDR block.
description: Describes an IPv6 CIDR block associated with a subnet.
LaunchTemplateVersion:
title: LaunchTemplateVersion
type: object
properties:
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
VersionNumber:
type: integer
format: int32
VersionDescription:
maxLength: 255
type: string
CreateTime:
type: string
format: date-time
CreatedBy:
type: string
DefaultVersion:
type: boolean
LaunchTemplateData:
allOf:
- $ref: '#/components/schemas/ResponseLaunchTemplateData'
- description: The information for a launch template.
description: Describes a launch template version.
VpcEndpoint:
title: VpcEndpoint
type: object
properties:
VpcEndpointId:
type: string
VpcEndpointType:
$ref: '#/components/schemas/VpcEndpointType'
VpcId:
type: string
ServiceName:
type: string
State:
$ref: '#/components/schemas/State'
PolicyDocument:
type: string
RouteTableIds:
type: array
items:
type: string
description: ''
SubnetIds:
type: array
items:
type: string
description: ''
Groups:
type: array
items:
$ref: '#/components/schemas/SecurityGroupIdentifier'
description: ''
PrivateDnsEnabled:
type: boolean
RequesterManaged:
type: boolean
NetworkInterfaceIds:
type: array
items:
type: string
description: ''
DnsEntries:
type: array
items:
$ref: '#/components/schemas/DnsEntry'
description: ''
CreationTimestamp:
type: string
format: date-time
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a VPC endpoint.
VpcAttachment:
title: VpcAttachment
type: object
properties:
State:
$ref: '#/components/schemas/AttachmentStatus'
VpcId:
type: string
description: Describes an attachment between a virtual private gateway and a VPC.
AutoAcceptSharedAttachmentsValue:
title: AutoAcceptSharedAttachmentsValue
enum:
- enable
- disable
type: string
DeleteFpgaImageResult:
title: DeleteFpgaImageResult
type: object
properties:
Return:
type: boolean
AssociateVpcCidrBlockResult:
title: AssociateVpcCidrBlockResult
type: object
properties:
Ipv6CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- description: Describes an IPv6 CIDR block associated with a VPC.
CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockAssociation'
- description: Describes an IPv4 CIDR block associated with a VPC.
VpcId:
type: string
ModifyClientVpnEndpointResult:
title: ModifyClientVpnEndpointResult
type: object
properties:
Return:
type: boolean
ModifyFleetResult:
title: ModifyFleetResult
type: object
properties:
Return:
type: boolean
ActivityStatus:
title: ActivityStatus
enum:
- error
- pending_fulfillment
- pending_termination
- fulfilled
type: string
CreateReservedInstancesListingRequest:
title: CreateReservedInstancesListingRequest
required:
- ClientToken
- InstanceCount
- PriceSchedules
- ReservedInstancesId
type: object
properties:
ClientToken:
type: string
InstanceCount:
type: integer
format: int32
PriceSchedules:
type: array
items:
$ref: '#/components/schemas/PriceScheduleSpecification'
description: ''
ReservedInstancesId:
type: string
description: Contains the parameters for CreateReservedInstancesListing.
DescribeNetworkInterfaceAttributeResult:
title: DescribeNetworkInterfaceAttributeResult
type: object
properties:
Attachment:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttachment'
- description: Describes a network interface attachment.
Description:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
Groups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
NetworkInterfaceId:
type: string
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
description: Contains the output of DescribeNetworkInterfaceAttribute.
example:
NetworkInterfaceId: eni-686ea200
SourceDestCheck:
Value: true
RevokeSecurityGroupEgressRequest:
title: RevokeSecurityGroupEgressRequest
required:
- GroupId
type: object
properties:
DryRun:
type: boolean
GroupId:
type: string
IpPermissions:
type: array
items:
$ref: '#/components/schemas/IpPermission'
description: ''
CidrIp:
type: string
FromPort:
type: integer
format: int32
IpProtocol:
type: string
ToPort:
type: integer
format: int32
SourceSecurityGroupName:
type: string
SourceSecurityGroupOwnerId:
type: string
DescribeNatGatewaysRequest:
title: DescribeNatGatewaysRequest
type: object
properties:
Filter:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
type: integer
format: int32
NatGatewayIds:
type: array
items:
type: string
description: ''
NextToken:
type: string
AcceptReservedInstancesExchangeQuoteRequest:
title: AcceptReservedInstancesExchangeQuoteRequest
required:
- ReservedInstanceIds
type: object
properties:
DryRun:
type: boolean
ReservedInstanceIds:
type: array
items:
type: string
description: ''
TargetConfigurations:
type: array
items:
$ref: '#/components/schemas/TargetConfigurationRequest'
description: ''
description: Contains the parameters for accepting the quote.
RuleAction:
title: RuleAction
enum:
- allow
- deny
type: string
PurchaseReservedInstancesOfferingRequest:
title: PurchaseReservedInstancesOfferingRequest
required:
- InstanceCount
- ReservedInstancesOfferingId
type: object
properties:
InstanceCount:
type: integer
format: int32
ReservedInstancesOfferingId:
type: string
DryRun:
type: boolean
LimitPrice:
allOf:
- $ref: '#/components/schemas/ReservedInstanceLimitPrice'
- description: Describes the limit price of a Reserved Instance offering.
description: Contains the parameters for PurchaseReservedInstancesOffering.
NetworkInterfaceAssociation:
title: NetworkInterfaceAssociation
type: object
properties:
AllocationId:
type: string
AssociationId:
type: string
IpOwnerId:
type: string
PublicDnsName:
type: string
PublicIp:
type: string
description: Describes association information for an Elastic IP address (IPv4 only).
LaunchTemplateCpuOptionsRequest:
title: LaunchTemplateCpuOptionsRequest
type: object
properties:
CoreCount:
type: integer
format: int32
ThreadsPerCore:
type: integer
format: int32
description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
CreateClientVpnEndpointRequest:
title: CreateClientVpnEndpointRequest
required:
- ClientCidrBlock
- ServerCertificateArn
- AuthenticationOptions
- ConnectionLogOptions
type: object
properties:
ClientCidrBlock:
type: string
ServerCertificateArn:
type: string
AuthenticationOptions:
type: array
items:
$ref: '#/components/schemas/ClientVpnAuthenticationRequest'
description: ''
ConnectionLogOptions:
allOf:
- $ref: '#/components/schemas/ConnectionLogOptions'
- description: Describes the client connection logging options for the Client VPN endpoint.
DnsServers:
type: array
items:
type: string
description: ''
TransportProtocol:
$ref: '#/components/schemas/TransportProtocol'
Description:
type: string
DryRun:
type: boolean
ClientToken:
type: string
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: ''
ServiceTypeDetail:
title: ServiceTypeDetail
type: object
properties:
ServiceType:
$ref: '#/components/schemas/ServiceType'
description: Describes the type of service for a VPC endpoint.
CancelBundleTaskRequest:
title: CancelBundleTaskRequest
required:
- BundleId
type: object
properties:
BundleId:
type: string
DryRun:
type: boolean
description: Contains the parameters for CancelBundleTask.
DescribeVpcPeeringConnectionsRequest:
title: DescribeVpcPeeringConnectionsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
VpcPeeringConnectionIds:
type: array
items:
type: string
description: ''
NextToken:
type: string
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
CancelExportTaskRequest:
title: CancelExportTaskRequest
required:
- ExportTaskId
type: object
properties:
ExportTaskId:
type: string
description: Contains the parameters for CancelExportTask.
VpcEndpointType:
title: VpcEndpointType
enum:
- Interface
- Gateway
type: string
VpcState:
title: VpcState
enum:
- pending
- available
type: string
CreateVolumePermission:
title: CreateVolumePermission
type: object
properties:
Group:
$ref: '#/components/schemas/PermissionGroup'
UserId:
type: string
description: Describes the user or group to be added or removed from the list of create volume permissions for a volume.
CancelImportTaskRequest:
title: CancelImportTaskRequest
type: object
properties:
CancelReason:
type: string
DryRun:
type: boolean
ImportTaskId:
type: string
description: Contains the parameters for CancelImportTask.
DescribeInstanceAttributeRequest:
title: DescribeInstanceAttributeRequest
required:
- Attribute
- InstanceId
type: object
properties:
Attribute:
$ref: '#/components/schemas/InstanceAttributeName'
DryRun:
type: boolean
InstanceId:
type: string
ImportInstanceResult:
title: ImportInstanceResult
type: object
properties:
ConversionTask:
allOf:
- $ref: '#/components/schemas/ConversionTask'
- description: Describes a conversion task.
description: Contains the output for ImportInstance.
ModifyInstanceEventStartTimeRequest:
title: ModifyInstanceEventStartTimeRequest
required:
- InstanceId
- InstanceEventId
- NotBefore
type: object
properties:
DryRun:
type: boolean
InstanceId:
type: string
InstanceEventId:
type: string
NotBefore:
type: string
format: date-time
CreateVolumePermissionModifications:
title: CreateVolumePermissionModifications
type: object
properties:
Add:
type: array
items:
$ref: '#/components/schemas/CreateVolumePermission'
description: ''
Remove:
type: array
items:
$ref: '#/components/schemas/CreateVolumePermission'
description: ''
description: Describes modifications to the list of create volume permissions for a volume.
CreateDefaultSubnetRequest:
title: CreateDefaultSubnetRequest
required:
- AvailabilityZone
type: object
properties:
AvailabilityZone:
type: string
DryRun:
type: boolean
ScheduledInstance:
title: ScheduledInstance
type: object
properties:
AvailabilityZone:
type: string
CreateDate:
type: string
format: date-time
HourlyPrice:
type: string
InstanceCount:
type: integer
format: int32
InstanceType:
type: string
NetworkPlatform:
type: string
NextSlotStartTime:
type: string
format: date-time
Platform:
type: string
PreviousSlotEndTime:
type: string
format: date-time
Recurrence:
allOf:
- $ref: '#/components/schemas/ScheduledInstanceRecurrence'
- description: Describes the recurring schedule for a Scheduled Instance.
ScheduledInstanceId:
type: string
SlotDurationInHours:
type: integer
format: int32
TermEndDate:
type: string
format: date-time
TermStartDate:
type: string
format: date-time
TotalScheduledInstanceHours:
type: integer
format: int32
description: Describes a Scheduled Instance.
ModifyVpcEndpointResult:
title: ModifyVpcEndpointResult
type: object
properties:
Return:
type: boolean
ModifyVpcEndpointServiceConfigurationResult:
title: ModifyVpcEndpointServiceConfigurationResult
type: object
properties:
Return:
type: boolean
ImportClientVpnClientCertificateRevocationListRequest:
title: ImportClientVpnClientCertificateRevocationListRequest
required:
- ClientVpnEndpointId
- CertificateRevocationList
type: object
properties:
ClientVpnEndpointId:
type: string
CertificateRevocationList:
type: string
DryRun:
type: boolean
DeleteLaunchTemplateVersionsRequest:
title: DeleteLaunchTemplateVersionsRequest
required:
- Versions
type: object
properties:
DryRun:
type: boolean
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
Versions:
type: array
items:
type: string
description: ''
EbsBlockDevice:
title: EbsBlockDevice
type: object
properties:
DeleteOnTermination:
type: boolean
Iops:
type: integer
format: int32
SnapshotId:
type: string
VolumeSize:
type: integer
format: int32
VolumeType:
$ref: '#/components/schemas/VolumeType'
Encrypted:
type: boolean
KmsKeyId:
type: string
description: Describes a block device for an EBS volume.
EgressOnlyInternetGateway:
title: EgressOnlyInternetGateway
type: object
properties:
Attachments:
type: array
items:
$ref: '#/components/schemas/InternetGatewayAttachment'
description: ''
EgressOnlyInternetGatewayId:
type: string
description: Describes an egress-only internet gateway.
RunInstancesRequest:
title: RunInstancesRequest
required:
- MaxCount
- MinCount
type: object
properties:
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/BlockDeviceMapping'
description: ''
ImageId:
type: string
InstanceType:
$ref: '#/components/schemas/InstanceType'
Ipv6AddressCount:
type: integer
format: int32
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/InstanceIpv6Address'
description: ''
KernelId:
type: string
KeyName:
type: string
MaxCount:
type: integer
format: int32
MinCount:
type: integer
format: int32
Monitoring:
allOf:
- $ref: '#/components/schemas/RunInstancesMonitoringEnabled'
- description: Describes the monitoring of an instance.
Placement:
allOf:
- $ref: '#/components/schemas/Placement'
- description: Describes the placement of an instance.
RamdiskId:
type: string
SecurityGroupIds:
type: array
items:
type: string
description: ''
SecurityGroups:
type: array
items:
type: string
description: ''
SubnetId:
type: string
UserData:
type: string
AdditionalInfo:
type: string
ClientToken:
type: string
DisableApiTermination:
type: boolean
DryRun:
type: boolean
EbsOptimized:
type: boolean
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileSpecification'
- description: Describes an IAM instance profile.
InstanceInitiatedShutdownBehavior:
$ref: '#/components/schemas/ShutdownBehavior'
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/InstanceNetworkInterfaceSpecification'
description: ''
PrivateIpAddress:
type: string
ElasticGpuSpecification:
type: array
items:
$ref: '#/components/schemas/ElasticGpuSpecification'
description: ''
ElasticInferenceAccelerators:
type: array
items:
$ref: '#/components/schemas/ElasticInferenceAccelerator'
description: ''
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: ''
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplateSpecification'
- description: The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.
InstanceMarketOptions:
allOf:
- $ref: '#/components/schemas/InstanceMarketOptionsRequest'
- description: Describes the market (purchasing) option for the instances.
CreditSpecification:
allOf:
- $ref: '#/components/schemas/CreditSpecificationRequest'
- description: The credit option for CPU usage of a T2 or T3 instance.
CpuOptions:
allOf:
- $ref: '#/components/schemas/CpuOptionsRequest'
- description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
CapacityReservationSpecification:
allOf:
- $ref: '#/components/schemas/CapacityReservationSpecification'
- description: 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.
SpotFleetLaunchSpecification; you must use LaunchTemplateConfig.
TransitGatewayRouteTable:
title: TransitGatewayRouteTable
type: object
properties:
TransitGatewayRouteTableId:
type: string
TransitGatewayId:
type: string
State:
$ref: '#/components/schemas/TransitGatewayRouteTableState'
DefaultAssociationRouteTable:
type: boolean
DefaultPropagationRouteTable:
type: boolean
CreationTime:
type: string
format: date-time
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a transit gateway route table.
ReservationState:
title: ReservationState
enum:
- payment-pending
- payment-failed
- active
- retired
type: string
DescribeVpcEndpointServicePermissionsResult:
title: DescribeVpcEndpointServicePermissionsResult
type: object
properties:
AllowedPrincipals:
type: array
items:
$ref: '#/components/schemas/AllowedPrincipal'
description: ''
NextToken:
type: string
VpcClassicLink:
title: VpcClassicLink
type: object
properties:
ClassicLinkEnabled:
type: boolean
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VpcId:
type: string
description: Describes whether a VPC is enabled for ClassicLink.
RejectVpcPeeringConnectionRequest:
title: RejectVpcPeeringConnectionRequest
required:
- VpcPeeringConnectionId
type: object
properties:
DryRun:
type: boolean
VpcPeeringConnectionId:
type: string
ExcessCapacityTerminationPolicy:
title: ExcessCapacityTerminationPolicy
enum:
- noTermination
- default
type: string
AvailableCapacity:
title: AvailableCapacity
type: object
properties:
AvailableInstanceCapacity:
type: array
items:
$ref: '#/components/schemas/InstanceCapacity'
description: ''
AvailableVCpus:
type: integer
format: int32
description: The capacity information for instances launched onto the Dedicated Host.
UserIdGroupPair:
title: UserIdGroupPair
type: object
properties:
Description:
type: string
GroupId:
type: string
GroupName:
type: string
PeeringStatus:
type: string
UserId:
type: string
VpcId:
type: string
VpcPeeringConnectionId:
type: string
description: Describes a security group and AWS account ID pair.
DisassociateIamInstanceProfileResult:
title: DisassociateIamInstanceProfileResult
type: object
properties:
IamInstanceProfileAssociation:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileAssociation'
- description: Describes an association between an IAM instance profile and an instance.
example:
IamInstanceProfileAssociation:
AssociationId: iip-assoc-05020b59952902f5f
IamInstanceProfile:
Arn: arn:aws:iam::123456789012:instance-profile/admin-role
Id: AIPAI5IVIHMFFYY2DKV5Y
InstanceId: i-123456789abcde123
State: disassociating
LaunchTemplateEbsBlockDevice:
title: LaunchTemplateEbsBlockDevice
type: object
properties:
Encrypted:
type: boolean
DeleteOnTermination:
type: boolean
Iops:
type: integer
format: int32
KmsKeyId:
type: string
SnapshotId:
type: string
VolumeSize:
type: integer
format: int32
VolumeType:
$ref: '#/components/schemas/VolumeType'
description: Describes a block device for an EBS volume.
DisableVpcClassicLinkDnsSupportResult:
title: DisableVpcClassicLinkDnsSupportResult
type: object
properties:
Return:
type: boolean
AttachClassicLinkVpcRequest:
title: AttachClassicLinkVpcRequest
required:
- Groups
- InstanceId
- VpcId
type: object
properties:
DryRun:
type: boolean
Groups:
type: array
items:
type: string
description: ''
InstanceId:
type: string
VpcId:
type: string
Host:
title: Host
type: object
properties:
AutoPlacement:
$ref: '#/components/schemas/AutoPlacement'
AvailabilityZone:
type: string
AvailableCapacity:
allOf:
- $ref: '#/components/schemas/AvailableCapacity'
- description: The capacity information for instances launched onto the Dedicated Host.
ClientToken:
type: string
HostId:
type: string
HostProperties:
allOf:
- $ref: '#/components/schemas/HostProperties'
- description: Describes properties of a Dedicated Host.
HostReservationId:
type: string
Instances:
type: array
items:
$ref: '#/components/schemas/HostInstance'
description: ''
State:
$ref: '#/components/schemas/AllocationState'
AllocationTime:
type: string
format: date-time
ReleaseTime:
type: string
format: date-time
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes the properties of the Dedicated Host.
CreateNetworkInterfacePermissionRequest:
title: CreateNetworkInterfacePermissionRequest
required:
- NetworkInterfaceId
- Permission
type: object
properties:
NetworkInterfaceId:
type: string
AwsAccountId:
type: string
AwsService:
type: string
Permission:
$ref: '#/components/schemas/InterfacePermissionType'
DryRun:
type: boolean
description: Contains the parameters for CreateNetworkInterfacePermission.
CancelSpotFleetRequestsError:
title: CancelSpotFleetRequestsError
type: object
properties:
Code:
$ref: '#/components/schemas/CancelBatchErrorCode'
Message:
type: string
description: Describes a Spot Fleet error.
CreateFleetError:
title: CreateFleetError
type: object
properties:
LaunchTemplateAndOverrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- description: Describes a launch template and overrides.
Lifecycle:
$ref: '#/components/schemas/InstanceLifecycle'
ErrorCode:
type: string
ErrorMessage:
type: string
description: Describes the instances that could not be launched by the fleet.
PurchaseHostReservationRequest:
title: PurchaseHostReservationRequest
required:
- HostIdSet
- OfferingId
type: object
properties:
ClientToken:
type: string
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
HostIdSet:
type: array
items:
type: string
description: ''
LimitPrice:
type: string
OfferingId:
type: string
ReservedInstancesId:
title: ReservedInstancesId
type: object
properties:
ReservedInstancesId:
type: string
description: Describes the ID of a Reserved Instance.
AllocationState:
title: AllocationState
enum:
- available
- under-assessment
- permanent-failure
- released
- released-permanent-failure
type: string
ClientVpnEndpoint:
title: ClientVpnEndpoint
type: object
properties:
ClientVpnEndpointId:
type: string
Description:
type: string
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointStatus'
- description: Describes the state of a Client VPN endpoint.
CreationTime:
type: string
DeletionTime:
type: string
DnsName:
type: string
ClientCidrBlock:
type: string
DnsServers:
type: array
items:
type: string
description: ''
SplitTunnel:
type: boolean
VpnProtocol:
$ref: '#/components/schemas/VpnProtocol'
TransportProtocol:
$ref: '#/components/schemas/TransportProtocol'
AssociatedTargetNetworks:
type: array
items:
$ref: '#/components/schemas/AssociatedTargetNetwork'
description: ''
ServerCertificateArn:
type: string
AuthenticationOptions:
type: array
items:
$ref: '#/components/schemas/ClientVpnAuthentication'
description: ''
ConnectionLogOptions:
allOf:
- $ref: '#/components/schemas/ConnectionLogResponseOptions'
- description: Information about the client connection logging options for a Client VPN endpoint.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a Client VPN endpoint.
ElasticGpuSpecificationResponse:
title: ElasticGpuSpecificationResponse
type: object
properties:
Type:
type: string
description: Describes an elastic GPU.
AuthorizationRule:
title: AuthorizationRule
type: object
properties:
ClientVpnEndpointId:
type: string
Description:
type: string
GroupId:
type: string
AccessAll:
type: boolean
DestinationCidr:
type: string
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- description: Describes the state of an authorization rule.
description: Information about an authorization rule.
DescribeIdFormatRequest:
title: DescribeIdFormatRequest
type: object
properties:
Resource:
type: string
VpcAttributeName:
title: VpcAttributeName
enum:
- enableDnsSupport
- enableDnsHostnames
type: string
VpnTunnelOptionsSpecification:
title: VpnTunnelOptionsSpecification
type: object
properties:
TunnelInsideCidr:
type: string
PreSharedKey:
type: string
description: The tunnel options for a VPN connection.
DescribeHostsRequest:
title: DescribeHostsRequest
type: object
properties:
Filter:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
HostIds:
type: array
items:
type: string
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
Reservation:
title: Reservation
type: object
properties:
Groups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
Instances:
type: array
items:
$ref: '#/components/schemas/Instance'
description: ''
OwnerId:
type: string
RequesterId:
type: string
ReservationId:
type: string
description: Describes a reservation.
example: {}
ModifyClientVpnEndpointRequest:
title: ModifyClientVpnEndpointRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
ServerCertificateArn:
type: string
ConnectionLogOptions:
allOf:
- $ref: '#/components/schemas/ConnectionLogOptions'
- description: Describes the client connection logging options for the Client VPN endpoint.
DnsServers:
allOf:
- $ref: '#/components/schemas/DnsServersOptionsModifyStructure'
- description: Information about the DNS server to be used.
Description:
type: string
DryRun:
type: boolean
ScheduledInstancesPrivateIpAddressConfig:
title: ScheduledInstancesPrivateIpAddressConfig
type: object
properties:
Primary:
type: boolean
PrivateIpAddress:
type: string
description: Describes a private IPv4 address for a Scheduled Instance.
EnableTransitGatewayRouteTablePropagationResult:
title: EnableTransitGatewayRouteTablePropagationResult
type: object
properties:
Propagation:
allOf:
- $ref: '#/components/schemas/TransitGatewayPropagation'
- description: Describes route propagation.
IpRange:
title: IpRange
type: object
properties:
CidrIp:
type: string
Description:
type: string
description: Describes an IPv4 range.
CreateFlowLogsRequest:
title: CreateFlowLogsRequest
required:
- ResourceIds
- ResourceType
- TrafficType
type: object
properties:
DryRun:
type: boolean
ClientToken:
type: string
DeliverLogsPermissionArn:
type: string
LogGroupName:
type: string
ResourceIds:
type: array
items:
type: string
description: ''
ResourceType:
$ref: '#/components/schemas/FlowLogsResourceType'
TrafficType:
$ref: '#/components/schemas/TrafficType'
LogDestinationType:
$ref: '#/components/schemas/LogDestinationType'
LogDestination:
type: string
MonitoringState:
title: MonitoringState
enum:
- disabled
- disabling
- enabled
- pending
type: string
VpnGateway:
title: VpnGateway
type: object
properties:
AvailabilityZone:
type: string
State:
$ref: '#/components/schemas/VpnState'
Type:
$ref: '#/components/schemas/GatewayType'
VpcAttachments:
type: array
items:
$ref: '#/components/schemas/VpcAttachment'
description: ''
VpnGatewayId:
type: string
AmazonSideAsn:
type: integer
format: int32
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a virtual private gateway.
PricingDetail:
title: PricingDetail
type: object
properties:
Count:
type: integer
format: int32
Price:
type: number
description: Describes a Reserved Instance offering.
DescribeImportSnapshotTasksResult:
title: DescribeImportSnapshotTasksResult
type: object
properties:
ImportSnapshotTasks:
type: array
items:
$ref: '#/components/schemas/ImportSnapshotTask'
description: ''
NextToken:
type: string
description: Contains the output for DescribeImportSnapshotTasks.
DeleteFleetErrorCode:
title: DeleteFleetErrorCode
enum:
- fleetIdDoesNotExist
- fleetIdMalformed
- fleetNotInDeletableState
- unexpectedError
type: string
ExportTransitGatewayRoutesResult:
title: ExportTransitGatewayRoutesResult
type: object
properties:
S3Location:
type: string
ScheduledInstancesNetworkInterface:
title: ScheduledInstancesNetworkInterface
type: object
properties:
AssociatePublicIpAddress:
type: boolean
DeleteOnTermination:
type: boolean
Description:
type: string
DeviceIndex:
type: integer
format: int32
Groups:
type: array
items:
type: string
description: ''
Ipv6AddressCount:
type: integer
format: int32
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/ScheduledInstancesIpv6Address'
description: ''
NetworkInterfaceId:
type: string
PrivateIpAddress:
type: string
PrivateIpAddressConfigs:
type: array
items:
$ref: '#/components/schemas/ScheduledInstancesPrivateIpAddressConfig'
description: ''
SecondaryPrivateIpAddressCount:
type: integer
format: int32
SubnetId:
type: string
description: Describes a network interface for a Scheduled Instance.
GetLaunchTemplateDataRequest:
title: GetLaunchTemplateDataRequest
required:
- InstanceId
type: object
properties:
DryRun:
type: boolean
InstanceId:
type: string
UpdateSecurityGroupRuleDescriptionsIngressResult:
title: UpdateSecurityGroupRuleDescriptionsIngressResult
type: object
properties:
Return:
type: boolean
example: {}
HibernationOptions:
title: HibernationOptions
type: object
properties:
Configured:
type: boolean
description: Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
ResetFpgaImageAttributeName:
title: ResetFpgaImageAttributeName
enum:
- loadPermission
type: string
DescribeVpcAttributeRequest:
title: DescribeVpcAttributeRequest
required:
- Attribute
- VpcId
type: object
properties:
Attribute:
$ref: '#/components/schemas/VpcAttributeName'
VpcId:
type: string
DryRun:
type: boolean
AvailabilityZone:
title: AvailabilityZone
type: object
properties:
State:
$ref: '#/components/schemas/AvailabilityZoneState'
Messages:
type: array
items:
$ref: '#/components/schemas/AvailabilityZoneMessage'
description: ''
RegionName:
type: string
ZoneName:
type: string
ZoneId:
type: string
description: Describes an Availability Zone.
HistoryRecordEntry:
title: HistoryRecordEntry
type: object
properties:
EventInformation:
allOf:
- $ref: '#/components/schemas/EventInformation'
- description: Describes an EC2 Fleet or Spot Fleet event.
EventType:
$ref: '#/components/schemas/FleetEventType'
Timestamp:
type: string
format: date-time
description: Describes an event in the history of an EC2 Fleet.
ImageAttribute:
title: ImageAttribute
type: object
properties:
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/BlockDeviceMapping'
description: ''
ImageId:
type: string
LaunchPermissions:
type: array
items:
$ref: '#/components/schemas/LaunchPermission'
description: ''
ProductCodes:
type: array
items:
$ref: '#/components/schemas/ProductCode'
description: ''
Description:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
KernelId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
RamdiskId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
description: Describes an image attribute.
example:
ImageId: ami-5731123e
LaunchPermissions:
- UserId: '123456789012'
DeleteSubnetRequest:
title: DeleteSubnetRequest
required:
- SubnetId
type: object
properties:
SubnetId:
type: string
DryRun:
type: boolean
TransitGatewayState:
title: TransitGatewayState
enum:
- pending
- available
- modifying
- deleting
- deleted
type: string
RevokeClientVpnIngressRequest:
title: RevokeClientVpnIngressRequest
required:
- ClientVpnEndpointId
- TargetNetworkCidr
type: object
properties:
ClientVpnEndpointId:
type: string
TargetNetworkCidr:
type: string
AccessGroupId:
type: string
RevokeAllGroups:
type: boolean
DryRun:
type: boolean
SpotInstanceStatus:
title: SpotInstanceStatus
type: object
properties:
Code:
type: string
Message:
type: string
UpdateTime:
type: string
format: date-time
description: Describes the status of a Spot Instance request.
SnapshotAttributeName:
title: SnapshotAttributeName
enum:
- productCodes
- createVolumePermission
type: string
ElasticGpuHealth:
title: ElasticGpuHealth
type: object
properties:
Status:
$ref: '#/components/schemas/ElasticGpuStatus'
description: Describes the status of an Elastic Graphics accelerator.
DeleteTransitGatewayVpcAttachmentResult:
title: DeleteTransitGatewayVpcAttachmentResult
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- description: Describes a VPC attachment.
CancelBatchErrorCode:
title: CancelBatchErrorCode
enum:
- fleetRequestIdDoesNotExist
- fleetRequestIdMalformed
- fleetRequestNotInCancellableState
- unexpectedError
type: string
DisableVpcClassicLinkDnsSupportRequest:
title: DisableVpcClassicLinkDnsSupportRequest
type: object
properties:
VpcId:
type: string
CreateReservedInstancesListingResult:
title: CreateReservedInstancesListingResult
type: object
properties:
ReservedInstancesListings:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesListing'
description: ''
description: Contains the output of CreateReservedInstancesListing.
DeleteVpcEndpointServiceConfigurationsResult:
title: DeleteVpcEndpointServiceConfigurationsResult
type: object
properties:
Unsuccessful:
type: array
items:
$ref: '#/components/schemas/UnsuccessfulItem'
description: ''
DescribeNetworkInterfaceAttributeRequest:
title: DescribeNetworkInterfaceAttributeRequest
required:
- NetworkInterfaceId
type: object
properties:
Attribute:
$ref: '#/components/schemas/NetworkInterfaceAttribute'
DryRun:
type: boolean
NetworkInterfaceId:
type: string
description: Contains the parameters for DescribeNetworkInterfaceAttribute.
CreateVpcEndpointServiceConfigurationRequest:
title: CreateVpcEndpointServiceConfigurationRequest
required:
- NetworkLoadBalancerArns
type: object
properties:
DryRun:
type: boolean
AcceptanceRequired:
type: boolean
NetworkLoadBalancerArns:
type: array
items:
type: string
description: ''
ClientToken:
type: string
CreateVpnConnectionRouteRequest:
title: CreateVpnConnectionRouteRequest
required:
- DestinationCidrBlock
- VpnConnectionId
type: object
properties:
DestinationCidrBlock:
type: string
VpnConnectionId:
type: string
description: Contains the parameters for CreateVpnConnectionRoute.
PurchaseReservedInstancesOfferingResult:
title: PurchaseReservedInstancesOfferingResult
type: object
properties:
ReservedInstancesId:
type: string
description: Contains the output of PurchaseReservedInstancesOffering.
SpotFleetRequestConfig:
title: SpotFleetRequestConfig
type: object
properties:
ActivityStatus:
$ref: '#/components/schemas/ActivityStatus'
CreateTime:
type: string
format: date-time
SpotFleetRequestConfig:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestConfigData'
- description: Describes the configuration of a Spot Fleet request.
SpotFleetRequestId:
type: string
SpotFleetRequestState:
$ref: '#/components/schemas/BatchState'
description: Describes a Spot Fleet request.
VpnConnection:
title: VpnConnection
type: object
properties:
CustomerGatewayConfiguration:
type: string
CustomerGatewayId:
type: string
Category:
type: string
State:
$ref: '#/components/schemas/VpnState'
Type:
$ref: '#/components/schemas/GatewayType'
VpnConnectionId:
type: string
VpnGatewayId:
type: string
TransitGatewayId:
type: string
Options:
allOf:
- $ref: '#/components/schemas/VpnConnectionOptions'
- description: Describes VPN connection options.
Routes:
type: array
items:
$ref: '#/components/schemas/VpnStaticRoute'
description: ''
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VgwTelemetry:
type: array
items:
$ref: '#/components/schemas/VgwTelemetry'
description: ''
description: Describes a VPN connection.
ReplaceIamInstanceProfileAssociationRequest:
title: ReplaceIamInstanceProfileAssociationRequest
required:
- IamInstanceProfile
- AssociationId
type: object
properties:
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileSpecification'
- description: Describes an IAM instance profile.
AssociationId:
type: string
LaunchTemplateAndOverridesResponse:
title: LaunchTemplateAndOverridesResponse
type: object
properties:
LaunchTemplateSpecification:
allOf:
- $ref: '#/components/schemas/FleetLaunchTemplateSpecification'
- description: Describes a launch template.
Overrides:
allOf:
- $ref: '#/components/schemas/FleetLaunchTemplateOverrides'
- description: Describes overrides for a launch template.
description: Describes a launch template and overrides.
InstanceCreditSpecification:
title: InstanceCreditSpecification
type: object
properties:
InstanceId:
type: string
CpuCredits:
type: string
description: Describes the credit option for CPU usage of a T2 or T3 instance.
PlacementStrategy:
title: PlacementStrategy
enum:
- cluster
- spread
- partition
type: string
DescribeTransitGatewayRouteTablesRequest:
title: DescribeTransitGatewayRouteTablesRequest
type: object
properties:
TransitGatewayRouteTableIds:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
NextToken:
type: string
DryRun:
type: boolean
DescribeDhcpOptionsResult:
title: DescribeDhcpOptionsResult
type: object
properties:
DhcpOptions:
type: array
items:
$ref: '#/components/schemas/DhcpOptions'
description: ''
NextToken:
type: string
example:
DhcpOptions:
- DhcpConfigurations:
- Key: domain-name-servers
Values:
- Value: 10.2.5.2
- Value: 10.2.5.1
DhcpOptionsId: dopt-d9070ebb
AllocationStrategy:
title: AllocationStrategy
enum:
- lowestPrice
- diversified
type: string
VolumeModification:
title: VolumeModification
type: object
properties:
VolumeId:
type: string
ModificationState:
$ref: '#/components/schemas/VolumeModificationState'
StatusMessage:
type: string
TargetSize:
type: integer
format: int32
TargetIops:
type: integer
format: int32
TargetVolumeType:
$ref: '#/components/schemas/VolumeType'
OriginalSize:
type: integer
format: int32
OriginalIops:
type: integer
format: int32
OriginalVolumeType:
$ref: '#/components/schemas/VolumeType'
Progress:
type: integer
format: int32
StartTime:
type: string
format: date-time
EndTime:
type: string
format: date-time
description: Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
DescribeScheduledInstancesResult: title: DescribeScheduledInstancesResult type: object properties: NextToken: type: string ScheduledInstanceSet: type: array items: $ref: '#/components/schemas/ScheduledInstance' description: '' description: Contains the output of DescribeScheduledInstances. example: ScheduledInstanceSet: - AvailabilityZone: us-west-2b CreateDate: 2016-01-25T21:43:38.612Z HourlyPrice: '0.095' InstanceCount: 1 InstanceType: c4.large NetworkPlatform: EC2-VPC NextSlotStartTime: 2016-01-31T09:00:00.000Z Platform: Linux/UNIX Recurrence: Frequency: Weekly Interval: 1 OccurrenceDaySet: - 1 OccurrenceRelativeToEnd: false OccurrenceUnit: '' ScheduledInstanceId: sci-1234-1234-1234-1234-123456789012 SlotDurationInHours: 32 TermEndDate: 2017-01-31T09:00:00.000Z TermStartDate: 2016-01-31T09:00:00.000Z TotalScheduledInstanceHours: 1696 TransitGatewayVpcAttachmentOptions: title: TransitGatewayVpcAttachmentOptions type: object properties: DnsSupport: $ref: '#/components/schemas/DnsSupportValue' Ipv6Support: $ref: '#/components/schemas/Ipv6SupportValue' description: Describes the VPC attachment options. DeleteVpcEndpointConnectionNotificationsResult: title: DeleteVpcEndpointConnectionNotificationsResult type: object properties: Unsuccessful: type: array items: $ref: '#/components/schemas/UnsuccessfulItem' description: '' DescribeSnapshotsRequest: title: DescribeSnapshotsRequest type: object properties: Filters: type: array items: $ref: '#/components/schemas/Filter' description: '' MaxResults: type: integer format: int32 NextToken: type: string OwnerIds: type: array items: type: string description: '' RestorableByUserIds: type: array items: type: string description: '' SnapshotIds: type: array items: type: string description: '' DryRun: type: boolean GetConsoleOutputResult: title: GetConsoleOutputResult type: object properties: InstanceId: type: string Output: type: string Timestamp: type: string format: date-time example: InstanceId: i-1234567890abcdef0 Output: '...' Timestamp: 2018-05-25T21:23:53.000Z SpotAllocationStrategy: title: SpotAllocationStrategy enum: - lowest-price - diversified type: string RecurringCharge: title: RecurringCharge type: object properties: Amount: type: number Frequency: $ref: '#/components/schemas/RecurringChargeFrequency' description: Describes a recurring charge. UnmonitorInstancesRequest: title: UnmonitorInstancesRequest required: - InstanceIds type: object properties: InstanceIds: type: array items: type: string description: '' DryRun: type: boolean LaunchTemplateInstanceNetworkInterfaceSpecificationRequest: title: LaunchTemplateInstanceNetworkInterfaceSpecificationRequest type: object properties: AssociatePublicIpAddress: type: boolean DeleteOnTermination: type: boolean Description: type: string DeviceIndex: type: integer format: int32 Groups: type: array items: type: string description: '' InterfaceType: type: string Ipv6AddressCount: type: integer format: int32 Ipv6Addresses: type: array items: $ref: '#/components/schemas/InstanceIpv6AddressRequest' description: '' NetworkInterfaceId: type: string PrivateIpAddress: type: string PrivateIpAddresses: type: array items: $ref: '#/components/schemas/PrivateIpAddressSpecification' description: '' SecondaryPrivateIpAddressCount: type: integer format: int32 SubnetId: type: string description: The parameters for a network interface. TransitGatewayOptions: title: TransitGatewayOptions type: object properties: AmazonSideAsn: type: integer format: int32 AutoAcceptSharedAttachments: $ref: '#/components/schemas/AutoAcceptSharedAttachmentsValue' DefaultRouteTableAssociation: $ref: '#/components/schemas/DefaultRouteTableAssociationValue' AssociationDefaultRouteTableId: type: string DefaultRouteTablePropagation: $ref: '#/components/schemas/DefaultRouteTablePropagationValue' PropagationDefaultRouteTableId: type: string VpnEcmpSupport: $ref: '#/components/schemas/VpnEcmpSupportValue' DnsSupport: $ref: '#/components/schemas/DnsSupportValue' description: Describes the options for a transit gateway. CreateRouteResult: title: CreateRouteResult type: object properties: Return: type: boolean DescribeInstanceStatusRequest: title: DescribeInstanceStatusRequest type: object properties: Filters: type: array items: $ref: '#/components/schemas/Filter' description: '' InstanceIds: type: array items: type: string description: '' MaxResults: type: integer format: int32 NextToken: type: string DryRun: type: boolean IncludeAllInstances: type: boolean SubnetCidrBlockStateCode: title: SubnetCidrBlockStateCode enum: - associating - associated - disassociating - disassociated - failing - failed type: string Filter: title: Filter type: object properties: Name: type: string Values: type: array items: type: string description: '' 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. The filters supported by a describe operation are documented with the describe operation. For example:
maintain, you can specify a target capacity of 0 and add capacity later.
TerminateInstancesWithExpiration:
type: boolean
Type:
$ref: '#/components/schemas/FleetType'
ValidFrom:
type: string
format: date-time
ValidUntil:
type: string
format: date-time
ReplaceUnhealthyInstances:
type: boolean
SpotOptions:
allOf:
- $ref: '#/components/schemas/SpotOptions'
- description: Describes the configuration of Spot Instances in an EC2 Fleet.
OnDemandOptions:
allOf:
- $ref: '#/components/schemas/OnDemandOptions'
- description: The allocation strategy of On-Demand Instances in an EC2 Fleet.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
Errors:
type: array
items:
$ref: '#/components/schemas/DescribeFleetError'
description: ''
Instances:
type: array
items:
$ref: '#/components/schemas/DescribeFleetsInstances'
description: ''
description: Describes an EC2 Fleet.
CertificateAuthenticationRequest:
title: CertificateAuthenticationRequest
type: object
properties:
ClientRootCertificateChainArn:
type: string
description: Information about the client certificate to be used for authentication.
LaunchTemplateCapacityReservationSpecificationResponse:
title: LaunchTemplateCapacityReservationSpecificationResponse
type: object
properties:
CapacityReservationPreference:
$ref: '#/components/schemas/CapacityReservationPreference'
CapacityReservationTarget:
allOf:
- $ref: '#/components/schemas/CapacityReservationTargetResponse'
- description: Describes a target Capacity Reservation.
description: Information about the Capacity Reservation targeting option.
HostOffering:
title: HostOffering
type: object
properties:
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
Duration:
type: integer
format: int32
HourlyPrice:
type: string
InstanceFamily:
type: string
OfferingId:
type: string
PaymentOption:
$ref: '#/components/schemas/PaymentOption'
UpfrontPrice:
type: string
description: Details about the Dedicated Host Reservation offering.
FleetLaunchTemplateOverridesRequest:
title: FleetLaunchTemplateOverridesRequest
type: object
properties:
InstanceType:
$ref: '#/components/schemas/InstanceType'
MaxPrice:
type: string
SubnetId:
type: string
AvailabilityZone:
type: string
WeightedCapacity:
type: number
Priority:
type: number
Placement:
allOf:
- $ref: '#/components/schemas/Placement'
- description: Describes the placement of an instance.
description: Describes overrides for a launch template.
CopyFpgaImageResult:
title: CopyFpgaImageResult
type: object
properties:
FpgaImageId:
type: string
DescribeIamInstanceProfileAssociationsResult:
title: DescribeIamInstanceProfileAssociationsResult
type: object
properties:
IamInstanceProfileAssociations:
type: array
items:
$ref: '#/components/schemas/IamInstanceProfileAssociation'
description: ''
NextToken:
maxLength: 1024
minLength: 1
type: string
example:
IamInstanceProfileAssociations:
- AssociationId: iip-assoc-0db249b1f25fa24b8
IamInstanceProfile:
Arn: arn:aws:iam::123456789012:instance-profile/admin-role
Id: AIPAJVQN4F5WVLGCJDRGM
InstanceId: i-09eb09efa73ec1dee
State: associated
DiskImageDetail:
title: DiskImageDetail
required:
- Bytes
- Format
- ImportManifestUrl
type: object
properties:
Bytes:
type: integer
format: int32
Format:
$ref: '#/components/schemas/DiskImageFormat'
ImportManifestUrl:
type: string
description: Describes a disk image.
LogDestinationType:
title: LogDestinationType
enum:
- cloud-watch-logs
- s3
type: string
DescribeSpotDatafeedSubscriptionRequest:
title: DescribeSpotDatafeedSubscriptionRequest
type: object
properties:
DryRun:
type: boolean
description: Contains the parameters for DescribeSpotDatafeedSubscription.
FleetLaunchTemplateSpecification:
title: FleetLaunchTemplateSpecification
type: object
properties:
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
Version:
type: string
description: Describes a launch template.
ScheduledInstancesIpv6Address:
title: ScheduledInstancesIpv6Address
type: object
properties:
Ipv6Address:
type: string
description: Describes an IPv6 address.
DescribeClientVpnTargetNetworksRequest:
title: DescribeClientVpnTargetNetworksRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
AssociationIds:
type: array
items:
type: string
description: ''
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
NetworkInterface:
title: NetworkInterface
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAssociation'
- description: Describes association information for an Elastic IP address (IPv4 only).
Attachment:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttachment'
- description: Describes a network interface attachment.
AvailabilityZone:
type: string
Description:
type: string
Groups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
InterfaceType:
$ref: '#/components/schemas/NetworkInterfaceType'
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/NetworkInterfaceIpv6Address'
description: ''
MacAddress:
type: string
NetworkInterfaceId:
type: string
OwnerId:
type: string
PrivateDnsName:
type: string
PrivateIpAddress:
type: string
PrivateIpAddresses:
type: array
items:
$ref: '#/components/schemas/NetworkInterfacePrivateIpAddress'
description: ''
RequesterId:
type: string
RequesterManaged:
type: boolean
SourceDestCheck:
type: boolean
Status:
$ref: '#/components/schemas/NetworkInterfaceStatus'
SubnetId:
type: string
TagSet:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VpcId:
type: string
description: Describes a network interface.
SecurityGroupIdentifier:
title: SecurityGroupIdentifier
type: object
properties:
GroupId:
type: string
GroupName:
type: string
description: Describes a security group.
DescribeLaunchTemplateVersionsRequest:
title: DescribeLaunchTemplateVersionsRequest
type: object
properties:
DryRun:
type: boolean
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
Versions:
type: array
items:
type: string
description: ''
MinVersion:
type: string
MaxVersion:
type: string
NextToken:
type: string
MaxResults:
type: integer
format: int32
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
CopySnapshotResult:
title: CopySnapshotResult
type: object
properties:
SnapshotId:
type: string
description: Contains the output of CopySnapshot.
example:
SnapshotId: snap-066877671789bd71b
TargetGroup:
title: TargetGroup
type: object
properties:
Arn:
type: string
description: Describes a load balancer target group.
DescribeSecurityGroupsResult:
title: DescribeSecurityGroupsResult
type: object
properties:
SecurityGroups:
type: array
items:
$ref: '#/components/schemas/SecurityGroup'
description: ''
NextToken:
type: string
example: {}
EnableVpcClassicLinkRequest:
title: EnableVpcClassicLinkRequest
required:
- VpcId
type: object
properties:
DryRun:
type: boolean
VpcId:
type: string
DescribeClassicLinkInstancesRequest:
title: DescribeClassicLinkInstancesRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
InstanceIds:
type: array
items:
type: string
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
PurchaseHostReservationResult:
title: PurchaseHostReservationResult
type: object
properties:
ClientToken:
type: string
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
Purchase:
type: array
items:
$ref: '#/components/schemas/Purchase'
description: ''
TotalHourlyPrice:
type: string
TotalUpfrontPrice:
type: string
TargetGroupsConfig:
title: TargetGroupsConfig
type: object
properties:
TargetGroups:
maxItems: 5
minItems: 1
type: array
items:
$ref: '#/components/schemas/TargetGroup'
description: ''
description: Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
CreateVpcResult:
title: CreateVpcResult
type: object
properties:
Vpc:
allOf:
- $ref: '#/components/schemas/Vpc'
- description: Describes a VPC.
example:
Vpc:
CidrBlock: 10.0.0.0/16
DhcpOptionsId: dopt-7a8b9c2d
InstanceTenancy: default
State: pending
VpcId: vpc-a01106c2
AttachNetworkInterfaceRequest:
title: AttachNetworkInterfaceRequest
required:
- DeviceIndex
- InstanceId
- NetworkInterfaceId
type: object
properties:
DeviceIndex:
type: integer
format: int32
DryRun:
type: boolean
InstanceId:
type: string
NetworkInterfaceId:
type: string
description: Contains the parameters for AttachNetworkInterface.
DisassociateSubnetCidrBlockRequest:
title: DisassociateSubnetCidrBlockRequest
required:
- AssociationId
type: object
properties:
AssociationId:
type: string
Purchase:
title: Purchase
type: object
properties:
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
Duration:
type: integer
format: int32
HostIdSet:
type: array
items:
type: string
description: ''
HostReservationId:
type: string
HourlyPrice:
type: string
InstanceFamily:
type: string
PaymentOption:
$ref: '#/components/schemas/PaymentOption'
UpfrontPrice:
type: string
description: Describes the result of the purchase.
DescribeAccountAttributesRequest:
title: DescribeAccountAttributesRequest
type: object
properties:
AttributeNames:
type: array
items:
$ref: '#/components/schemas/AccountAttributeName'
description: ''
DryRun:
type: boolean
SecurityGroup:
title: SecurityGroup
type: object
properties:
Description:
type: string
GroupName:
type: string
IpPermissions:
type: array
items:
$ref: '#/components/schemas/IpPermission'
description: ''
OwnerId:
type: string
GroupId:
type: string
IpPermissionsEgress:
type: array
items:
$ref: '#/components/schemas/IpPermission'
description: ''
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VpcId:
type: string
description: Describes a security group
DisassociateRouteTableRequest:
title: DisassociateRouteTableRequest
required:
- AssociationId
type: object
properties:
AssociationId:
type: string
DryRun:
type: boolean
DescribeAggregateIdFormatResult:
title: DescribeAggregateIdFormatResult
type: object
properties:
UseLongIdsAggregated:
type: boolean
Statuses:
type: array
items:
$ref: '#/components/schemas/IdFormat'
description: ''
PublicIpv4Pool:
title: PublicIpv4Pool
type: object
properties:
PoolId:
type: string
Description:
type: string
PoolAddressRanges:
type: array
items:
$ref: '#/components/schemas/PublicIpv4PoolRange'
description: ''
TotalAddressCount:
type: integer
format: int32
TotalAvailableAddressCount:
type: integer
format: int32
description: Describes an address pool.
InstanceStateChange:
title: InstanceStateChange
type: object
properties:
CurrentState:
allOf:
- $ref: '#/components/schemas/InstanceState'
- description: Describes the current state of an instance.
InstanceId:
type: string
PreviousState:
allOf:
- $ref: '#/components/schemas/InstanceState'
- description: Describes the current state of an instance.
description: Describes an instance state change.
DescribeFlowLogsResult:
title: DescribeFlowLogsResult
type: object
properties:
FlowLogs:
type: array
items:
$ref: '#/components/schemas/FlowLog'
description: ''
NextToken:
type: string
DescribeVpcAttributeResult:
title: DescribeVpcAttributeResult
type: object
properties:
VpcId:
type: string
EnableDnsHostnames:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
EnableDnsSupport:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
example:
EnableDnsHostnames:
Value: true
VpcId: vpc-a01106c2
LaunchTemplateTagSpecificationRequest:
title: LaunchTemplateTagSpecificationRequest
type: object
properties:
ResourceType:
$ref: '#/components/schemas/ResourceType'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: The tags specification for the launch template.
DetachVolumeRequest:
title: DetachVolumeRequest
required:
- VolumeId
type: object
properties:
Device:
type: string
Force:
type: boolean
InstanceId:
type: string
VolumeId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DetachVolume.
ImportVolumeResult:
title: ImportVolumeResult
type: object
properties:
ConversionTask:
allOf:
- $ref: '#/components/schemas/ConversionTask'
- description: Describes a conversion task.
description: Contains the output for ImportVolume.
Affinity:
title: Affinity
enum:
- default
- host
type: string
Region:
title: Region
type: object
properties:
Endpoint:
type: string
RegionName:
type: string
description: Describes a Region.
DeleteNetworkInterfacePermissionResult:
title: DeleteNetworkInterfacePermissionResult
type: object
properties:
Return:
type: boolean
description: Contains the output for DeleteNetworkInterfacePermission.
CancelSpotInstanceRequestState:
title: CancelSpotInstanceRequestState
enum:
- active
- open
- closed
- cancelled
- completed
type: string
UnsuccessfulItemError:
title: UnsuccessfulItemError
type: object
properties:
Code:
type: string
Message:
type: string
description: Information about the error that occurred. For more information about errors, see Error Codes.
CapacityReservationSpecification:
title: CapacityReservationSpecification
type: object
properties:
CapacityReservationPreference:
$ref: '#/components/schemas/CapacityReservationPreference'
CapacityReservationTarget:
allOf:
- $ref: '#/components/schemas/CapacityReservationTarget'
- description: Describes a target Capacity Reservation.
description: 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.
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.
Image:
title: Image
type: object
properties:
Architecture:
$ref: '#/components/schemas/ArchitectureValues'
CreationDate:
type: string
ImageId:
type: string
ImageLocation:
type: string
ImageType:
$ref: '#/components/schemas/ImageTypeValues'
Public:
type: boolean
KernelId:
type: string
OwnerId:
type: string
Platform:
$ref: '#/components/schemas/PlatformValues'
ProductCodes:
type: array
items:
$ref: '#/components/schemas/ProductCode'
description: ''
RamdiskId:
type: string
State:
$ref: '#/components/schemas/ImageState'
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/BlockDeviceMapping'
description: ''
Description:
type: string
EnaSupport:
type: boolean
Hypervisor:
$ref: '#/components/schemas/HypervisorType'
ImageOwnerAlias:
type: string
Name:
type: string
RootDeviceName:
type: string
RootDeviceType:
$ref: '#/components/schemas/DeviceType'
SriovNetSupport:
type: string
StateReason:
allOf:
- $ref: '#/components/schemas/StateReason'
- description: Describes a state change.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VirtualizationType:
$ref: '#/components/schemas/VirtualizationType'
description: Describes an image.
RejectTransitGatewayVpcAttachmentResult:
title: RejectTransitGatewayVpcAttachmentResult
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- description: Describes a VPC attachment.
DetachNetworkInterfaceRequest:
title: DetachNetworkInterfaceRequest
required:
- AttachmentId
type: object
properties:
AttachmentId:
type: string
DryRun:
type: boolean
Force:
type: boolean
description: Contains the parameters for DetachNetworkInterface.
DescribeCustomerGatewaysResult:
title: DescribeCustomerGatewaysResult
type: object
properties:
CustomerGateways:
type: array
items:
$ref: '#/components/schemas/CustomerGateway'
description: ''
description: Contains the output of DescribeCustomerGateways.
example:
CustomerGateways:
- BgpAsn: '65534'
CustomerGatewayId: cgw-0e11f167
IpAddress: 12.1.2.3
State: available
Type: ipsec.1
DescribePrincipalIdFormatResult:
title: DescribePrincipalIdFormatResult
type: object
properties:
Principals:
type: array
items:
$ref: '#/components/schemas/PrincipalIdFormat'
description: ''
NextToken:
type: string
UnassignPrivateIpAddressesRequest:
title: UnassignPrivateIpAddressesRequest
required:
- NetworkInterfaceId
- PrivateIpAddresses
type: object
properties:
NetworkInterfaceId:
type: string
PrivateIpAddresses:
type: array
items:
type: string
description: ''
description: Contains the parameters for UnassignPrivateIpAddresses.
AssociateIamInstanceProfileRequest:
title: AssociateIamInstanceProfileRequest
required:
- IamInstanceProfile
- InstanceId
type: object
properties:
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileSpecification'
- description: Describes an IAM instance profile.
InstanceId:
type: string
DisassociateVpcCidrBlockResult:
title: DisassociateVpcCidrBlockResult
type: object
properties:
Ipv6CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcIpv6CidrBlockAssociation'
- description: Describes an IPv6 CIDR block associated with a VPC.
CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/VpcCidrBlockAssociation'
- description: Describes an IPv4 CIDR block associated with a VPC.
VpcId:
type: string
CreateTransitGatewayRouteRequest:
title: CreateTransitGatewayRouteRequest
required:
- DestinationCidrBlock
- TransitGatewayRouteTableId
type: object
properties:
DestinationCidrBlock:
type: string
TransitGatewayRouteTableId:
type: string
TransitGatewayAttachmentId:
type: string
Blackhole:
type: boolean
DryRun:
type: boolean
DescribeFleetInstancesResult:
title: DescribeFleetInstancesResult
type: object
properties:
ActiveInstances:
type: array
items:
$ref: '#/components/schemas/ActiveInstance'
description: ''
NextToken:
type: string
FleetId:
type: string
DiskImageDescription:
title: DiskImageDescription
type: object
properties:
Checksum:
type: string
Format:
$ref: '#/components/schemas/DiskImageFormat'
ImportManifestUrl:
type: string
Size:
type: integer
format: int32
description: Describes a disk image.
CancelBundleTaskResult:
title: CancelBundleTaskResult
type: object
properties:
BundleTask:
allOf:
- $ref: '#/components/schemas/BundleTask'
- description: Describes a bundle task.
description: Contains the output of CancelBundleTask.
ClassicLinkInstance:
title: ClassicLinkInstance
type: object
properties:
Groups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
InstanceId:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VpcId:
type: string
description: Describes a linked EC2-Classic instance.
ProductCodeValues:
title: ProductCodeValues
enum:
- devpay
- marketplace
type: string
CreateVpcEndpointConnectionNotificationResult:
title: CreateVpcEndpointConnectionNotificationResult
type: object
properties:
ConnectionNotification:
allOf:
- $ref: '#/components/schemas/ConnectionNotification'
- description: Describes a connection notification for a VPC endpoint or VPC endpoint service.
ClientToken:
type: string
GetReservedInstancesExchangeQuoteResult:
title: GetReservedInstancesExchangeQuoteResult
type: object
properties:
CurrencyCode:
type: string
IsValidExchange:
type: boolean
OutputReservedInstancesWillExpireAt:
type: string
format: date-time
PaymentDue:
type: string
ReservedInstanceValueRollup:
allOf:
- $ref: '#/components/schemas/ReservationValue'
- description: The cost associated with the Reserved Instance.
ReservedInstanceValueSet:
type: array
items:
$ref: '#/components/schemas/ReservedInstanceReservationValue'
description: ''
TargetConfigurationValueRollup:
allOf:
- $ref: '#/components/schemas/ReservationValue'
- description: The cost associated with the Reserved Instance.
TargetConfigurationValueSet:
type: array
items:
$ref: '#/components/schemas/TargetReservationValue'
description: ''
ValidationFailureReason:
type: string
description: Contains the output of GetReservedInstancesExchangeQuote.
CertificateAuthentication:
title: CertificateAuthentication
type: object
properties:
ClientRootCertificateChain:
type: string
description: Information about the client certificate used for authentication.
DeleteNetworkAclEntryRequest:
title: DeleteNetworkAclEntryRequest
required:
- Egress
- NetworkAclId
- RuleNumber
type: object
properties:
DryRun:
type: boolean
Egress:
type: boolean
NetworkAclId:
type: string
RuleNumber:
type: integer
format: int32
DescribeKeyPairsResult:
title: DescribeKeyPairsResult
type: object
properties:
KeyPairs:
type: array
items:
$ref: '#/components/schemas/KeyPairInfo'
description: ''
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
DescribeAddressesRequest:
title: DescribeAddressesRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
PublicIps:
type: array
items:
type: string
description: ''
AllocationIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
DescribeFpgaImageAttributeResult:
title: DescribeFpgaImageAttributeResult
type: object
properties:
FpgaImageAttribute:
allOf:
- $ref: '#/components/schemas/FpgaImageAttribute'
- description: Describes an Amazon FPGA image (AFI) attribute.
PrincipalIdFormat:
title: PrincipalIdFormat
type: object
properties:
Arn:
type: string
Statuses:
type: array
items:
$ref: '#/components/schemas/IdFormat'
description: ''
description: PrincipalIdFormat description
CustomerGateway:
title: CustomerGateway
type: object
properties:
BgpAsn:
type: string
CustomerGatewayId:
type: string
IpAddress:
type: string
State:
type: string
Type:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a customer gateway.
InstanceAttribute:
title: InstanceAttribute
type: object
properties:
Groups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/InstanceBlockDeviceMapping'
description: ''
DisableApiTermination:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
EnaSupport:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
EbsOptimized:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
InstanceId:
type: string
InstanceInitiatedShutdownBehavior:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
InstanceType:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
KernelId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
ProductCodes:
type: array
items:
$ref: '#/components/schemas/ProductCode'
description: ''
RamdiskId:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
RootDeviceName:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
SriovNetSupport:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
UserData:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
description: Describes an instance attribute.
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
SpotInstanceRequest:
title: SpotInstanceRequest
type: object
properties:
ActualBlockHourlyPrice:
type: string
AvailabilityZoneGroup:
type: string
BlockDurationMinutes:
type: integer
format: int32
CreateTime:
type: string
format: date-time
Fault:
allOf:
- $ref: '#/components/schemas/SpotInstanceStateFault'
- description: Describes a Spot Instance state change.
InstanceId:
type: string
LaunchGroup:
type: string
LaunchSpecification:
allOf:
- $ref: '#/components/schemas/LaunchSpecification'
- description: Describes the launch specification for an instance.
LaunchedAvailabilityZone:
type: string
ProductDescription:
$ref: '#/components/schemas/RIProductDescription'
SpotInstanceRequestId:
type: string
SpotPrice:
type: string
State:
$ref: '#/components/schemas/SpotInstanceState'
Status:
allOf:
- $ref: '#/components/schemas/SpotInstanceStatus'
- description: Describes the status of a Spot Instance request.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
Type:
$ref: '#/components/schemas/SpotInstanceType'
ValidFrom:
type: string
format: date-time
ValidUntil:
type: string
format: date-time
InstanceInterruptionBehavior:
$ref: '#/components/schemas/InstanceInterruptionBehavior'
description: Describes a Spot Instance request.
DeleteNatGatewayResult:
title: DeleteNatGatewayResult
type: object
properties:
NatGatewayId:
type: string
example:
NatGatewayId: nat-04ae55e711cec5680
ImportSnapshotResult:
title: ImportSnapshotResult
type: object
properties:
Description:
type: string
ImportTaskId:
type: string
SnapshotTaskDetail:
allOf:
- $ref: '#/components/schemas/SnapshotTaskDetail'
- description: Details about the import snapshot task.
description: Contains the output for ImportSnapshot.
BatchState:
title: BatchState
enum:
- submitted
- active
- cancelled
- failed
- cancelled_running
- cancelled_terminating
- modifying
type: string
AcceptVpcEndpointConnectionsRequest:
title: AcceptVpcEndpointConnectionsRequest
required:
- ServiceId
- VpcEndpointIds
type: object
properties:
DryRun:
type: boolean
ServiceId:
type: string
VpcEndpointIds:
type: array
items:
type: string
description: ''
DescribeVpcEndpointConnectionsResult:
title: DescribeVpcEndpointConnectionsResult
type: object
properties:
VpcEndpointConnections:
type: array
items:
$ref: '#/components/schemas/VpcEndpointConnection'
description: ''
NextToken:
type: string
CreateVpcPeeringConnectionRequest:
title: CreateVpcPeeringConnectionRequest
type: object
properties:
DryRun:
type: boolean
PeerOwnerId:
type: string
PeerVpcId:
type: string
VpcId:
type: string
PeerRegion:
type: string
DescribePrefixListsRequest:
title: DescribePrefixListsRequest
type: object
properties:
DryRun:
type: boolean
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
PrefixListIds:
type: array
items:
type: string
description: ''
CreateTransitGatewayVpcAttachmentResult:
title: CreateTransitGatewayVpcAttachmentResult
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- description: Describes a VPC attachment.
DescribeVolumeAttributeRequest:
title: DescribeVolumeAttributeRequest
required:
- Attribute
- VolumeId
type: object
properties:
Attribute:
$ref: '#/components/schemas/VolumeAttributeName'
VolumeId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DescribeVolumeAttribute.
CreateCustomerGatewayRequest:
title: CreateCustomerGatewayRequest
required:
- BgpAsn
- PublicIp
- Type
type: object
properties:
BgpAsn:
type: integer
format: int32
PublicIp:
type: string
Type:
enum:
- ipsec.1
type: string
DryRun:
type: boolean
description: Contains the parameters for CreateCustomerGateway.
RebootInstancesRequest:
title: RebootInstancesRequest
required:
- InstanceIds
type: object
properties:
InstanceIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
GetTransitGatewayRouteTableAssociationsResult:
title: GetTransitGatewayRouteTableAssociationsResult
type: object
properties:
Associations:
type: array
items:
$ref: '#/components/schemas/TransitGatewayRouteTableAssociation'
description: ''
NextToken:
type: string
VolumeType:
title: VolumeType
enum:
- standard
- io1
- gp2
- sc1
- st1
type: string
VolumeStatusEvent:
title: VolumeStatusEvent
type: object
properties:
Description:
type: string
EventId:
type: string
EventType:
type: string
NotAfter:
type: string
format: date-time
NotBefore:
type: string
format: date-time
description: Describes a volume status event.
MoveStatus:
title: MoveStatus
enum:
- movingToVpc
- restoringToClassic
type: string
ConnectionNotificationState:
title: ConnectionNotificationState
enum:
- Enabled
- Disabled
type: string
BlockDeviceMapping:
title: BlockDeviceMapping
type: object
properties:
DeviceName:
type: string
VirtualName:
type: string
Ebs:
allOf:
- $ref: '#/components/schemas/EbsBlockDevice'
- description: Describes a block device for an EBS volume.
NoDevice:
type: string
description: Describes a block device mapping.
EnableVpcClassicLinkDnsSupportResult:
title: EnableVpcClassicLinkDnsSupportResult
type: object
properties:
Return:
type: boolean
DescribeFleetError:
title: DescribeFleetError
type: object
properties:
LaunchTemplateAndOverrides:
allOf:
- $ref: '#/components/schemas/LaunchTemplateAndOverridesResponse'
- description: Describes a launch template and overrides.
Lifecycle:
$ref: '#/components/schemas/InstanceLifecycle'
ErrorCode:
type: string
ErrorMessage:
type: string
description: Describes the instances that could not be launched by the fleet.
DescribeIdentityIdFormatRequest:
title: DescribeIdentityIdFormatRequest
required:
- PrincipalArn
type: object
properties:
PrincipalArn:
type: string
Resource:
type: string
ImportImageRequest:
title: ImportImageRequest
type: object
properties:
Architecture:
type: string
ClientData:
allOf:
- $ref: '#/components/schemas/ClientData'
- description: Describes the client-specific data.
ClientToken:
type: string
Description:
type: string
DiskContainers:
type: array
items:
$ref: '#/components/schemas/ImageDiskContainer'
description: ''
DryRun:
type: boolean
Encrypted:
type: boolean
Hypervisor:
type: string
KmsKeyId:
type: string
LicenseType:
type: string
Platform:
type: string
RoleName:
type: string
description: Contains the parameters for ImportImage.
RejectTransitGatewayVpcAttachmentRequest:
title: RejectTransitGatewayVpcAttachmentRequest
required:
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayAttachmentId:
type: string
DryRun:
type: boolean
ExportToS3TaskSpecification:
title: ExportToS3TaskSpecification
type: object
properties:
ContainerFormat:
$ref: '#/components/schemas/ContainerFormat'
DiskImageFormat:
$ref: '#/components/schemas/DiskImageFormat'
S3Bucket:
type: string
S3Prefix:
type: string
description: Describes an instance export task.
DeleteFpgaImageRequest:
title: DeleteFpgaImageRequest
required:
- FpgaImageId
type: object
properties:
DryRun:
type: boolean
FpgaImageId:
type: string
DescribeStaleSecurityGroupsRequest:
title: DescribeStaleSecurityGroupsRequest
required:
- VpcId
type: object
properties:
DryRun:
type: boolean
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
VpcId:
type: string
DescribeAddressesResult:
title: DescribeAddressesResult
type: object
properties:
Addresses:
type: array
items:
$ref: '#/components/schemas/Address'
description: ''
example:
Addresses:
- Domain: standard
InstanceId: i-1234567890abcdef0
PublicIp: 198.51.100.0
VolumeState:
title: VolumeState
enum:
- creating
- available
- in-use
- deleting
- deleted
- error
type: string
LaunchTemplateLicenseConfigurationRequest:
title: LaunchTemplateLicenseConfigurationRequest
type: object
properties:
LicenseConfigurationArn:
type: string
description: Describes a license configuration.
VolumeStatusDetails:
title: VolumeStatusDetails
type: object
properties:
Name:
$ref: '#/components/schemas/VolumeStatusName'
Status:
type: string
description: Describes a volume status.
FlowLog:
title: FlowLog
type: object
properties:
CreationTime:
type: string
format: date-time
DeliverLogsErrorMessage:
type: string
DeliverLogsPermissionArn:
type: string
DeliverLogsStatus:
type: string
FlowLogId:
type: string
FlowLogStatus:
type: string
LogGroupName:
type: string
ResourceId:
type: string
TrafficType:
$ref: '#/components/schemas/TrafficType'
LogDestinationType:
$ref: '#/components/schemas/LogDestinationType'
LogDestination:
type: string
description: Describes a flow log.
ModifyVpcTenancyRequest:
title: ModifyVpcTenancyRequest
required:
- VpcId
- InstanceTenancy
type: object
properties:
VpcId:
type: string
InstanceTenancy:
enum:
- default
type: string
DryRun:
type: boolean
DescribeClientVpnRoutesRequest:
title: DescribeClientVpnRoutesRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
DryRun:
type: boolean
StatusType:
title: StatusType
enum:
- passed
- failed
- insufficient-data
- initializing
type: string
DeleteDhcpOptionsRequest:
title: DeleteDhcpOptionsRequest
required:
- DhcpOptionsId
type: object
properties:
DhcpOptionsId:
type: string
DryRun:
type: boolean
ImageTypeValues:
title: ImageTypeValues
enum:
- machine
- kernel
- ramdisk
type: string
DescribeSpotFleetRequestHistoryResponse:
title: DescribeSpotFleetRequestHistoryResponse
type: object
properties:
HistoryRecords:
type: array
items:
$ref: '#/components/schemas/HistoryRecord'
description: ''
LastEvaluatedTime:
type: string
format: date-time
NextToken:
type: string
SpotFleetRequestId:
type: string
StartTime:
type: string
format: date-time
description: Contains the output of DescribeSpotFleetRequestHistory.
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:00.000Z
AssociateVpcCidrBlockRequest:
title: AssociateVpcCidrBlockRequest
required:
- VpcId
type: object
properties:
AmazonProvidedIpv6CidrBlock:
type: boolean
CidrBlock:
type: string
VpcId:
type: string
IdFormat:
title: IdFormat
type: object
properties:
Deadline:
type: string
format: date-time
Resource:
type: string
UseLongIds:
type: boolean
description: Describes the ID format for a resource.
InstanceIpv6AddressRequest:
title: InstanceIpv6AddressRequest
type: object
properties:
Ipv6Address:
type: string
description: Describes an IPv6 address.
ModifyVpcPeeringConnectionOptionsResult:
title: ModifyVpcPeeringConnectionOptionsResult
type: object
properties:
AccepterPeeringConnectionOptions:
allOf:
- $ref: '#/components/schemas/PeeringConnectionOptions'
- description: Describes the VPC peering connection options.
RequesterPeeringConnectionOptions:
allOf:
- $ref: '#/components/schemas/PeeringConnectionOptions'
- description: Describes the VPC peering connection options.
DescribeSecurityGroupsRequest:
title: DescribeSecurityGroupsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
GroupIds:
type: array
items:
type: string
description: ''
GroupNames:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
NextToken:
type: string
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
DescribeVpcEndpointsRequest:
title: DescribeVpcEndpointsRequest
type: object
properties:
DryRun:
type: boolean
VpcEndpointIds:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
description: Contains the parameters for DescribeVpcEndpoints.
ProvisionByoipCidrResult:
title: ProvisionByoipCidrResult
type: object
properties:
ByoipCidr:
allOf:
- $ref: '#/components/schemas/ByoipCidr'
- description: Information about an address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
ResponseError:
title: ResponseError
type: object
properties:
Code:
$ref: '#/components/schemas/LaunchTemplateErrorCode'
Message:
type: string
description: Describes the error that's returned when you cannot delete a launch template version.
CreateVpnGatewayRequest:
title: CreateVpnGatewayRequest
required:
- Type
type: object
properties:
AvailabilityZone:
type: string
Type:
enum:
- ipsec.1
type: string
AmazonSideAsn:
type: integer
format: int32
DryRun:
type: boolean
description: Contains the parameters for CreateVpnGateway.
ModifySpotFleetRequestResponse:
title: ModifySpotFleetRequestResponse
type: object
properties:
Return:
type: boolean
description: Contains the output of ModifySpotFleetRequest.
example:
Return: true
DescribeConversionTasksRequest:
title: DescribeConversionTasksRequest
type: object
properties:
ConversionTaskIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
description: Contains the parameters for DescribeConversionTasks.
StartInstancesResult:
title: StartInstancesResult
type: object
properties:
StartingInstances:
type: array
items:
$ref: '#/components/schemas/InstanceStateChange'
description: ''
example:
StartingInstances:
- CurrentState:
Code: 0
Name: pending
InstanceId: i-1234567890abcdef0
PreviousState:
Code: 80
Name: stopped
AssociateRouteTableResult:
title: AssociateRouteTableResult
type: object
properties:
AssociationId:
type: string
example:
AssociationId: rtbassoc-781d0d1a
InternetGateway:
title: InternetGateway
type: object
properties:
Attachments:
type: array
items:
$ref: '#/components/schemas/InternetGatewayAttachment'
description: ''
InternetGatewayId:
type: string
OwnerId:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes an internet gateway.
CreateLaunchTemplateVersionResult:
title: CreateLaunchTemplateVersionResult
type: object
properties:
LaunchTemplateVersion:
allOf:
- $ref: '#/components/schemas/LaunchTemplateVersion'
- description: Describes a launch template version.
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
PaymentOption:
title: PaymentOption
enum:
- AllUpfront
- PartialUpfront
- NoUpfront
type: string
DescribeReservedInstancesListingsResult:
title: DescribeReservedInstancesListingsResult
type: object
properties:
ReservedInstancesListings:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesListing'
description: ''
description: Contains the output of DescribeReservedInstancesListings.
GetConsoleOutputRequest:
title: GetConsoleOutputRequest
required:
- InstanceId
type: object
properties:
InstanceId:
type: string
DryRun:
type: boolean
Latest:
type: boolean
LaunchTemplatesMonitoring:
title: LaunchTemplatesMonitoring
type: object
properties:
Enabled:
type: boolean
description: Describes the monitoring for the instance.
ReplaceRouteTableAssociationResult:
title: ReplaceRouteTableAssociationResult
type: object
properties:
NewAssociationId:
type: string
example:
NewAssociationId: rtbassoc-3a1f0f58
VpcPeeringConnectionVpcInfo:
title: VpcPeeringConnectionVpcInfo
type: object
properties:
CidrBlock:
type: string
Ipv6CidrBlockSet:
type: array
items:
$ref: '#/components/schemas/Ipv6CidrBlock'
description: ''
CidrBlockSet:
type: array
items:
$ref: '#/components/schemas/CidrBlock'
description: ''
OwnerId:
type: string
PeeringOptions:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionOptionsDescription'
- description: Describes the VPC peering connection options.
VpcId:
type: string
Region:
type: string
description: Describes a VPC in a VPC peering connection.
ReleaseAddressRequest:
title: ReleaseAddressRequest
type: object
properties:
AllocationId:
type: string
PublicIp:
type: string
DryRun:
type: boolean
DescribeByoipCidrsRequest:
title: DescribeByoipCidrsRequest
required:
- MaxResults
type: object
properties:
DryRun:
type: boolean
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
DescribeExportTasksRequest:
title: DescribeExportTasksRequest
type: object
properties:
ExportTaskIds:
type: array
items:
type: string
description: ''
description: Contains the parameters for DescribeExportTasks.
RegisterImageResult:
title: RegisterImageResult
type: object
properties:
ImageId:
type: string
description: Contains the output of RegisterImage.
ModifyFpgaImageAttributeResult:
title: ModifyFpgaImageAttributeResult
type: object
properties:
FpgaImageAttribute:
allOf:
- $ref: '#/components/schemas/FpgaImageAttribute'
- description: Describes an Amazon FPGA image (AFI) attribute.
HostProperties:
title: HostProperties
type: object
properties:
Cores:
type: integer
format: int32
InstanceType:
type: string
Sockets:
type: integer
format: int32
TotalVCpus:
type: integer
format: int32
description: Describes properties of a Dedicated Host.
LaunchTemplateBlockDeviceMappingRequest:
title: LaunchTemplateBlockDeviceMappingRequest
type: object
properties:
DeviceName:
type: string
VirtualName:
type: string
Ebs:
allOf:
- $ref: '#/components/schemas/LaunchTemplateEbsBlockDeviceRequest'
- description: The parameters for a block device for an EBS volume.
NoDevice:
type: string
description: Describes a block device mapping.
DescribeClientVpnEndpointsRequest:
title: DescribeClientVpnEndpointsRequest
type: object
properties:
ClientVpnEndpointIds:
type: array
items:
type: string
description: ''
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
CpuOptions:
title: CpuOptions
type: object
properties:
CoreCount:
type: integer
format: int32
ThreadsPerCore:
type: integer
format: int32
description: The CPU options for the instance.
FleetOnDemandAllocationStrategy:
title: FleetOnDemandAllocationStrategy
enum:
- lowest-price
- prioritized
type: string
DescribeNetworkInterfacesResult:
title: DescribeNetworkInterfacesResult
type: object
properties:
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/NetworkInterface'
description: ''
NextToken:
type: string
description: Contains the output of DescribeNetworkInterfaces.
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
SpotPrice:
title: SpotPrice
type: object
properties:
AvailabilityZone:
type: string
InstanceType:
$ref: '#/components/schemas/InstanceType'
ProductDescription:
$ref: '#/components/schemas/RIProductDescription'
SpotPrice:
type: string
Timestamp:
type: string
format: date-time
description: Describes the maximum price per hour that you are willing to pay for a Spot Instance.
InstanceStateName:
title: InstanceStateName
enum:
- pending
- running
- shutting-down
- terminated
- stopping
- stopped
type: string
StatusName:
title: StatusName
enum:
- reachability
type: string
RouteOrigin:
title: RouteOrigin
enum:
- CreateRouteTable
- CreateRoute
- EnableVgwRoutePropagation
type: string
MonitorInstancesRequest:
title: MonitorInstancesRequest
required:
- InstanceIds
type: object
properties:
InstanceIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
CancelSpotInstanceRequestsResult:
title: CancelSpotInstanceRequestsResult
type: object
properties:
CancelledSpotInstanceRequests:
type: array
items:
$ref: '#/components/schemas/CancelledSpotInstanceRequest'
description: ''
description: Contains the output of CancelSpotInstanceRequests.
example:
CancelledSpotInstanceRequests:
- SpotInstanceRequestId: sir-08b93456
State: cancelled
DescribeVpnGatewaysRequest:
title: DescribeVpnGatewaysRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
VpnGatewayIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
description: Contains the parameters for DescribeVpnGateways.
AcceptVpcPeeringConnectionResult:
title: AcceptVpcPeeringConnectionResult
type: object
properties:
VpcPeeringConnection:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnection'
- description: Describes a VPC peering connection.
DescribeVpnConnectionsResult:
title: DescribeVpnConnectionsResult
type: object
properties:
VpnConnections:
type: array
items:
$ref: '#/components/schemas/VpnConnection'
description: ''
description: Contains the output of DescribeVpnConnections.
ElasticGpuAssociation:
title: ElasticGpuAssociation
type: object
properties:
ElasticGpuId:
type: string
ElasticGpuAssociationId:
type: string
ElasticGpuAssociationState:
type: string
ElasticGpuAssociationTime:
type: string
description: Describes the association between an instance and an Elastic Graphics accelerator.
ReservedInstancesOffering:
title: ReservedInstancesOffering
type: object
properties:
AvailabilityZone:
type: string
Duration:
type: integer
format: int32
FixedPrice:
type: number
InstanceType:
$ref: '#/components/schemas/InstanceType'
ProductDescription:
$ref: '#/components/schemas/RIProductDescription'
ReservedInstancesOfferingId:
type: string
UsagePrice:
type: number
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
InstanceTenancy:
$ref: '#/components/schemas/Tenancy'
Marketplace:
type: boolean
OfferingClass:
$ref: '#/components/schemas/OfferingClassType'
OfferingType:
$ref: '#/components/schemas/OfferingTypeValues'
PricingDetails:
type: array
items:
$ref: '#/components/schemas/PricingDetail'
description: ''
RecurringCharges:
type: array
items:
$ref: '#/components/schemas/RecurringCharge'
description: ''
Scope:
$ref: '#/components/schemas/scope'
description: Describes a Reserved Instance offering.
ImportInstanceVolumeDetailItem:
title: ImportInstanceVolumeDetailItem
type: object
properties:
AvailabilityZone:
type: string
BytesConverted:
type: integer
format: int32
Description:
type: string
Image:
allOf:
- $ref: '#/components/schemas/DiskImageDescription'
- description: Describes a disk image.
Status:
type: string
StatusMessage:
type: string
Volume:
allOf:
- $ref: '#/components/schemas/DiskImageVolumeDescription'
- description: Describes a disk image volume.
description: Describes an import volume task.
Instance:
title: Instance
type: object
properties:
AmiLaunchIndex:
type: integer
format: int32
ImageId:
type: string
InstanceId:
type: string
InstanceType:
$ref: '#/components/schemas/InstanceType'
KernelId:
type: string
KeyName:
type: string
LaunchTime:
type: string
format: date-time
Monitoring:
allOf:
- $ref: '#/components/schemas/Monitoring'
- description: Describes the monitoring of an instance.
Placement:
allOf:
- $ref: '#/components/schemas/Placement'
- description: Describes the placement of an instance.
Platform:
$ref: '#/components/schemas/PlatformValues'
PrivateDnsName:
type: string
PrivateIpAddress:
type: string
ProductCodes:
type: array
items:
$ref: '#/components/schemas/ProductCode'
description: ''
PublicDnsName:
type: string
PublicIpAddress:
type: string
RamdiskId:
type: string
State:
allOf:
- $ref: '#/components/schemas/InstanceState'
- description: Describes the current state of an instance.
StateTransitionReason:
type: string
SubnetId:
type: string
VpcId:
type: string
Architecture:
$ref: '#/components/schemas/ArchitectureValues'
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/InstanceBlockDeviceMapping'
description: ''
ClientToken:
type: string
EbsOptimized:
type: boolean
EnaSupport:
type: boolean
Hypervisor:
$ref: '#/components/schemas/HypervisorType'
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfile'
- description: Describes an IAM instance profile.
InstanceLifecycle:
$ref: '#/components/schemas/InstanceLifecycleType'
ElasticGpuAssociations:
type: array
items:
$ref: '#/components/schemas/ElasticGpuAssociation'
description: ''
ElasticInferenceAcceleratorAssociations:
type: array
items:
$ref: '#/components/schemas/ElasticInferenceAcceleratorAssociation'
description: ''
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/InstanceNetworkInterface'
description: ''
RootDeviceName:
type: string
RootDeviceType:
$ref: '#/components/schemas/DeviceType'
SecurityGroups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
SourceDestCheck:
type: boolean
SpotInstanceRequestId:
type: string
SriovNetSupport:
type: string
StateReason:
allOf:
- $ref: '#/components/schemas/StateReason'
- description: Describes a state change.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VirtualizationType:
$ref: '#/components/schemas/VirtualizationType'
CpuOptions:
allOf:
- $ref: '#/components/schemas/CpuOptions'
- description: The CPU options for the instance.
CapacityReservationId:
type: string
CapacityReservationSpecification:
allOf:
- $ref: '#/components/schemas/CapacityReservationSpecificationResponse'
- description: Describes the instance's Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation.
HibernationOptions:
allOf:
- $ref: '#/components/schemas/HibernationOptions'
- description: Indicates whether your instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux. For more information, see Hibernate Your Instance in the Amazon Elastic Compute Cloud User Guide.
Licenses:
type: array
items:
$ref: '#/components/schemas/LicenseConfiguration'
description: ''
description: Describes an instance.
InstanceBlockDeviceMapping:
title: InstanceBlockDeviceMapping
type: object
properties:
DeviceName:
type: string
Ebs:
allOf:
- $ref: '#/components/schemas/EbsInstanceBlockDevice'
- description: Describes a parameter used to set up an EBS volume in a block device mapping.
description: Describes a block device mapping.
DeleteClientVpnEndpointRequest:
title: DeleteClientVpnEndpointRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
DryRun:
type: boolean
DeleteNetworkInterfaceRequest:
title: DeleteNetworkInterfaceRequest
required:
- NetworkInterfaceId
type: object
properties:
DryRun:
type: boolean
NetworkInterfaceId:
type: string
description: Contains the parameters for DeleteNetworkInterface.
ProvisionedBandwidth:
title: ProvisionedBandwidth
type: object
properties:
ProvisionTime:
type: string
format: date-time
Provisioned:
type: string
RequestTime:
type: string
format: date-time
Requested:
type: string
Status:
type: string
description: Reserved. If you need to sustain traffic greater than the documented limits, contact us through the Support Center.
DefaultTargetCapacityType:
title: DefaultTargetCapacityType
enum:
- spot
- on-demand
type: string
CreateSpotDatafeedSubscriptionRequest:
title: CreateSpotDatafeedSubscriptionRequest
required:
- Bucket
type: object
properties:
Bucket:
type: string
DryRun:
type: boolean
Prefix:
type: string
description: Contains the parameters for CreateSpotDatafeedSubscription.
DeleteLaunchTemplateResult:
title: DeleteLaunchTemplateResult
type: object
properties:
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplate'
- description: Describes a launch template.
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
DeleteTransitGatewayVpcAttachmentRequest:
title: DeleteTransitGatewayVpcAttachmentRequest
required:
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayAttachmentId:
type: string
DryRun:
type: boolean
AssociateAddressResult:
title: AssociateAddressResult
type: object
properties:
AssociationId:
type: string
example:
AssociationId: eipassoc-2bebb745
RequestSpotFleetRequest:
title: RequestSpotFleetRequest
required:
- SpotFleetRequestConfig
type: object
properties:
DryRun:
type: boolean
SpotFleetRequestConfig:
allOf:
- $ref: '#/components/schemas/SpotFleetRequestConfigData'
- description: Describes the configuration of a Spot Fleet request.
description: Contains the parameters for RequestSpotFleet.
LaunchSpecification:
title: LaunchSpecification
type: object
properties:
UserData:
type: string
SecurityGroups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
AddressingType:
type: string
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/BlockDeviceMapping'
description: ''
EbsOptimized:
type: boolean
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/IamInstanceProfileSpecification'
- description: Describes an IAM instance profile.
ImageId:
type: string
InstanceType:
$ref: '#/components/schemas/InstanceType'
KernelId:
type: string
KeyName:
type: string
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/InstanceNetworkInterfaceSpecification'
description: ''
Placement:
allOf:
- $ref: '#/components/schemas/SpotPlacement'
- description: Describes Spot Instance placement.
RamdiskId:
type: string
SubnetId:
type: string
Monitoring:
allOf:
- $ref: '#/components/schemas/RunInstancesMonitoringEnabled'
- description: Describes the monitoring of an instance.
description: Describes the launch specification for an instance.
InstanceType:
title: InstanceType
enum:
- 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
- m1.small
- m1.medium
- m1.large
- m1.xlarge
- m3.medium
- m3.large
- m3.xlarge
- m3.2xlarge
- m4.large
- m4.xlarge
- m4.2xlarge
- m4.4xlarge
- m4.10xlarge
- m4.16xlarge
- m2.xlarge
- m2.2xlarge
- m2.4xlarge
- cr1.8xlarge
- 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.12xlarge
- r5.24xlarge
- r5.metal
- r5a.large
- r5a.xlarge
- r5a.2xlarge
- r5a.4xlarge
- r5a.12xlarge
- r5a.24xlarge
- r5d.large
- r5d.xlarge
- r5d.2xlarge
- r5d.4xlarge
- r5d.12xlarge
- r5d.24xlarge
- r5d.metal
- r5ad.large
- r5ad.xlarge
- r5ad.2xlarge
- r5ad.4xlarge
- r5ad.8xlarge
- r5ad.12xlarge
- r5ad.16xlarge
- r5ad.24xlarge
- x1.16xlarge
- x1.32xlarge
- x1e.xlarge
- x1e.2xlarge
- x1e.4xlarge
- x1e.8xlarge
- x1e.16xlarge
- x1e.32xlarge
- i2.xlarge
- i2.2xlarge
- i2.4xlarge
- i2.8xlarge
- i3.large
- i3.xlarge
- i3.2xlarge
- i3.4xlarge
- i3.8xlarge
- i3.16xlarge
- i3.metal
- hi1.4xlarge
- hs1.8xlarge
- 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.18xlarge
- c5d.large
- c5d.xlarge
- c5d.2xlarge
- c5d.4xlarge
- c5d.9xlarge
- c5d.18xlarge
- c5n.large
- c5n.xlarge
- c5n.2xlarge
- c5n.4xlarge
- c5n.9xlarge
- c5n.18xlarge
- cc1.4xlarge
- cc2.8xlarge
- g2.2xlarge
- g2.8xlarge
- g3.4xlarge
- g3.8xlarge
- g3.16xlarge
- g3s.xlarge
- cg1.4xlarge
- p2.xlarge
- p2.8xlarge
- p2.16xlarge
- p3.2xlarge
- p3.8xlarge
- p3.16xlarge
- p3dn.24xlarge
- d2.xlarge
- d2.2xlarge
- d2.4xlarge
- d2.8xlarge
- f1.2xlarge
- f1.4xlarge
- f1.16xlarge
- m5.large
- m5.xlarge
- m5.2xlarge
- m5.4xlarge
- m5.12xlarge
- m5.24xlarge
- m5.metal
- m5a.large
- m5a.xlarge
- m5a.2xlarge
- m5a.4xlarge
- m5a.12xlarge
- m5a.24xlarge
- m5d.large
- m5d.xlarge
- m5d.2xlarge
- m5d.4xlarge
- m5d.12xlarge
- m5d.24xlarge
- m5d.metal
- m5ad.large
- m5ad.xlarge
- m5ad.2xlarge
- m5ad.4xlarge
- m5ad.8xlarge
- m5ad.12xlarge
- m5ad.16xlarge
- m5ad.24xlarge
- h1.2xlarge
- h1.4xlarge
- h1.8xlarge
- h1.16xlarge
- z1d.large
- z1d.xlarge
- z1d.2xlarge
- z1d.3xlarge
- z1d.6xlarge
- z1d.12xlarge
- z1d.metal
- u-6tb1.metal
- u-9tb1.metal
- u-12tb1.metal
- a1.medium
- a1.large
- a1.xlarge
- a1.2xlarge
- a1.4xlarge
type: string
ExportTransitGatewayRoutesRequest:
title: ExportTransitGatewayRoutesRequest
required:
- TransitGatewayRouteTableId
- S3Bucket
type: object
properties:
TransitGatewayRouteTableId:
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
S3Bucket:
type: string
DryRun:
type: boolean
AttachClassicLinkVpcResult:
title: AttachClassicLinkVpcResult
type: object
properties:
Return:
type: boolean
CreateEgressOnlyInternetGatewayResult:
title: CreateEgressOnlyInternetGatewayResult
type: object
properties:
ClientToken:
type: string
EgressOnlyInternetGateway:
allOf:
- $ref: '#/components/schemas/EgressOnlyInternetGateway'
- description: Describes an egress-only internet gateway.
DescribeInstanceCreditSpecificationsResult:
title: DescribeInstanceCreditSpecificationsResult
type: object
properties:
InstanceCreditSpecifications:
type: array
items:
$ref: '#/components/schemas/InstanceCreditSpecification'
description: ''
NextToken:
type: string
ServiceState:
title: ServiceState
enum:
- Pending
- Available
- Deleting
- Deleted
- Failed
type: string
ImportClientVpnClientCertificateRevocationListResult:
title: ImportClientVpnClientCertificateRevocationListResult
type: object
properties:
Return:
type: boolean
CreateSecurityGroupResult:
title: CreateSecurityGroupResult
type: object
properties:
GroupId:
type: string
example:
GroupId: sg-903004f8
SlotDateTimeRangeRequest:
title: SlotDateTimeRangeRequest
required:
- EarliestTime
- LatestTime
type: object
properties:
EarliestTime:
type: string
format: date-time
LatestTime:
type: string
format: date-time
description: Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.
CreateNetworkInterfaceResult:
title: CreateNetworkInterfaceResult
type: object
properties:
NetworkInterface:
allOf:
- $ref: '#/components/schemas/NetworkInterface'
- description: Describes a network interface.
description: Contains the output of CreateNetworkInterface.
DescribeRouteTablesRequest:
title: DescribeRouteTablesRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
RouteTableIds:
type: array
items:
type: string
description: ''
NextToken:
type: string
MaxResults:
maximum: 100
minimum: 5
type: integer
format: int32
LaunchTemplateIamInstanceProfileSpecification:
title: LaunchTemplateIamInstanceProfileSpecification
type: object
properties:
Arn:
type: string
Name:
type: string
description: Describes an IAM instance profile.
CreateVpcEndpointResult:
title: CreateVpcEndpointResult
type: object
properties:
VpcEndpoint:
allOf:
- $ref: '#/components/schemas/VpcEndpoint'
- description: Describes a VPC endpoint.
ClientToken:
type: string
description: Contains the output of CreateVpcEndpoint.
LaunchTemplateElasticInferenceAccelerator:
title: LaunchTemplateElasticInferenceAccelerator
required:
- Type
type: object
properties:
Type:
type: string
description: Describes an elastic inference accelerator.
EnableVgwRoutePropagationRequest:
title: EnableVgwRoutePropagationRequest
required:
- GatewayId
- RouteTableId
type: object
properties:
GatewayId:
type: string
RouteTableId:
type: string
description: Contains the parameters for EnableVgwRoutePropagation.
InstanceMatchCriteria:
title: InstanceMatchCriteria
enum:
- open
- targeted
type: string
LaunchTemplateBlockDeviceMapping:
title: LaunchTemplateBlockDeviceMapping
type: object
properties:
DeviceName:
type: string
VirtualName:
type: string
Ebs:
allOf:
- $ref: '#/components/schemas/LaunchTemplateEbsBlockDevice'
- description: Describes a block device for an EBS volume.
NoDevice:
type: string
description: Describes a block device mapping.
EnableTransitGatewayRouteTablePropagationRequest:
title: EnableTransitGatewayRouteTablePropagationRequest
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayRouteTableId:
type: string
TransitGatewayAttachmentId:
type: string
DryRun:
type: boolean
ModifyVpcEndpointServicePermissionsResult:
title: ModifyVpcEndpointServicePermissionsResult
type: object
properties:
ReturnValue:
type: boolean
DeleteVolumeRequest:
title: DeleteVolumeRequest
required:
- VolumeId
type: object
properties:
VolumeId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DeleteVolume.
TargetCapacitySpecification:
title: TargetCapacitySpecification
type: object
properties:
TotalTargetCapacity:
type: integer
format: int32
OnDemandTargetCapacity:
type: integer
format: int32
SpotTargetCapacity:
type: integer
format: int32
DefaultTargetCapacityType:
$ref: '#/components/schemas/DefaultTargetCapacityType'
description: 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.
ModifyVpnConnectionResult:
title: ModifyVpnConnectionResult
type: object
properties:
VpnConnection:
allOf:
- $ref: '#/components/schemas/VpnConnection'
- description: Describes a VPN connection.
DeleteSecurityGroupRequest:
title: DeleteSecurityGroupRequest
type: object
properties:
GroupId:
type: string
GroupName:
type: string
DryRun:
type: boolean
NetworkInterfacePermissionStateCode:
title: NetworkInterfacePermissionStateCode
enum:
- pending
- granted
- revoking
- revoked
type: string
DescribeVpcEndpointServicesRequest:
title: DescribeVpcEndpointServicesRequest
type: object
properties:
DryRun:
type: boolean
ServiceNames:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
description: Contains the parameters for DescribeVpcEndpointServices.
GetHostReservationPurchasePreviewRequest:
title: GetHostReservationPurchasePreviewRequest
required:
- HostIdSet
- OfferingId
type: object
properties:
HostIdSet:
type: array
items:
type: string
description: ''
OfferingId:
type: string
RevokeSecurityGroupIngressRequest:
title: RevokeSecurityGroupIngressRequest
type: object
properties:
CidrIp:
type: string
FromPort:
type: integer
format: int32
GroupId:
type: string
GroupName:
type: string
IpPermissions:
type: array
items:
$ref: '#/components/schemas/IpPermission'
description: ''
IpProtocol:
type: string
SourceSecurityGroupName:
type: string
SourceSecurityGroupOwnerId:
type: string
ToPort:
type: integer
format: int32
DryRun:
type: boolean
DescribeClassicLinkInstancesResult:
title: DescribeClassicLinkInstancesResult
type: object
properties:
Instances:
type: array
items:
$ref: '#/components/schemas/ClassicLinkInstance'
description: ''
NextToken:
type: string
DescribeSpotFleetRequestsRequest:
title: DescribeSpotFleetRequestsRequest
type: object
properties:
DryRun:
type: boolean
MaxResults:
type: integer
format: int32
NextToken:
type: string
SpotFleetRequestIds:
type: array
items:
type: string
description: ''
description: Contains the parameters for DescribeSpotFleetRequests.
PriceScheduleSpecification:
title: PriceScheduleSpecification
type: object
properties:
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
Price:
type: number
Term:
type: integer
format: int32
description: Describes the price for a Reserved Instance.
AttachVolumeRequest:
title: AttachVolumeRequest
required:
- Device
- InstanceId
- VolumeId
type: object
properties:
Device:
type: string
InstanceId:
type: string
VolumeId:
type: string
DryRun:
type: boolean
description: Contains the parameters for AttachVolume.
CapacityReservationTenancy:
title: CapacityReservationTenancy
enum:
- default
- dedicated
type: string
AcceptReservedInstancesExchangeQuoteResult:
title: AcceptReservedInstancesExchangeQuoteResult
type: object
properties:
ExchangeId:
type: string
description: The result of the exchange and whether it was successful.
DeleteClientVpnEndpointResult:
title: DeleteClientVpnEndpointResult
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointStatus'
- description: Describes the state of a Client VPN endpoint.
CreateClientVpnEndpointResult:
title: CreateClientVpnEndpointResult
type: object
properties:
ClientVpnEndpointId:
type: string
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnEndpointStatus'
- description: Describes the state of a Client VPN endpoint.
DnsName:
type: string
DescribeIdFormatResult:
title: DescribeIdFormatResult
type: object
properties:
Statuses:
type: array
items:
$ref: '#/components/schemas/IdFormat'
description: ''
VpnStaticRoute:
title: VpnStaticRoute
type: object
properties:
DestinationCidrBlock:
type: string
Source:
$ref: '#/components/schemas/VpnStaticRouteSource'
State:
$ref: '#/components/schemas/VpnState'
description: Describes a static route for a VPN connection.
DescribeFpgaImagesRequest:
title: DescribeFpgaImagesRequest
type: object
properties:
DryRun:
type: boolean
FpgaImageIds:
type: array
items:
type: string
description: ''
Owners:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
NextToken:
maxLength: 1024
minLength: 1
type: string
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
ResetNetworkInterfaceAttributeRequest:
title: ResetNetworkInterfaceAttributeRequest
required:
- NetworkInterfaceId
type: object
properties:
DryRun:
type: boolean
NetworkInterfaceId:
type: string
SourceDestCheck:
type: string
description: Contains the parameters for ResetNetworkInterfaceAttribute.
DescribeSnapshotAttributeRequest:
title: DescribeSnapshotAttributeRequest
required:
- Attribute
- SnapshotId
type: object
properties:
Attribute:
$ref: '#/components/schemas/SnapshotAttributeName'
SnapshotId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DescribeSnapshotAttribute.
DescribeReservedInstancesOfferingsResult:
title: DescribeReservedInstancesOfferingsResult
type: object
properties:
ReservedInstancesOfferings:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesOffering'
description: ''
NextToken:
type: string
description: Contains the output of DescribeReservedInstancesOfferings.
ReportInstanceReasonCodes:
title: ReportInstanceReasonCodes
enum:
- instance-stuck-in-state
- unresponsive
- not-accepting-credentials
- password-not-available
- performance-network
- performance-instance-store
- performance-ebs-volume
- performance-other
- other
type: string
CreateNetworkInterfaceRequest:
title: CreateNetworkInterfaceRequest
required:
- SubnetId
type: object
properties:
Description:
type: string
DryRun:
type: boolean
Groups:
type: array
items:
type: string
description: ''
Ipv6AddressCount:
type: integer
format: int32
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/InstanceIpv6Address'
description: ''
PrivateIpAddress:
type: string
PrivateIpAddresses:
type: array
items:
$ref: '#/components/schemas/PrivateIpAddressSpecification'
description: ''
SecondaryPrivateIpAddressCount:
type: integer
format: int32
InterfaceType:
$ref: '#/components/schemas/NetworkInterfaceCreationType'
SubnetId:
type: string
description: Contains the parameters for CreateNetworkInterface.
DescribeInstancesResult:
title: DescribeInstancesResult
type: object
properties:
Reservations:
type: array
items:
$ref: '#/components/schemas/Reservation'
description: ''
NextToken:
type: string
example: {}
RejectVpcPeeringConnectionResult:
title: RejectVpcPeeringConnectionResult
type: object
properties:
Return:
type: boolean
FleetEventType:
title: FleetEventType
enum:
- instance-change
- fleet-change
- service-error
type: string
CreateInstanceExportTaskResult:
title: CreateInstanceExportTaskResult
type: object
properties:
ExportTask:
allOf:
- $ref: '#/components/schemas/ExportTask'
- description: Describes an instance export task.
description: Contains the output for CreateInstanceExportTask.
ReportStatusType:
title: ReportStatusType
enum:
- ok
- impaired
type: string
CreateNatGatewayResult:
title: CreateNatGatewayResult
type: object
properties:
ClientToken:
type: string
NatGateway:
allOf:
- $ref: '#/components/schemas/NatGateway'
- description: Describes a NAT gateway.
example:
NatGateway:
CreateTime: 2015-12-17T12:45:26.732Z
NatGatewayAddresses:
- AllocationId: eipalloc-37fc1a52
NatGatewayId: nat-08d48af2a8e83edfd
State: pending
SubnetId: subnet-1a2b3c4d
VpcId: vpc-1122aabb
DescribeReservedInstancesResult:
title: DescribeReservedInstancesResult
type: object
properties:
ReservedInstances:
type: array
items:
$ref: '#/components/schemas/ReservedInstances'
description: ''
description: Contains the output for DescribeReservedInstances.
RejectVpcEndpointConnectionsRequest:
title: RejectVpcEndpointConnectionsRequest
required:
- ServiceId
- VpcEndpointIds
type: object
properties:
DryRun:
type: boolean
ServiceId:
type: string
VpcEndpointIds:
type: array
items:
type: string
description: ''
Tenancy:
title: Tenancy
enum:
- default
- dedicated
- host
type: string
DeleteCustomerGatewayRequest:
title: DeleteCustomerGatewayRequest
required:
- CustomerGatewayId
type: object
properties:
CustomerGatewayId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DeleteCustomerGateway.
GetConsoleScreenshotResult:
title: GetConsoleScreenshotResult
type: object
properties:
ImageData:
type: string
InstanceId:
type: string
ImportKeyPairRequest:
title: ImportKeyPairRequest
required:
- KeyName
- PublicKeyMaterial
type: object
properties:
DryRun:
type: boolean
KeyName:
type: string
PublicKeyMaterial:
type: string
LaunchTemplatePlacement:
title: LaunchTemplatePlacement
type: object
properties:
AvailabilityZone:
type: string
Affinity:
type: string
GroupName:
type: string
HostId:
type: string
Tenancy:
$ref: '#/components/schemas/Tenancy'
SpreadDomain:
type: string
description: Describes the placement of an instance.
DescribeFleetsResult:
title: DescribeFleetsResult
type: object
properties:
NextToken:
type: string
Fleets:
type: array
items:
$ref: '#/components/schemas/FleetData'
description: ''
VpnProtocol:
title: VpnProtocol
enum:
- openvpn
type: string
DescribeSpotInstanceRequestsResult:
title: DescribeSpotInstanceRequestsResult
type: object
properties:
SpotInstanceRequests:
type: array
items:
$ref: '#/components/schemas/SpotInstanceRequest'
description: ''
NextToken:
type: string
description: Contains the output of DescribeSpotInstanceRequests.
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
AssociatedNetworkType:
title: AssociatedNetworkType
enum:
- vpc
type: string
TransitGatewayRouteTableAssociation:
title: TransitGatewayRouteTableAssociation
type: object
properties:
TransitGatewayAttachmentId:
type: string
ResourceId:
type: string
ResourceType:
$ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
State:
$ref: '#/components/schemas/TransitGatewayAssociationState'
description: Describes an association between a route table and a resource attachment.
ModifyVolumeRequest:
title: ModifyVolumeRequest
required:
- VolumeId
type: object
properties:
DryRun:
type: boolean
VolumeId:
type: string
Size:
type: integer
format: int32
VolumeType:
$ref: '#/components/schemas/VolumeType'
Iops:
type: integer
format: int32
ClientVpnAuthorizationRuleStatusCode:
title: ClientVpnAuthorizationRuleStatusCode
enum:
- authorizing
- active
- failed
- revoking
type: string
SlotStartTimeRangeRequest:
title: SlotStartTimeRangeRequest
type: object
properties:
EarliestTime:
type: string
format: date-time
LatestTime:
type: string
format: date-time
description: Describes the time period for a Scheduled Instance to start its first schedule.
CreateFleetRequest:
title: CreateFleetRequest
required:
- LaunchTemplateConfigs
- TargetCapacitySpecification
type: object
properties:
DryRun:
type: boolean
ClientToken:
type: string
SpotOptions:
allOf:
- $ref: '#/components/schemas/SpotOptionsRequest'
- description: Describes the configuration of Spot Instances in an EC2 Fleet request.
OnDemandOptions:
allOf:
- $ref: '#/components/schemas/OnDemandOptionsRequest'
- description: The allocation strategy of On-Demand Instances in an EC2 Fleet.
ExcessCapacityTerminationPolicy:
$ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy'
LaunchTemplateConfigs:
maxItems: 50
type: array
items:
$ref: '#/components/schemas/FleetLaunchTemplateConfigRequest'
description: ''
TargetCapacitySpecification:
allOf:
- $ref: '#/components/schemas/TargetCapacitySpecificationRequest'
- description: 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.
TerminateInstancesWithExpiration:
type: boolean
Type:
$ref: '#/components/schemas/FleetType'
ValidFrom:
type: string
format: date-time
ValidUntil:
type: string
format: date-time
ReplaceUnhealthyInstances:
type: boolean
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: ''
MarketType:
title: MarketType
enum:
- spot
type: string
DescribeFpgaImageAttributeRequest:
title: DescribeFpgaImageAttributeRequest
required:
- FpgaImageId
- Attribute
type: object
properties:
DryRun:
type: boolean
FpgaImageId:
type: string
Attribute:
$ref: '#/components/schemas/FpgaImageAttributeName'
ReservationValue:
title: ReservationValue
type: object
properties:
HourlyPrice:
type: string
RemainingTotalValue:
type: string
RemainingUpfrontValue:
type: string
description: The cost associated with the Reserved Instance.
DescribeVpcClassicLinkDnsSupportRequest:
title: DescribeVpcClassicLinkDnsSupportRequest
type: object
properties:
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
NextToken:
maxLength: 1024
minLength: 1
type: string
VpcIds:
type: array
items:
type: string
description: ''
ModifyVpnConnectionRequest:
title: ModifyVpnConnectionRequest
required:
- VpnConnectionId
type: object
properties:
VpnConnectionId:
type: string
TransitGatewayId:
type: string
VpnGatewayId:
type: string
DryRun:
type: boolean
RequestLaunchTemplateData:
title: RequestLaunchTemplateData
type: object
properties:
KernelId:
type: string
EbsOptimized:
type: boolean
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/LaunchTemplateIamInstanceProfileSpecificationRequest'
- description: An IAM instance profile.
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateBlockDeviceMappingRequest'
description: ''
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateInstanceNetworkInterfaceSpecificationRequest'
description: ''
ImageId:
type: string
InstanceType:
$ref: '#/components/schemas/InstanceType'
KeyName:
type: string
Monitoring:
allOf:
- $ref: '#/components/schemas/LaunchTemplatesMonitoringRequest'
- description: Describes the monitoring for the instance.
Placement:
allOf:
- $ref: '#/components/schemas/LaunchTemplatePlacementRequest'
- description: Describes the placement of an instance.
RamDiskId:
type: string
DisableApiTermination:
type: boolean
InstanceInitiatedShutdownBehavior:
$ref: '#/components/schemas/ShutdownBehavior'
UserData:
type: string
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateTagSpecificationRequest'
description: ''
ElasticGpuSpecifications:
type: array
items:
$ref: '#/components/schemas/ElasticGpuSpecification'
description: ''
ElasticInferenceAccelerators:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateElasticInferenceAccelerator'
description: ''
SecurityGroupIds:
type: array
items:
type: string
description: ''
SecurityGroups:
type: array
items:
type: string
description: ''
InstanceMarketOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateInstanceMarketOptionsRequest'
- description: The market (purchasing) option for the instances.
CreditSpecification:
allOf:
- $ref: '#/components/schemas/CreditSpecificationRequest'
- description: The credit option for CPU usage of a T2 or T3 instance.
CpuOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateCpuOptionsRequest'
- description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
CapacityReservationSpecification:
allOf:
- $ref: '#/components/schemas/LaunchTemplateCapacityReservationSpecificationRequest'
- description: Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the CapacityReservationPreference parameter to configure the instance to run in On-Demand capacity or to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the CapacityReservationTarget parameter to explicitly target a specific Capacity Reservation.
LicenseSpecifications:
type: array
items:
$ref: '#/components/schemas/LaunchTemplateLicenseConfigurationRequest'
description: ''
HibernationOptions:
allOf:
- $ref: '#/components/schemas/LaunchTemplateHibernationOptionsRequest'
- description: Indicates whether the instance is configured for hibernation. This parameter is valid only if the instance meets the hibernation prerequisites. Hibernation is currently supported only for Amazon Linux.
description: The information to include in the launch template.
ElasticGpuStatus:
title: ElasticGpuStatus
enum:
- OK
- IMPAIRED
type: string
ReplaceTransitGatewayRouteResult:
title: ReplaceTransitGatewayRouteResult
type: object
properties:
Route:
allOf:
- $ref: '#/components/schemas/TransitGatewayRoute'
- description: Describes a route for a transit gateway route table.
DescribeClientVpnAuthorizationRulesRequest:
title: DescribeClientVpnAuthorizationRulesRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
DryRun:
type: boolean
NextToken:
maxLength: 1024
minLength: 1
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
RouteTable:
title: RouteTable
type: object
properties:
Associations:
type: array
items:
$ref: '#/components/schemas/RouteTableAssociation'
description: ''
PropagatingVgws:
type: array
items:
$ref: '#/components/schemas/PropagatingVgw'
description: ''
RouteTableId:
type: string
Routes:
type: array
items:
$ref: '#/components/schemas/Route'
description: ''
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VpcId:
type: string
OwnerId:
type: string
description: Describes a route table.
SpotInstanceState:
title: SpotInstanceState
enum:
- open
- active
- closed
- cancelled
- failed
type: string
AcceptTransitGatewayVpcAttachmentResult:
title: AcceptTransitGatewayVpcAttachmentResult
type: object
properties:
TransitGatewayVpcAttachment:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachment'
- description: Describes a VPC attachment.
CreateTagsRequest:
title: CreateTagsRequest
required:
- Resources
- Tags
type: object
properties:
DryRun:
type: boolean
Resources:
type: array
items:
type: string
description: ''
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
AllocateHostsRequest:
title: AllocateHostsRequest
required:
- AvailabilityZone
- InstanceType
- Quantity
type: object
properties:
AutoPlacement:
$ref: '#/components/schemas/AutoPlacement'
AvailabilityZone:
type: string
ClientToken:
type: string
InstanceType:
type: string
Quantity:
type: integer
format: int32
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: ''
UnassignIpv6AddressesResult:
title: UnassignIpv6AddressesResult
type: object
properties:
NetworkInterfaceId:
type: string
UnassignedIpv6Addresses:
type: array
items:
type: string
description: ''
DisableVgwRoutePropagationRequest:
title: DisableVgwRoutePropagationRequest
required:
- GatewayId
- RouteTableId
type: object
properties:
GatewayId:
type: string
RouteTableId:
type: string
description: Contains the parameters for DisableVgwRoutePropagation.
InstanceNetworkInterface:
title: InstanceNetworkInterface
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/InstanceNetworkInterfaceAssociation'
- description: Describes association information for an Elastic IP address (IPv4).
Attachment:
allOf:
- $ref: '#/components/schemas/InstanceNetworkInterfaceAttachment'
- description: Describes a network interface attachment.
Description:
type: string
Groups:
type: array
items:
$ref: '#/components/schemas/GroupIdentifier'
description: ''
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/InstanceIpv6Address'
description: ''
MacAddress:
type: string
NetworkInterfaceId:
type: string
OwnerId:
type: string
PrivateDnsName:
type: string
PrivateIpAddress:
type: string
PrivateIpAddresses:
type: array
items:
$ref: '#/components/schemas/InstancePrivateIpAddress'
description: ''
SourceDestCheck:
type: boolean
Status:
$ref: '#/components/schemas/NetworkInterfaceStatus'
SubnetId:
type: string
VpcId:
type: string
InterfaceType:
type: string
description: Describes a network interface.
CreateSpotDatafeedSubscriptionResult:
title: CreateSpotDatafeedSubscriptionResult
type: object
properties:
SpotDatafeedSubscription:
allOf:
- $ref: '#/components/schemas/SpotDatafeedSubscription'
- description: Describes the data feed for a Spot Instance.
description: Contains the output of CreateSpotDatafeedSubscription.
example:
SpotDatafeedSubscription:
Bucket: my-s3-bucket
OwnerId: '123456789012'
Prefix: spotdata
State: Active
Address:
title: Address
type: object
properties:
InstanceId:
type: string
PublicIp:
type: string
AllocationId:
type: string
AssociationId:
type: string
Domain:
$ref: '#/components/schemas/DomainType'
NetworkInterfaceId:
type: string
NetworkInterfaceOwnerId:
type: string
PrivateIpAddress:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
PublicIpv4Pool:
type: string
description: Describes an Elastic IP address.
ContainerFormat:
title: ContainerFormat
enum:
- ova
type: string
DescribePublicIpv4PoolsResult:
title: DescribePublicIpv4PoolsResult
type: object
properties:
PublicIpv4Pools:
type: array
items:
$ref: '#/components/schemas/PublicIpv4Pool'
description: ''
NextToken:
type: string
DescribeInternetGatewaysRequest:
title: DescribeInternetGatewaysRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
InternetGatewayIds:
type: array
items:
type: string
description: ''
NextToken:
type: string
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
ActiveInstance:
title: ActiveInstance
type: object
properties:
InstanceId:
type: string
InstanceType:
type: string
SpotInstanceRequestId:
type: string
InstanceHealth:
$ref: '#/components/schemas/InstanceHealthStatus'
description: Describes a running instance in a Spot Fleet.
DeleteLaunchTemplateRequest:
title: DeleteLaunchTemplateRequest
type: object
properties:
DryRun:
type: boolean
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
DescribeReservedInstancesModificationsResult:
title: DescribeReservedInstancesModificationsResult
type: object
properties:
NextToken:
type: string
ReservedInstancesModifications:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesModification'
description: ''
description: Contains the output of DescribeReservedInstancesModifications.
LoadPermissionRequest:
title: LoadPermissionRequest
type: object
properties:
Group:
$ref: '#/components/schemas/PermissionGroup'
UserId:
type: string
description: Describes a load permission.
AssociationStatus:
title: AssociationStatus
type: object
properties:
Code:
$ref: '#/components/schemas/AssociationStatusCode'
Message:
type: string
description: Describes the state of a target network association.
ServiceDetail:
title: ServiceDetail
type: object
properties:
ServiceName:
type: string
ServiceId:
type: string
ServiceType:
type: array
items:
$ref: '#/components/schemas/ServiceTypeDetail'
description: ''
AvailabilityZones:
type: array
items:
type: string
description: ''
Owner:
type: string
BaseEndpointDnsNames:
type: array
items:
type: string
description: ''
PrivateDnsName:
type: string
VpcEndpointPolicySupported:
type: boolean
AcceptanceRequired:
type: boolean
ManagesVpcEndpoints:
type: boolean
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a VPC endpoint service.
OnDemandOptions:
title: OnDemandOptions
type: object
properties:
AllocationStrategy:
$ref: '#/components/schemas/FleetOnDemandAllocationStrategy'
SingleInstanceType:
type: boolean
SingleAvailabilityZone:
type: boolean
MinTargetCapacity:
type: integer
format: int32
description: The allocation strategy of On-Demand Instances in an EC2 Fleet.
Ipv6SupportValue:
title: Ipv6SupportValue
enum:
- enable
- disable
type: string
CancelCapacityReservationRequest:
title: CancelCapacityReservationRequest
required:
- CapacityReservationId
type: object
properties:
CapacityReservationId:
type: string
DryRun:
type: boolean
ProductCode:
title: ProductCode
type: object
properties:
ProductCodeId:
type: string
ProductCodeType:
$ref: '#/components/schemas/ProductCodeValues'
description: Describes a product code.
VpcTenancy:
title: VpcTenancy
enum:
- default
type: string
NetworkInterfacePermission:
title: NetworkInterfacePermission
type: object
properties:
NetworkInterfacePermissionId:
type: string
NetworkInterfaceId:
type: string
AwsAccountId:
type: string
AwsService:
type: string
Permission:
$ref: '#/components/schemas/InterfacePermissionType'
PermissionState:
allOf:
- $ref: '#/components/schemas/NetworkInterfacePermissionState'
- description: Describes the state of a network interface permission.
description: Describes a permission for a network interface.
PropagatingVgw:
title: PropagatingVgw
type: object
properties:
GatewayId:
type: string
description: Describes a virtual private gateway propagating route.
BundleInstanceRequest:
title: BundleInstanceRequest
required:
- InstanceId
- Storage
type: object
properties:
InstanceId:
type: string
Storage:
allOf:
- $ref: '#/components/schemas/Storage'
- description: Describes the storage location for an instance store-backed AMI.
DryRun:
type: boolean
description: Contains the parameters for BundleInstance.
LaunchTemplateTagSpecification:
title: LaunchTemplateTagSpecification
type: object
properties:
ResourceType:
$ref: '#/components/schemas/ResourceType'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: The tag specification for the launch template.
CreateKeyPairRequest:
title: CreateKeyPairRequest
required:
- KeyName
type: object
properties:
KeyName:
type: string
DryRun:
type: boolean
TransitGateway:
title: TransitGateway
type: object
properties:
TransitGatewayId:
type: string
TransitGatewayArn:
type: string
State:
$ref: '#/components/schemas/TransitGatewayState'
OwnerId:
type: string
Description:
type: string
CreationTime:
type: string
format: date-time
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayOptions'
- description: Describes the options for a transit gateway.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a transit gateway.
DeleteEgressOnlyInternetGatewayRequest:
title: DeleteEgressOnlyInternetGatewayRequest
required:
- EgressOnlyInternetGatewayId
type: object
properties:
DryRun:
type: boolean
EgressOnlyInternetGatewayId:
type: string
ModifyIdentityIdFormatRequest:
title: ModifyIdentityIdFormatRequest
required:
- PrincipalArn
- Resource
- UseLongIds
type: object
properties:
PrincipalArn:
type: string
Resource:
type: string
UseLongIds:
type: boolean
Snapshot:
title: Snapshot
type: object
properties:
DataEncryptionKeyId:
type: string
Description:
type: string
Encrypted:
type: boolean
KmsKeyId:
type: string
OwnerId:
type: string
Progress:
type: string
SnapshotId:
type: string
StartTime:
type: string
format: date-time
State:
$ref: '#/components/schemas/SnapshotState'
StateMessage:
type: string
VolumeId:
type: string
VolumeSize:
type: integer
format: int32
OwnerAlias:
type: string
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a snapshot.
example:
Description: This is my root volume snapshot.
OwnerId: '12345678910'
SnapshotId: snap-066877671789bd71b
StartTime: 2014-02-28T21:06:01.000Z
State: pending
Tags: []
VolumeId: vol-1234567890abcdef0
VolumeSize: 8
DescribeVpcEndpointConnectionNotificationsRequest:
title: DescribeVpcEndpointConnectionNotificationsRequest
type: object
properties:
DryRun:
type: boolean
ConnectionNotificationId:
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
CpuOptionsRequest:
title: CpuOptionsRequest
type: object
properties:
CoreCount:
type: integer
format: int32
ThreadsPerCore:
type: integer
format: int32
description: The CPU options for the instance. Both the core count and threads per core must be specified in the request.
CreateLaunchTemplateResult:
title: CreateLaunchTemplateResult
type: object
properties:
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplate'
- description: Describes a launch template.
example:
LaunchTemplate:
CreateTime: 2017-11-27T09:13:24.000Z
CreatedBy: arn:aws:iam::123456789012:root
DefaultVersionNumber: 1
LatestVersionNumber: 1
LaunchTemplateId: lt-01238c059e3466abc
LaunchTemplateName: my-template
TransitGatewayPropagationState:
title: TransitGatewayPropagationState
enum:
- enabling
- enabled
- disabling
- disabled
type: string
DescribePlacementGroupsResult:
title: DescribePlacementGroupsResult
type: object
properties:
PlacementGroups:
type: array
items:
$ref: '#/components/schemas/PlacementGroup'
description: ''
CapacityReservationInstancePlatform:
title: CapacityReservationInstancePlatform
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
type: string
DeleteFleetErrorItem:
title: DeleteFleetErrorItem
type: object
properties:
Error:
allOf:
- $ref: '#/components/schemas/DeleteFleetError'
- description: Describes an EC2 Fleet error.
FleetId:
type: string
description: Describes an EC2 Fleet that was not successfully deleted.
AssociateClientVpnTargetNetworkResult:
title: AssociateClientVpnTargetNetworkResult
type: object
properties:
AssociationId:
type: string
Status:
allOf:
- $ref: '#/components/schemas/AssociationStatus'
- description: Describes the state of a target network association.
DescribeClientVpnConnectionsResult:
title: DescribeClientVpnConnectionsResult
type: object
properties:
Connections:
type: array
items:
$ref: '#/components/schemas/ClientVpnConnection'
description: ''
NextToken:
maxLength: 1024
minLength: 1
type: string
DeleteFleetsRequest:
title: DeleteFleetsRequest
required:
- FleetIds
- TerminateInstances
type: object
properties:
DryRun:
type: boolean
FleetIds:
type: array
items:
type: string
description: ''
TerminateInstances:
type: boolean
DeleteVpcPeeringConnectionRequest:
title: DeleteVpcPeeringConnectionRequest
required:
- VpcPeeringConnectionId
type: object
properties:
DryRun:
type: boolean
VpcPeeringConnectionId:
type: string
TargetCapacitySpecificationRequest:
title: TargetCapacitySpecificationRequest
required:
- TotalTargetCapacity
type: object
properties:
TotalTargetCapacity:
type: integer
format: int32
OnDemandTargetCapacity:
type: integer
format: int32
SpotTargetCapacity:
type: integer
format: int32
DefaultTargetCapacityType:
$ref: '#/components/schemas/DefaultTargetCapacityType'
description: 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.
WithdrawByoipCidrRequest:
title: WithdrawByoipCidrRequest
required:
- Cidr
type: object
properties:
Cidr:
type: string
DryRun:
type: boolean
PrefixListId:
title: PrefixListId
type: object
properties:
Description:
type: string
PrefixListId:
type: string
description: Describes a prefix list ID.
CreateTransitGatewayResult:
title: CreateTransitGatewayResult
type: object
properties:
TransitGateway:
allOf:
- $ref: '#/components/schemas/TransitGateway'
- description: Describes a transit gateway.
ReservedInstances:
title: ReservedInstances
type: object
properties:
AvailabilityZone:
type: string
Duration:
type: integer
format: int32
End:
type: string
format: date-time
FixedPrice:
type: number
InstanceCount:
type: integer
format: int32
InstanceType:
$ref: '#/components/schemas/InstanceType'
ProductDescription:
$ref: '#/components/schemas/RIProductDescription'
ReservedInstancesId:
type: string
Start:
type: string
format: date-time
State:
$ref: '#/components/schemas/ReservedInstanceState'
UsagePrice:
type: number
CurrencyCode:
$ref: '#/components/schemas/CurrencyCodeValues'
InstanceTenancy:
$ref: '#/components/schemas/Tenancy'
OfferingClass:
$ref: '#/components/schemas/OfferingClassType'
OfferingType:
$ref: '#/components/schemas/OfferingTypeValues'
RecurringCharges:
type: array
items:
$ref: '#/components/schemas/RecurringCharge'
description: ''
Scope:
$ref: '#/components/schemas/scope'
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a Reserved Instance.
TransitGatewayVpcAttachment:
title: TransitGatewayVpcAttachment
type: object
properties:
TransitGatewayAttachmentId:
type: string
TransitGatewayId:
type: string
VpcId:
type: string
VpcOwnerId:
type: string
State:
$ref: '#/components/schemas/TransitGatewayAttachmentState'
SubnetIds:
type: array
items:
type: string
description: ''
CreationTime:
type: string
format: date-time
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayVpcAttachmentOptions'
- description: Describes the VPC attachment options.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
description: Describes a VPC attachment.
ScheduledInstancesIamInstanceProfile:
title: ScheduledInstancesIamInstanceProfile
type: object
properties:
Arn:
type: string
Name:
type: string
description: Describes an IAM instance profile for a Scheduled Instance.
DescribeClientVpnTargetNetworksResult:
title: DescribeClientVpnTargetNetworksResult
type: object
properties:
ClientVpnTargetNetworks:
type: array
items:
$ref: '#/components/schemas/TargetNetwork'
description: ''
NextToken:
maxLength: 1024
minLength: 1
type: string
DescribeVpcEndpointsResult:
title: DescribeVpcEndpointsResult
type: object
properties:
VpcEndpoints:
type: array
items:
$ref: '#/components/schemas/VpcEndpoint'
description: ''
NextToken:
type: string
description: Contains the output of DescribeVpcEndpoints.
ReleaseHostsRequest:
title: ReleaseHostsRequest
required:
- HostIds
type: object
properties:
HostIds:
type: array
items:
type: string
description: ''
DescribeSnapshotAttributeResult:
title: DescribeSnapshotAttributeResult
type: object
properties:
CreateVolumePermissions:
type: array
items:
$ref: '#/components/schemas/CreateVolumePermission'
description: ''
ProductCodes:
type: array
items:
$ref: '#/components/schemas/ProductCode'
description: ''
SnapshotId:
type: string
description: Contains the output of DescribeSnapshotAttribute.
example:
CreateVolumePermissions: []
SnapshotId: snap-066877671789bd71b
DetachClassicLinkVpcResult:
title: DetachClassicLinkVpcResult
type: object
properties:
Return:
type: boolean
CapacityReservationSpecificationResponse:
title: CapacityReservationSpecificationResponse
type: object
properties:
CapacityReservationPreference:
$ref: '#/components/schemas/CapacityReservationPreference'
CapacityReservationTarget:
allOf:
- $ref: '#/components/schemas/CapacityReservationTargetResponse'
- description: Describes a target Capacity Reservation.
description: Describes the instance's Capacity Reservation targeting preferences. The action returns the capacityReservationPreference response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the capacityReservationTarget response element if the instance explicily targets a specific Capacity Reservation.
CreateVpcRequest:
title: CreateVpcRequest
required:
- CidrBlock
type: object
properties:
CidrBlock:
type: string
AmazonProvidedIpv6CidrBlock:
type: boolean
DryRun:
type: boolean
InstanceTenancy:
$ref: '#/components/schemas/Tenancy'
DeleteTransitGatewayRouteRequest:
title: DeleteTransitGatewayRouteRequest
required:
- TransitGatewayRouteTableId
- DestinationCidrBlock
type: object
properties:
TransitGatewayRouteTableId:
type: string
DestinationCidrBlock:
type: string
DryRun:
type: boolean
ScheduledInstancesEbs:
title: ScheduledInstancesEbs
type: object
properties:
DeleteOnTermination:
type: boolean
Encrypted:
type: boolean
Iops:
type: integer
format: int32
SnapshotId:
type: string
VolumeSize:
type: integer
format: int32
VolumeType:
type: string
description: Describes an EBS volume for a Scheduled Instance.
VolumeAttachmentState:
title: VolumeAttachmentState
enum:
- attaching
- attached
- detaching
- detached
- busy
type: string
CidrAuthorizationContext:
title: CidrAuthorizationContext
required:
- Message
- Signature
type: object
properties:
Message:
type: string
Signature:
type: string
description: Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP). For more information, see Prepare to Bring Your Address Range to Your AWS Account in the Amazon Elastic Compute Cloud User Guide.
Monitoring:
title: Monitoring
type: object
properties:
State:
$ref: '#/components/schemas/MonitoringState'
description: Describes the monitoring of an instance.
DescribeVpcEndpointConnectionNotificationsResult:
title: DescribeVpcEndpointConnectionNotificationsResult
type: object
properties:
ConnectionNotificationSet:
type: array
items:
$ref: '#/components/schemas/ConnectionNotification'
description: ''
NextToken:
type: string
ScheduledInstancesBlockDeviceMapping:
title: ScheduledInstancesBlockDeviceMapping
type: object
properties:
DeviceName:
type: string
Ebs:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesEbs'
- description: Describes an EBS volume for a Scheduled Instance.
NoDevice:
type: string
VirtualName:
type: string
description: Describes a block device mapping for a Scheduled Instance.
DeleteRouteRequest:
title: DeleteRouteRequest
required:
- RouteTableId
type: object
properties:
DestinationCidrBlock:
type: string
DestinationIpv6CidrBlock:
type: string
DryRun:
type: boolean
RouteTableId:
type: string
DetachClassicLinkVpcRequest:
title: DetachClassicLinkVpcRequest
required:
- InstanceId
- VpcId
type: object
properties:
DryRun:
type: boolean
InstanceId:
type: string
VpcId:
type: string
DescribePublicIpv4PoolsRequest:
title: DescribePublicIpv4PoolsRequest
type: object
properties:
PoolIds:
type: array
items:
type: string
description: ''
NextToken:
maxLength: 1024
minLength: 1
type: string
MaxResults:
maximum: 10
minimum: 1
type: integer
format: int32
ModifyVpcAttributeRequest:
title: ModifyVpcAttributeRequest
required:
- VpcId
type: object
properties:
EnableDnsHostnames:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
EnableDnsSupport:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
VpcId:
type: string
CreateTransitGatewayRouteResult:
title: CreateTransitGatewayRouteResult
type: object
properties:
Route:
allOf:
- $ref: '#/components/schemas/TransitGatewayRoute'
- description: Describes a route for a transit gateway route table.
TargetNetwork:
title: TargetNetwork
type: object
properties:
AssociationId:
type: string
VpcId:
type: string
TargetNetworkId:
type: string
ClientVpnEndpointId:
type: string
Status:
allOf:
- $ref: '#/components/schemas/AssociationStatus'
- description: Describes the state of a target network association.
SecurityGroups:
type: array
items:
type: string
description: ''
description: Describes a target network associated with a Client VPN endpoint.
VpcPeeringConnectionStateReason:
title: VpcPeeringConnectionStateReason
type: object
properties:
Code:
$ref: '#/components/schemas/VpcPeeringConnectionStateReasonCode'
Message:
type: string
description: Describes the status of a VPC peering connection.
DeleteVpcEndpointConnectionNotificationsRequest:
title: DeleteVpcEndpointConnectionNotificationsRequest
required:
- ConnectionNotificationIds
type: object
properties:
DryRun:
type: boolean
ConnectionNotificationIds:
type: array
items:
type: string
description: ''
TelemetryStatus:
title: TelemetryStatus
enum:
- UP
- DOWN
type: string
RequestSpotInstancesResult:
title: RequestSpotInstancesResult
type: object
properties:
SpotInstanceRequests:
type: array
items:
$ref: '#/components/schemas/SpotInstanceRequest'
description: ''
description: Contains the output of RequestSpotInstances.
UnmonitorInstancesResult:
title: UnmonitorInstancesResult
type: object
properties:
InstanceMonitorings:
type: array
items:
$ref: '#/components/schemas/InstanceMonitoring'
description: ''
ScheduledInstancesPlacement:
title: ScheduledInstancesPlacement
type: object
properties:
AvailabilityZone:
type: string
GroupName:
type: string
description: Describes the placement for a Scheduled Instance.
CreateFpgaImageResult:
title: CreateFpgaImageResult
type: object
properties:
FpgaImageId:
type: string
FpgaImageGlobalId:
type: string
SubnetCidrBlockState:
title: SubnetCidrBlockState
type: object
properties:
State:
$ref: '#/components/schemas/SubnetCidrBlockStateCode'
StatusMessage:
type: string
description: Describes the state of a CIDR block.
DefaultRouteTableAssociationValue:
title: DefaultRouteTableAssociationValue
enum:
- enable
- disable
type: string
InstanceNetworkInterfaceSpecification:
title: InstanceNetworkInterfaceSpecification
type: object
properties:
AssociatePublicIpAddress:
type: boolean
DeleteOnTermination:
type: boolean
Description:
type: string
DeviceIndex:
type: integer
format: int32
Groups:
type: array
items:
type: string
description: ''
Ipv6AddressCount:
type: integer
format: int32
Ipv6Addresses:
type: array
items:
$ref: '#/components/schemas/InstanceIpv6Address'
description: ''
NetworkInterfaceId:
type: string
PrivateIpAddress:
type: string
PrivateIpAddresses:
type: array
items:
$ref: '#/components/schemas/PrivateIpAddressSpecification'
description: ''
SecondaryPrivateIpAddressCount:
type: integer
format: int32
SubnetId:
type: string
InterfaceType:
type: string
description: Describes a network interface.
CreateTransitGatewayRequest:
title: CreateTransitGatewayRequest
type: object
properties:
Description:
type: string
Options:
allOf:
- $ref: '#/components/schemas/TransitGatewayRequestOptions'
- description: Describes the options for a transit gateway.
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: ''
DryRun:
type: boolean
ModifyVpcEndpointServicePermissionsRequest:
title: ModifyVpcEndpointServicePermissionsRequest
required:
- ServiceId
type: object
properties:
DryRun:
type: boolean
ServiceId:
type: string
AddAllowedPrincipals:
type: array
items:
type: string
description: ''
RemoveAllowedPrincipals:
type: array
items:
type: string
description: ''
TerminateClientVpnConnectionsRequest:
title: TerminateClientVpnConnectionsRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
ConnectionId:
type: string
Username:
type: string
DryRun:
type: boolean
GetPasswordDataResult:
title: GetPasswordDataResult
type: object
properties:
InstanceId:
type: string
PasswordData:
type: string
Timestamp:
type: string
format: date-time
VpcPeeringConnection:
title: VpcPeeringConnection
type: object
properties:
AccepterVpcInfo:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
- description: Describes a VPC in a VPC peering connection.
ExpirationTime:
type: string
format: date-time
RequesterVpcInfo:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionVpcInfo'
- description: Describes a VPC in a VPC peering connection.
Status:
allOf:
- $ref: '#/components/schemas/VpcPeeringConnectionStateReason'
- description: Describes the status of a VPC peering connection.
Tags:
type: array
items:
$ref: '#/components/schemas/Tag'
description: ''
VpcPeeringConnectionId:
type: string
description: Describes a VPC peering connection.
VolumeStatusInfoStatus:
title: VolumeStatusInfoStatus
enum:
- ok
- impaired
- insufficient-data
type: string
DescribeVpcEndpointServiceConfigurationsResult:
title: DescribeVpcEndpointServiceConfigurationsResult
type: object
properties:
ServiceConfigurations:
type: array
items:
$ref: '#/components/schemas/ServiceConfiguration'
description: ''
NextToken:
type: string
DisassociateTransitGatewayRouteTableResult:
title: DisassociateTransitGatewayRouteTableResult
type: object
properties:
Association:
allOf:
- $ref: '#/components/schemas/TransitGatewayAssociation'
- description: Describes an association between a resource attachment and a transit gateway route table.
ReplaceTransitGatewayRouteRequest:
title: ReplaceTransitGatewayRouteRequest
required:
- DestinationCidrBlock
- TransitGatewayRouteTableId
type: object
properties:
DestinationCidrBlock:
type: string
TransitGatewayRouteTableId:
type: string
TransitGatewayAttachmentId:
type: string
Blackhole:
type: boolean
DryRun:
type: boolean
UnsuccessfulInstanceCreditSpecificationItem:
title: UnsuccessfulInstanceCreditSpecificationItem
type: object
properties:
InstanceId:
type: string
Error:
allOf:
- $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationItemError'
- description: Information about the error for the T2 or T3 instance whose credit option for CPU usage was not modified.
description: Describes the T2 or T3 instance whose credit option for CPU usage was not modified.
DescribeSpotFleetRequestsResponse:
title: DescribeSpotFleetRequestsResponse
type: object
properties:
NextToken:
type: string
SpotFleetRequestConfigs:
type: array
items:
$ref: '#/components/schemas/SpotFleetRequestConfig'
description: ''
description: Contains the output of DescribeSpotFleetRequests.
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
CurrencyCodeValues:
title: CurrencyCodeValues
enum:
- USD
type: string
CreateSecurityGroupRequest:
title: CreateSecurityGroupRequest
required:
- Description
- GroupName
type: object
properties:
Description:
type: string
GroupName:
type: string
VpcId:
type: string
DryRun:
type: boolean
DescribeNetworkAclsResult:
title: DescribeNetworkAclsResult
type: object
properties:
NetworkAcls:
type: array
items:
$ref: '#/components/schemas/NetworkAcl'
description: ''
NextToken:
type: string
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
ModifyLaunchTemplateResult:
title: ModifyLaunchTemplateResult
type: object
properties:
LaunchTemplate:
allOf:
- $ref: '#/components/schemas/LaunchTemplate'
- description: Describes a launch template.
example:
LaunchTemplate:
CreateTime: 2017-12-01T13:35:46.000Z
CreatedBy: arn:aws:iam::123456789012:root
DefaultVersionNumber: 2
LatestVersionNumber: 2
LaunchTemplateId: lt-0abcd290751193123
LaunchTemplateName: WebServers
DescribeTransitGatewayAttachmentsRequest:
title: DescribeTransitGatewayAttachmentsRequest
type: object
properties:
TransitGatewayAttachmentIds:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
NextToken:
type: string
DryRun:
type: boolean
DescribeClientVpnConnectionsRequest:
title: DescribeClientVpnConnectionsRequest
required:
- ClientVpnEndpointId
type: object
properties:
ClientVpnEndpointId:
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
NextToken:
maxLength: 1024
minLength: 1
type: string
MaxResults:
maximum: 255
minimum: 5
type: integer
format: int32
DryRun:
type: boolean
CreateTransitGatewayRouteTableRequest:
title: CreateTransitGatewayRouteTableRequest
required:
- TransitGatewayId
type: object
properties:
TransitGatewayId:
type: string
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: ''
DryRun:
type: boolean
VolumeStatusInfo:
title: VolumeStatusInfo
type: object
properties:
Details:
type: array
items:
$ref: '#/components/schemas/VolumeStatusDetails'
description: ''
Status:
$ref: '#/components/schemas/VolumeStatusInfoStatus'
description: Describes the status of a volume.
SpotOptionsRequest:
title: SpotOptionsRequest
type: object
properties:
AllocationStrategy:
$ref: '#/components/schemas/SpotAllocationStrategy'
InstanceInterruptionBehavior:
$ref: '#/components/schemas/SpotInstanceInterruptionBehavior'
InstancePoolsToUseCount:
type: integer
format: int32
SingleInstanceType:
type: boolean
SingleAvailabilityZone:
type: boolean
MinTargetCapacity:
type: integer
format: int32
description: Describes the configuration of Spot Instances in an EC2 Fleet request.
PlatformValues:
title: PlatformValues
enum:
- Windows
type: string
InstanceStatusSummary:
title: InstanceStatusSummary
type: object
properties:
Details:
type: array
items:
$ref: '#/components/schemas/InstanceStatusDetails'
description: ''
Status:
$ref: '#/components/schemas/SummaryStatus'
description: Describes the status of an instance.
DisassociateTransitGatewayRouteTableRequest:
title: DisassociateTransitGatewayRouteTableRequest
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayRouteTableId:
type: string
TransitGatewayAttachmentId:
type: string
DryRun:
type: boolean
DescribeIdentityIdFormatResult:
title: DescribeIdentityIdFormatResult
type: object
properties:
Statuses:
type: array
items:
$ref: '#/components/schemas/IdFormat'
description: ''
LaunchPermission:
title: LaunchPermission
type: object
properties:
Group:
$ref: '#/components/schemas/PermissionGroup'
UserId:
type: string
description: Describes a launch permission.
DeleteLaunchTemplateVersionsResult:
title: DeleteLaunchTemplateVersionsResult
type: object
properties:
SuccessfullyDeletedLaunchTemplateVersions:
type: array
items:
$ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseSuccessItem'
description: ''
UnsuccessfullyDeletedLaunchTemplateVersions:
type: array
items:
$ref: '#/components/schemas/DeleteLaunchTemplateVersionsResponseErrorItem'
description: ''
example:
SuccessfullyDeletedLaunchTemplateVersions:
- LaunchTemplateId: lt-0abcd290751193123
LaunchTemplateName: my-template
VersionNumber: 1
UnsuccessfullyDeletedLaunchTemplateVersions: []
ModifyHostsRequest:
title: ModifyHostsRequest
required:
- AutoPlacement
- HostIds
type: object
properties:
AutoPlacement:
$ref: '#/components/schemas/AutoPlacement'
HostIds:
type: array
items:
type: string
description: ''
TargetConfiguration:
title: TargetConfiguration
type: object
properties:
InstanceCount:
type: integer
format: int32
OfferingId:
type: string
description: Information about the Convertible Reserved Instance offering.
TransitGatewayRoute:
title: TransitGatewayRoute
type: object
properties:
DestinationCidrBlock:
type: string
TransitGatewayAttachments:
type: array
items:
$ref: '#/components/schemas/TransitGatewayRouteAttachment'
description: ''
Type:
$ref: '#/components/schemas/TransitGatewayRouteType'
State:
$ref: '#/components/schemas/TransitGatewayRouteState'
description: Describes a route for a transit gateway route table.
MovingAddressStatus:
title: MovingAddressStatus
type: object
properties:
MoveStatus:
$ref: '#/components/schemas/MoveStatus'
PublicIp:
type: string
description: Describes the status of a moving Elastic IP address.
TagDescription:
title: TagDescription
type: object
properties:
Key:
type: string
ResourceId:
type: string
ResourceType:
$ref: '#/components/schemas/ResourceType'
Value:
type: string
description: Describes a tag.
SpotOptions:
title: SpotOptions
type: object
properties:
AllocationStrategy:
$ref: '#/components/schemas/SpotAllocationStrategy'
InstanceInterruptionBehavior:
$ref: '#/components/schemas/SpotInstanceInterruptionBehavior'
InstancePoolsToUseCount:
type: integer
format: int32
SingleInstanceType:
type: boolean
SingleAvailabilityZone:
type: boolean
MinTargetCapacity:
type: integer
format: int32
description: Describes the configuration of Spot Instances in an EC2 Fleet.
CreateSubnetRequest:
title: CreateSubnetRequest
required:
- CidrBlock
- VpcId
type: object
properties:
AvailabilityZone:
type: string
AvailabilityZoneId:
type: string
CidrBlock:
type: string
Ipv6CidrBlock:
type: string
VpcId:
type: string
DryRun:
type: boolean
NetworkInterfaceAttribute:
title: NetworkInterfaceAttribute
enum:
- description
- groupSet
- sourceDestCheck
- attachment
type: string
DescribeScheduledInstancesRequest:
title: DescribeScheduledInstancesRequest
type: object
properties:
DryRun:
type: boolean
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
type: integer
format: int32
NextToken:
type: string
ScheduledInstanceIds:
type: array
items:
type: string
description: ''
SlotStartTimeRange:
allOf:
- $ref: '#/components/schemas/SlotStartTimeRangeRequest'
- description: Describes the time period for a Scheduled Instance to start its first schedule.
description: Contains the parameters for DescribeScheduledInstances.
OnDemandAllocationStrategy:
title: OnDemandAllocationStrategy
enum:
- lowestPrice
- prioritized
type: string
GetTransitGatewayRouteTablePropagationsRequest:
title: GetTransitGatewayRouteTablePropagationsRequest
required:
- TransitGatewayRouteTableId
type: object
properties:
TransitGatewayRouteTableId:
type: string
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
NextToken:
type: string
DryRun:
type: boolean
ClientVpnAuthenticationType:
title: ClientVpnAuthenticationType
enum:
- certificate-authentication
- directory-service-authentication
type: string
ModifyCapacityReservationRequest:
title: ModifyCapacityReservationRequest
required:
- CapacityReservationId
type: object
properties:
CapacityReservationId:
type: string
InstanceCount:
type: integer
format: int32
EndDate:
type: string
format: date-time
EndDateType:
$ref: '#/components/schemas/EndDateType'
DryRun:
type: boolean
LoadBalancersConfig:
title: LoadBalancersConfig
type: object
properties:
ClassicLoadBalancersConfig:
allOf:
- $ref: '#/components/schemas/ClassicLoadBalancersConfig'
- description: Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.
TargetGroupsConfig:
allOf:
- $ref: '#/components/schemas/TargetGroupsConfig'
- description: Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.
description: Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.
DescribeReservedInstancesRequest:
title: DescribeReservedInstancesRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
OfferingClass:
$ref: '#/components/schemas/OfferingClassType'
ReservedInstancesIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
OfferingType:
$ref: '#/components/schemas/OfferingTypeValues'
description: Contains the parameters for DescribeReservedInstances.
UserBucketDetails:
title: UserBucketDetails
type: object
properties:
S3Bucket:
type: string
S3Key:
type: string
description: Describes the S3 bucket for the disk image.
StopInstancesRequest:
title: StopInstancesRequest
required:
- InstanceIds
type: object
properties:
InstanceIds:
type: array
items:
type: string
description: ''
Hibernate:
type: boolean
DryRun:
type: boolean
Force:
type: boolean
GetLaunchTemplateDataResult:
title: GetLaunchTemplateDataResult
type: object
properties:
LaunchTemplateData:
allOf:
- $ref: '#/components/schemas/ResponseLaunchTemplateData'
- description: The information for a launch template.
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
RunScheduledInstancesResult:
title: RunScheduledInstancesResult
type: object
properties:
InstanceIdSet:
type: array
items:
type: string
description: ''
description: Contains the output of RunScheduledInstances.
example:
InstanceIdSet:
- i-1234567890abcdef0
DeleteRouteTableRequest:
title: DeleteRouteTableRequest
required:
- RouteTableId
type: object
properties:
DryRun:
type: boolean
RouteTableId:
type: string
AssociateTransitGatewayRouteTableRequest:
title: AssociateTransitGatewayRouteTableRequest
required:
- TransitGatewayRouteTableId
- TransitGatewayAttachmentId
type: object
properties:
TransitGatewayRouteTableId:
type: string
TransitGatewayAttachmentId:
type: string
DryRun:
type: boolean
DeleteTransitGatewayResult:
title: DeleteTransitGatewayResult
type: object
properties:
TransitGateway:
allOf:
- $ref: '#/components/schemas/TransitGateway'
- description: Describes a transit gateway.
UserData:
title: UserData
type: object
properties:
Data:
type: string
description: Describes the user data for an instance.
ModifyInstanceEventStartTimeResult:
title: ModifyInstanceEventStartTimeResult
type: object
properties:
Event:
allOf:
- $ref: '#/components/schemas/InstanceStatusEvent'
- description: Describes a scheduled event for an instance.
TransitGatewayPropagation:
title: TransitGatewayPropagation
type: object
properties:
TransitGatewayAttachmentId:
type: string
ResourceId:
type: string
ResourceType:
$ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
TransitGatewayRouteTableId:
type: string
State:
$ref: '#/components/schemas/TransitGatewayPropagationState'
description: Describes route propagation.
ResetSnapshotAttributeRequest:
title: ResetSnapshotAttributeRequest
required:
- Attribute
- SnapshotId
type: object
properties:
Attribute:
$ref: '#/components/schemas/SnapshotAttributeName'
SnapshotId:
type: string
DryRun:
type: boolean
description: Contains the parameters for ResetSnapshotAttribute.
TransitGatewayAssociation:
title: TransitGatewayAssociation
type: object
properties:
TransitGatewayRouteTableId:
type: string
TransitGatewayAttachmentId:
type: string
ResourceId:
type: string
ResourceType:
$ref: '#/components/schemas/TransitGatewayAttachmentResourceType'
State:
$ref: '#/components/schemas/TransitGatewayAssociationState'
description: Describes an association between a resource attachment and a transit gateway route table.
CreateVpnConnectionRequest:
title: CreateVpnConnectionRequest
required:
- CustomerGatewayId
- Type
type: object
properties:
CustomerGatewayId:
type: string
Type:
type: string
VpnGatewayId:
type: string
TransitGatewayId:
type: string
DryRun:
type: boolean
Options:
allOf:
- $ref: '#/components/schemas/VpnConnectionOptionsSpecification'
- description: Describes VPN connection options.
description: Contains the parameters for CreateVpnConnection.
AllocateAddressResult:
title: AllocateAddressResult
type: object
properties:
PublicIp:
type: string
AllocationId:
type: string
PublicIpv4Pool:
type: string
Domain:
$ref: '#/components/schemas/DomainType'
example:
Domain: standard
PublicIp: 198.51.100.0
DescribeTransitGatewayVpcAttachmentsResult:
title: DescribeTransitGatewayVpcAttachmentsResult
type: object
properties:
TransitGatewayVpcAttachments:
type: array
items:
$ref: '#/components/schemas/TransitGatewayVpcAttachment'
description: ''
NextToken:
type: string
MoveAddressToVpcResult:
title: MoveAddressToVpcResult
type: object
properties:
AllocationId:
type: string
Status:
$ref: '#/components/schemas/Status'
example:
Status: MoveInProgress
CreateSnapshotRequest:
title: CreateSnapshotRequest
required:
- VolumeId
type: object
properties:
Description:
type: string
VolumeId:
type: string
TagSpecifications:
type: array
items:
$ref: '#/components/schemas/TagSpecification'
description: ''
DryRun:
type: boolean
description: Contains the parameters for CreateSnapshot.
CreateInternetGatewayRequest:
title: CreateInternetGatewayRequest
type: object
properties:
DryRun:
type: boolean
BundleInstanceResult:
title: BundleInstanceResult
type: object
properties:
BundleTask:
allOf:
- $ref: '#/components/schemas/BundleTask'
- description: Describes a bundle task.
description: Contains the output of BundleInstance.
CreateTransitGatewayRouteTableResult:
title: CreateTransitGatewayRouteTableResult
type: object
properties:
TransitGatewayRouteTable:
allOf:
- $ref: '#/components/schemas/TransitGatewayRouteTable'
- description: Describes a transit gateway route table.
ModifyInstancePlacementRequest:
title: ModifyInstancePlacementRequest
required:
- InstanceId
type: object
properties:
Affinity:
$ref: '#/components/schemas/Affinity'
GroupName:
type: string
HostId:
type: string
InstanceId:
type: string
Tenancy:
$ref: '#/components/schemas/HostTenancy'
PartitionNumber:
type: integer
format: int32
DescribeReservedInstancesListingsRequest:
title: DescribeReservedInstancesListingsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
ReservedInstancesId:
type: string
ReservedInstancesListingId:
type: string
description: Contains the parameters for DescribeReservedInstancesListings.
AssignIpv6AddressesResult:
title: AssignIpv6AddressesResult
type: object
properties:
AssignedIpv6Addresses:
type: array
items:
type: string
description: ''
NetworkInterfaceId:
type: string
BundleTaskError:
title: BundleTaskError
type: object
properties:
Code:
type: string
Message:
type: string
description: Describes an error for BundleInstance.
LaunchTemplateSpecification:
title: LaunchTemplateSpecification
type: object
properties:
LaunchTemplateId:
type: string
LaunchTemplateName:
type: string
Version:
type: string
description: The launch template to use. You must specify either the launch template ID or launch template name in the request, but not both.
DescribeTransitGatewaysRequest:
title: DescribeTransitGatewaysRequest
type: object
properties:
TransitGatewayIds:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
NextToken:
type: string
DryRun:
type: boolean
AcceptVpcPeeringConnectionRequest:
title: AcceptVpcPeeringConnectionRequest
type: object
properties:
DryRun:
type: boolean
VpcPeeringConnectionId:
type: string
DescribeDhcpOptionsRequest:
title: DescribeDhcpOptionsRequest
type: object
properties:
DhcpOptionsIds:
type: array
items:
type: string
description: ''
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
NextToken:
type: string
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
ModifyVpcEndpointConnectionNotificationRequest:
title: ModifyVpcEndpointConnectionNotificationRequest
required:
- ConnectionNotificationId
type: object
properties:
DryRun:
type: boolean
ConnectionNotificationId:
type: string
ConnectionNotificationArn:
type: string
ConnectionEvents:
type: array
items:
type: string
description: ''
ClientCertificateRevocationListStatusCode:
title: ClientCertificateRevocationListStatusCode
enum:
- pending
- active
type: string
ImportKeyPairResult:
title: ImportKeyPairResult
type: object
properties:
KeyFingerprint:
type: string
KeyName:
type: string
DeleteFleetsResult:
title: DeleteFleetsResult
type: object
properties:
SuccessfulFleetDeletions:
type: array
items:
$ref: '#/components/schemas/DeleteFleetSuccessItem'
description: ''
UnsuccessfulFleetDeletions:
type: array
items:
$ref: '#/components/schemas/DeleteFleetErrorItem'
description: ''
DescribeBundleTasksResult:
title: DescribeBundleTasksResult
type: object
properties:
BundleTasks:
type: array
items:
$ref: '#/components/schemas/BundleTask'
description: ''
CreateFlowLogsResult:
title: CreateFlowLogsResult
type: object
properties:
ClientToken:
type: string
FlowLogIds:
type: array
items:
type: string
description: ''
Unsuccessful:
type: array
items:
$ref: '#/components/schemas/UnsuccessfulItem'
description: ''
StateReason:
title: StateReason
type: object
properties:
Code:
type: string
Message:
type: string
description: Describes a state change.
DescribeByoipCidrsResult:
title: DescribeByoipCidrsResult
type: object
properties:
ByoipCidrs:
type: array
items:
$ref: '#/components/schemas/ByoipCidr'
description: ''
NextToken:
type: string
PrincipalType:
title: PrincipalType
enum:
- All
- Service
- OrganizationUnit
- Account
- User
- Role
type: string
ReservedInstanceState:
title: ReservedInstanceState
enum:
- payment-pending
- active
- payment-failed
- retired
type: string
CreateVpcEndpointConnectionNotificationRequest:
title: CreateVpcEndpointConnectionNotificationRequest
required:
- ConnectionNotificationArn
- ConnectionEvents
type: object
properties:
DryRun:
type: boolean
ServiceId:
type: string
VpcEndpointId:
type: string
ConnectionNotificationArn:
type: string
ConnectionEvents:
type: array
items:
type: string
description: ''
ClientToken:
type: string
FleetLaunchTemplateSpecificationRequest:
title: FleetLaunchTemplateSpecificationRequest
type: object
properties:
LaunchTemplateId:
type: string
LaunchTemplateName:
maxLength: 128
minLength: 3
pattern: '[a-zA-Z0-9\(\)\.\-/_]+'
type: string
Version:
type: string
description: The launch template to use. You must specify either the launch template ID or launch template name in the request.
ClientVpnEndpointStatusCode:
title: ClientVpnEndpointStatusCode
enum:
- pending-associate
- available
- deleting
- deleted
type: string
GatewayType:
title: GatewayType
enum:
- ipsec.1
type: string
CancelImportTaskResult:
title: CancelImportTaskResult
type: object
properties:
ImportTaskId:
type: string
PreviousState:
type: string
State:
type: string
description: Contains the output for CancelImportTask.
GetTransitGatewayRouteTablePropagationsResult:
title: GetTransitGatewayRouteTablePropagationsResult
type: object
properties:
TransitGatewayRouteTablePropagations:
type: array
items:
$ref: '#/components/schemas/TransitGatewayRouteTablePropagation'
description: ''
NextToken:
type: string
ApplySecurityGroupsToClientVpnTargetNetworkRequest:
title: ApplySecurityGroupsToClientVpnTargetNetworkRequest
required:
- ClientVpnEndpointId
- VpcId
- SecurityGroupIds
type: object
properties:
ClientVpnEndpointId:
type: string
VpcId:
type: string
SecurityGroupIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
DeleteNetworkInterfacePermissionRequest:
title: DeleteNetworkInterfacePermissionRequest
required:
- NetworkInterfacePermissionId
type: object
properties:
NetworkInterfacePermissionId:
type: string
Force:
type: boolean
DryRun:
type: boolean
description: Contains the parameters for DeleteNetworkInterfacePermission.
DescribeNetworkAclsRequest:
title: DescribeNetworkAclsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
DryRun:
type: boolean
NetworkAclIds:
type: array
items:
type: string
description: ''
NextToken:
type: string
MaxResults:
maximum: 1000
minimum: 5
type: integer
format: int32
StopInstancesResult:
title: StopInstancesResult
type: object
properties:
StoppingInstances:
type: array
items:
$ref: '#/components/schemas/InstanceStateChange'
description: ''
example:
StoppingInstances:
- CurrentState:
Code: 64
Name: stopping
InstanceId: i-1234567890abcdef0
PreviousState:
Code: 16
Name: running
DeleteVpcRequest:
title: DeleteVpcRequest
required:
- VpcId
type: object
properties:
VpcId:
type: string
DryRun:
type: boolean
ReservedInstancesModificationResult:
title: ReservedInstancesModificationResult
type: object
properties:
ReservedInstancesId:
type: string
TargetConfiguration:
allOf:
- $ref: '#/components/schemas/ReservedInstancesConfiguration'
- description: Describes the configuration settings for the modified Reserved Instances.
description: Describes the modification request/s.
DescribeElasticGpusRequest:
title: DescribeElasticGpusRequest
type: object
properties:
ElasticGpuIds:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
MaxResults:
maximum: 1000
minimum: 10
type: integer
format: int32
NextToken:
type: string
CancelSpotFleetRequestsRequest:
title: CancelSpotFleetRequestsRequest
required:
- SpotFleetRequestIds
- TerminateInstances
type: object
properties:
DryRun:
type: boolean
SpotFleetRequestIds:
type: array
items:
type: string
description: ''
TerminateInstances:
type: boolean
description: Contains the parameters for CancelSpotFleetRequests.
LaunchTemplateLicenseConfiguration:
title: LaunchTemplateLicenseConfiguration
type: object
properties:
LicenseConfigurationArn:
type: string
description: Describes a license configuration.
DescribeConversionTasksResult:
title: DescribeConversionTasksResult
type: object
properties:
ConversionTasks:
type: array
items:
$ref: '#/components/schemas/ConversionTask'
description: ''
description: Contains the output for DescribeConversionTasks.
PlacementResponse:
title: PlacementResponse
type: object
properties:
GroupName:
type: string
description: Describes the placement of an instance.
NetworkAclAssociation:
title: NetworkAclAssociation
type: object
properties:
NetworkAclAssociationId:
type: string
NetworkAclId:
type: string
SubnetId:
type: string
description: Describes an association between a network ACL and a subnet.
ModifyVpcEndpointConnectionNotificationResult:
title: ModifyVpcEndpointConnectionNotificationResult
type: object
properties:
ReturnValue:
type: boolean
DescribeInternetGatewaysResult:
title: DescribeInternetGatewaysResult
type: object
properties:
InternetGateways:
type: array
items:
$ref: '#/components/schemas/InternetGateway'
description: ''
NextToken:
type: string
AssociateSubnetCidrBlockResult:
title: AssociateSubnetCidrBlockResult
type: object
properties:
Ipv6CidrBlockAssociation:
allOf:
- $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation'
- description: Describes an IPv6 CIDR block associated with a subnet.
SubnetId:
type: string
PlacementGroupState:
title: PlacementGroupState
enum:
- pending
- available
- deleting
- deleted
type: string
ModifyNetworkInterfaceAttributeRequest:
title: ModifyNetworkInterfaceAttributeRequest
required:
- NetworkInterfaceId
type: object
properties:
Attachment:
allOf:
- $ref: '#/components/schemas/NetworkInterfaceAttachmentChanges'
- description: Describes an attachment change.
Description:
allOf:
- $ref: '#/components/schemas/AttributeValue'
- description: Describes a value for a resource attribute that is a String.
DryRun:
type: boolean
Groups:
type: array
items:
type: string
description: ''
NetworkInterfaceId:
type: string
SourceDestCheck:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
description: Contains the parameters for ModifyNetworkInterfaceAttribute.
CancelReservedInstancesListingResult:
title: CancelReservedInstancesListingResult
type: object
properties:
ReservedInstancesListings:
type: array
items:
$ref: '#/components/schemas/ReservedInstancesListing'
description: ''
description: Contains the output of CancelReservedInstancesListing.
FleetLaunchTemplateConfigRequest:
title: 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:
maxItems: 50
type: array
items:
$ref: '#/components/schemas/FleetLaunchTemplateOverridesRequest'
description: ''
description: Describes a launch template and overrides.
DescribeRegionsRequest:
title: DescribeRegionsRequest
type: object
properties:
Filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
RegionNames:
type: array
items:
type: string
description: ''
DryRun:
type: boolean
MonitorInstancesResult:
title: MonitorInstancesResult
type: object
properties:
InstanceMonitorings:
type: array
items:
$ref: '#/components/schemas/InstanceMonitoring'
description: ''
BundleTaskState:
title: BundleTaskState
enum:
- pending
- waiting-for-shutdown
- bundling
- storing
- cancelling
- complete
- failed
type: string
ModifySubnetAttributeRequest:
title: ModifySubnetAttributeRequest
required:
- SubnetId
type: object
properties:
AssignIpv6AddressOnCreation:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
MapPublicIpOnLaunch:
allOf:
- $ref: '#/components/schemas/AttributeBooleanValue'
- description: Describes a value for a resource attribute that is a Boolean value.
SubnetId:
type: string
ExportClientVpnClientCertificateRevocationListResult:
title: ExportClientVpnClientCertificateRevocationListResult
type: object
properties:
CertificateRevocationList:
type: string
Status:
allOf:
- $ref: '#/components/schemas/ClientCertificateRevocationListStatus'
- description: Describes the state of a client certificate revocation list.
HypervisorType:
title: HypervisorType
enum:
- ovm
- xen
type: string
PurchaseScheduledInstancesRequest:
title: PurchaseScheduledInstancesRequest
required:
- PurchaseRequests
type: object
properties:
ClientToken:
type: string
DryRun:
type: boolean
PurchaseRequests:
minItems: 1
type: array
items:
$ref: '#/components/schemas/PurchaseRequest'
description: ''
description: Contains the parameters for PurchaseScheduledInstances.
CapacityReservationPreference:
title: CapacityReservationPreference
enum:
- open
- none
type: string
InstanceLifecycle:
title: InstanceLifecycle
enum:
- spot
- on-demand
type: string
ByoipCidr:
title: ByoipCidr
type: object
properties:
Cidr:
type: string
Description:
type: string
StatusMessage:
type: string
State:
$ref: '#/components/schemas/ByoipCidrState'
description: Information about an address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).
ModifyFleetRequest:
title: ModifyFleetRequest
required:
- FleetId
- TargetCapacitySpecification
type: object
properties:
DryRun:
type: boolean
ExcessCapacityTerminationPolicy:
$ref: '#/components/schemas/FleetExcessCapacityTerminationPolicy'
FleetId:
type: string
TargetCapacitySpecification:
allOf:
- $ref: '#/components/schemas/TargetCapacitySpecificationRequest'
- description: 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.
DescribeSpotDatafeedSubscriptionResult:
title: DescribeSpotDatafeedSubscriptionResult
type: object
properties:
SpotDatafeedSubscription:
allOf:
- $ref: '#/components/schemas/SpotDatafeedSubscription'
- description: Describes the data feed for a Spot Instance.
description: Contains the output of DescribeSpotDatafeedSubscription.
example:
SpotDatafeedSubscription:
Bucket: my-s3-bucket
OwnerId: '123456789012'
Prefix: spotdata
State: Active
DeleteVpnConnectionRequest:
title: DeleteVpnConnectionRequest
required:
- VpnConnectionId
type: object
properties:
VpnConnectionId:
type: string
DryRun:
type: boolean
description: Contains the parameters for DeleteVpnConnection.
AuthorizeClientVpnIngressResult:
title: AuthorizeClientVpnIngressResult
type: object
properties:
Status:
allOf:
- $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus'
- description: Describes the state of an authorization rule.
ConnectionLogResponseOptions:
title: ConnectionLogResponseOptions
type: object
properties:
Enabled:
type: boolean
CloudwatchLogGroup:
type: string
CloudwatchLogStream:
type: string
description: Information about the client connection logging options for a Client VPN endpoint.
ScheduledInstancesLaunchSpecification:
title: ScheduledInstancesLaunchSpecification
required:
- ImageId
type: object
properties:
BlockDeviceMappings:
type: array
items:
$ref: '#/components/schemas/ScheduledInstancesBlockDeviceMapping'
description: ''
EbsOptimized:
type: boolean
IamInstanceProfile:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesIamInstanceProfile'
- description: Describes an IAM instance profile for a Scheduled Instance.
ImageId:
type: string
InstanceType:
type: string
KernelId:
type: string
KeyName:
type: string
Monitoring:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesMonitoring'
- description: Describes whether monitoring is enabled for a Scheduled Instance.
NetworkInterfaces:
type: array
items:
$ref: '#/components/schemas/ScheduledInstancesNetworkInterface'
description: ''
Placement:
allOf:
- $ref: '#/components/schemas/ScheduledInstancesPlacement'
- description: Describes the placement for a Scheduled Instance.
RamdiskId:
type: string
SecurityGroupIds:
type: array
items:
type: string
description: ''
SubnetId:
type: string
UserData:
type: string
description: 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.
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.
Describes the modification status of an EBS volume.
If the volume has never been modified, some element values will be null.
DescribeImportSnapshotTasksRequest: title: DescribeImportSnapshotTasksRequest type: object properties: DryRun: type: boolean Filters: type: array items: $ref: '#/components/schemas/Filter' description: '' ImportTaskIds: type: array items: type: string description: '' MaxResults: type: integer format: int32 NextToken: type: string description: Contains the parameters for DescribeImportSnapshotTasks. DescribeKeyPairsRequest: title: DescribeKeyPairsRequest type: object properties: Filters: type: array items: $ref: '#/components/schemas/Filter' description: '' KeyNames: type: array items: type: string description: '' DryRun: type: boolean DescribeEgressOnlyInternetGatewaysResult: title: DescribeEgressOnlyInternetGatewaysResult type: object properties: EgressOnlyInternetGateways: type: array items: $ref: '#/components/schemas/EgressOnlyInternetGateway' description: '' NextToken: type: string WithdrawByoipCidrResult: title: WithdrawByoipCidrResult type: object properties: ByoipCidr: allOf: - $ref: '#/components/schemas/ByoipCidr' - description: Information about an address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP). ByoipCidrState: title: ByoipCidrState enum: - advertised - deprovisioned - failed-deprovision - failed-provision - pending-deprovision - pending-provision - provisioned type: string ModifyInstanceAttributeRequest: title: ModifyInstanceAttributeRequest required: - InstanceId type: object properties: SourceDestCheck: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - description: Describes a value for a resource attribute that is a Boolean value. Attribute: $ref: '#/components/schemas/InstanceAttributeName' BlockDeviceMappings: type: array items: $ref: '#/components/schemas/InstanceBlockDeviceMappingSpecification' description: '' DisableApiTermination: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - description: Describes a value for a resource attribute that is a Boolean value. DryRun: type: boolean EbsOptimized: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - description: Describes a value for a resource attribute that is a Boolean value. EnaSupport: allOf: - $ref: '#/components/schemas/AttributeBooleanValue' - description: Describes a value for a resource attribute that is a Boolean value. Groups: type: array items: type: string description: '' InstanceId: type: string InstanceInitiatedShutdownBehavior: allOf: - $ref: '#/components/schemas/AttributeValue' - description: Describes a value for a resource attribute that is a String. InstanceType: allOf: - $ref: '#/components/schemas/AttributeValue' - description: Describes a value for a resource attribute that is a String. Kernel: allOf: - $ref: '#/components/schemas/AttributeValue' - description: Describes a value for a resource attribute that is a String. Ramdisk: allOf: - $ref: '#/components/schemas/AttributeValue' - description: Describes a value for a resource attribute that is a String. SriovNetSupport: allOf: - $ref: '#/components/schemas/AttributeValue' - description: Describes a value for a resource attribute that is a String. UserData: $ref: '#/components/schemas/BlobAttributeValue' Value: type: string DeviceType: title: DeviceType enum: - ebs - instance-store type: string GetHostReservationPurchasePreviewResult: title: GetHostReservationPurchasePreviewResult type: object properties: CurrencyCode: $ref: '#/components/schemas/CurrencyCodeValues' Purchase: type: array items: $ref: '#/components/schemas/Purchase' description: '' TotalHourlyPrice: type: string TotalUpfrontPrice: type: string DeleteEgressOnlyInternetGatewayResult: title: DeleteEgressOnlyInternetGatewayResult type: object properties: ReturnCode: type: boolean DescribeCapacityReservationsResult: title: DescribeCapacityReservationsResult type: object properties: NextToken: type: string CapacityReservations: type: array items: $ref: '#/components/schemas/CapacityReservation' description: '' ReservedInstanceLimitPrice: title: ReservedInstanceLimitPrice type: object properties: Amount: type: number CurrencyCode: $ref: '#/components/schemas/CurrencyCodeValues' description: Describes the limit price of a Reserved Instance offering. RevokeClientVpnIngressResult: title: RevokeClientVpnIngressResult type: object properties: Status: allOf: - $ref: '#/components/schemas/ClientVpnAuthorizationRuleStatus' - description: Describes the state of an authorization rule. DescribeSpotPriceHistoryRequest: title: DescribeSpotPriceHistoryRequest type: object properties: Filters: type: array items: $ref: '#/components/schemas/Filter' description: '' AvailabilityZone: type: string DryRun: type: boolean EndTime: type: string format: date-time InstanceTypes: type: array items: $ref: '#/components/schemas/InstanceType' description: '' MaxResults: type: integer format: int32 NextToken: type: string ProductDescriptions: type: array items: type: string description: '' StartTime: type: string format: date-time description: Contains the parameters for DescribeSpotPriceHistory. ReplaceNetworkAclEntryRequest: title: ReplaceNetworkAclEntryRequest required: - Egress - NetworkAclId - Protocol - RuleAction - RuleNumber type: object properties: CidrBlock: type: string DryRun: type: boolean Egress: type: boolean IcmpTypeCode: allOf: - $ref: '#/components/schemas/IcmpTypeCode' - description: Describes the ICMP type and code. Ipv6CidrBlock: type: string NetworkAclId: type: string PortRange: allOf: - $ref: '#/components/schemas/PortRange' - description: Describes a range of ports. Protocol: type: string RuleAction: $ref: '#/components/schemas/RuleAction' RuleNumber: type: integer format: int32 DiskImageFormat: title: DiskImageFormat enum: - VMDK - RAW - VHD type: string VpnConnectionOptionsSpecification: title: VpnConnectionOptionsSpecification type: object properties: StaticRoutesOnly: type: boolean TunnelOptions: type: array items: $ref: '#/components/schemas/VpnTunnelOptionsSpecification' description: '' description: Describes VPN connection options. DisassociateSubnetCidrBlockResult: title: DisassociateSubnetCidrBlockResult type: object properties: Ipv6CidrBlockAssociation: allOf: - $ref: '#/components/schemas/SubnetIpv6CidrBlockAssociation' - description: Describes an IPv6 CIDR block associated with a subnet. SubnetId: type: string CreateClientVpnRouteRequest: title: CreateClientVpnRouteRequest required: - ClientVpnEndpointId - DestinationCidrBlock - TargetVpcSubnetId type: object properties: ClientVpnEndpointId: type: string DestinationCidrBlock: type: string TargetVpcSubnetId: type: string Description: type: string DryRun: type: boolean EventInformation: title: EventInformation type: object properties: EventDescription: type: string EventSubType: type: string InstanceId: type: string description: Describes an EC2 Fleet or Spot Fleet event. ImportInstanceLaunchSpecification: title: ImportInstanceLaunchSpecification type: object properties: AdditionalInfo: type: string Architecture: $ref: '#/components/schemas/ArchitectureValues' GroupIds: type: array items: type: string description: '' GroupNames: type: array items: type: string description: '' InstanceInitiatedShutdownBehavior: $ref: '#/components/schemas/ShutdownBehavior' InstanceType: $ref: '#/components/schemas/InstanceType' Monitoring: type: boolean Placement: allOf: - $ref: '#/components/schemas/Placement' - description: Describes the placement of an instance. PrivateIpAddress: type: string SubnetId: type: string UserData: allOf: - $ref: '#/components/schemas/UserData' - description: Describes the user data for an instance. description: Describes the launch specification for VM import. VolumeAttributeName: title: VolumeAttributeName enum: - autoEnableIO - productCodes type: string ModifyIdFormatRequest: title: ModifyIdFormatRequest required: - Resource - UseLongIds type: object properties: Resource: type: string UseLongIds: type: boolean DescribeClientVpnAuthorizationRulesResult: title: DescribeClientVpnAuthorizationRulesResult type: object properties: AuthorizationRules: type: array items: $ref: '#/components/schemas/AuthorizationRule' description: '' NextToken: maxLength: 1024 minLength: 1 type: string EbsInstanceBlockDevice: title: EbsInstanceBlockDevice type: object properties: AttachTime: type: string format: date-time DeleteOnTermination: type: boolean Status: $ref: '#/components/schemas/AttachmentStatus' VolumeId: type: string description: Describes a parameter used to set up an EBS volume in a block device mapping. CopyImageRequest: title: CopyImageRequest required: - Name - SourceImageId - SourceRegion type: object properties: ClientToken: type: string Description: type: string Encrypted: type: boolean KmsKeyId: type: string Name: type: string SourceImageId: type: string SourceRegion: type: string DryRun: type: boolean description: Contains the parameters for CopyImage. ElasticGpuState: title: ElasticGpuState enum: - ATTACHED type: string DiskImageVolumeDescription: title: DiskImageVolumeDescription type: object properties: Id: type: string Size: type: integer format: int32 description: Describes a disk image volume. DeleteTransitGatewayRouteTableRequest: title: DeleteTransitGatewayRouteTableRequest required: - TransitGatewayRouteTableId type: object properties: TransitGatewayRouteTableId: type: string DryRun: type: boolean CreateCapacityReservationRequest: title: CreateCapacityReservationRequest required: - InstanceType - InstancePlatform - AvailabilityZone - InstanceCount type: object properties: ClientToken: type: string InstanceType: type: string InstancePlatform: $ref: '#/components/schemas/CapacityReservationInstancePlatform' AvailabilityZone: type: string Tenancy: $ref: '#/components/schemas/CapacityReservationTenancy' InstanceCount: type: integer format: int32 EbsOptimized: type: boolean EphemeralStorage: type: boolean EndDate: type: string format: date-time EndDateType: $ref: '#/components/schemas/EndDateType' InstanceMatchCriteria: $ref: '#/components/schemas/InstanceMatchCriteria' TagSpecifications: type: array items: $ref: '#/components/schemas/TagSpecification' description: '' DryRun: type: boolean ImportInstanceRequest: title: ImportInstanceRequest required: - Platform type: object properties: Description: type: string DiskImages: type: array items: $ref: '#/components/schemas/DiskImage' description: '' DryRun: type: boolean LaunchSpecification: allOf: - $ref: '#/components/schemas/ImportInstanceLaunchSpecification' - description: Describes the launch specification for VM import. Platform: enum: - Windows type: string description: Contains the parameters for ImportInstance. UnsuccessfulInstanceCreditSpecificationItemError: title: UnsuccessfulInstanceCreditSpecificationItemError type: object properties: Code: $ref: '#/components/schemas/UnsuccessfulInstanceCreditSpecificationErrorCode' Message: type: string description: Information about the error for the T2 or T3 instance whose credit option for CPU usage was not modified. ExportEnvironment: title: ExportEnvironment enum: - citrix - vmware - microsoft type: string ModifyInstanceCapacityReservationAttributesRequest: title: ModifyInstanceCapacityReservationAttributesRequest required: - InstanceId - CapacityReservationSpecification type: object properties: InstanceId: type: string CapacityReservationSpecification: allOf: - $ref: '#/components/schemas/CapacityReservationSpecification' - description: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.
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 AMI attribute.
Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use DescribeImages to get information about the block device mapping for the AMI.
The instance attribute.
Note: The enaSupport attribute is not supported at this time.
The attribute to reset.
You can only reset the following attributes: kernel | ramdisk | sourceDestCheck. To change an instance attribute, use ModifyInstanceAttribute.
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 Instance Placement and Host Affinity in the Amazon EC2 User Guide for Linux Instances.
Default: on
totalUpfrontPrice, LimitPrice, and totalHourlyPrice amounts are specified. At this time, the only supported currency is USD.
Domain1:
title: Domain1
enum:
- vpc
- standard
type: string
description: 'Set to vpc to allocate the address for use with instances in a VPC.
Default: The address is for use with instances in EC2-Classic.
' EndDateType2: title: EndDateType2 enum: - unlimited - limited type: string 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. 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 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.
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).
Default: stop
terminate.
InstanceMatchCriteria2:
title: InstanceMatchCriteria2
enum:
- open
- targeted
type: string
description: 'Indicates the type of instance launches that the Capacity Reservation accepts. The options include:
open - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters.
targeted - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity.
Default: open
The 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 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
m1.small). For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
InstanceType4:
title: InstanceType4
enum:
- 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
- m1.small
- m1.medium
- m1.large
- m1.xlarge
- m3.medium
- m3.large
- m3.xlarge
- m3.2xlarge
- m4.large
- m4.xlarge
- m4.2xlarge
- m4.4xlarge
- m4.10xlarge
- m4.16xlarge
- m2.xlarge
- m2.2xlarge
- m2.4xlarge
- cr1.8xlarge
- 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.12xlarge
- r5.24xlarge
- r5.metal
- r5a.large
- r5a.xlarge
- r5a.2xlarge
- r5a.4xlarge
- r5a.12xlarge
- r5a.24xlarge
- r5d.large
- r5d.xlarge
- r5d.2xlarge
- r5d.4xlarge
- r5d.12xlarge
- r5d.24xlarge
- r5d.metal
- r5ad.large
- r5ad.xlarge
- r5ad.2xlarge
- r5ad.4xlarge
- r5ad.8xlarge
- r5ad.12xlarge
- r5ad.16xlarge
- r5ad.24xlarge
- x1.16xlarge
- x1.32xlarge
- x1e.xlarge
- x1e.2xlarge
- x1e.4xlarge
- x1e.8xlarge
- x1e.16xlarge
- x1e.32xlarge
- i2.xlarge
- i2.2xlarge
- i2.4xlarge
- i2.8xlarge
- i3.large
- i3.xlarge
- i3.2xlarge
- i3.4xlarge
- i3.8xlarge
- i3.16xlarge
- i3.metal
- hi1.4xlarge
- hs1.8xlarge
- 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.18xlarge
- c5d.large
- c5d.xlarge
- c5d.2xlarge
- c5d.4xlarge
- c5d.9xlarge
- c5d.18xlarge
- c5n.large
- c5n.xlarge
- c5n.2xlarge
- c5n.4xlarge
- c5n.9xlarge
- c5n.18xlarge
- cc1.4xlarge
- cc2.8xlarge
- g2.2xlarge
- g2.8xlarge
- g3.4xlarge
- g3.8xlarge
- g3.16xlarge
- g3s.xlarge
- cg1.4xlarge
- p2.xlarge
- p2.8xlarge
- p2.16xlarge
- p3.2xlarge
- p3.8xlarge
- p3.16xlarge
- p3dn.24xlarge
- d2.xlarge
- d2.2xlarge
- d2.4xlarge
- d2.8xlarge
- f1.2xlarge
- f1.4xlarge
- f1.16xlarge
- m5.large
- m5.xlarge
- m5.2xlarge
- m5.4xlarge
- m5.12xlarge
- m5.24xlarge
- m5.metal
- m5a.large
- m5a.xlarge
- m5a.2xlarge
- m5a.4xlarge
- m5a.12xlarge
- m5a.24xlarge
- m5d.large
- m5d.xlarge
- m5d.2xlarge
- m5d.4xlarge
- m5d.12xlarge
- m5d.24xlarge
- m5d.metal
- m5ad.large
- m5ad.xlarge
- m5ad.2xlarge
- m5ad.4xlarge
- m5ad.8xlarge
- m5ad.12xlarge
- m5ad.16xlarge
- m5ad.24xlarge
- h1.2xlarge
- h1.4xlarge
- h1.8xlarge
- h1.16xlarge
- z1d.large
- z1d.xlarge
- z1d.2xlarge
- z1d.3xlarge
- z1d.6xlarge
- z1d.12xlarge
- z1d.metal
- u-6tb1.metal
- u-9tb1.metal
- u-12tb1.metal
- a1.medium
- a1.large
- a1.xlarge
- a1.2xlarge
- a1.4xlarge
type: string
description: 'The instance type. For more information, see Instance Types in the Amazon Elastic Compute Cloud User Guide.
Default: m1.small
Indicates whether the network interface is an Elastic Fabric Adapter (EFA). Only specify this parameter to create an EFA. For more information, see Elastic Fabric Adapter in the Amazon Elastic Compute Cloud User Guide.
If you are not creating an EFA ENI, omit this parameter.
LogDestinationType2: title: LogDestinationType2 enum: - cloud-watch-logs - s3 type: string description: 'Specifies the type of destination to which the flow log data is to be published. Flow log data can be published to CloudWatch Logs or Amazon S3. To publish flow log data to CloudWatch Logs, specify cloud-watch-logs. To publish flow log data to Amazon S3, specify s3.
If you specify LogDestinationType as s3, do not specify DeliverLogsPermissionArn or LogGroupName.
Default: cloud-watch-logs
standard or convertible.
OfferingType1:
title: OfferingType1
enum:
- Heavy Utilization
- Medium Utilization
- Light Utilization
- No Upfront
- Partial Upfront
- All Upfront
type: string
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.
OperationType2:
title: OperationType2
enum:
- add
- remove
type: string
description: The operation type.
OperationType4:
title: OperationType4
enum:
- add
- remove
type: string
description: The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
OperationType6:
title: OperationType6
enum:
- add
- remove
type: string
description: The type of operation to perform to the attribute.
Permission1:
title: Permission1
enum:
- INSTANCE-ATTACH
- EIP-ASSOCIATE
type: string
description: The type of permission to grant.
Platform1:
title: Platform1
enum:
- Windows
type: string
description: The instance operating system.
ProductDescription1:
title: ProductDescription1
enum:
- Linux/UNIX
- Linux/UNIX (Amazon VPC)
- Windows
- Windows (Amazon VPC)
type: string
description: The Reserved Instance product platform description. Instances that include (Amazon VPC) in the description are for use with Amazon VPC.
ResourceType2:
title: ResourceType2
enum:
- VPC
- Subnet
- NetworkInterface
type: string
description: The type of resource for which to create the flow log. For example, if you specified a VPC ID for the ResourceId property, specify VPC for this property.
RuleAction2:
title: RuleAction2
enum:
- allow
- deny
type: string
description: Indicates whether to allow or deny the traffic that matches the rule.
Status2:
title: Status2
enum:
- ok
- impaired
type: string
description: The status of all instances listed.
Strategy1:
title: Strategy1
enum:
- cluster
- spread
- partition
type: string
description: The placement strategy.
TargetEnvironment1:
title: TargetEnvironment1
enum:
- citrix
- vmware
- microsoft
type: string
description: The target virtualization environment.
Tenancy2:
title: Tenancy2
enum:
- default
- dedicated
type: string
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 AWS accounts.
dedicated - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account.
The transport protocol to be used by the VPN session.
Default value: udp
ipsec.1).
Type3:
title: Type3
enum:
- request
- maintain
- instant
type: string
description: The type of the request. By default, the EC2 Fleet places an asynchronous request for your desired capacity, and maintains it by replenishing interrupted Spot Instances (maintain). A value of instant places a synchronous one-time request, and returns errors for any instances that could not be launched. A value of request places an asynchronous one-time request without maintaining capacity or submitting requests in alternative capacity pools if capacity is unavailable. For more information, see EC2 Fleet Request Types in the Amazon Elastic Compute Cloud User Guide.
Type5:
title: Type5
enum:
- ipsec.1
type: string
description: The type of VPN connection this virtual private gateway supports.
Type7:
title: Type7
enum:
- one-time
- persistent
type: string
description: 'The Spot Instance request type.
Default: one-time
The volume type. This can be gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1 for Cold HDD, or standard for Magnetic volumes.
Defaults: If no volume type is specified, the default is standard in us-east-1, eu-west-1, eu-central-1, us-west-2, us-west-1, sa-east-1, ap-northeast-1, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-south-1, us-gov-west-1, and cn-north-1. In all other Regions, EBS defaults to gp2.
The target EBS volume type of the volume.
Default: If no type is specified, the existing type is retained.
' VpcEndpointType2: title: VpcEndpointType2 enum: - Interface - Gateway type: string description: 'The type of endpoint.
Default: Gateway
' securitySchemes: hmac: type: apiKey description: Amazon Signature authorization v4 name: Authorization in: header security: - hmac: [] tags: [] externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/ec2/