Amazon Elastic Compute Cloud API Reference API Version 2016-11-15 Amazon Elastic Compute Cloud API Reference Amazon Elastic Compute Cloud: API Reference Copyright © 2022 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. Amazon Elastic Compute Cloud API Reference Table of Contents Welcome........................................................................................................................................... 1 Actions by service .............................................................................................................................. 3 Amazon EC2 actions................................................................................................................... 3 Amazon EBS actions ................................................................................................................... 9 Amazon VPC actions................................................................................................................. 10 Amazon IPAM actions ............................................................................................................... 14 AWS Transit Gateway actions ..................................................................................................... 15 AWS PrivateLink actions............................................................................................................ 17 AWS Client VPN actions............................................................................................................ 17 AWS Site-to-Site VPN actions .................................................................................................... 18 AWS Verified Access actions....................................................................................................... 19 AWS Outposts actions ............................................................................................................... 20 AWS Wavelength actions........................................................................................................... 21 VM Import/Export actions......................................................................................................... 21 AWS Nitro Enclaves.................................................................................................................. 21 Recycle Bin.............................................................................................................................. 22 Actions............................................................................................................................................ 23 AcceptAddressTransfer.............................................................................................................. 36 Request Parameters.......................................................................................................... 36 Response Elements........................................................................................................... 36 Errors.............................................................................................................................. 36 See Also.......................................................................................................................... 37 AcceptReservedInstancesExchangeQuote..................................................................................... 38 Request Parameters.......................................................................................................... 38 Response Elements........................................................................................................... 38 Errors.............................................................................................................................. 38 See Also.......................................................................................................................... 39 AcceptTransitGatewayMulticastDomainAssociations....................................................................... 40 Request Parameters.......................................................................................................... 40 Response Elements........................................................................................................... 40 Errors.............................................................................................................................. 41 See Also.......................................................................................................................... 41 AcceptTransitGatewayPeeringAttachment.................................................................................... 42 Request Parameters.......................................................................................................... 42 Response Elements........................................................................................................... 42 Errors.............................................................................................................................. 42 Examples......................................................................................................................... 42 See Also.......................................................................................................................... 43 AcceptTransitGatewayVpcAttachment.......................................................................................... 44 Request Parameters.......................................................................................................... 44 Response Elements........................................................................................................... 44 Errors.............................................................................................................................. 44 See Also.......................................................................................................................... 44 AcceptVpcEndpointConnections.................................................................................................. 46 Request Parameters.......................................................................................................... 46 Response Elements........................................................................................................... 46 Errors.............................................................................................................................. 46 Examples......................................................................................................................... 47 See Also.......................................................................................................................... 47 AcceptVpcPeeringConnection..................................................................................................... 48 Request Parameters.......................................................................................................... 48 Response Elements........................................................................................................... 48 Errors.............................................................................................................................. 48 Examples......................................................................................................................... 48 API Version 2016-11-15 iii Amazon Elastic Compute Cloud API Reference See Also.......................................................................................................................... 49 AdvertiseByoipCidr.................................................................................................................... 50 Request Parameters.......................................................................................................... 50 Response Elements........................................................................................................... 50 Errors.............................................................................................................................. 51 See Also.......................................................................................................................... 51 AllocateAddress........................................................................................................................ 52 Request Parameters.......................................................................................................... 52 Response Elements........................................................................................................... 53 Errors.............................................................................................................................. 54 Examples......................................................................................................................... 54 See Also.......................................................................................................................... 55 AllocateHosts........................................................................................................................... 56 Request Parameters.......................................................................................................... 56 Response Elements........................................................................................................... 57 Errors.............................................................................................................................. 57 Examples......................................................................................................................... 58 See Also.......................................................................................................................... 59 AllocateIpamPoolCidr................................................................................................................ 61 Request Parameters.......................................................................................................... 61 Response Elements........................................................................................................... 62 Errors.............................................................................................................................. 62 See Also.......................................................................................................................... 62 ApplySecurityGroupsToClientVpnTargetNetwork........................................................................... 64 Request Parameters.......................................................................................................... 64 Response Elements........................................................................................................... 64 Errors.............................................................................................................................. 65 Examples......................................................................................................................... 65 See Also.......................................................................................................................... 65 AssignIpv6Addresses................................................................................................................. 66 Request Parameters.......................................................................................................... 66 Response Elements........................................................................................................... 67 Errors.............................................................................................................................. 67 Examples......................................................................................................................... 67 See Also.......................................................................................................................... 68 AssignPrivateIpAddresses........................................................................................................... 69 Request Parameters.......................................................................................................... 69 Response Elements........................................................................................................... 70 Errors.............................................................................................................................. 70 Examples......................................................................................................................... 70 See Also.......................................................................................................................... 71 AssociateAddress...................................................................................................................... 73 Request Parameters.......................................................................................................... 73 Response Elements........................................................................................................... 74 Errors.............................................................................................................................. 75 Examples......................................................................................................................... 75 See Also.......................................................................................................................... 75 AssociateClientVpnTargetNetwork.............................................................................................. 77 Request Parameters.......................................................................................................... 77 Response Elements........................................................................................................... 77 Errors.............................................................................................................................. 78 Examples......................................................................................................................... 78 See Also.......................................................................................................................... 78 AssociateDhcpOptions............................................................................................................... 80 Request Parameters.......................................................................................................... 80 Response Elements........................................................................................................... 80 Errors.............................................................................................................................. 81 API Version 2016-11-15 iv Amazon Elastic Compute Cloud API Reference Examples......................................................................................................................... 81 See Also.......................................................................................................................... 81 AssociateEnclaveCertificateIamRole............................................................................................. 83 Request Parameters.......................................................................................................... 83 Response Elements........................................................................................................... 83 Errors.............................................................................................................................. 84 See Also.......................................................................................................................... 84 AssociateIamInstanceProfile....................................................................................................... 85 Request Parameters.......................................................................................................... 85 Response Elements........................................................................................................... 85 Errors.............................................................................................................................. 85 Examples......................................................................................................................... 85 See Also.......................................................................................................................... 86 AssociateInstanceEventWindow.................................................................................................. 87 Request Parameters.......................................................................................................... 87 Response Elements........................................................................................................... 87 Errors.............................................................................................................................. 87 See Also.......................................................................................................................... 88 AssociateRouteTable................................................................................................................. 89 Request Parameters.......................................................................................................... 89 Response Elements........................................................................................................... 89 Errors.............................................................................................................................. 90 Examples......................................................................................................................... 90 See Also.......................................................................................................................... 90 AssociateSubnetCidrBlock.......................................................................................................... 92 Request Parameters.......................................................................................................... 92 Response Elements........................................................................................................... 92 Errors.............................................................................................................................. 92 Examples......................................................................................................................... 92 See Also.......................................................................................................................... 93 AssociateTransitGatewayMulticastDomain.................................................................................... 94 Request Parameters.......................................................................................................... 94 Response Elements........................................................................................................... 94 Errors.............................................................................................................................. 95 Examples......................................................................................................................... 95 See Also.......................................................................................................................... 95 AssociateTransitGatewayPolicyTable............................................................................................ 97 Request Parameters.......................................................................................................... 97 Response Elements........................................................................................................... 97 Errors.............................................................................................................................. 97 See Also.......................................................................................................................... 97 AssociateTransitGatewayRouteTable............................................................................................ 99 Request Parameters.......................................................................................................... 99 Response Elements........................................................................................................... 99 Errors.............................................................................................................................. 99 See Also........................................................................................................................ 100 AssociateTrunkInterface........................................................................................................... 101 Request Parameters........................................................................................................ 101 Response Elements......................................................................................................... 102 Errors............................................................................................................................ 102 See Also........................................................................................................................ 102 AssociateVpcCidrBlock............................................................................................................. 103 Request Parameters........................................................................................................ 103 Response Elements......................................................................................................... 104 Errors............................................................................................................................ 105 Examples....................................................................................................................... 105 See Also........................................................................................................................ 106 API Version 2016-11-15 v Amazon Elastic Compute Cloud API Reference AttachClassicLinkVpc............................................................................................................... 107 Request Parameters........................................................................................................ 107 Response Elements......................................................................................................... 107 Errors............................................................................................................................ 108 Examples....................................................................................................................... 108 See Also........................................................................................................................ 108 AttachInternetGateway............................................................................................................ 110 Request Parameters........................................................................................................ 110 Response Elements......................................................................................................... 110 Errors............................................................................................................................ 110 Examples....................................................................................................................... 111 See Also........................................................................................................................ 111 AttachNetworkInterface........................................................................................................... 112 Request Parameters........................................................................................................ 112 Response Elements......................................................................................................... 112 Errors............................................................................................................................ 113 Examples....................................................................................................................... 113 See Also........................................................................................................................ 113 AttachVerifiedAccessTrustProvider............................................................................................. 115 Request Parameters........................................................................................................ 115 Response Elements......................................................................................................... 115 Errors............................................................................................................................ 116 See Also........................................................................................................................ 116 AttachVolume........................................................................................................................ 117 Request Parameters........................................................................................................ 117 Response Elements......................................................................................................... 118 Errors............................................................................................................................ 118 Examples....................................................................................................................... 118 See Also........................................................................................................................ 119 AttachVpnGateway................................................................................................................. 120 Request Parameters........................................................................................................ 120 Response Elements......................................................................................................... 120 Errors............................................................................................................................ 120 Examples....................................................................................................................... 121 See Also........................................................................................................................ 121 AuthorizeClientVpnIngress....................................................................................................... 122 Request Parameters........................................................................................................ 122 Response Elements......................................................................................................... 123 Errors............................................................................................................................ 123 Examples....................................................................................................................... 123 See Also........................................................................................................................ 123 AuthorizeSecurityGroupEgress.................................................................................................. 125 Request Parameters........................................................................................................ 125 Response Elements......................................................................................................... 126 Errors............................................................................................................................ 127 Examples....................................................................................................................... 127 See Also........................................................................................................................ 128 AuthorizeSecurityGroupIngress................................................................................................. 129 Request Parameters........................................................................................................ 129 Response Elements......................................................................................................... 131 Errors............................................................................................................................ 131 Examples....................................................................................................................... 131 See Also........................................................................................................................ 134 BundleInstance....................................................................................................................... 135 Request Parameters........................................................................................................ 135 Response Elements......................................................................................................... 135 Errors............................................................................................................................ 136 API Version 2016-11-15 vi Amazon Elastic Compute Cloud API Reference Examples....................................................................................................................... 136 See Also........................................................................................................................ 136 CancelBundleTask................................................................................................................... 138 Request Parameters........................................................................................................ 138 Response Elements......................................................................................................... 138 Errors............................................................................................................................ 138 Examples....................................................................................................................... 138 See Also........................................................................................................................ 139 CancelCapacityReservation....................................................................................................... 140 Request Parameters........................................................................................................ 140 Response Elements......................................................................................................... 140 Errors............................................................................................................................ 140 See Also........................................................................................................................ 140 CancelCapacityReservationFleets.............................................................................................. 142 Request Parameters........................................................................................................ 142 Response Elements......................................................................................................... 142 Errors............................................................................................................................ 143 See Also........................................................................................................................ 143 CancelConversionTask............................................................................................................. 144 Request Parameters........................................................................................................ 144 Response Elements......................................................................................................... 144 Errors............................................................................................................................ 144 Examples....................................................................................................................... 145 See Also........................................................................................................................ 145 CancelExportTask.................................................................................................................... 146 Request Parameters........................................................................................................ 146 Response Elements......................................................................................................... 146 Errors............................................................................................................................ 146 Examples....................................................................................................................... 146 See Also........................................................................................................................ 147 CancelImageLaunchPermission................................................................................................. 148 Request Parameters........................................................................................................ 148 Response Elements......................................................................................................... 148 Errors............................................................................................................................ 148 See Also........................................................................................................................ 148 CancelImportTask................................................................................................................... 150 Request Parameters........................................................................................................ 150 Response Elements......................................................................................................... 150 Errors............................................................................................................................ 151 See Also........................................................................................................................ 151 CancelReservedInstancesListing................................................................................................ 152 Request Parameters........................................................................................................ 152 Response Elements......................................................................................................... 152 Errors............................................................................................................................ 152 Examples....................................................................................................................... 152 See Also........................................................................................................................ 154 CancelSpotFleetRequests......................................................................................................... 155 Request Parameters........................................................................................................ 155 Response Elements......................................................................................................... 155 Errors............................................................................................................................ 156 Examples....................................................................................................................... 156 See Also........................................................................................................................ 156 CancelSpotInstanceRequests.................................................................................................... 157 Request Parameters........................................................................................................ 157 Response Elements......................................................................................................... 157 Errors............................................................................................................................ 157 Examples....................................................................................................................... 157 API Version 2016-11-15 vii Amazon Elastic Compute Cloud API Reference See Also........................................................................................................................ 158 ConfirmProductInstance.......................................................................................................... 159 Request Parameters........................................................................................................ 159 Response Elements......................................................................................................... 159 Errors............................................................................................................................ 160 Examples....................................................................................................................... 160 See Also........................................................................................................................ 160 CopyFpgaImage...................................................................................................................... 161 Request Parameters........................................................................................................ 161 Response Elements......................................................................................................... 161 Errors............................................................................................................................ 162 Examples....................................................................................................................... 162 See Also........................................................................................................................ 162 CopyImage............................................................................................................................. 163 Request Parameters........................................................................................................ 163 Response Elements......................................................................................................... 165 Errors............................................................................................................................ 165 Examples....................................................................................................................... 165 See Also........................................................................................................................ 166 CopySnapshot........................................................................................................................ 167 Request Parameters........................................................................................................ 167 Response Elements......................................................................................................... 169 Errors............................................................................................................................ 169 Examples....................................................................................................................... 169 See Also........................................................................................................................ 170 CreateCapacityReservation....................................................................................................... 172 Request Parameters........................................................................................................ 172 Response Elements......................................................................................................... 175 Errors............................................................................................................................ 175 See Also........................................................................................................................ 175 CreateCapacityReservationFleet................................................................................................ 177 Request Parameters........................................................................................................ 177 Response Elements......................................................................................................... 178 Errors............................................................................................................................ 180 See Also........................................................................................................................ 180 CreateCarrierGateway.............................................................................................................. 181 Request Parameters........................................................................................................ 181 Response Elements......................................................................................................... 181 Errors............................................................................................................................ 182 See Also........................................................................................................................ 182 CreateClientVpnEndpoint......................................................................................................... 183 Request Parameters........................................................................................................ 183 Response Elements......................................................................................................... 186 Errors............................................................................................................................ 186 Examples....................................................................................................................... 186 See Also........................................................................................................................ 187 CreateClientVpnRoute............................................................................................................. 188 Request Parameters........................................................................................................ 188 Response Elements......................................................................................................... 189 Errors............................................................................................................................ 189 Examples....................................................................................................................... 189 See Also........................................................................................................................ 190 CreateCoipCidr....................................................................................................................... 191 Request Parameters........................................................................................................ 191 Response Elements......................................................................................................... 191 Errors............................................................................................................................ 191 See Also........................................................................................................................ 191 API Version 2016-11-15 viii Amazon Elastic Compute Cloud API Reference CreateCoipPool....................................................................................................................... 193 Request Parameters........................................................................................................ 193 Response Elements......................................................................................................... 193 Errors............................................................................................................................ 193 See Also........................................................................................................................ 193 CreateCustomerGateway.......................................................................................................... 195 Request Parameters........................................................................................................ 195 Response Elements......................................................................................................... 196 Errors............................................................................................................................ 196 Examples....................................................................................................................... 196 See Also........................................................................................................................ 197 CreateDefaultSubnet............................................................................................................... 198 Request Parameters........................................................................................................ 198 Response Elements......................................................................................................... 198 Errors............................................................................................................................ 198 Examples....................................................................................................................... 199 See Also........................................................................................................................ 199 CreateDefaultVpc.................................................................................................................... 200 Request Parameters........................................................................................................ 200 Response Elements......................................................................................................... 200 Errors............................................................................................................................ 200 Examples....................................................................................................................... 201 See Also........................................................................................................................ 201 CreateDhcpOptions................................................................................................................. 202 Request Parameters........................................................................................................ 202 Response Elements......................................................................................................... 203 Errors............................................................................................................................ 203 Examples....................................................................................................................... 203 See Also........................................................................................................................ 204 CreateEgressOnlyInternetGateway............................................................................................ 205 Request Parameters........................................................................................................ 205 Response Elements......................................................................................................... 205 Errors............................................................................................................................ 206 Examples....................................................................................................................... 206 See Also........................................................................................................................ 206 CreateFleet............................................................................................................................ 207 Request Parameters........................................................................................................ 207 Response Elements......................................................................................................... 209 Errors............................................................................................................................ 209 Examples....................................................................................................................... 210 See Also........................................................................................................................ 210 CreateFlowLogs...................................................................................................................... 211 Request Parameters........................................................................................................ 211 Response Elements......................................................................................................... 213 Errors............................................................................................................................ 214 Examples....................................................................................................................... 214 See Also........................................................................................................................ 215 CreateFpgaImage.................................................................................................................... 216 Request Parameters........................................................................................................ 216 Response Elements......................................................................................................... 217 Errors............................................................................................................................ 217 Examples....................................................................................................................... 217 See Also........................................................................................................................ 218 CreateImage.......................................................................................................................... 219 Request Parameters........................................................................................................ 219 Response Elements......................................................................................................... 220 Errors............................................................................................................................ 221 API Version 2016-11-15 ix Amazon Elastic Compute Cloud API Reference Examples....................................................................................................................... 221 See Also........................................................................................................................ 222 CreateInstanceEventWindow.................................................................................................... 223 Request Parameters........................................................................................................ 223 Response Elements......................................................................................................... 224 Errors............................................................................................................................ 224 See Also........................................................................................................................ 224 CreateInstanceExportTask........................................................................................................ 226 Request Parameters........................................................................................................ 226 Response Elements......................................................................................................... 226 Errors............................................................................................................................ 227 Examples....................................................................................................................... 227 See Also........................................................................................................................ 227 CreateInternetGateway............................................................................................................ 229 Request Parameters........................................................................................................ 229 Response Elements......................................................................................................... 229 Errors............................................................................................................................ 229 Examples....................................................................................................................... 229 See Also........................................................................................................................ 230 CreateIpam............................................................................................................................ 231 Request Parameters........................................................................................................ 231 Response Elements......................................................................................................... 232 Errors............................................................................................................................ 232 See Also........................................................................................................................ 232 CreateIpamPool ...................................................................................................................... 233 Request Parameters........................................................................................................ 233 Response Elements......................................................................................................... 235 Errors............................................................................................................................ 236 See Also........................................................................................................................ 236 CreateIpamScope.................................................................................................................... 237 Request Parameters........................................................................................................ 237 Response Elements......................................................................................................... 238 Errors............................................................................................................................ 238 See Also........................................................................................................................ 238 CreateKeyPair......................................................................................................................... 239 Request Parameters........................................................................................................ 239 Response Elements......................................................................................................... 240 Errors............................................................................................................................ 240 Examples....................................................................................................................... 240 See Also........................................................................................................................ 241 CreateLaunchTemplate............................................................................................................ 243 Request Parameters........................................................................................................ 243 Response Elements......................................................................................................... 244 Errors............................................................................................................................ 244 Examples....................................................................................................................... 244 See Also........................................................................................................................ 245 CreateLaunchTemplateVersion.................................................................................................. 247 Request Parameters........................................................................................................ 247 Response Elements......................................................................................................... 248 Errors............................................................................................................................ 248 Examples....................................................................................................................... 249 See Also........................................................................................................................ 249 CreateLocalGatewayRoute........................................................................................................ 250 Request Parameters........................................................................................................ 250 Response Elements......................................................................................................... 250 Errors............................................................................................................................ 251 See Also........................................................................................................................ 251 API Version 2016-11-15 x