Amazon Elastic Compute Cloud
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, see the following resources:
-
Amazon EC2: AmazonEC2 product page, Amazon EC2 documentation
-
Amazon EBS: Amazon EBS product page, Amazon EBS documentation
-
Amazon VPC: Amazon VPC product page, Amazon VPC documentation
-
AWS VPN: AWS VPN product page, AWS VPN documentation
License: Apache 2.0 License
Resources
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
ReservedInstanceId
|
array |
The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value. |
TargetConfiguration
|
array |
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. |
Action
|
string Allowed values: - AcceptReservedInstancesExchangeQuote |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptReservedInstancesExchangeQuoteResult
|
object |
The result of the exchange and whether it was |
Properties
ExchangeId
|
String |
The ID of the successful exchange. |
||||
|
||||||
Accepts the Convertible Reserved Instance exchange quote described in the GetReservedInstancesExchangeQuote call.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AcceptReservedInstancesExchangeQuote |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
ReservedInstanceId
|
array |
The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value. |
TargetConfiguration
|
array |
The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptReservedInstancesExchangeQuoteResult
|
object |
The result of the exchange and whether it was |
Properties
ExchangeId
|
String |
The ID of the successful exchange. |
||||
|
||||||
Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
Request
Query
| Name | Data Type | Description |
|---|---|---|
TransitGatewayAttachmentId
|
string |
The ID of the transit gateway attachment. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AcceptTransitGatewayPeeringAttachment |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptTransitGatewayPeeringAttachmentResult
|
object |
Properties
TransitGatewayPeeringAttachment
|
TransitGatewayPeeringAttachment |
The transit gateway peering attachment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Accepts a transit gateway peering attachment request. The peering attachment must be in the pendingAcceptance state.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AcceptTransitGatewayPeeringAttachment |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
TransitGatewayAttachmentId
|
string |
The ID of the transit gateway attachment. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptTransitGatewayPeeringAttachmentResult
|
object |
Properties
TransitGatewayPeeringAttachment
|
TransitGatewayPeeringAttachment |
The transit gateway peering attachment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
TransitGatewayAttachmentId
|
string |
The ID of the attachment. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AcceptTransitGatewayVpcAttachment |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptTransitGatewayVpcAttachmentResult
|
object |
Properties
TransitGatewayVpcAttachment
|
TransitGatewayVpcAttachment |
The VPC attachment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AcceptTransitGatewayVpcAttachment |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
TransitGatewayAttachmentId
|
string |
The ID of the attachment. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptTransitGatewayVpcAttachmentResult
|
object |
Properties
TransitGatewayVpcAttachment
|
TransitGatewayVpcAttachment |
The VPC attachment. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
ServiceId
|
string |
The ID of the VPC endpoint service. |
VpcEndpointId
|
array |
The IDs of one or more interface VPC endpoints. |
Action
|
string Allowed values: - AcceptVpcEndpointConnections |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptVpcEndpointConnectionsResult
|
object |
Properties
Unsuccessful
|
UnsuccessfulItemSet |
Information about the interface endpoints that were not accepted, if applicable. |
|||||||||||||||||
|
|||||||||||||||||||
Accepts one or more interface VPC endpoint connection requests to your VPC endpoint service.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AcceptVpcEndpointConnections |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
ServiceId
|
string |
The ID of the VPC endpoint service. |
VpcEndpointId
|
array |
The IDs of one or more interface VPC endpoints. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptVpcEndpointConnectionsResult
|
object |
Properties
Unsuccessful
|
UnsuccessfulItemSet |
Information about the interface endpoints that were not accepted, if applicable. |
|||||||||||||||||
|
|||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
VpcPeeringConnectionId
|
string |
The ID of the VPC peering connection. You must specify this parameter in the request. |
Action
|
string Allowed values: - AcceptVpcPeeringConnection |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptVpcPeeringConnectionResult
|
object |
Properties
VpcPeeringConnection
|
VpcPeeringConnection |
Information about the VPC peering connection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AcceptVpcPeeringConnection |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
VpcPeeringConnectionId
|
string |
The ID of the VPC peering connection. You must specify this parameter in the request. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AcceptVpcPeeringConnectionResult
|
object |
Properties
VpcPeeringConnection
|
VpcPeeringConnection |
Information about the VPC peering connection. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Advertises an IPv4 or IPv6 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Cidr
|
string |
The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AdvertiseByoipCidr |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AdvertiseByoipCidrResult
|
object |
Properties
ByoipCidr
|
ByoipCidr |
Information about the address range. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
Advertises an IPv4 or IPv6 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AdvertiseByoipCidr |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Cidr
|
string |
The address range, in CIDR notation. This must be the exact range that you provisioned. You can't advertise only a portion of the provisioned range. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AdvertiseByoipCidrResult
|
object |
Properties
ByoipCidr
|
ByoipCidr |
Information about the address range. |
||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Domain
|
string Allowed values: - vpc- standard |
Set to Default: The address is for use with instances in EC2-Classic. |
Address
|
string |
[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool. |
PublicIpv4Pool
|
string |
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 |
NetworkBorderGroup
|
string |
The location from which the IP address is advertised. Use this parameter to limit the address to this location. Use DescribeVpcs to view the network border groups. You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an |
CustomerOwnedIpv4Pool
|
string |
The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AllocateAddress |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AllocateAddressResult
|
object |
Properties
CustomerOwnedIpv4Pool
|
String |
The ID of the customer-owned address pool. |
||||
|
||||||
CustomerOwnedIp
|
String |
The customer-owned IP address. |
||||
|
||||||
Domain
|
DomainType |
Indicates whether this Elastic IP address is for use with instances in EC2-Classic ( |
||||
|
||||||
NetworkBorderGroup
|
String |
The location from which the IP address is advertised. |
||||
|
||||||
PublicIpv4Pool
|
String |
The ID of an address pool. |
||||
|
||||||
AllocationId
|
String |
[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC. |
||||
|
||||||
PublicIp
|
String |
The Elastic IP address. |
||||
|
||||||
Examples
{
"Domain": "standard",
"PublicIp": "198.51.100.0"
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AllocateAddress |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Domain
|
string Allowed values: - vpc- standard |
Set to Default: The address is for use with instances in EC2-Classic. |
Address
|
string |
[EC2-VPC] The Elastic IP address to recover or an IPv4 address from an address pool. |
PublicIpv4Pool
|
string |
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 |
NetworkBorderGroup
|
string |
The location from which the IP address is advertised. Use this parameter to limit the address to this location. Use DescribeVpcs to view the network border groups. You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 classic, you will receive an |
CustomerOwnedIpv4Pool
|
string |
The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address pool. Alternatively, specify a specific address from the address pool. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AllocateAddressResult
|
object |
Properties
CustomerOwnedIpv4Pool
|
String |
The ID of the customer-owned address pool. |
||||
|
||||||
CustomerOwnedIp
|
String |
The customer-owned IP address. |
||||
|
||||||
Domain
|
DomainType |
Indicates whether this Elastic IP address is for use with instances in EC2-Classic ( |
||||
|
||||||
NetworkBorderGroup
|
String |
The location from which the IP address is advertised. |
||||
|
||||||
PublicIpv4Pool
|
String |
The ID of an address pool. |
||||
|
||||||
AllocationId
|
String |
[EC2-VPC] The ID that AWS assigns to represent the allocation of the Elastic IP address for use with instances in a VPC. |
||||
|
||||||
PublicIp
|
String |
The Elastic IP address. |
||||
|
||||||
Examples
{
"Domain": "standard",
"PublicIp": "198.51.100.0"
}Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
Request
Query
| Name | Data Type | Description |
|---|---|---|
AutoPlacement
|
string Allowed values: - on- off |
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: |
AvailabilityZone
|
string |
The Availability Zone in which to allocate the Dedicated Host. |
ClientToken
|
string |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. |
InstanceType
|
string |
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request. |
InstanceFamily
|
string |
Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request. |
Quantity
|
integer |
The number of Dedicated Hosts to allocate to your account with these parameters. |
TagSpecification
|
array |
The tags to apply to the Dedicated Host during creation. |
HostRecovery
|
string Allowed values: - on- off |
Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide. Default: |
Action
|
string Allowed values: - AllocateHosts |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AllocateHostsResult
|
object |
Contains the output of AllocateHosts. |
Properties
HostIds
|
ResponseHostIdList |
The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host. |
|||||||||||
|
|||||||||||||
Allocates a Dedicated Host to your account. At a minimum, specify the supported instance type or instance family, the Availability Zone in which to allocate the host, and the number of hosts to allocate.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AllocateHosts |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
AutoPlacement
|
string Allowed values: - on- off |
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: |
AvailabilityZone
|
string |
The Availability Zone in which to allocate the Dedicated Host. |
ClientToken
|
string |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. |
InstanceType
|
string |
Specifies the instance type to be supported by the Dedicated Hosts. If you specify an instance type, the Dedicated Hosts support instances of the specified instance type only. If you want the Dedicated Hosts to support multiple instance types in a specific instance family, omit this parameter and specify InstanceFamily instead. You cannot specify InstanceType and InstanceFamily in the same request. |
InstanceFamily
|
string |
Specifies the instance family to be supported by the Dedicated Hosts. If you specify an instance family, the Dedicated Hosts support multiple instance types within that instance family. If you want the Dedicated Hosts to support a specific instance type only, omit this parameter and specify InstanceType instead. You cannot specify InstanceFamily and InstanceType in the same request. |
Quantity
|
integer |
The number of Dedicated Hosts to allocate to your account with these parameters. |
TagSpecification
|
array |
The tags to apply to the Dedicated Host during creation. |
HostRecovery
|
string Allowed values: - on- off |
Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see Host Recovery in the Amazon Elastic Compute Cloud User Guide. Default: |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AllocateHostsResult
|
object |
Contains the output of AllocateHosts. |
Properties
HostIds
|
ResponseHostIdList |
The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host. |
|||||||||||
|
|||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
ClientVpnEndpointId
|
string |
The ID of the Client VPN endpoint. |
VpcId
|
string |
The ID of the VPC in which the associated target network is located. |
SecurityGroupId
|
array |
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
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - ApplySecurityGroupsToClientVpnTargetNetwork |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ApplySecurityGroupsToClientVpnTargetNetworkResult
|
object |
Properties
SecurityGroupIds
|
ClientVpnSecurityGroupIdSet |
The IDs of the applied security groups. |
|||||||||||
|
|||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - ApplySecurityGroupsToClientVpnTargetNetwork |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ClientVpnEndpointId
|
string |
The ID of the Client VPN endpoint. |
VpcId
|
string |
The ID of the VPC in which the associated target network is located. |
SecurityGroupId
|
array |
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
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
ApplySecurityGroupsToClientVpnTargetNetworkResult
|
object |
Properties
SecurityGroupIds
|
ClientVpnSecurityGroupIdSet |
The IDs of the applied security groups. |
|||||||||||
|
|||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Ipv6AddressCount
|
integer |
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. |
Ipv6Addresses
|
array |
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
|
string |
The ID of the network interface. |
Action
|
string Allowed values: - AssignIpv6Addresses |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssignIpv6AddressesResult
|
object |
Properties
NetworkInterfaceId
|
String |
The ID of the network interface. |
|||||||||||
|
|||||||||||||
AssignedIpv6Addresses
|
Ipv6AddressList |
The IPv6 addresses assigned to the network interface. |
|||||||||||
|
|||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssignIpv6Addresses |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Ipv6AddressCount
|
integer |
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. |
Ipv6Addresses
|
array |
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
|
string |
The ID of the network interface. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssignIpv6AddressesResult
|
object |
Properties
NetworkInterfaceId
|
String |
The ID of the network interface. |
|||||||||||
|
|||||||||||||
AssignedIpv6Addresses
|
Ipv6AddressList |
The IPv6 addresses assigned to the network interface. |
|||||||||||
|
|||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
AllowReassignment
|
boolean |
Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. |
NetworkInterfaceId
|
string |
The ID of the network interface. |
PrivateIpAddress
|
array |
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
|
integer |
The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. |
Action
|
string Allowed values: - AssignPrivateIpAddresses |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssignPrivateIpAddressesResult
|
object |
Properties
AssignedPrivateIpAddresses
|
AssignedPrivateIpAddressList |
The private IP addresses assigned to the network interface. |
||||||||||||||
|
||||||||||||||||
NetworkInterfaceId
|
String |
The ID of the network interface. |
||||||||||||||
|
||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssignPrivateIpAddresses |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
AllowReassignment
|
boolean |
Indicates whether to allow an IP address that is already assigned to another network interface or instance to be reassigned to the specified network interface. |
NetworkInterfaceId
|
string |
The ID of the network interface. |
PrivateIpAddress
|
array |
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
|
integer |
The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssignPrivateIpAddressesResult
|
object |
Properties
AssignedPrivateIpAddresses
|
AssignedPrivateIpAddressList |
The private IP addresses assigned to the network interface. |
||||||||||||||
|
||||||||||||||||
NetworkInterfaceId
|
String |
The ID of the network interface. |
||||||||||||||
|
||||||||||||||||
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.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
Request
Query
| Name | Data Type | Description |
|---|---|---|
AllocationId
|
string |
[EC2-VPC] The allocation ID. This is required for EC2-VPC. |
InstanceId
|
string |
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached. |
PublicIp
|
string |
The Elastic IP address to associate with the instance. This is required for EC2-Classic. |
AllowReassociation
|
boolean |
[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
NetworkInterfaceId
|
string |
[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
|
string |
[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. |
Action
|
string Allowed values: - AssociateAddress |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateAddressResult
|
object |
Properties
AssociationId
|
String |
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance. |
||||
|
||||||
Examples
{
"AssociationId": "eipassoc-2bebb745"
}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.
You cannot associate an Elastic IP address with an interface in a different network border group.
This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error, and you may be charged for each time the Elastic IP address is remapped to the same instance. For more information, see the Elastic IP Addresses section of Amazon EC2 Pricing.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateAddress |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
AllocationId
|
string |
[EC2-VPC] The allocation ID. This is required for EC2-VPC. |
InstanceId
|
string |
The ID of the instance. This is required for EC2-Classic. For EC2-VPC, you can specify either the instance ID or the network interface ID, but not both. The operation fails if you specify an instance ID unless exactly one network interface is attached. |
PublicIp
|
string |
The Elastic IP address to associate with the instance. This is required for EC2-Classic. |
AllowReassociation
|
boolean |
[EC2-VPC] For a VPC in an EC2-Classic account, specify true to allow an Elastic IP address that is already associated with an instance or network interface to be reassociated with the specified instance or network interface. Otherwise, the operation fails. In a VPC in an EC2-VPC-only account, reassociation is automatic, therefore you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
NetworkInterfaceId
|
string |
[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
|
string |
[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. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateAddressResult
|
object |
Properties
AssociationId
|
String |
[EC2-VPC] The ID that represents the association of the Elastic IP address with an instance. |
||||
|
||||||
Examples
{
"AssociationId": "eipassoc-2bebb745"
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
ClientVpnEndpointId
|
string |
The ID of the Client VPN endpoint. |
SubnetId
|
string |
The ID of the subnet to associate with the Client VPN endpoint. |
ClientToken
|
string |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AssociateClientVpnTargetNetwork |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateClientVpnTargetNetworkResult
|
object |
Properties
Status
|
AssociationStatus |
The current state of the target network association. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
AssociationId
|
String |
The unique ID of the target network association. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateClientVpnTargetNetwork |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
ClientVpnEndpointId
|
string |
The ID of the Client VPN endpoint. |
SubnetId
|
string |
The ID of the subnet to associate with the Client VPN endpoint. |
ClientToken
|
string |
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateClientVpnTargetNetworkResult
|
object |
Properties
Status
|
AssociationStatus |
The current state of the target network association. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
AssociationId
|
String |
The unique ID of the target network association. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DhcpOptionsId
|
string |
The ID of the DHCP options set, or |
VpcId
|
string |
The ID of the VPC. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AssociateDhcpOptions |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateDhcpOptions |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DhcpOptionsId
|
string |
The ID of the DHCP options set, or |
VpcId
|
string |
The ID of the VPC. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
Request
Query
| Name | Data Type | Description |
|---|---|---|
IamInstanceProfile.Arn
|
string |
Describes an IAM instance profile. The Amazon Resource Name (ARN) of the instance profile. |
IamInstanceProfile.Name
|
string |
Describes an IAM instance profile. The name of the instance profile. |
InstanceId
|
string |
The ID of the instance. |
Action
|
string Allowed values: - AssociateIamInstanceProfile |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateIamInstanceProfileResult
|
object |
Properties
IamInstanceProfileAssociation
|
IamInstanceProfileAssociation |
Information about the IAM instance profile association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"IamInstanceProfileAssociation": {
"AssociationId": "iip-assoc-0e7736511a163c209",
"IamInstanceProfile": {
"Arn": "arn:aws:iam::123456789012:instance-profile\/admin-role",
"Id": "AIPAJBLK7RKJKWDXVHIEC"
},
"InstanceId": "i-123456789abcde123",
"State": "associating"
}
}Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateIamInstanceProfile |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
IamInstanceProfile.Arn
|
string |
Describes an IAM instance profile. The Amazon Resource Name (ARN) of the instance profile. |
IamInstanceProfile.Name
|
string |
Describes an IAM instance profile. The name of the instance profile. |
InstanceId
|
string |
The ID of the instance. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateIamInstanceProfileResult
|
object |
Properties
IamInstanceProfileAssociation
|
IamInstanceProfileAssociation |
Information about the IAM instance profile association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Examples
{
"IamInstanceProfileAssociation": {
"AssociationId": "iip-assoc-0e7736511a163c209",
"IamInstanceProfile": {
"Arn": "arn:aws:iam::123456789012:instance-profile\/admin-role",
"Id": "AIPAJBLK7RKJKWDXVHIEC"
},
"InstanceId": "i-123456789abcde123",
"State": "associating"
}
}Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
RouteTableId
|
string |
The ID of the route table. |
SubnetId
|
string |
The ID of the subnet. |
GatewayId
|
string |
The ID of the internet gateway or virtual private gateway. |
Action
|
string Allowed values: - AssociateRouteTable |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateRouteTableResult
|
object |
Properties
AssociationState
|
RouteTableAssociationState |
The state of the association. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
AssociationId
|
String |
The route table association ID. This ID is required for disassociating the route table. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Examples
{
"AssociationId": "rtbassoc-781d0d1a"
}Associates a subnet in your VPC or an internet gateway or virtual private gateway attached to your VPC with a route table in your VPC. This association causes traffic from the subnet or gateway to be routed according to the routes in the route table. The action returns an association ID, which you need in order to disassociate the route table later. A route table can be associated with multiple subnets.
For more information, see Route Tables in the Amazon Virtual Private Cloud User Guide.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateRouteTable |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
RouteTableId
|
string |
The ID of the route table. |
SubnetId
|
string |
The ID of the subnet. |
GatewayId
|
string |
The ID of the internet gateway or virtual private gateway. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateRouteTableResult
|
object |
Properties
AssociationState
|
RouteTableAssociationState |
The state of the association. |
||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||
AssociationId
|
String |
The route table association ID. This ID is required for disassociating the route table. |
||||||||||||||||||||||||
|
||||||||||||||||||||||||||
Examples
{
"AssociationId": "rtbassoc-781d0d1a"
}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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Ipv6CidrBlock
|
string |
The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. |
SubnetId
|
string |
The ID of your subnet. |
Action
|
string Allowed values: - AssociateSubnetCidrBlock |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateSubnetCidrBlockResult
|
object |
Properties
SubnetId
|
String |
The ID of the subnet. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
Ipv6CidrBlockAssociation
|
SubnetIpv6CidrBlockAssociation |
Information about the IPv6 CIDR block association. |
||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateSubnetCidrBlock |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
Ipv6CidrBlock
|
string |
The IPv6 CIDR block for your subnet. The subnet must have a /64 prefix length. |
SubnetId
|
string |
The ID of your subnet. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateSubnetCidrBlockResult
|
object |
Properties
SubnetId
|
String |
The ID of the subnet. |
||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||
Ipv6CidrBlockAssociation
|
SubnetIpv6CidrBlockAssociation |
Information about the IPv6 CIDR block association. |
||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
TransitGatewayMulticastDomainId
|
string |
The ID of the transit gateway multicast domain. |
TransitGatewayAttachmentId
|
string |
The ID of the transit gateway attachment to associate with the transit gateway multicast domain. |
SubnetIds
|
array |
The IDs of the subnets to associate with the transit gateway multicast domain. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AssociateTransitGatewayMulticastDomain |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateTransitGatewayMulticastDomainResult
|
object |
Properties
Associations
|
TransitGatewayMulticastDomainAssociations |
Information about the transit gateway multicast domain associations. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Associates the specified subnets and transit gateway attachments with the specified transit gateway multicast domain.
The transit gateway attachment must be in the available state before you can add a resource. Use DescribeTransitGatewayAttachments to see the state of the attachment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateTransitGatewayMulticastDomain |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
TransitGatewayMulticastDomainId
|
string |
The ID of the transit gateway multicast domain. |
TransitGatewayAttachmentId
|
string |
The ID of the transit gateway attachment to associate with the transit gateway multicast domain. |
SubnetIds
|
array |
The IDs of the subnets to associate with the transit gateway multicast domain. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateTransitGatewayMulticastDomainResult
|
object |
Properties
Associations
|
TransitGatewayMulticastDomainAssociations |
Information about the transit gateway multicast domain associations. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
TransitGatewayRouteTableId
|
string |
The ID of the transit gateway route table. |
TransitGatewayAttachmentId
|
string |
The ID of the attachment. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Action
|
string Allowed values: - AssociateTransitGatewayRouteTable |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateTransitGatewayRouteTableResult
|
object |
Properties
Association
|
TransitGatewayAssociation |
The ID of the association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateTransitGatewayRouteTable |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
TransitGatewayRouteTableId
|
string |
The ID of the transit gateway route table. |
TransitGatewayAttachmentId
|
string |
The ID of the attachment. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateTransitGatewayRouteTableResult
|
object |
Properties
Association
|
TransitGatewayAssociation |
The ID of the association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
AmazonProvidedIpv6CidrBlock
|
boolean |
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
|
string |
An IPv4 CIDR block to associate with the VPC. |
VpcId
|
string |
The ID of the VPC. |
Ipv6Pool
|
string |
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. |
Ipv6CidrBlock
|
string |
An IPv6 CIDR block from the IPv6 address pool. You must also specify To let Amazon choose the IPv6 CIDR block for you, omit this parameter. |
Ipv6CidrBlockNetworkBorderGroup
|
string |
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CiDR block to this location. You must set You can have one IPv6 CIDR block association per network border group. |
Action
|
string Allowed values: - AssociateVpcCidrBlock |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateVpcCidrBlockResult
|
object |
Properties
VpcId
|
String |
The ID of the VPC. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CidrBlockAssociation
|
VpcCidrBlockAssociation |
Information about the IPv4 CIDR block association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ipv6CidrBlockAssociation
|
VpcIpv6CidrBlockAssociation |
Information about the IPv6 CIDR block association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Associates a CIDR block with your VPC. You can associate a secondary IPv4 CIDR block, an Amazon-provided IPv6 CIDR block, or an IPv6 CIDR block from an IPv6 address pool that you provisioned through bring your own IP addresses (BYOIP). The IPv6 CIDR block size is fixed at /56.
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AssociateVpcCidrBlock |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
AmazonProvidedIpv6CidrBlock
|
boolean |
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
|
string |
An IPv4 CIDR block to associate with the VPC. |
VpcId
|
string |
The ID of the VPC. |
Ipv6Pool
|
string |
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. |
Ipv6CidrBlock
|
string |
An IPv6 CIDR block from the IPv6 address pool. You must also specify To let Amazon choose the IPv6 CIDR block for you, omit this parameter. |
Ipv6CidrBlockNetworkBorderGroup
|
string |
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CiDR block to this location. You must set You can have one IPv6 CIDR block association per network border group. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AssociateVpcCidrBlockResult
|
object |
Properties
VpcId
|
String |
The ID of the VPC. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CidrBlockAssociation
|
VpcCidrBlockAssociation |
Information about the IPv4 CIDR block association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Ipv6CidrBlockAssociation
|
VpcIpv6CidrBlockAssociation |
Information about the IPv6 CIDR block association. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
SecurityGroupId
|
array |
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC. |
InstanceId
|
string |
The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC. |
VpcId
|
string |
The ID of a ClassicLink-enabled VPC. |
Action
|
string Allowed values: - AttachClassicLinkVpc |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AttachClassicLinkVpcResult
|
object |
Properties
Return
|
Boolean |
Returns |
||||
|
||||||
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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AttachClassicLinkVpc |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
SecurityGroupId
|
array |
The ID of one or more of the VPC's security groups. You cannot specify security groups from a different VPC. |
InstanceId
|
string |
The ID of an EC2-Classic instance to link to the ClassicLink-enabled VPC. |
VpcId
|
string |
The ID of a ClassicLink-enabled VPC. |
Responses
Body
| Name | Data Type | Description |
|---|---|---|
AttachClassicLinkVpcResult
|
object |
Properties
Return
|
Boolean |
Returns |
||||
|
||||||
Attaches an internet gateway or a virtual private 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
InternetGatewayId
|
string |
The ID of the internet gateway. |
VpcId
|
string |
The ID of the VPC. |
Action
|
string Allowed values: - AttachInternetGateway |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Responses
Attaches an internet gateway or a virtual private 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.
Request
Query
| Name | Data Type | Description |
|---|---|---|
Action
|
string Allowed values: - AttachInternetGateway |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |
X-Amz-Date
|
string | |
X-Amz-Algorithm
|
string | |
X-Amz-Credential
|
string | |
X-Amz-Security-Token
|
string | |
X-Amz-Signature
|
string | |
X-Amz-SignedHeaders
|
string |
Form Data
| Name | Data Type | Description |
|---|---|---|
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
InternetGatewayId
|
string |
The ID of the internet gateway. |
VpcId
|
string |
The ID of the VPC. |
Responses
Attaches a network interface to an instance.
Request
Query
| Name | Data Type | Description |
|---|---|---|
DeviceIndex
|
integer |
The index of the device for the network interface attachment. |
DryRun
|
boolean |
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is |
InstanceId
|
string |
The ID of the instance. |
NetworkInterfaceId
|
string |
The ID of the network interface. |
Action
|
string Allowed values: - AttachNetworkInterface |
|
Version
|
string Allowed values: - 2016-11-15 |
Header
| Name | Data Type | Description |
|---|---|---|
X-Amz-Content-Sha256
|
string | |