@itentialopensource/adapter-aws_ec2

openapi: 3.0.0 info: title: awsec2 description: <fullname>Amazon Elastic Compute Cloud</fullname> 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: <ul> <li> <a href="http://aws.amazon.com/ec2">Amazon EC2 product page</a> </li> <li> <a href="http://aws.amazon.com/documentation/ec2">Amazon EC2 documentation</a> </li> <li> <a href="http://aws.amazon.com/ebs">Amazon EBS product page</a> </li> <li> <a href="http://aws.amazon.com/vpc">Amazon VPC product page</a> </li> <li> <a href="http://aws.amazon.com/documentation/vpc">Amazon VPC documentation</a> </li> </ul> contact: name: Mike Ralphson url: https://github.com/mermade/aws2openapi email: mike.ralphson@gmail.com version: '2016-11-15' servers: - url: https://ec2.amazonaws.com/ variables: {} - url: http://ec2.amazonaws.com/ variables: {} paths: /#Action=AcceptReservedInstancesExchangeQuote: get: summary: GET AcceptReservedInstancesExchangeQuote description: Accepts the Convertible Reserved Instance exchange quote described in the <a>GetReservedInstancesExchangeQuote</a> call. operationId: GETAcceptReservedInstancesExchangeQuote parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <code>successful</code>. deprecated: false post: summary: POST AcceptReservedInstancesExchangeQuote description: Accepts the Convertible Reserved Instance exchange quote described in the <a>GetReservedInstancesExchangeQuote</a> 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <code>successful</code>. 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 <code>pendingAcceptance</code> state. Use <a>DescribeTransitGatewayVpcAttachments</a> to view your pending VPC attachment requests. Use <a>RejectTransitGatewayVpcAttachment</a> to reject a VPC attachment request. operationId: GETAcceptTransitGatewayVpcAttachment parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <code>pendingAcceptance</code> state. Use <a>DescribeTransitGatewayVpcAttachments</a> to view your pending VPC attachment requests. Use <a>RejectTransitGatewayVpcAttachment</a> to reject a VPC attachment request. operationId: POSTAcceptTransitGatewayVpcAttachment parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - 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' 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use <a>DescribeVpcPeeringConnections</a> 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 is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <code>pending-acceptance</code> state, and you must be the owner of the peer VPC. Use <a>DescribeVpcPeeringConnections</a> 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 is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <a>WithdrawByoipCidr</a>. 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 is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <a>WithdrawByoipCidr</a>. 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 is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring Your Own IP Addresses (BYOIP)</a> 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> 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 <code>vpc</code> 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 <code>vpc</code> 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 the <code>Address</code> 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html">Bring Your Own IP Addresses (BYOIP)</a> 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html">Elastic IP Addresses</a> 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 <code>vpc</code> 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 the <code>Address</code> 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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>. 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding"> Understanding Instance Placement and Host Affinity</a> in the Amazon EC2 User Guide for Linux Instances. Default: <code>on</code> ' style: form explode: true schema: allOf: - $ref: '#/components/schemas/AutoPlacement' - description: 'Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding"> Understanding Instance Placement and Host Affinity</a> in the Amazon EC2 User Guide for Linux Instances. Default: <code>on</code> ' - name: AvailabilityZone in: query description: The Availability Zone in which to allocate the Dedicated Host. 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a> in the Amazon Elastic Compute Cloud User Guide. style: form explode: true schema: type: string - name: InstanceType in: query description: Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host. required: true style: form explode: true schema: type: string - name: Quantity in: query description: The number of Dedicated Hosts to allocate to your account with these parameters. required: true style: form explode: true schema: type: integer format: int32 - name: TagSpecification in: query description: The tags to apply to the Dedicated Host 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/Action12' - 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/AllocateHostsResult' - description: Contains the output of AllocateHosts. deprecated: false post: summary: POST 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: POSTAllocateHosts parameters: - name: X-Amz-Content-Sha256 in: header description: '' style: simple schema: type: string - name: X-Amz-Date in: header description: '' style: simple schema: type: string - name: X-Amz-Algorithm in: header description: '' style: simple schema: type: string - name: X-Amz-Credential in: header description: '' style: simple schema: type: string - name: X-Amz-Security-Token in: header description: '' style: simple schema: type: string - name: X-Amz-Signature in: header description: '' style: simple schema: type: string - name: X-Amz-SignedHeaders in: header description: '' style: simple schema: type: string - name: Action in: query description: '' required: true style: form explode: true schema: $ref: '#/components/schemas/Action12' - name: 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 - InstanceType - Quantity type: object properties: AutoPlacement: allOf: - $ref: '#/components/schemas/AutoPlacement2' - 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 <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding"> Understanding Instance Placement and Host Affinity</a> in the Amazon EC2 User Guide for Linux Instances. Default: <code>on</code> ' AvailabilityZone: type: string description: The Availability Zone in which to allocate the Dedicated Host. ClientToken: type: string description: Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html">How to Ensure Idempotency</a> in the Amazon Elastic Compute Cloud User Guide. InstanceType: type: string description: Specifies the instance type for which to configure your Dedicated Hosts. When you specify the instance type, that is the only instance type that you can launch onto that host. Quantity: type: integer description: The number of Dedicated Hosts to allocate to your account with these parameters. format: int32 TagSpecification: type: array items: type: string