io-enabled

# Actions The following actions are supported: + [AcceptAddressTransfer](API_AcceptAddressTransfer.md) + [AcceptCapacityReservationBillingOwnership](API_AcceptCapacityReservationBillingOwnership.md) + [AcceptReservedInstancesExchangeQuote](API_AcceptReservedInstancesExchangeQuote.md) + [AcceptTransitGatewayMulticastDomainAssociations](API_AcceptTransitGatewayMulticastDomainAssociations.md) + [AcceptTransitGatewayPeeringAttachment](API_AcceptTransitGatewayPeeringAttachment.md) + [AcceptTransitGatewayVpcAttachment](API_AcceptTransitGatewayVpcAttachment.md) + [AcceptVpcEndpointConnections](API_AcceptVpcEndpointConnections.md) + [AcceptVpcPeeringConnection](API_AcceptVpcPeeringConnection.md) + [AdvertiseByoipCidr](API_AdvertiseByoipCidr.md) + [AllocateAddress](API_AllocateAddress.md) + [AllocateHosts](API_AllocateHosts.md) + [AllocateIpamPoolCidr](API_AllocateIpamPoolCidr.md) + [ApplySecurityGroupsToClientVpnTargetNetwork](API_ApplySecurityGroupsToClientVpnTargetNetwork.md) + [AssignIpv6Addresses](API_AssignIpv6Addresses.md) + [AssignPrivateIpAddresses](API_AssignPrivateIpAddresses.md) + [AssignPrivateNatGatewayAddress](API_AssignPrivateNatGatewayAddress.md) + [AssociateAddress](API_AssociateAddress.md) + [AssociateCapacityReservationBillingOwner](API_AssociateCapacityReservationBillingOwner.md) + [AssociateClientVpnTargetNetwork](API_AssociateClientVpnTargetNetwork.md) + [AssociateDhcpOptions](API_AssociateDhcpOptions.md) + [AssociateEnclaveCertificateIamRole](API_AssociateEnclaveCertificateIamRole.md) + [AssociateIamInstanceProfile](API_AssociateIamInstanceProfile.md) + [AssociateInstanceEventWindow](API_AssociateInstanceEventWindow.md) + [AssociateIpamByoasn](API_AssociateIpamByoasn.md) + [AssociateIpamResourceDiscovery](API_AssociateIpamResourceDiscovery.md) + [AssociateNatGatewayAddress](API_AssociateNatGatewayAddress.md) + [AssociateRouteServer](API_AssociateRouteServer.md) + [AssociateRouteTable](API_AssociateRouteTable.md) + [AssociateSecurityGroupVpc](API_AssociateSecurityGroupVpc.md) + [AssociateSubnetCidrBlock](API_AssociateSubnetCidrBlock.md) + [AssociateTransitGatewayMulticastDomain](API_AssociateTransitGatewayMulticastDomain.md) + [AssociateTransitGatewayPolicyTable](API_AssociateTransitGatewayPolicyTable.md) + [AssociateTransitGatewayRouteTable](API_AssociateTransitGatewayRouteTable.md) + [AssociateTrunkInterface](API_AssociateTrunkInterface.md) + [AssociateVpcCidrBlock](API_AssociateVpcCidrBlock.md) + [AttachClassicLinkVpc](API_AttachClassicLinkVpc.md) + [AttachInternetGateway](API_AttachInternetGateway.md) + [AttachNetworkInterface](API_AttachNetworkInterface.md) + [AttachVerifiedAccessTrustProvider](API_AttachVerifiedAccessTrustProvider.md) + [AttachVolume](API_AttachVolume.md) + [AttachVpnGateway](API_AttachVpnGateway.md) + [AuthorizeClientVpnIngress](API_AuthorizeClientVpnIngress.md) + [AuthorizeSecurityGroupEgress](API_AuthorizeSecurityGroupEgress.md) + [AuthorizeSecurityGroupIngress](API_AuthorizeSecurityGroupIngress.md) + [BundleInstance](API_BundleInstance.md) + [CancelBundleTask](API_CancelBundleTask.md) + [CancelCapacityReservation](API_CancelCapacityReservation.md) + [CancelCapacityReservationFleets](API_CancelCapacityReservationFleets.md) + [CancelConversionTask](API_CancelConversionTask.md) + [CancelDeclarativePoliciesReport](API_CancelDeclarativePoliciesReport.md) + [CancelExportTask](API_CancelExportTask.md) + [CancelImageLaunchPermission](API_CancelImageLaunchPermission.md) + [CancelImportTask](API_CancelImportTask.md) + [CancelReservedInstancesListing](API_CancelReservedInstancesListing.md) + [CancelSpotFleetRequests](API_CancelSpotFleetRequests.md) + [CancelSpotInstanceRequests](API_CancelSpotInstanceRequests.md) + [ConfirmProductInstance](API_ConfirmProductInstance.md) + [CopyFpgaImage](API_CopyFpgaImage.md) + [CopyImage](API_CopyImage.md) + [CopySnapshot](API_CopySnapshot.md) + [CopyVolumes](API_CopyVolumes.md) + [CreateCapacityManagerDataExport](API_CreateCapacityManagerDataExport.md) + [CreateCapacityReservation](API_CreateCapacityReservation.md) + [CreateCapacityReservationBySplitting](API_CreateCapacityReservationBySplitting.md) + [CreateCapacityReservationFleet](API_CreateCapacityReservationFleet.md) + [CreateCarrierGateway](API_CreateCarrierGateway.md) + [CreateClientVpnEndpoint](API_CreateClientVpnEndpoint.md) + [CreateClientVpnRoute](API_CreateClientVpnRoute.md) + [CreateCoipCidr](API_CreateCoipCidr.md) + [CreateCoipPool](API_CreateCoipPool.md) + [CreateCustomerGateway](API_CreateCustomerGateway.md) + [CreateDefaultSubnet](API_CreateDefaultSubnet.md) + [CreateDefaultVpc](API_CreateDefaultVpc.md) + [CreateDelegateMacVolumeOwnershipTask](API_CreateDelegateMacVolumeOwnershipTask.md) + [CreateDhcpOptions](API_CreateDhcpOptions.md) + [CreateEgressOnlyInternetGateway](API_CreateEgressOnlyInternetGateway.md) + [CreateFleet](API_CreateFleet.md) + [CreateFlowLogs](API_CreateFlowLogs.md) + [CreateFpgaImage](API_CreateFpgaImage.md) + [CreateImage](API_CreateImage.md) + [CreateImageUsageReport](API_CreateImageUsageReport.md) + [CreateInstanceConnectEndpoint](API_CreateInstanceConnectEndpoint.md) + [CreateInstanceEventWindow](API_CreateInstanceEventWindow.md) + [CreateInstanceExportTask](API_CreateInstanceExportTask.md) + [CreateInternetGateway](API_CreateInternetGateway.md) + [CreateInterruptibleCapacityReservationAllocation](API_CreateInterruptibleCapacityReservationAllocation.md) + [CreateIpam](API_CreateIpam.md) + [CreateIpamExternalResourceVerificationToken](API_CreateIpamExternalResourceVerificationToken.md) + [CreateIpamPolicy](API_CreateIpamPolicy.md) + [CreateIpamPool](API_CreateIpamPool.md) + [CreateIpamPrefixListResolver](API_CreateIpamPrefixListResolver.md) + [CreateIpamPrefixListResolverTarget](API_CreateIpamPrefixListResolverTarget.md) + [CreateIpamResourceDiscovery](API_CreateIpamResourceDiscovery.md) + [CreateIpamScope](API_CreateIpamScope.md) + [CreateKeyPair](API_CreateKeyPair.md) + [CreateLaunchTemplate](API_CreateLaunchTemplate.md) + [CreateLaunchTemplateVersion](API_CreateLaunchTemplateVersion.md) + [CreateLocalGatewayRoute](API_CreateLocalGatewayRoute.md) + [CreateLocalGatewayRouteTable](API_CreateLocalGatewayRouteTable.md) + [CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation](API_CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation.md) + [CreateLocalGatewayRouteTableVpcAssociation](API_CreateLocalGatewayRouteTableVpcAssociation.md) + [CreateLocalGatewayVirtualInterface](API_CreateLocalGatewayVirtualInterface.md) + [CreateLocalGatewayVirtualInterfaceGroup](API_CreateLocalGatewayVirtualInterfaceGroup.md) + [CreateMacSystemIntegrityProtectionModificationTask](API_CreateMacSystemIntegrityProtectionModificationTask.md) + [CreateManagedPrefixList](API_CreateManagedPrefixList.md) + [CreateNatGateway](API_CreateNatGateway.md) + [CreateNetworkAcl](API_CreateNetworkAcl.md) + [CreateNetworkAclEntry](API_CreateNetworkAclEntry.md) + [CreateNetworkInsightsAccessScope](API_CreateNetworkInsightsAccessScope.md) + [CreateNetworkInsightsPath](API_CreateNetworkInsightsPath.md) + [CreateNetworkInterface](API_CreateNetworkInterface.md) + [CreateNetworkInterfacePermission](API_CreateNetworkInterfacePermission.md) + [CreatePlacementGroup](API_CreatePlacementGroup.md) + [CreatePublicIpv4Pool](API_CreatePublicIpv4Pool.md) + [CreateReplaceRootVolumeTask](API_CreateReplaceRootVolumeTask.md) + [CreateReservedInstancesListing](API_CreateReservedInstancesListing.md) + [CreateRestoreImageTask](API_CreateRestoreImageTask.md) + [CreateRoute](API_CreateRoute.md) + [CreateRouteServer](API_CreateRouteServer.md) + [CreateRouteServerEndpoint](API_CreateRouteServerEndpoint.md) + [CreateRouteServerPeer](API_CreateRouteServerPeer.md) + [CreateRouteTable](API_CreateRouteTable.md) + [CreateSecondaryNetwork](API_CreateSecondaryNetwork.md) + [CreateSecondarySubnet](API_CreateSecondarySubnet.md) + [CreateSecurityGroup](API_CreateSecurityGroup.md) + [CreateSnapshot](API_CreateSnapshot.md) + [CreateSnapshots](API_CreateSnapshots.md) + [CreateSpotDatafeedSubscription](API_CreateSpotDatafeedSubscription.md) + [CreateStoreImageTask](API_CreateStoreImageTask.md) + [CreateSubnet](API_CreateSubnet.md) + [CreateSubnetCidrReservation](API_CreateSubnetCidrReservation.md) + [CreateTags](API_CreateTags.md) + [CreateTrafficMirrorFilter](API_CreateTrafficMirrorFilter.md) + [CreateTrafficMirrorFilterRule](API_CreateTrafficMirrorFilterRule.md) + [CreateTrafficMirrorSession](API_CreateTrafficMirrorSession.md) + [CreateTrafficMirrorTarget](API_CreateTrafficMirrorTarget.md) + [CreateTransitGateway](API_CreateTransitGateway.md) + [CreateTransitGatewayConnect](API_CreateTransitGatewayConnect.md) + [CreateTransitGatewayConnectPeer](API_CreateTransitGatewayConnectPeer.md) + [CreateTransitGatewayMeteringPolicy](API_CreateTransitGatewayMeteringPolicy.md) + [CreateTransitGatewayMeteringPolicyEntry](API_CreateTransitGatewayMeteringPolicyEntry.md) + [CreateTransitGatewayMulticastDomain](API_CreateTransitGatewayMulticastDomain.md) + [CreateTransitGatewayPeeringAttachment](API_CreateTransitGatewayPeeringAttachment.md) + [CreateTransitGatewayPolicyTable](API_CreateTransitGatewayPolicyTable.md) + [CreateTransitGatewayPrefixListReference](API_CreateTransitGatewayPrefixListReference.md) + [CreateTransitGatewayRoute](API_CreateTransitGatewayRoute.md) + [CreateTransitGatewayRouteTable](API_CreateTransitGatewayRouteTable.md) + [CreateTransitGatewayRouteTableAnnouncement](API_CreateTransitGatewayRouteTableAnnouncement.md) + [CreateTransitGatewayVpcAttachment](API_CreateTransitGatewayVpcAttachment.md) + [CreateVerifiedAccessEndpoint](API_CreateVerifiedAccessEndpoint.md) + [CreateVerifiedAccessGroup](API_CreateVerifiedAccessGroup.md) + [CreateVerifiedAccessInstance](API_CreateVerifiedAccessInstance.md) + [CreateVerifiedAccessTrustProvider](API_CreateVerifiedAccessTrustProvider.md) + [CreateVolume](API_CreateVolume.md) + [CreateVpc](API_CreateVpc.md) + [CreateVpcBlockPublicAccessExclusion](API_CreateVpcBlockPublicAccessExclusion.md) + [CreateVpcEncryptionControl](API_CreateVpcEncryptionControl.md) + [CreateVpcEndpoint](API_CreateVpcEndpoint.md) + [CreateVpcEndpointConnectionNotification](API_CreateVpcEndpointConnectionNotification.md) + [CreateVpcEndpointServiceConfiguration](API_CreateVpcEndpointServiceConfiguration.md) + [CreateVpcPeeringConnection](API_CreateVpcPeeringConnection.md) + [CreateVpnConcentrator](API_CreateVpnConcentrator.md) + [CreateVpnConnection](API_CreateVpnConnection.md) + [CreateVpnConnectionRoute](API_CreateVpnConnectionRoute.md) + [CreateVpnGateway](API_CreateVpnGateway.md) + [DeleteCapacityManagerDataExport](API_DeleteCapacityManagerDataExport.md) + [DeleteCarrierGateway](API_DeleteCarrierGateway.md) + [DeleteClientVpnEndpoint](API_DeleteClientVpnEndpoint.md) + [DeleteClientVpnRoute](API_DeleteClientVpnRoute.md) + [DeleteCoipCidr](API_DeleteCoipCidr.md) + [DeleteCoipPool](API_DeleteCoipPool.md) + [DeleteCustomerGateway](API_DeleteCustomerGateway.md) + [DeleteDhcpOptions](API_DeleteDhcpOptions.md) + [DeleteEgressOnlyInternetGateway](API_DeleteEgressOnlyInternetGateway.md) + [DeleteFleets](API_DeleteFleets.md) + [DeleteFlowLogs](API_DeleteFlowLogs.md) + [DeleteFpgaImage](API_DeleteFpgaImage.md) + [DeleteImageUsageReport](API_DeleteImageUsageReport.md) + [DeleteInstanceConnectEndpoint](API_DeleteInstanceConnectEndpoint.md) + [DeleteInstanceEventWindow](API_DeleteInstanceEventWindow.md) + [DeleteInternetGateway](API_DeleteInternetGateway.md) + [DeleteIpam](API_DeleteIpam.md) + [DeleteIpamExternalResourceVerificationToken](API_DeleteIpamExternalResourceVerificationToken.md) + [DeleteIpamPolicy](API_DeleteIpamPolicy.md) + [DeleteIpamPool](API_DeleteIpamPool.md) + [DeleteIpamPrefixListResolver](API_DeleteIpamPrefixListResolver.md) + [DeleteIpamPrefixListResolverTarget](API_DeleteIpamPrefixListResolverTarget.md) + [DeleteIpamResourceDiscovery](API_DeleteIpamResourceDiscovery.md) + [DeleteIpamScope](API_DeleteIpamScope.md) + [DeleteKeyPair](API_DeleteKeyPair.md) + [DeleteLaunchTemplate](API_DeleteLaunchTemplate.md) + [DeleteLaunchTemplateVersions](API_DeleteLaunchTemplateVersions.md) + [DeleteLocalGatewayRoute](API_DeleteLocalGatewayRoute.md) + [DeleteLocalGatewayRouteTable](API_DeleteLocalGatewayRouteTable.md) + [DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation](API_DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation.md) + [DeleteLocalGatewayRouteTableVpcAssociation](API_DeleteLocalGatewayRouteTableVpcAssociation.md) + [DeleteLocalGatewayVirtualInterface](API_DeleteLocalGatewayVirtualInterface.md) + [DeleteLocalGatewayVirtualInterfaceGroup](API_DeleteLocalGatewayVirtualInterfaceGroup.md) + [DeleteManagedPrefixList](API_DeleteManagedPrefixList.md) + [DeleteNatGateway](API_DeleteNatGateway.md) + [DeleteNetworkAcl](API_DeleteNetworkAcl.md) + [DeleteNetworkAclEntry](API_DeleteNetworkAclEntry.md) + [DeleteNetworkInsightsAccessScope](API_DeleteNetworkInsightsAccessScope.md) + [DeleteNetworkInsightsAccessScopeAnalysis](API_DeleteNetworkInsightsAccessScopeAnalysis.md) + [DeleteNetworkInsightsAnalysis](API_DeleteNetworkInsightsAnalysis.md) + [DeleteNetworkInsightsPath](API_DeleteNetworkInsightsPath.md) + [DeleteNetworkInterface](API_DeleteNetworkInterface.md) + [DeleteNetworkInterfacePermission](API_DeleteNetworkInterfacePermission.md) + [DeletePlacementGroup](API_DeletePlacementGroup.md) + [DeletePublicIpv4Pool](API_DeletePublicIpv4Pool.md) + [DeleteQueuedReservedInstances](API_DeleteQueuedReservedInstances.md) + [DeleteRoute](API_DeleteRoute.md) + [DeleteRouteServer](API_DeleteRouteServer.md) + [DeleteRouteServerEndpoint](API_DeleteRouteServerEndpoint.md) + [DeleteRouteServerPeer](API_DeleteRouteServerPeer.md) + [DeleteRouteTable](API_DeleteRouteTable.md) + [DeleteSecondaryNetwork](API_DeleteSecondaryNetwork.md) + [DeleteSecondarySubnet](API_DeleteSecondarySubnet.md) + [DeleteSecurityGroup](API_DeleteSecurityGroup.md) + [DeleteSnapshot](API_DeleteSnapshot.md) + [DeleteSpotDatafeedSubscription](API_DeleteSpotDatafeedSubscription.md) + [DeleteSubnet](API_DeleteSubnet.md) + [DeleteSubnetCidrReservation](API_DeleteSubnetCidrReservation.md) + [DeleteTags](API_DeleteTags.md) + [DeleteTrafficMirrorFilter](API_DeleteTrafficMirrorFilter.md) + [DeleteTrafficMirrorFilterRule](API_DeleteTrafficMirrorFilterRule.md) + [DeleteTrafficMirrorSession](API_DeleteTrafficMirrorSession.md) + [DeleteTrafficMirrorTarget](API_DeleteTrafficMirrorTarget.md) + [DeleteTransitGateway](API_DeleteTransitGateway.md) + [DeleteTransitGatewayConnect](API_DeleteTransitGatewayConnect.md) + [DeleteTransitGatewayConnectPeer](API_DeleteTransitGatewayConnectPeer.md) + [DeleteTransitGatewayMeteringPolicy](API_DeleteTransitGatewayMeteringPolicy.md) + [DeleteTransitGatewayMeteringPolicyEntry](API_DeleteTransitGatewayMeteringPolicyEntry.md) + [DeleteTransitGatewayMulticastDomain](API_DeleteTransitGatewayMulticastDomain.md) + [DeleteTransitGatewayPeeringAttachment](API_DeleteTransitGatewayPeeringAttachment.md) + [DeleteTransitGatewayPolicyTable](API_DeleteTransitGatewayPolicyTable.md) + [DeleteTransitGatewayPrefixListReference](API_DeleteTransitGatewayPrefixListReference.md) + [DeleteTransitGatewayRoute](API_DeleteTransitGatewayRoute.md) + [DeleteTransitGatewayRouteTable](API_DeleteTransitGatewayRouteTable.md) + [DeleteTransitGatewayRouteTableAnnouncement](API_DeleteTransitGatewayRouteTableAnnouncement.md) + [DeleteTransitGatewayVpcAttachment](API_DeleteTransitGatewayVpcAttachment.md) + [DeleteVerifiedAccessEndpoint](API_DeleteVerifiedAccessEndpoint.md) + [DeleteVerifiedAccessGroup](API_DeleteVerifiedAccessGroup.md) + [DeleteVerifiedAccessInstance](API_DeleteVerifiedAccessInstance.md) + [DeleteVerifiedAccessTrustProvider](API_DeleteVerifiedAccessTrustProvider.md) + [DeleteVolume](API_DeleteVolume.md) + [DeleteVpc](API_DeleteVpc.md) + [DeleteVpcBlockPublicAccessExclusion](API_DeleteVpcBlockPublicAccessExclusion.md) + [DeleteVpcEncryptionControl](API_DeleteVpcEncryptionControl.md) + [DeleteVpcEndpointConnectionNotifications](API_DeleteVpcEndpointConnectionNotifications.md) + [DeleteVpcEndpoints](API_DeleteVpcEndpoints.md) + [DeleteVpcEndpointServiceConfigurations](API_DeleteVpcEndpointServiceConfigurations.md) + [DeleteVpcPeeringConnection](API_DeleteVpcPeeringConnection.md) + [DeleteVpnConcentrator](API_DeleteVpnConcentrator.md) + [DeleteVpnConnection](API_DeleteVpnConnection.md) + [DeleteVpnConnectionRoute](API_DeleteVpnConnectionRoute.md) + [DeleteVpnGateway](API_DeleteVpnGateway.md) + [DeprovisionByoipCidr](API_DeprovisionByoipCidr.md) + [DeprovisionIpamByoasn](API_DeprovisionIpamByoasn.md) + [DeprovisionIpamPoolCidr](API_DeprovisionIpamPoolCidr.md) + [DeprovisionPublicIpv4PoolCidr](API_DeprovisionPublicIpv4PoolCidr.md) + [DeregisterImage](API_DeregisterImage.md) + [DeregisterInstanceEventNotificationAttributes](API_DeregisterInstanceEventNotificationAttributes.md) + [DeregisterTransitGatewayMulticastGroupMembers](API_DeregisterTransitGatewayMulticastGroupMembers.md) + [DeregisterTransitGatewayMulticastGroupSources](API_DeregisterTransitGatewayMulticastGroupSources.md) + [DescribeAccountAttributes](API_DescribeAccountAttributes.md) + [DescribeAddresses](API_DescribeAddresses.md) + [DescribeAddressesAttribute](API_DescribeAddressesAttribute.md) + [DescribeAddressTransfers](API_DescribeAddressTransfers.md) + [DescribeAggregateIdFormat](API_DescribeAggregateIdFormat.md) + [DescribeAvailabilityZones](API_DescribeAvailabilityZones.md) + [DescribeAwsNetworkPerformanceMetricSubscriptions](API_DescribeAwsNetworkPerformanceMetricSubscriptions.md) + [DescribeBundleTasks](API_DescribeBundleTasks.md) + [DescribeByoipCidrs](API_DescribeByoipCidrs.md) + [DescribeCapacityBlockExtensionHistory](API_DescribeCapacityBlockExtensionHistory.md) + [DescribeCapacityBlockExtensionOfferings](API_DescribeCapacityBlockExtensionOfferings.md) + [DescribeCapacityBlockOfferings](API_DescribeCapacityBlockOfferings.md) + [DescribeCapacityBlocks](API_DescribeCapacityBlocks.md) + [DescribeCapacityBlockStatus](API_DescribeCapacityBlockStatus.md) + [DescribeCapacityManagerDataExports](API_DescribeCapacityManagerDataExports.md) + [DescribeCapacityReservationBillingRequests](API_DescribeCapacityReservationBillingRequests.md) + [DescribeCapacityReservationFleets](API_DescribeCapacityReservationFleets.md) + [DescribeCapacityReservations](API_DescribeCapacityReservations.md) + [DescribeCapacityReservationTopology](API_DescribeCapacityReservationTopology.md) + [DescribeCarrierGateways](API_DescribeCarrierGateways.md) + [DescribeClassicLinkInstances](API_DescribeClassicLinkInstances.md) + [DescribeClientVpnAuthorizationRules](API_DescribeClientVpnAuthorizationRules.md) + [DescribeClientVpnConnections](API_DescribeClientVpnConnections.md) + [DescribeClientVpnEndpoints](API_DescribeClientVpnEndpoints.md) + [DescribeClientVpnRoutes](API_DescribeClientVpnRoutes.md) + [DescribeClientVpnTargetNetworks](API_DescribeClientVpnTargetNetworks.md) + [DescribeCoipPools](API_DescribeCoipPools.md) + [DescribeConversionTasks](API_DescribeConversionTasks.md) + [DescribeCustomerGateways](API_DescribeCustomerGateways.md) + [DescribeDeclarativePoliciesReports](API_DescribeDeclarativePoliciesReports.md) + [DescribeDhcpOptions](API_DescribeDhcpOptions.md) + [DescribeEgressOnlyInternetGateways](API_DescribeEgressOnlyInternetGateways.md) + [DescribeElasticGpus](API_DescribeElasticGpus.md) + [DescribeExportImageTasks](API_DescribeExportImageTasks.md) + [DescribeExportTasks](API_DescribeExportTasks.md) + [DescribeFastLaunchImages](API_DescribeFastLaunchImages.md) + [DescribeFastSnapshotRestores](API_DescribeFastSnapshotRestores.md) + [DescribeFleetHistory](API_DescribeFleetHistory.md) + [DescribeFleetInstances](API_DescribeFleetInstances.md) + [DescribeFleets](API_DescribeFleets.md) + [DescribeFlowLogs](API_DescribeFlowLogs.md) + [DescribeFpgaImageAttribute](API_DescribeFpgaImageAttribute.md) + [DescribeFpgaImages](API_DescribeFpgaImages.md) + [DescribeHostReservationOfferings](API_DescribeHostReservationOfferings.md) + [DescribeHostReservations](API_DescribeHostReservations.md) + [DescribeHosts](API_DescribeHosts.md) + [DescribeIamInstanceProfileAssociations](API_DescribeIamInstanceProfileAssociations.md) + [DescribeIdentityIdFormat](API_DescribeIdentityIdFormat.md) + [DescribeIdFormat](API_DescribeIdFormat.md) + [DescribeImageAttribute](API_DescribeImageAttribute.md) + [DescribeImageReferences](API_DescribeImageReferences.md) + [DescribeImages](API_DescribeImages.md) + [DescribeImageUsageReportEntries](API_DescribeImageUsageReportEntries.md) + [DescribeImageUsageReports](API_DescribeImageUsageReports.md) + [DescribeImportImageTasks](API_DescribeImportImageTasks.md) + [DescribeImportSnapshotTasks](API_DescribeImportSnapshotTasks.md) + [DescribeInstanceAttribute](API_DescribeInstanceAttribute.md) + [DescribeInstanceConnectEndpoints](API_DescribeInstanceConnectEndpoints.md) + [DescribeInstanceCreditSpecifications](API_DescribeInstanceCreditSpecifications.md) + [DescribeInstanceEventNotificationAttributes](API_DescribeInstanceEventNotificationAttributes.md) + [DescribeInstanceEventWindows](API_DescribeInstanceEventWindows.md) + [DescribeInstanceImageMetadata](API_DescribeInstanceImageMetadata.md) + [DescribeInstances](API_DescribeInstances.md) + [DescribeInstanceSqlHaHistoryStates](API_DescribeInstanceSqlHaHistoryStates.md) + [DescribeInstanceSqlHaStates](API_DescribeInstanceSqlHaStates.md) + [DescribeInstanceStatus](API_DescribeInstanceStatus.md) + [DescribeInstanceTopology](API_DescribeInstanceTopology.md) + [DescribeInstanceTypeOfferings](API_DescribeInstanceTypeOfferings.md) + [DescribeInstanceTypes](API_DescribeInstanceTypes.md) + [DescribeInternetGateways](API_DescribeInternetGateways.md) + [DescribeIpamByoasn](API_DescribeIpamByoasn.md) + [DescribeIpamExternalResourceVerificationTokens](API_DescribeIpamExternalResourceVerificationTokens.md) + [DescribeIpamPolicies](API_DescribeIpamPolicies.md) + [DescribeIpamPools](API_DescribeIpamPools.md) + [DescribeIpamPrefixListResolvers](API_DescribeIpamPrefixListResolvers.md) + [DescribeIpamPrefixListResolverTargets](API_DescribeIpamPrefixListResolverTargets.md) + [DescribeIpamResourceDiscoveries](API_DescribeIpamResourceDiscoveries.md) + [DescribeIpamResourceDiscoveryAssociations](API_DescribeIpamResourceDiscoveryAssociations.md) + [DescribeIpams](API_DescribeIpams.md) + [DescribeIpamScopes](API_DescribeIpamScopes.md) + [DescribeIpv6Pools](API_DescribeIpv6Pools.md) + [DescribeKeyPairs](API_DescribeKeyPairs.md) + [DescribeLaunchTemplates](API_DescribeLaunchTemplates.md) + [DescribeLaunchTemplateVersions](API_DescribeLaunchTemplateVersions.md) + [DescribeLocalGatewayRouteTables](API_DescribeLocalGatewayRouteTables.md) + [DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations](API_DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations.md) + [DescribeLocalGatewayRouteTableVpcAssociations](API_DescribeLocalGatewayRouteTableVpcAssociations.md) + [DescribeLocalGateways](API_DescribeLocalGateways.md) + [DescribeLocalGatewayVirtualInterfaceGroups](API_DescribeLocalGatewayVirtualInterfaceGroups.md) + [DescribeLocalGatewayVirtualInterfaces](API_DescribeLocalGatewayVirtualInterfaces.md) + [DescribeLockedSnapshots](API_DescribeLockedSnapshots.md) + [DescribeMacHosts](API_DescribeMacHosts.md) + [DescribeMacModificationTasks](API_DescribeMacModificationTasks.md) + [DescribeManagedPrefixLists](API_DescribeManagedPrefixLists.md) + [DescribeMovingAddresses](API_DescribeMovingAddresses.md) + [DescribeNatGateways](API_DescribeNatGateways.md) + [DescribeNetworkAcls](API_DescribeNetworkAcls.md) + [DescribeNetworkInsightsAccessScopeAnalyses](API_DescribeNetworkInsightsAccessScopeAnalyses.md) + [DescribeNetworkInsightsAccessScopes](API_DescribeNetworkInsightsAccessScopes.md) + [DescribeNetworkInsightsAnalyses](API_DescribeNetworkInsightsAnalyses.md) + [DescribeNetworkInsightsPaths](API_DescribeNetworkInsightsPaths.md) + [DescribeNetworkInterfaceAttribute](API_DescribeNetworkInterfaceAttribute.md) + [DescribeNetworkInterfacePermissions](API_DescribeNetworkInterfacePermissions.md) + [DescribeNetworkInterfaces](API_DescribeNetworkInterfaces.md) + [DescribeOutpostLags](API_DescribeOutpostLags.md) + [DescribePlacementGroups](API_DescribePlacementGroups.md) + [DescribePrefixLists](API_DescribePrefixLists.md) + [DescribePrincipalIdFormat](API_DescribePrincipalIdFormat.md) + [DescribePublicIpv4Pools](API_DescribePublicIpv4Pools.md) + [DescribeRegions](API_DescribeRegions.md) + [DescribeReplaceRootVolumeTasks](API_DescribeReplaceRootVolumeTasks.md) + [DescribeReservedInstances](API_DescribeReservedInstances.md) + [DescribeReservedInstancesListings](API_DescribeReservedInstancesListings.md) + [DescribeReservedInstancesModifications](API_DescribeReservedInstancesModifications.md) + [DescribeReservedInstancesOfferings](API_DescribeReservedInstancesOfferings.md) + [DescribeRouteServerEndpoints](API_DescribeRouteServerEndpoints.md) + [DescribeRouteServerPeers](API_DescribeRouteServerPeers.md) + [DescribeRouteServers](API_DescribeRouteServers.md) + [DescribeRouteTables](API_DescribeRouteTables.md) + [DescribeScheduledInstanceAvailability](API_DescribeScheduledInstanceAvailability.md) + [DescribeScheduledInstances](API_DescribeScheduledInstances.md) + [DescribeSecondaryInterfaces](API_DescribeSecondaryInterfaces.md) + [DescribeSecondaryNetworks](API_DescribeSecondaryNetworks.md) + [DescribeSecondarySubnets](API_DescribeSecondarySubnets.md) + [DescribeSecurityGroupReferences](API_DescribeSecurityGroupReferences.md) + [DescribeSecurityGroupRules](API_DescribeSecurityGroupRules.md) + [DescribeSecurityGroups](API_DescribeSecurityGroups.md) + [DescribeSecurityGroupVpcAssociations](API_DescribeSecurityGroupVpcAssociations.md) + [DescribeServiceLinkVirtualInterfaces](API_DescribeServiceLinkVirtualInterfaces.md) + [DescribeSnapshotAttribute](API_DescribeSnapshotAttribute.md) + [DescribeSnapshots](API_DescribeSnapshots.md) + [DescribeSnapshotTierStatus](API_DescribeSnapshotTierStatus.md) + [DescribeSpotDatafeedSubscription](API_DescribeSpotDatafeedSubscription.md) + [DescribeSpotFleetInstances](API_DescribeSpotFleetInstances.md) + [DescribeSpotFleetRequestHistory](API_DescribeSpotFleetRequestHistory.md) + [DescribeSpotFleetRequests](API_DescribeSpotFleetRequests.md) + [DescribeSpotInstanceRequests](API_DescribeSpotInstanceRequests.md) + [DescribeSpotPriceHistory](API_DescribeSpotPriceHistory.md) + [DescribeStaleSecurityGroups](API_DescribeStaleSecurityGroups.md) + [DescribeStoreImageTasks](API_DescribeStoreImageTasks.md) + [DescribeSubnets](API_DescribeSubnets.md) + [DescribeTags](API_DescribeTags.md) + [DescribeTrafficMirrorFilterRules](API_DescribeTrafficMirrorFilterRules.md) + [DescribeTrafficMirrorFilters](API_DescribeTrafficMirrorFilters.md) + [DescribeTrafficMirrorSessions](API_DescribeTrafficMirrorSessions.md) + [DescribeTrafficMirrorTargets](API_DescribeTrafficMirrorTargets.md) + [DescribeTransitGatewayAttachments](API_DescribeTransitGatewayAttachments.md) + [DescribeTransitGatewayConnectPeers](API_DescribeTransitGatewayConnectPeers.md) + [DescribeTransitGatewayConnects](API_DescribeTransitGatewayConnects.md) + [DescribeTransitGatewayMeteringPolicies](API_DescribeTransitGatewayMeteringPolicies.md) + [DescribeTransitGatewayMulticastDomains](API_DescribeTransitGatewayMulticastDomains.md) + [DescribeTransitGatewayPeeringAttachments](API_DescribeTransitGatewayPeeringAttachments.md) + [DescribeTransitGatewayPolicyTables](API_DescribeTransitGatewayPolicyTables.md) + [DescribeTransitGatewayRouteTableAnnouncements](API_DescribeTransitGatewayRouteTableAnnouncements.md) + [DescribeTransitGatewayRouteTables](API_DescribeTransitGatewayRouteTables.md) + [DescribeTransitGateways](API_DescribeTransitGateways.md) + [DescribeTransitGatewayVpcAttachments](API_DescribeTransitGatewayVpcAttachments.md) + [DescribeTrunkInterfaceAssociations](API_DescribeTrunkInterfaceAssociations.md) + [DescribeVerifiedAccessEndpoints](API_DescribeVerifiedAccessEndpoints.md) + [DescribeVerifiedAccessGroups](API_DescribeVerifiedAccessGroups.md) + [DescribeVerifiedAccessInstanceLoggingConfigurations](API_DescribeVerifiedAccessInstanceLoggingConfigurations.md) + [DescribeVerifiedAccessInstances](API_DescribeVerifiedAccessInstances.md) + [DescribeVerifiedAccessTrustProviders](API_DescribeVerifiedAccessTrustProviders.md) + [DescribeVolumeAttribute](API_DescribeVolumeAttribute.md) + [DescribeVolumes](API_DescribeVolumes.md) + [DescribeVolumesModifications](API_DescribeVolumesModifications.md) + [DescribeVolumeStatus](API_DescribeVolumeStatus.md) + [DescribeVpcAttribute](API_DescribeVpcAttribute.md) + [DescribeVpcBlockPublicAccessExclusions](API_DescribeVpcBlockPublicAccessExclusions.md) + [DescribeVpcBlockPublicAccessOptions](API_DescribeVpcBlockPublicAccessOptions.md) + [DescribeVpcClassicLink](API_DescribeVpcClassicLink.md) + [DescribeVpcClassicLinkDnsSupport](API_DescribeVpcClassicLinkDnsSupport.md) + [DescribeVpcEncryptionControls](API_DescribeVpcEncryptionControls.md) + [DescribeVpcEndpointAssociations](API_DescribeVpcEndpointAssociations.md) + [DescribeVpcEndpointConnectionNotifications](API_DescribeVpcEndpointConnectionNotifications.md) + [DescribeVpcEndpointConnections](API_DescribeVpcEndpointConnections.md) + [DescribeVpcEndpoints](API_DescribeVpcEndpoints.md) + [DescribeVpcEndpointServiceConfigurations](API_DescribeVpcEndpointServiceConfigurations.md) + [DescribeVpcEndpointServicePermissions](API_DescribeVpcEndpointServicePermissions.md) + [DescribeVpcEndpointServices](API_DescribeVpcEndpointServices.md) + [DescribeVpcPeeringConnections](API_DescribeVpcPeeringConnections.md) + [DescribeVpcs](API_DescribeVpcs.md) + [DescribeVpnConcentrators](API_DescribeVpnConcentrators.md) + [DescribeVpnConnections](API_DescribeVpnConnections.md) + [DescribeVpnGateways](API_DescribeVpnGateways.md) + [DetachClassicLinkVpc](API_DetachClassicLinkVpc.md) + [DetachInternetGateway](API_DetachInternetGateway.md) + [DetachNetworkInterface](API_DetachNetworkInterface.md) + [DetachVerifiedAccessTrustProvider](API_DetachVerifiedAccessTrustProvider.md) + [DetachVolume](API_DetachVolume.md) + [DetachVpnGateway](API_DetachVpnGateway.md) + [DisableAddressTransfer](API_DisableAddressTransfer.md) + [DisableAllowedImagesSettings](API_DisableAllowedImagesSettings.md) + [DisableAwsNetworkPerformanceMetricSubscription](API_DisableAwsNetworkPerformanceMetricSubscription.md) + [DisableCapacityManager](API_DisableCapacityManager.md) + [DisableEbsEncryptionByDefault](API_DisableEbsEncryptionByDefault.md) + [DisableFastLaunch](API_DisableFastLaunch.md) + [DisableFastSnapshotRestores](API_DisableFastSnapshotRestores.md) + [DisableImage](API_DisableImage.md) + [DisableImageBlockPublicAccess](API_DisableImageBlockPublicAccess.md) + [DisableImageDeprecation](API_DisableImageDeprecation.md) + [DisableImageDeregistrationProtection](API_DisableImageDeregistrationProtection.md) + [DisableInstanceSqlHaStandbyDetections](API_DisableInstanceSqlHaStandbyDetections.md) + [DisableIpamOrganizationAdminAccount](API_DisableIpamOrganizationAdminAccount.md) + [DisableIpamPolicy](API_DisableIpamPolicy.md) + [DisableRouteServerPropagation](API_DisableRouteServerPropagation.md) + [DisableSerialConsoleAccess](API_DisableSerialConsoleAccess.md) + [DisableSnapshotBlockPublicAccess](API_DisableSnapshotBlockPublicAccess.md) + [DisableTransitGatewayRouteTablePropagation](API_DisableTransitGatewayRouteTablePropagation.md) + [DisableVgwRoutePropagation](API_DisableVgwRoutePropagation.md) + [DisableVpcClassicLink](API_DisableVpcClassicLink.md) + [DisableVpcClassicLinkDnsSupport](API_DisableVpcClassicLinkDnsSupport.md) + [DisassociateAddress](API_DisassociateAddress.md) + [DisassociateCapacityReservationBillingOwner](API_DisassociateCapacityReservationBillingOwner.md) + [DisassociateClientVpnTargetNetwork](API_DisassociateClientVpnTargetNetwork.md) + [DisassociateEnclaveCertificateIamRole](API_DisassociateEnclaveCertificateIamRole.md) + [DisassociateIamInstanceProfile](API_DisassociateIamInstanceProfile.md) + [DisassociateInstanceEventWindow](API_DisassociateInstanceEventWindow.md) + [DisassociateIpamByoasn](API_DisassociateIpamByoasn.md) + [DisassociateIpamResourceDiscovery](API_DisassociateIpamResourceDiscovery.md) + [DisassociateNatGatewayAddress](API_DisassociateNatGatewayAddress.md) + [DisassociateRouteServer](API_DisassociateRouteServer.md) + [DisassociateRouteTable](API_DisassociateRouteTable.md) + [DisassociateSecurityGroupVpc](API_DisassociateSecurityGroupVpc.md) + [DisassociateSubnetCidrBlock](API_DisassociateSubnetCidrBlock.md) + [DisassociateTransitGatewayMulticastDomain](API_DisassociateTransitGatewayMulticastDomain.md) + [DisassociateTransitGatewayPolicyTable](API_DisassociateTransitGatewayPolicyTable.md) + [DisassociateTransitGatewayRouteTable](API_DisassociateTransitGatewayRouteTable.md) + [DisassociateTrunkInterface](API_DisassociateTrunkInterface.md) + [DisassociateVpcCidrBlock](API_DisassociateVpcCidrBlock.md) + [EnableAddressTransfer](API_EnableAddressTransfer.md) + [EnableAllowedImagesSettings](API_EnableAllowedImagesSettings.md) + [EnableAwsNetworkPerformanceMetricSubscription](API_EnableAwsNetworkPerformanceMetricSubscription.md) + [EnableCapacityManager](API_EnableCapacityManager.md) + [EnableEbsEncryptionByDefault](API_EnableEbsEncryptionByDefault.md) + [EnableFastLaunch](API_EnableFastLaunch.md) + [EnableFastSnapshotRestores](API_EnableFastSnapshotRestores.md) + [EnableImage](API_EnableImage.md) + [EnableImageBlockPublicAccess](API_EnableImageBlockPublicAccess.md) + [EnableImageDeprecation](API_EnableImageDeprecation.md) + [EnableImageDeregistrationProtection](API_EnableImageDeregistrationProtection.md) + [EnableInstanceSqlHaStandbyDetections](API_EnableInstanceSqlHaStandbyDetections.md) + [EnableIpamOrganizationAdminAccount](API_EnableIpamOrganizationAdminAccount.md) + [EnableIpamPolicy](API_EnableIpamPolicy.md) + [EnableReachabilityAnalyzerOrganizationSharing](API_EnableReachabilityAnalyzerOrganizationSharing.md) + [EnableRouteServerPropagation](API_EnableRouteServerPropagation.md) + [EnableSerialConsoleAccess](API_EnableSerialConsoleAccess.md) + [EnableSnapshotBlockPublicAccess](API_EnableSnapshotBlockPublicAccess.md) + [EnableTransitGatewayRouteTablePropagation](API_EnableTransitGatewayRouteTablePropagation.md) + [EnableVgwRoutePropagation](API_EnableVgwRoutePropagation.md) + [EnableVolumeIO](API_EnableVolumeIO.md) + [EnableVpcClassicLink](API_EnableVpcClassicLink.md) + [EnableVpcClassicLinkDnsSupport](API_EnableVpcClassicLinkDnsSupport.md) + [ExportClientVpnClientCertificateRevocationList](API_ExportClientVpnClientCertificateRevocationList.md) + [ExportClientVpnClientConfiguration](API_ExportClientVpnClientConfiguration.md) + [ExportImage](API_ExportImage.md) + [ExportTransitGatewayRoutes](API_ExportTransitGatewayRoutes.md) + [ExportVerifiedAccessInstanceClientConfiguration](API_ExportVerifiedAccessInstanceClientConfiguration.md) + [GetActiveVpnTunnelStatus](API_GetActiveVpnTunnelStatus.md) + [GetAllowedImagesSettings](API_GetAllowedImagesSettings.md) + [GetAssociatedEnclaveCertificateIamRoles](API_GetAssociatedEnclaveCertificateIamRoles.md) + [GetAssociatedIpv6PoolCidrs](API_GetAssociatedIpv6PoolCidrs.md) + [GetAwsNetworkPerformanceData](API_GetAwsNetworkPerformanceData.md) + [GetCapacityManagerAttributes](API_GetCapacityManagerAttributes.md) + [GetCapacityManagerMetricData](API_GetCapacityManagerMetricData.md) + [GetCapacityManagerMetricDimensions](API_GetCapacityManagerMetricDimensions.md) + [GetCapacityManagerMonitoredTagKeys](API_GetCapacityManagerMonitoredTagKeys.md) + [GetCapacityReservationUsage](API_GetCapacityReservationUsage.md) + [GetCoipPoolUsage](API_GetCoipPoolUsage.md) + [GetConsoleOutput](API_GetConsoleOutput.md) + [GetConsoleScreenshot](API_GetConsoleScreenshot.md) + [GetDeclarativePoliciesReportSummary](API_GetDeclarativePoliciesReportSummary.md) + [GetDefaultCreditSpecification](API_GetDefaultCreditSpecification.md) + [GetEbsDefaultKmsKeyId](API_GetEbsDefaultKmsKeyId.md) + [GetEbsEncryptionByDefault](API_GetEbsEncryptionByDefault.md) + [GetEnabledIpamPolicy](API_GetEnabledIpamPolicy.md) + [GetFlowLogsIntegrationTemplate](API_GetFlowLogsIntegrationTemplate.md) + [GetGroupsForCapacityReservation](API_GetGroupsForCapacityReservation.md) + [GetHostReservationPurchasePreview](API_GetHostReservationPurchasePreview.md) + [GetImageAncestry](API_GetImageAncestry.md) + [GetImageBlockPublicAccessState](API_GetImageBlockPublicAccessState.md) + [GetInstanceMetadataDefaults](API_GetInstanceMetadataDefaults.md) + [GetInstanceTpmEkPub](API_GetInstanceTpmEkPub.md) + [GetInstanceTypesFromInstanceRequirements](API_GetInstanceTypesFromInstanceRequirements.md) + [GetInstanceUefiData](API_GetInstanceUefiData.md) + [GetIpamAddressHistory](API_GetIpamAddressHistory.md) + [GetIpamDiscoveredAccounts](API_GetIpamDiscoveredAccounts.md) + [GetIpamDiscoveredPublicAddresses](API_GetIpamDiscoveredPublicAddresses.md) + [GetIpamDiscoveredResourceCidrs](API_GetIpamDiscoveredResourceCidrs.md) + [GetIpamPolicyAllocationRules](API_GetIpamPolicyAllocationRules.md) + [GetIpamPolicyOrganizationTargets](API_GetIpamPolicyOrganizationTargets.md) + [GetIpamPoolAllocations](API_GetIpamPoolAllocations.md) + [GetIpamPoolCidrs](API_GetIpamPoolCidrs.md) + [GetIpamPrefixListResolverRules](API_GetIpamPrefixListResolverRules.md) + [GetIpamPrefixListResolverVersionEntries](API_GetIpamPrefixListResolverVersionEntries.md) + [GetIpamPrefixListResolverVersions](API_GetIpamPrefixListResolverVersions.md) + [GetIpamResourceCidrs](API_GetIpamResourceCidrs.md) + [GetLaunchTemplateData](API_GetLaunchTemplateData.md) + [GetManagedPrefixListAssociations](API_GetManagedPrefixListAssociations.md) + [GetManagedPrefixListEntries](API_GetManagedPrefixListEntries.md) + [GetNetworkInsightsAccessScopeAnalysisFindings](API_GetNetworkInsightsAccessScopeAnalysisFindings.md) + [GetNetworkInsightsAccessScopeContent](API_GetNetworkInsightsAccessScopeContent.md) + [GetPasswordData](API_GetPasswordData.md) + [GetReservedInstancesExchangeQuote](API_GetReservedInstancesExchangeQuote.md) + [GetRouteServerAssociations](API_GetRouteServerAssociations.md) + [GetRouteServerPropagations](API_GetRouteServerPropagations.md) + [GetRouteServerRoutingDatabase](API_GetRouteServerRoutingDatabase.md) + [GetSecurityGroupsForVpc](API_GetSecurityGroupsForVpc.md) + [GetSerialConsoleAccessStatus](API_GetSerialConsoleAccessStatus.md) + [GetSnapshotBlockPublicAccessState](API_GetSnapshotBlockPublicAccessState.md) + [GetSpotPlacementScores](API_GetSpotPlacementScores.md) + [GetSubnetCidrReservations](API_GetSubnetCidrReservations.md) + [GetTransitGatewayAttachmentPropagations](API_GetTransitGatewayAttachmentPropagations.md) + [GetTransitGatewayMeteringPolicyEntries](API_GetTransitGatewayMeteringPolicyEntries.md) + [GetTransitGatewayMulticastDomainAssociations](API_GetTransitGatewayMulticastDomainAssociations.md) + [GetTransitGatewayPolicyTableAssociations](API_GetTransitGatewayPolicyTableAssociations.md) + [GetTransitGatewayPolicyTableEntries](API_GetTransitGatewayPolicyTableEntries.md) + [GetTransitGatewayPrefixListReferences](API_GetTransitGatewayPrefixListReferences.md) + [GetTransitGatewayRouteTableAssociations](API_GetTransitGatewayRouteTableAssociations.md) + [GetTransitGatewayRouteTablePropagations](API_GetTransitGatewayRouteTablePropagations.md) + [GetVerifiedAccessEndpointPolicy](API_GetVerifiedAccessEndpointPolicy.md) + [GetVerifiedAccessEndpointTargets](API_GetVerifiedAccessEndpointTargets.md) + [GetVerifiedAccessGroupPolicy](API_GetVerifiedAccessGroupPolicy.md) + [GetVpcResourcesBlockingEncryptionEnforcement](API_GetVpcResourcesBlockingEncryptionEnforcement.md) + [GetVpnConnectionDeviceSampleConfiguration](API_GetVpnConnectionDeviceSampleConfiguration.md) + [GetVpnConnectionDeviceTypes](API_GetVpnConnectionDeviceTypes.md) + [GetVpnTunnelReplacementStatus](API_GetVpnTunnelReplacementStatus.md) + [ImportClientVpnClientCertificateRevocationList](API_ImportClientVpnClientCertificateRevocationList.md) + [ImportImage](API_ImportImage.md) + [ImportInstance](API_ImportInstance.md) + [ImportKeyPair](API_ImportKeyPair.md) + [ImportSnapshot](API_ImportSnapshot.md) + [ImportVolume](API_ImportVolume.md) + [ListImagesInRecycleBin](API_ListImagesInRecycleBin.md) + [ListSnapshotsInRecycleBin](API_ListSnapshotsInRecycleBin.md) + [ListVolumesInRecycleBin](API_ListVolumesInRecycleBin.md) + [LockSnapshot](API_LockSnapshot.md) + [ModifyAddressAttribute](API_ModifyAddressAttribute.md) + [ModifyAvailabilityZoneGroup](API_ModifyAvailabilityZoneGroup.md) + [ModifyCapacityReservation](API_ModifyCapacityReservation.md) + [ModifyCapacityReservationFleet](API_ModifyCapacityReservationFleet.md) + [ModifyClientVpnEndpoint](API_ModifyClientVpnEndpoint.md) + [ModifyDefaultCreditSpecification](API_ModifyDefaultCreditSpecification.md) + [ModifyEbsDefaultKmsKeyId](API_ModifyEbsDefaultKmsKeyId.md) + [ModifyFleet](API_ModifyFleet.md) + [ModifyFpgaImageAttribute](API_ModifyFpgaImageAttribute.md) + [ModifyHosts](API_ModifyHosts.md) + [ModifyIdentityIdFormat](API_ModifyIdentityIdFormat.md) + [ModifyIdFormat](API_ModifyIdFormat.md) + [ModifyImageAttribute](API_ModifyImageAttribute.md) + [ModifyInstanceAttribute](API_ModifyInstanceAttribute.md) + [ModifyInstanceCapacityReservationAttributes](API_ModifyInstanceCapacityReservationAttributes.md) + [ModifyInstanceConnectEndpoint](API_ModifyInstanceConnectEndpoint.md) + [ModifyInstanceCpuOptions](API_ModifyInstanceCpuOptions.md) + [ModifyInstanceCreditSpecification](API_ModifyInstanceCreditSpecification.md) + [ModifyInstanceEventStartTime](API_ModifyInstanceEventStartTime.md) + [ModifyInstanceEventWindow](API_ModifyInstanceEventWindow.md) + [ModifyInstanceMaintenanceOptions](API_ModifyInstanceMaintenanceOptions.md) + [ModifyInstanceMetadataDefaults](API_ModifyInstanceMetadataDefaults.md) + [ModifyInstanceMetadataOptions](API_ModifyInstanceMetadataOptions.md) + [ModifyInstanceNetworkPerformanceOptions](API_ModifyInstanceNetworkPerformanceOptions.md) + [ModifyInstancePlacement](API_ModifyInstancePlacement.md) + [ModifyIpam](API_ModifyIpam.md) + [ModifyIpamPolicyAllocationRules](API_ModifyIpamPolicyAllocationRules.md) + [ModifyIpamPool](API_ModifyIpamPool.md) + [ModifyIpamPrefixListResolver](API_ModifyIpamPrefixListResolver.md) + [ModifyIpamPrefixListResolverTarget](API_ModifyIpamPrefixListResolverTarget.md) + [ModifyIpamResourceCidr](API_ModifyIpamResourceCidr.md) + [ModifyIpamResourceDiscovery](API_ModifyIpamResourceDiscovery.md) + [ModifyIpamScope](API_ModifyIpamScope.md) + [ModifyLaunchTemplate](API_ModifyLaunchTemplate.md) + [ModifyLocalGatewayRoute](API_ModifyLocalGatewayRoute.md) + [ModifyManagedPrefixList](API_ModifyManagedPrefixList.md) + [ModifyNetworkInterfaceAttribute](API_ModifyNetworkInterfaceAttribute.md) + [ModifyPrivateDnsNameOptions](API_ModifyPrivateDnsNameOptions.md) + [ModifyPublicIpDnsNameOptions](API_ModifyPublicIpDnsNameOptions.md) + [ModifyReservedInstances](API_ModifyReservedInstances.md) + [ModifyRouteServer](API_ModifyRouteServer.md) + [ModifySecurityGroupRules](API_ModifySecurityGroupRules.md) + [ModifySnapshotAttribute](API_ModifySnapshotAttribute.md) + [ModifySnapshotTier](API_ModifySnapshotTier.md) + [ModifySpotFleetRequest](API_ModifySpotFleetRequest.md) + [ModifySubnetAttribute](API_ModifySubnetAttribute.md) + [ModifyTrafficMirrorFilterNetworkServices](API_ModifyTrafficMirrorFilterNetworkServices.md) + [ModifyTrafficMirrorFilterRule](API_ModifyTrafficMirrorFilterRule.md) + [ModifyTrafficMirrorSession](API_ModifyTrafficMirrorSession.md) + [ModifyTransitGateway](API_ModifyTransitGateway.md) + [ModifyTransitGatewayMeteringPolicy](API_ModifyTransitGatewayMeteringPolicy.md) + [ModifyTransitGatewayPrefixListReference](API_ModifyTransitGatewayPrefixListReference.md) + [ModifyTransitGatewayVpcAttachment](API_ModifyTransitGatewayVpcAttachment.md) + [ModifyVerifiedAccessEndpoint](API_ModifyVerifiedAccessEndpoint.md) + [ModifyVerifiedAccessEndpointPolicy](API_ModifyVerifiedAccessEndpointPolicy.md) + [ModifyVerifiedAccessGroup](API_ModifyVerifiedAccessGroup.md) + [ModifyVerifiedAccessGroupPolicy](API_ModifyVerifiedAccessGroupPolicy.md) + [ModifyVerifiedAccessInstance](API_ModifyVerifiedAccessInstance.md) + [ModifyVerifiedAccessInstanceLoggingConfiguration](API_ModifyVerifiedAccessInstanceLoggingConfiguration.md) + [ModifyVerifiedAccessTrustProvider](API_ModifyVerifiedAccessTrustProvider.md) + [ModifyVolume](API_ModifyVolume.md) + [ModifyVolumeAttribute](API_ModifyVolumeAttribute.md) + [ModifyVpcAttribute](API_ModifyVpcAttribute.md) + [ModifyVpcBlockPublicAccessExclusion](API_ModifyVpcBlockPublicAccessExclusion.md) + [ModifyVpcBlockPublicAccessOptions](API_ModifyVpcBlockPublicAccessOptions.md) + [ModifyVpcEncryptionControl](API_ModifyVpcEncryptionControl.md) + [ModifyVpcEndpoint](API_ModifyVpcEndpoint.md) + [ModifyVpcEndpointConnectionNotification](API_ModifyVpcEndpointConnectionNotification.md) + [ModifyVpcEndpointServiceConfiguration](API_ModifyVpcEndpointServiceConfiguration.md) + [ModifyVpcEndpointServicePayerResponsibility](API_ModifyVpcEndpointServicePayerResponsibility.md) + [ModifyVpcEndpointServicePermissions](API_ModifyVpcEndpointServicePermissions.md) + [ModifyVpcPeeringConnectionOptions](API_ModifyVpcPeeringConnectionOptions.md) + [ModifyVpcTenancy](API_ModifyVpcTenancy.md) + [ModifyVpnConnection](API_ModifyVpnConnection.md) + [ModifyVpnConnectionOptions](API_ModifyVpnConnectionOptions.md) + [ModifyVpnTunnelCertificate](API_ModifyVpnTunnelCertificate.md) + [ModifyVpnTunnelOptions](API_ModifyVpnTunnelOptions.md) + [MonitorInstances](API_MonitorInstances.md) + [MoveAddressToVpc](API_MoveAddressToVpc.md) + [MoveByoipCidrToIpam](API_MoveByoipCidrToIpam.md) + [MoveCapacityReservationInstances](API_MoveCapacityReservationInstances.md) + [ProvisionByoipCidr](API_ProvisionByoipCidr.md) + [ProvisionIpamByoasn](API_ProvisionIpamByoasn.md) + [ProvisionIpamPoolCidr](API_ProvisionIpamPoolCidr.md) + [ProvisionPublicIpv4PoolCidr](API_ProvisionPublicIpv4PoolCidr.md) + [PurchaseCapacityBlock](API_PurchaseCapacityBlock.md) + [PurchaseCapacityBlockExtension](API_PurchaseCapacityBlockExtension.md) + [PurchaseHostReservation](API_PurchaseHostReservation.md) + [PurchaseReservedInstancesOffering](API_PurchaseReservedInstancesOffering.md) + [PurchaseScheduledInstances](API_PurchaseScheduledInstances.md) + [RebootInstances](API_RebootInstances.md) + [RegisterImage](API_RegisterImage.md) + [RegisterInstanceEventNotificationAttributes](API_RegisterInstanceEventNotificationAttributes.md) + [RegisterTransitGatewayMulticastGroupMembers](API_RegisterTransitGatewayMulticastGroupMembers.md) + [RegisterTransitGatewayMulticastGroupSources](API_RegisterTransitGatewayMulticastGroupSources.md) + [RejectCapacityReservationBillingOwnership](API_RejectCapacityReservationBillingOwnership.md) + [RejectTransitGatewayMulticastDomainAssociations](API_RejectTransitGatewayMulticastDomainAssociations.md) + [RejectTransitGatewayPeeringAttachment](API_RejectTransitGatewayPeeringAttachment.md) + [RejectTransitGatewayVpcAttachment](API_RejectTransitGatewayVpcAttachment.md) + [RejectVpcEndpointConnections](API_RejectVpcEndpointConnections.md) + [RejectVpcPeeringConnection](API_RejectVpcPeeringConnection.md) + [ReleaseAddress](API_ReleaseAddress.md) + [ReleaseHosts](API_ReleaseHosts.md) + [ReleaseIpamPoolAllocation](API_ReleaseIpamPoolAllocation.md) + [ReplaceIamInstanceProfileAssociation](API_ReplaceIamInstanceProfileAssociation.md) + [ReplaceImageCriteriaInAllowedImagesSettings](API_ReplaceImageCriteriaInAllowedImagesSettings.md) + [ReplaceNetworkAclAssociation](API_ReplaceNetworkAclAssociation.md) + [ReplaceNetworkAclEntry](API_ReplaceNetworkAclEntry.md) + [ReplaceRoute](API_ReplaceRoute.md) + [ReplaceRouteTableAssociation](API_ReplaceRouteTableAssociation.md) + [ReplaceTransitGatewayRoute](API_ReplaceTransitGatewayRoute.md) + [ReplaceVpnTunnel](API_ReplaceVpnTunnel.md) + [ReportInstanceStatus](API_ReportInstanceStatus.md) + [RequestSpotFleet](API_RequestSpotFleet.md) + [RequestSpotInstances](API_RequestSpotInstances.md) + [ResetAddressAttribute](API_ResetAddressAttribute.md) + [ResetEbsDefaultKmsKeyId](API_ResetEbsDefaultKmsKeyId.md) + [ResetFpgaImageAttribute](API_ResetFpgaImageAttribute.md) + [ResetImageAttribute](API_ResetImageAttribute.md) + [ResetInstanceAttribute](API_ResetInstanceAttribute.md) + [ResetNetworkInterfaceAttribute](API_ResetNetworkInterfaceAttribute.md) + [ResetSnapshotAttribute](API_ResetSnapshotAttribute.md) + [RestoreAddressToClassic](API_RestoreAddressToClassic.md) + [RestoreImageFromRecycleBin](API_RestoreImageFromRecycleBin.md) + [RestoreManagedPrefixListVersion](API_RestoreManagedPrefixListVersion.md) + [RestoreSnapshotFromRecycleBin](API_RestoreSnapshotFromRecycleBin.md) + [RestoreSnapshotTier](API_RestoreSnapshotTier.md) + [RestoreVolumeFromRecycleBin](API_RestoreVolumeFromRecycleBin.md) + [RevokeClientVpnIngress](API_RevokeClientVpnIngress.md) + [RevokeSecurityGroupEgress](API_RevokeSecurityGroupEgress.md) + [RevokeSecurityGroupIngress](API_RevokeSecurityGroupIngress.md) + [RunInstances](API_RunInstances.md) + [RunScheduledInstances](API_RunScheduledInstances.md) + [SearchLocalGatewayRoutes](API_SearchLocalGatewayRoutes.md) + [SearchTransitGatewayMulticastGroups](API_SearchTransitGatewayMulticastGroups.md) + [SearchTransitGatewayRoutes](API_SearchTransitGatewayRoutes.md) + [SendDiagnosticInterrupt](API_SendDiagnosticInterrupt.md) + [StartDeclarativePoliciesReport](API_StartDeclarativePoliciesReport.md) + [StartInstances](API_StartInstances.md) + [StartNetworkInsightsAccessScopeAnalysis](API_StartNetworkInsightsAccessScopeAnalysis.md) + [StartNetworkInsightsAnalysis](API_StartNetworkInsightsAnalysis.md) + [StartVpcEndpointServicePrivateDnsVerification](API_StartVpcEndpointServicePrivateDnsVerification.md) + [StopInstances](API_StopInstances.md) + [TerminateClientVpnConnections](API_TerminateClientVpnConnections.md) + [TerminateInstances](API_TerminateInstances.md) + [UnassignIpv6Addresses](API_UnassignIpv6Addresses.md) + [UnassignPrivateIpAddresses](API_UnassignPrivateIpAddresses.md) + [UnassignPrivateNatGatewayAddress](API_UnassignPrivateNatGatewayAddress.md) + [UnlockSnapshot](API_UnlockSnapshot.md) + [UnmonitorInstances](API_UnmonitorInstances.md) + [UpdateCapacityManagerMonitoredTagKeys](API_UpdateCapacityManagerMonitoredTagKeys.md) + [UpdateCapacityManagerOrganizationsAccess](API_UpdateCapacityManagerOrganizationsAccess.md) + [UpdateInterruptibleCapacityReservationAllocation](API_UpdateInterruptibleCapacityReservationAllocation.md) + [UpdateSecurityGroupRuleDescriptionsEgress](API_UpdateSecurityGroupRuleDescriptionsEgress.md) + [UpdateSecurityGroupRuleDescriptionsIngress](API_UpdateSecurityGroupRuleDescriptionsIngress.md) + [WithdrawByoipCidr](API_WithdrawByoipCidr.md) # AcceptAddressTransfer Accepts an Elastic IP address transfer. For more information, see [Accept a transferred Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#using-instance-addressing-eips-transfer-accept) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Address** The Elastic IP address you are accepting for transfer. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **addressTransfer** An Elastic IP address transfer. Type: [AddressTransfer](API_AddressTransfer.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptAddressTransfer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptAddressTransfer) # AcceptCapacityReservationBillingOwnership Accepts a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see [ Billing assignment for shared Amazon EC2 Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the Capacity Reservation for which to accept the request. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptCapacityReservationBillingOwnership) # AcceptReservedInstancesExchangeQuote Accepts the Convertible Reserved Instance exchange quote described in the [GetReservedInstancesExchangeQuote](API_GetReservedInstancesExchangeQuote.md) call. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReservedInstanceId.N** The IDs of the Convertible Reserved Instances to exchange for another Convertible Reserved Instance of the same or higher value. Type: Array of strings Required: Yes **TargetConfiguration.N** The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. Type: Array of [TargetConfigurationRequest](API_TargetConfigurationRequest.md) objects Required: No ## Response Elements The following elements are returned by the service. **exchangeId** The ID of the successful exchange. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptReservedInstancesExchangeQuote) # AcceptTransitGatewayMulticastDomainAssociations Accepts a request to associate subnets with a transit gateway multicast domain. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SubnetIds.N** The IDs of the subnets to associate with the transit gateway multicast domain. Type: Array of strings Required: No **TransitGatewayAttachmentId** The ID of the transit gateway attachment. Type: String Required: No **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: No ## Response Elements The following elements are returned by the service. **associations** Information about the multicast domain associations. Type: [TransitGatewayMulticastDomainAssociations](API_TransitGatewayMulticastDomainAssociations.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptTransitGatewayMulticastDomainAssociations) # AcceptTransitGatewayPeeringAttachment Accepts a transit gateway peering attachment request. The peering attachment must be in the `pendingAcceptance` state. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the transit gateway attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPeeringAttachment** The transit gateway peering attachment. Type: [TransitGatewayPeeringAttachment](API_TransitGatewayPeeringAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example accepts the specified transit gateway peering attachment by specifying its attachment ID. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AcceptTransitGatewayPeeringAttachment &TransitGatewayAttachmentId=tgw-attach-12345678901abcd12 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptTransitGatewayPeeringAttachment) # AcceptTransitGatewayVpcAttachment Accepts a request to attach a VPC to a transit gateway. The VPC attachment must be in the `pendingAcceptance` state. Use [DescribeTransitGatewayVpcAttachments](API_DescribeTransitGatewayVpcAttachments.md) to view your pending VPC attachment requests. Use [RejectTransitGatewayVpcAttachment](API_RejectTransitGatewayVpcAttachment.md) to reject a VPC attachment request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayVpcAttachment** The VPC attachment. Type: [TransitGatewayVpcAttachment](API_TransitGatewayVpcAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptTransitGatewayVpcAttachment) # AcceptVpcEndpointConnections Accepts connection requests to your VPC endpoint service. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ServiceId** The ID of the VPC endpoint service. Type: String Required: Yes **VpcEndpointId.N** The IDs of the interface VPC endpoints. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **unsuccessful** Information about the interface endpoints that were not accepted, if applicable. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example accepts the request for interface endpoint `vpce-0c1308d7312217123` to connect to your service `vpce-svc-abc5ebb7d9579a2b3`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AcceptVpcEndpointConnections &ServiceId=vpce-svc-abc5ebb7d9579a2b3 &VpcEndpointId.1=vpce-0c1308d7312217123 &AUTHPARAMS ``` #### Sample Response ``` 986a2264-8a40-4da8-8f11-e8aaexample ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptVpcEndpointConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptVpcEndpointConnections) # AcceptVpcPeeringConnection 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](API_DescribeVpcPeeringConnections.md) 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 Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcPeeringConnectionId** The ID of the VPC peering connection. You must specify this parameter in the request. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcPeeringConnection** Information about the VPC peering connection. Type: [VpcPeeringConnection](API_VpcPeeringConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example accepts the specified VPC peering connection request. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AcceptVpcPeeringConnection &VpcPeeringConnectionId=pcx-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE pcx-1a2b3c4d 123456789012 vpc-1a2b3c4d 10.0.0.0/28 777788889999 vpc-111aaa22 10.0.1.0/28 false false false active Active " ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AcceptVpcPeeringConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceptVpcPeeringConnection) # AdvertiseByoipCidr 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](API_WithdrawByoipCidr.md). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Asn** The public 2-byte or 4-byte ASN that you want to advertise. Type: String Required: No **Cidr** 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. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkBorderGroup** If you have [Local Zones](https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html) enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the AWS resource it is associated with must reside in the same network border group. You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups: + us-east-1-dfw-2 + us-west-2-lax-1 + us-west-2-phx-2 You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time. Type: String Required: No ## Response Elements The following elements are returned by the service. **byoipCidr** Information about the address range. Type: [ByoipCidr](API_ByoipCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AdvertiseByoipCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AdvertiseByoipCidr) # AllocateAddress 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 one of the following address pools: + Amazon's pool of IPv4 addresses + Public IPv4 address range that you own and bring to your AWS account using [Bring Your Own IP Addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) + An IPv4 IPAM pool with an Amazon-provided or BYOIP public IPv4 address range + IPv4 addresses from your on-premises network made available for use with an Outpost using a [customer-owned IP address pool](https://docs.aws.amazon.com/outposts/latest/userguide/routing.html#ip-addressing) (CoIP pool) For more information, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*. If you release an Elastic IP address, you might be able to recover it. You cannot recover an Elastic IP address that you released after it is allocated to another AWS account. To attempt to recover an Elastic IP address that you released, specify it in this operation. You can allocate a carrier IP address which is a public IP address from a telecommunication carrier, to a network interface which resides in a subnet in a Wavelength Zone (for example an EC2 instance). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Address** The Elastic IP address to recover or an IPv4 address from an address pool. Type: String Required: No **CustomerOwnedIpv4Pool** 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. Type: String Required: No **Domain** The network (`vpc`). Type: String Valid Values: `vpc | standard` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPoolId** The ID of an IPAM pool which has an Amazon-provided or BYOIP public IPv4 CIDR provisioned to it. For more information, see [Allocate sequential Elastic IP addresses from an IPAM pool](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-eip-pool.html) in the *Amazon VPC IPAM User Guide*. Type: String Required: No **NetworkBorderGroup** A unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network border groups. Use [DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the network border groups. Type: String Required: No **PublicIpv4Pool** The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address pool. To specify a specific address from the address pool, use the `Address` parameter instead. Type: String Required: No **TagSpecification.N** The tags to assign to the Elastic IP address. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **allocationId** The ID that represents the allocation of the Elastic IP address. Type: String **carrierIp** The carrier IP address. Available only for network interfaces that reside in a subnet in a Wavelength Zone. Type: String **customerOwnedIp** The customer-owned IP address. Type: String **customerOwnedIpv4Pool** The ID of the customer-owned address pool. Type: String **domain** The network (`vpc`). Type: String Valid Values: `vpc | standard` **networkBorderGroup** The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. Type: String **publicIp** The Amazon-owned IP address. Not available when using an address pool that you own. Type: String **publicIpv4Pool** The ID of an address pool that you own. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example for Allocation This example request allocates an Elastic IP address. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AllocateAddress &Domain=vpc &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE 198.51.100.1 vpc eipalloc-5723d13e ``` ### Example for Recovery This example request shows how to recover an Elastic IP address that you previously released. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AllocateAddress &Domain=vpc &Address=203.0.113.3 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AllocateAddress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AllocateAddress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AllocateAddress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AllocateAddress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AllocateAddress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AllocateAddress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AllocateAddress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AllocateAddress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AllocateAddress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AllocateAddress) # AllocateHosts 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 Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssetId.N** The IDs of the Outpost hardware assets on which to allocate the Dedicated Hosts. Targeting specific hardware assets on an Outpost can help to minimize latency between your workloads. This parameter is supported only if you specify **OutpostArn**. If you are allocating the Dedicated Hosts in a Region, omit this parameter. + If you specify this parameter, you can omit **Quantity**. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. + If you specify both **AssetIds** and **Quantity**, then the value for **Quantity** must be equal to the number of asset IDs specified. Type: Array of strings Required: No **AutoPlacement** Indicates whether the host accepts any untargeted instance launches that match its instance type configuration, or if it only accepts Host tenancy instance launches that specify its unique host ID. For more information, see [ Understanding auto-placement and affinity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-understanding) in the *Amazon EC2 User Guide*. Default: `off` Type: String Valid Values: `on | off` Required: No **AvailabilityZone** The Availability Zone in which to allocate the Dedicated Host. Type: String Required: No **AvailabilityZoneId** The ID of the Availability Zone. Type: String Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **HostMaintenance** Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see [Host maintenance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `on | off` Required: No **HostRecovery** Indicates whether to enable or disable host recovery for the Dedicated Host. Host recovery is disabled by default. For more information, see [ Host recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) in the *Amazon EC2 User Guide*. Default: `off` Type: String Valid Values: `on | off` Required: No **InstanceFamily** 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. Type: String Required: No **InstanceType** 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. Type: String Required: No **OutpostArn** The Amazon Resource Name (ARN) of the AWS Outpost on which to allocate the Dedicated Host. If you specify **OutpostArn**, you can optionally specify **AssetIds**. If you are allocating the Dedicated Host in a Region, omit this parameter. Type: String Required: No **Quantity** The number of Dedicated Hosts to allocate to your account with these parameters. If you are allocating the Dedicated Hosts on an Outpost, and you specify **AssetIds**, you can omit this parameter. In this case, Amazon EC2 allocates a Dedicated Host on each specified hardware asset. If you specify both **AssetIds** and **Quantity**, then the value that you specify for **Quantity** must be equal to the number of asset IDs specified. Type: Integer Required: No **TagSpecification.N** The tags to apply to the Dedicated Host during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **hostIdSet** The ID of the allocated Dedicated Host. This is used to launch an instance onto a specific host. Type: Array of strings **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example allocates a Dedicated Host to your account, on to which you can launch only `m5.large` instances. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AllocateHosts &AvailabilityZone=us-east-1b &InstanceType=m5.large &Quantity=1 &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ### Example 2 This example allocates a Dedicated Host to your account, on to which you can launch multiple instance types in the `m5` instance family. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AllocateHosts &AvailabilityZone=us-east-1b &InstanceFamily=m5 &Quantity=1 &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ### Example 3 This example allocates a Dedicated Host to your account with host recovery `on`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AllocateHosts &AvailabilityZone=us-east-1b &InstanceType=m5.large &Quantity=1 &HostRecovery=on &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ### Example 4 This example allocates a Dedicated Host to your account with auto-placement `off`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AllocateHosts &AvailabilityZone=us-east-1b &InstanceFamily=m5 &Quantity=1 &AutoPlacement=off &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ### Example 5 This example allocates a Dedicated Host to your account, on to which you can launch only m5.2xlarge instances, and applies a tag with a key of `purpose` and a value of `production`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AllocateHosts &AvailabilityZone=us-east-1b &InstanceType=m5.2xlarge &Quantity=1 &TagSpecification.1.ResourceType=dedicated-host &TagSpecification.1.Tag.1.Key=purpose &TagSpecification.1.Tag.1.Value=production &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AllocateHosts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AllocateHosts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AllocateHosts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AllocateHosts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AllocateHosts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AllocateHosts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AllocateHosts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AllocateHosts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AllocateHosts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AllocateHosts) # AllocateIpamPoolCidr Allocate a CIDR from an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the AWS Region where this IPAM pool is available for allocations. In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource. For more information, see [Allocate CIDRs](https://docs.aws.amazon.com/vpc/latest/ipam/allocate-cidrs-ipam.html) in the *Amazon VPC IPAM User Guide*. **Note** This action creates an allocation with strong consistency. The returned CIDR will not overlap with any other allocations from the same pool. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllowedCidr.N** Include a particular CIDR range that can be returned by the pool. Allowed CIDRs are only allowed if using netmask length for allocation. Type: Array of strings Required: No **Cidr** The CIDR you would like to allocate from the IPAM pool. Note the following: + If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. + If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored. Possible values: Any available IPv4 or IPv6 CIDR. Type: String Required: No **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the allocation. Type: String Required: No **DisallowedCidr.N** Exclude a particular CIDR range from being returned by the pool. Disallowed CIDRs are only allowed if using netmask length for allocation. Type: Array of strings Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPoolId** The ID of the IPAM pool from which you would like to allocate a CIDR. Type: String Required: Yes **NetmaskLength** The netmask length of the CIDR you would like to allocate from the IPAM pool. Note the following: + If there is no DefaultNetmaskLength allocation rule set on the pool, you must specify either the NetmaskLength or the CIDR. + If the DefaultNetmaskLength allocation rule is set on the pool, you can specify either the NetmaskLength or the CIDR and the DefaultNetmaskLength allocation rule will be ignored. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. Type: Integer Required: No **PreviewNextCidr** A preview of the next available CIDR in a pool. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **ipamPoolAllocation** Information about the allocation created. Type: [IpamPoolAllocation](API_IpamPoolAllocation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AllocateIpamPoolCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AllocateIpamPoolCidr) # ApplySecurityGroupsToClientVpnTargetNetwork 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 Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SecurityGroupId.N** 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. Type: Array of strings Required: Yes **VpcId** The ID of the VPC in which the associated target network is located. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **securityGroupIds** The IDs of the applied security groups. Type: Array of strings ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example applies a security group to a Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ApplySecurityGroupsToClientVpnTargetNetwork &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &SecurityGroupId=sg-0618575f05EXAMPLE &VpcId=vpc-3db97056EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 5ef84b7f-505e-4e39-80cd-a11dbEXAMPLE sg-0618575f05EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ApplySecurityGroupsToClientVpnTargetNetwork) # AssignIpv6Addresses Assigns the specified IPv6 addresses to the specified network interface. You can specify specific IPv6 addresses, or you can specify the number of IPv6 addresses to be automatically assigned from 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 by instance type. You must specify either the IPv6 addresses or the IPv6 address count in the request. You can optionally use Prefix Delegation on the network interface. You must specify either the IPV6 Prefix Delegation prefixes, or the IPv6 Prefix Delegation count. For information, see [ Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Ipv6AddressCount** The number of additional IPv6 addresses to assign to the network interface. The specified number of IPv6 addresses are assigned in addition to the existing IPv6 addresses that are already assigned to the network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't use this option if specifying specific IPv6 addresses. Type: Integer Required: No **Ipv6Addresses.N** The IPv6 addresses to be assigned to the network interface. You can't use this option if you're specifying a number of IPv6 addresses. Type: Array of strings Required: No **Ipv6Prefix.N** One or more IPv6 prefixes assigned to the network interface. You can't use this option if you use the `Ipv6PrefixCount` option. Type: Array of strings Required: No **Ipv6PrefixCount** The number of IPv6 prefixes that AWS automatically assigns to the network interface. You cannot use this option if you use the `Ipv6Prefixes` option. Type: Integer Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **assignedIpv6Addresses** The new IPv6 addresses assigned to the network interface. Existing IPv6 addresses that were assigned to the network interface before the request are not included. Type: Array of strings **assignedIpv6PrefixSet** The IPv6 prefixes that are assigned to the network interface. Type: Array of strings **networkInterfaceId** The ID of the network interface. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example assigns two IPv6 addresses (`2001:db8:1234:1a00::123` and `2001:db8:1234:1a00::456`) to the specified network interface. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssignIpv6Addresses &NetworkInterfaceId=eni-d83388b1 &Ipv6Addresses.1=2001:db8:1234:1a00::123 &Ipv6Addresses.2=2001:db8:1234:1a00::456 &AUTHPARAMS ``` #### Sample Response ``` c36d17eb-a0ba-4d38-8727-example eni-d83388b1 2001:db8:1234:1a00::123 2001:db8:1234:1a00::456 ``` ### Example 2 This example assigns two IPv6 addresses to the specified network interface. Amazon EC2 automatically assigns the addresses from the available IPv6 addresses within the subnet's IPv6 CIDR block range. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssignIpv6Addresses &NetworkInterfaceId=eni-d83388b1 &Ipv6AddressCount=2 &AUTHPARAMS ``` #### Sample Response ``` c36d17eb-a0ba-4d38-8727-example eni-d83388b1 2001:db8:1234:1a00:3304:8879:34cf:4071 2002:db8:1234:1a00:9691:9503:25ad:1761 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssignIpv6Addresses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssignIpv6Addresses) # AssignPrivateIpAddresses Assigns the specified secondary private IP addresses to the specified network interface. You can specify specific secondary IP addresses, or you can specify the number of secondary IP addresses to be automatically assigned from the subnet's CIDR block range. The number of secondary IP addresses that you can assign to an instance varies by instance type. For more information about Elastic IP addresses, see [Elastic IP Addresses](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html) in the *Amazon EC2 User Guide*. When you move a secondary private IP address to another network interface, any Elastic IP address that is associated with the IP address is also moved. Remapping an IP address is an asynchronous operation. When you move an IP address from one network interface to another, check `network/interfaces/macs/mac/local-ipv4s` in the instance metadata to confirm that the remapping is complete. You must specify either the IP addresses or the IP address count in the request. You can optionally use Prefix Delegation on the network interface. You must specify either the IPv4 Prefix Delegation prefixes, or the IPv4 Prefix Delegation count. For information, see [ Assigning prefixes to network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-prefix-eni.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllowReassignment** 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. Type: Boolean Required: No **Ipv4Prefix.N** One or more IPv4 prefixes assigned to the network interface. You can't use this option if you use the `Ipv4PrefixCount` option. Type: Array of strings Required: No **Ipv4PrefixCount** The number of IPv4 prefixes that AWS automatically assigns to the network interface. You can't use this option if you use the `Ipv4 Prefixes` option. Type: Integer Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: Yes **PrivateIpAddress.N** The IP addresses to be assigned as a secondary private IP address to the network interface. You can't specify this parameter when also specifying a number of secondary IP addresses. If you don't specify an IP address, Amazon EC2 automatically selects an IP address within the subnet range. Type: Array of strings Required: No **SecondaryPrivateIpAddressCount** The number of secondary IP addresses to assign to the network interface. You can't specify this parameter when also specifying private IP addresses. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **assignedIpv4PrefixSet** The IPv4 prefixes that are assigned to the network interface. Type: Array of [Ipv4PrefixSpecification](API_Ipv4PrefixSpecification.md) objects **assignedPrivateIpAddressesSet** The private IP addresses assigned to the network interface. Type: Array of [AssignedPrivateIpAddress](API_AssignedPrivateIpAddress.md) objects **networkInterfaceId** The ID of the network interface. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example assigns two secondary private IP addresses (`10.0.2.1` and `10.0.2.11`) to the specified network interface. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssignPrivateIpAddresses &NetworkInterfaceId=eni-d83388b1 &PrivateIpAddress.1=10.0.2.1 &PrivateIpAddress.2=10.0.2.11 &AUTHPARAMS ``` #### Sample Response ``` 3fb591ba-558c-48f8-ae6b-c2f9d6d06425 eni-01d32da61c165ac3e 10.2.2.1 10.2.2.11 true ``` ### Example 2 This example assigns two secondary private IP addresses to the specified network interface. Amazon EC2 automatically assigns these IP addresses from the available IP addresses within the subnet's CIDR block range. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssignPrivateIpAddresses &NetworkInterfaceId=eni-d83388b1 &SecondaryPrivateIpAddressCount=2 &AUTHPARAMS ``` #### Sample Response ``` 3fb591ba-558c-48f8-ae6b-c2f9d6d06425 eni-01d32da61c165ac3e 10.2.2.7 10.2.2.5 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssignPrivateIpAddresses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssignPrivateIpAddresses) # AssignPrivateNatGatewayAddress Assigns private IPv4 addresses to a private NAT gateway. For more information, see [Work with NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NatGatewayId** The ID of the NAT gateway. Type: String Required: Yes **PrivateIpAddress.N** The private IPv4 addresses you want to assign to the private NAT gateway. Type: Array of strings Required: No **PrivateIpAddressCount** The number of private IP addresses to assign to the NAT gateway. You can't specify this parameter when also specifying private IP addresses. Type: Integer Valid Range: Minimum value of 1. Maximum value of 31. Required: No ## Response Elements The following elements are returned by the service. **natGatewayAddressSet** NAT gateway IP addresses. Type: Array of [NatGatewayAddress](API_NatGatewayAddress.md) objects **natGatewayId** The ID of the NAT gateway. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssignPrivateNatGatewayAddress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssignPrivateNatGatewayAddress) # AssociateAddress Associates an Elastic IP address, or carrier IP address (for instances that are in subnets in Wavelength Zones) with an instance or a network interface. Before you can use an Elastic IP address, you must allocate it to your account. If the Elastic IP address is already associated with a different instance, it is disassociated from that instance and associated with the specified instance. If you associate an Elastic IP address with an instance that has an existing Elastic IP address, the existing address is disassociated from the instance, but remains allocated to your account. [Subnets in Wavelength Zones] You can associate an IP address from the telecommunication carrier to the instance or network interface. You cannot associate an Elastic IP address with an interface in a different network border group. **Important** 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](http://aws.amazon.com/ec2/pricing/). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId** The allocation ID. This is required. Type: String Required: No **AllowReassociation** Reassociation is automatic, but you can specify false to ensure the operation fails if the Elastic IP address is already associated with another resource. Type: Boolean Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. The instance must have exactly one attached network interface. You can specify either the instance ID or the network interface ID, but not both. Type: String Required: No **NetworkInterfaceId** The ID of the network interface. If the instance has more than one network interface, you must specify a network interface ID. You can specify either the instance ID or the network interface ID, but not both. Type: String Required: No **PrivateIpAddress** 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. Type: String Required: No **PublicIp** Deprecated. Type: String Required: No ## Response Elements The following elements are returned by the service. **associationId** The ID that represents the association of the Elastic IP address with an instance. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request associates a Elastic IP address with an instance. The `AllowReassignment` parameter allows the Elastic IP address to be associated with the specified instance even if it's already associated with a different instance or a network interface. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateAddress &InstanceId=i-0598c7d356eba48d7 &AllocationId=eipalloc-5723d13e &AllowReassignment=true &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true eipassoc-fc5ca095 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateAddress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateAddress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateAddress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateAddress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateAddress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateAddress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateAddress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateAddress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateAddress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateAddress) # AssociateCapacityReservationBillingOwner Initiates a request to assign billing of the unused capacity of a shared Capacity Reservation to a consumer account that is consolidated under the same AWS organizations payer account. For more information, see [Billing assignment for shared Amazon EC2 Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the Capacity Reservation. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **UnusedReservationBillingOwnerId** The ID of the consumer account to which to assign billing. Type: String Length Constraints: Fixed length of 12. Pattern: `[0-9]{12}` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateCapacityReservationBillingOwner) # AssociateClientVpnTargetNetwork Associates a target network with a Client VPN endpoint. A target network is a subnet in a VPC. You can associate multiple subnets from the same VPC with a Client VPN endpoint. You can associate only one subnet in each Availability Zone. We recommend that you associate at least two subnets to provide Availability Zone redundancy. If you specified a VPC when you created the Client VPN endpoint or if you have previous subnet associations, the specified subnet must be in the same VPC. To specify a subnet that's in a different VPC, you must first modify the Client VPN endpoint ([ModifyClientVpnEndpoint](API_ModifyClientVpnEndpoint.md)) and change the VPC that's associated with it. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SubnetId** The ID of the subnet to associate with the Client VPN endpoint. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associationId** The unique ID of the target network association. Type: String **requestId** The ID of the request. Type: String **status** The current state of the target network association. Type: [AssociationStatus](API_AssociationStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example associates a subnet with a Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateClientVpnTargetNetwork &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &SubnetId=subnet-057fa0918fEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 7d1f819b-7f2a-4f81-aabf-81caeEXAMPLE associating cvpn-assoc-0822b0983cEXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateClientVpnTargetNetwork) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateClientVpnTargetNetwork) # AssociateDhcpOptions 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 option sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DhcpOptionsId** The ID of the DHCP options set, or `default` to associate no DHCP options with the VPC. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example associates the DHCP options with the ID `dopt-7a8b9c2d` with the VPC with the ID `vpc-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateDhcpOptions &DhcpOptionsId=dopt-7a8b9c2d &VpcId=vpc-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ### Example 2 This example changes the VPC with the ID `vpc-1a2b3c4d` to have no associated DHCP options set. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateDhcpOptions &DhcpOptionsId=default &VpcId=vpc-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateDhcpOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateDhcpOptions) # AssociateEnclaveCertificateIamRole Associates an AWS Identity and Access Management (IAM) role with an AWS Certificate Manager (ACM) certificate. This enables the certificate to be used by the ACM for Nitro Enclaves application inside an enclave. For more information, see [AWS Certificate Manager for Nitro Enclaves](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html) in the * AWS Nitro Enclaves User Guide*. When the IAM role is associated with the ACM certificate, the certificate, certificate chain, and encrypted private key are placed in an Amazon S3 location that only the associated IAM role can access. The private key of the certificate is encrypted with an AWS managed key that has an attached attestation-based key policy. To enable the IAM role to access the Amazon S3 object, you must grant it permission to call `s3:GetObject` on the Amazon S3 bucket returned by the command. To enable the IAM role to access the KMS key, you must grant it permission to call `kms:Decrypt` on the KMS key returned by the command. For more information, see [ Grant the role permission to access the certificate and encryption key](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave-refapp.html#add-policy) in the * AWS Nitro Enclaves User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CertificateArn** The ARN of the ACM certificate with which to associate the IAM role. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RoleArn** The ARN of the IAM role to associate with the ACM certificate. You can associate up to 16 IAM roles with an ACM certificate. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **certificateS3BucketName** The name of the Amazon S3 bucket to which the certificate was uploaded. Type: String **certificateS3ObjectKey** The Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored. The object key is formatted as follows: `role_arn`/`certificate_arn`. Type: String **encryptionKmsKeyId** The ID of the KMS key used to encrypt the private key of the certificate. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateEnclaveCertificateIamRole) # AssociateIamInstanceProfile Associates an IAM instance profile with a running or stopped instance. You cannot associate more than one IAM instance profile with an instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **IamInstanceProfile** The IAM instance profile. Type: [IamInstanceProfileSpecification](API_IamInstanceProfileSpecification.md) object Required: Yes **InstanceId** The ID of the instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **iamInstanceProfileAssociation** Information about the IAM instance profile association. Type: [IamInstanceProfileAssociation](API_IamInstanceProfileAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example associates the IAM instance profile with the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateIamInstanceProfile &InstanceId=i-1234567890abcdef0 &IamInstanceProfile.Name=AdminProfile &AUTHPARAMS ``` #### Sample Response ``` e10deeaf-7cda-48e7-950b-example iip-assoc-0750e3af14e2b40ad arn:aws:iam::123456789012:instance-profile/AdminProfile AIPAJEDNCAA64SSD265D6 i-1234567890abcdef0 associating ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateIamInstanceProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateIamInstanceProfile) # AssociateInstanceEventWindow Associates one or more targets with an event window. Only one type of target (instance IDs, Dedicated Host IDs, or tags) can be specified with an event window. For more information, see [Define event windows for scheduled events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationTarget** One or more targets associated with the specified event window. Type: [InstanceEventWindowAssociationRequest](API_InstanceEventWindowAssociationRequest.md) object Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceEventWindowId** The ID of the event window. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **instanceEventWindow** Information about the event window. Type: [InstanceEventWindow](API_InstanceEventWindow.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateInstanceEventWindow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateInstanceEventWindow) # AssociateIpamByoasn Associates your Autonomous System Number (ASN) with a BYOIP CIDR that you own in the same AWS Region. For more information, see [Tutorial: Bring your ASN to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) in the *Amazon VPC IPAM guide*. After the association succeeds, the ASN is eligible for advertisement. You can view the association with [DescribeByoipCidrs](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeByoipCidrs.html). You can advertise the CIDR with [AdvertiseByoipCidr](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AdvertiseByoipCidr.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Asn** A public 2-byte or 4-byte ASN. Type: String Required: Yes **Cidr** The BYOIP CIDR you want to associate with an ASN. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **asnAssociation** The ASN and BYOIP CIDR association. Type: [AsnAssociation](API_AsnAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateIpamByoasn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateIpamByoasn) # AssociateIpamResourceDiscovery Associates an IPAM resource discovery with an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A client token. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamId** An IPAM ID. Type: String Required: Yes **IpamResourceDiscoveryId** A resource discovery ID. Type: String Required: Yes **TagSpecification.N** Tag specifications. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamResourceDiscoveryAssociation** A resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. Type: [IpamResourceDiscoveryAssociation](API_IpamResourceDiscoveryAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateIpamResourceDiscovery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateIpamResourceDiscovery) # AssociateNatGatewayAddress Associates Elastic IP addresses (EIPs) and private IPv4 addresses with a public NAT gateway. For more information, see [Work with NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*. By default, you can associate up to 2 Elastic IP addresses per public NAT gateway. You can increase the limit by requesting a quota adjustment. For more information, see [Elastic IP address quotas](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-eips) in the *Amazon VPC User Guide*. **Important** When you associate an EIP or secondary EIPs with a public NAT gateway, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the EIP will fail to associate. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId.N** The allocation IDs of EIPs that you want to associate with your NAT gateway. Type: Array of strings Required: Yes **AvailabilityZone** For regional NAT gateways only: The Availability Zone where you want to associate an Elastic IP address (EIP). The regional NAT gateway uses a separate EIP in each AZ to handle outbound NAT traffic from that AZ. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region. Type: String Required: No **AvailabilityZoneId** For regional NAT gateways only: The ID of the Availability Zone where you want to associate an Elastic IP address (EIP). The regional NAT gateway uses a separate EIP in each AZ to handle outbound NAT traffic from that AZ. Use this instead of AvailabilityZone for consistent identification of AZs across AWS Regions. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NatGatewayId** The ID of the NAT gateway. Type: String Required: Yes **PrivateIpAddress.N** The private IPv4 addresses that you want to assign to the NAT gateway. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **natGatewayAddressSet** The IP addresses. Type: Array of [NatGatewayAddress](API_NatGatewayAddress.md) objects **natGatewayId** The ID of the NAT gateway. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateNatGatewayAddress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateNatGatewayAddress) # AssociateRouteServer Associates a route server with a VPC to enable dynamic route updates. A route server association is the connection established between a route server and a VPC. For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The unique identifier for the route server to be associated. Type: String Required: Yes **VpcId** The ID of the VPC to associate with the route server. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerAssociation** Information about the association between the route server and the VPC. Type: [RouteServerAssociation](API_RouteServerAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateRouteServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateRouteServer) # AssociateRouteTable 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](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GatewayId** The ID of the internet gateway or virtual private gateway. Type: String Required: No **PublicIpv4Pool** The ID of a public IPv4 pool. A public IPv4 pool is a pool of IPv4 addresses that you've brought to AWS with BYOIP. Type: String Required: No **RouteTableId** The ID of the route table. Type: String Required: Yes **SubnetId** The ID of the subnet. Type: String Required: No ## Response Elements The following elements are returned by the service. **associationId** The route table association ID. This ID is required for disassociating the route table. Type: String **associationState** The state of the association. Type: [RouteTableAssociationState](API_RouteTableAssociationState.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example associates a route table with the ID `rtb-11223344556677889` with a subnet with the ID `subnet-12345678901234567`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateRouteTable &RouteTableId=rtb-11223344556677889 &SubnetId=subnet-12345678901234567 ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE rtbassoc-04ca27a6914a0b4f ``` ### Example 2 This example associates a route table with the ID `rtb-11223344556677889` with an internet gateway with the ID `igw-1a2b3c4d1a2b3c4d1`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateRouteTable &RouteTableId=rtb-11223344556677889 &GatewayId=igw-1a2b3c4d1a2b3c4d1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateRouteTable) # AssociateSecurityGroupVpc Associates a security group with another VPC in the same Region. This enables you to use the same security group with network interfaces and instances in the specified VPC. **Note** The VPC you want to associate the security group with must be in the same Region. You can associate the security group with another VPC if your account owns the VPC or if the VPC was shared with you. You must own the security group. You cannot use this feature with default security groups. You cannot use this feature with the default VPC. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupId** A security group ID. Type: String Required: Yes **VpcId** A VPC ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **state** The state of the association. Type: String Valid Values: `associating | associated | association-failed | disassociating | disassociated | disassociation-failed` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateSecurityGroupVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateSecurityGroupVpc) # AssociateSubnetCidrBlock Associates a CIDR block with your subnet. You can only associate a single IPv6 CIDR block with your subnet. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Ipv6CidrBlock** The IPv6 CIDR block for your subnet. Type: String Required: No **Ipv6IpamPoolId** An IPv6 IPAM pool ID. Type: String Required: No **Ipv6NetmaskLength** An IPv6 netmask length. Type: Integer Required: No **SubnetId** The ID of your subnet. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipv6CidrBlockAssociation** Information about the IPv6 association. Type: [SubnetIpv6CidrBlockAssociation](API_SubnetIpv6CidrBlockAssociation.md) object **requestId** The ID of the request. Type: String **subnetId** The ID of the subnet. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example associates IPv6 CIDR block `2001:db8:1234:1a00::/64` with subnet `subnet-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateSubnetCidrBlock &SubnetId=subnet-1a2b3c4d &Ipv6CidrBlock=2001:db8:1234:1a00::/64 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE vpc-1a2b3c4d 2001:db8:1234:1a00::/64 associating subnet-cidr-assoc-3aa54053 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateSubnetCidrBlock) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateSubnetCidrBlock) # AssociateTransitGatewayMulticastDomain 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](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGatewayAttachments.html) to see the state of the attachment. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SubnetIds.N** The IDs of the subnets to associate with the transit gateway multicast domain. Type: Array of strings Required: Yes **TransitGatewayAttachmentId** The ID of the transit gateway attachment to associate with the transit gateway multicast domain. Type: String Required: Yes **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associations** Information about the transit gateway multicast domain associations. Type: [TransitGatewayMulticastDomainAssociations](API_TransitGatewayMulticastDomainAssociations.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example associates the transit gateway attachment `tgw-attach-028c1dd0f8EXAMPLE` with the multicast domain `tgw-mcast-domain-0c4905cef7EXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateTransitGatewayMulticastDomain &TransitGatewayAttachmentId=tgw-attach-028c1dd0f8EXAMPLE &TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef7EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` fa968e66-0290-4479-a8ca-e5c83EXAMPLE vpc-01128d2c24EXAMPLE vpc associating subnet-000de86e3bEXAMPLE tgw-attach-028c1dd0f8EXAMPLE tgw-mcast-domain-0c4905cef7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateTransitGatewayMulticastDomain) # AssociateTransitGatewayPolicyTable Associates the specified transit gateway attachment with a transit gateway policy table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the transit gateway attachment to associate with the policy table. Type: String Required: Yes **TransitGatewayPolicyTableId** The ID of the transit gateway policy table to associate with the transit gateway attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **association** Describes the association of a transit gateway and a transit gateway policy table. Type: [TransitGatewayPolicyTableAssociation](API_TransitGatewayPolicyTableAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateTransitGatewayPolicyTable) # AssociateTransitGatewayRouteTable Associates the specified attachment with the specified transit gateway route table. You can associate only one route table with an attachment. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **association** The ID of the association. Type: [TransitGatewayAssociation](API_TransitGatewayAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateTransitGatewayRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateTransitGatewayRouteTable) # AssociateTrunkInterface Associates a branch network interface with a trunk network interface. Before you create the association, use [CreateNetworkInterface](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateNetworkInterface.html) command and set the interface type to `trunk`. You must also create a network interface for each branch network interface that you want to associate with the trunk network interface. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BranchInterfaceId** The ID of the branch network interface. Type: String Required: Yes **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GreKey** The application key. This applies to the GRE protocol. Type: Integer Required: No **TrunkInterfaceId** The ID of the trunk network interface. Type: String Required: Yes **VlanId** The ID of the VLAN. This applies to the VLAN protocol. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String **interfaceAssociation** Information about the association between the trunk network interface and branch network interface. Type: [TrunkInterfaceAssociation](API_TrunkInterfaceAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateTrunkInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateTrunkInterface) # AssociateVpcCidrBlock 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html)). You must specify one of the following in the request: an IPv4 CIDR block, an IPv6 pool, or an Amazon-provided IPv6 CIDR block. For more information about associating CIDR blocks with your VPC and applicable restrictions, see [IP addressing for your VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AmazonProvidedIpv6CidrBlock** 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. Type: Boolean Required: No **CidrBlock** An IPv4 CIDR block to associate with the VPC. Type: String Required: No **Ipv4IpamPoolId** Associate a CIDR allocated from an IPv4 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: String Required: No **Ipv4NetmaskLength** The netmask length of the IPv4 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: Integer Required: No **Ipv6CidrBlock** An IPv6 CIDR block from the IPv6 address pool. You must also specify `Ipv6Pool` in the request. To let Amazon choose the IPv6 CIDR block for you, omit this parameter. Type: String Required: No **Ipv6CidrBlockNetworkBorderGroup** The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the CIDR block to this location. You must set `AmazonProvidedIpv6CidrBlock` to `true` to use this parameter. You can have one IPv6 CIDR block association per network border group. Type: String Required: No **Ipv6IpamPoolId** Associates a CIDR allocated from an IPv6 IPAM pool to a VPC. For more information about Amazon VPC IP Address Manager (IPAM), see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: String Required: No **Ipv6NetmaskLength** The netmask length of the IPv6 CIDR you would like to associate from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: Integer Required: No **Ipv6Pool** The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. Type: String Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **cidrBlockAssociation** Information about the IPv4 CIDR block association. Type: [VpcCidrBlockAssociation](API_VpcCidrBlockAssociation.md) object **ipv6CidrBlockAssociation** Information about the IPv6 CIDR block association. Type: [VpcIpv6CidrBlockAssociation](API_VpcIpv6CidrBlockAssociation.md) object **requestId** The ID of the request. Type: String **vpcId** The ID of the VPC. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example associates an IPv6 CIDR block with VPC `vpc-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateVpcCidrBlock &VpcId=vpc-1a2b3c4d &AmazonProvidedIpv6CidrBlock=true &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE associating vpc-cidr-assoc-e2a5408b vpc-1a2b3c4d ``` ### Example 2 This example associates the IPv4 CIDR block `10.2.0.0/16` with VPC `vpc-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AssociateVpcCidrBlock &VpcId=vpc-1a2b3c4d &CidrBlock=10.2.0.0/16 &AUTHPARAMS ``` #### Sample Response ``` 33af6c54-1139-4d50-b4f7-15a8example vpc-1a2b3c4d vpc-cidr-assoc-0280ab6b 10.2.0.0/16 associating ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AssociateVpcCidrBlock) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociateVpcCidrBlock) # AttachClassicLinkVpc **Note** This action is deprecated. Links an EC2-Classic instance to a ClassicLink-enabled VPC through one or more of the VPC security groups. You cannot link an EC2-Classic instance to more than one VPC at a time. You can only link an instance that's in the `running` state. An instance is automatically unlinked from a VPC when it's stopped - you can link it to the VPC again when you restart it. After you've linked an instance, you cannot change the VPC security groups that are associated with it. To change the security groups, you must first unlink the instance, and then link it again. Linking your instance to a VPC is sometimes referred to as *attaching* your instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the EC2-Classic instance. Type: String Required: Yes **SecurityGroupId.N** The IDs of the security groups. You cannot specify security groups from a different VPC. Type: Array of strings Required: Yes **VpcId** The ID of the ClassicLink-enabled VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AttachClassicLinkVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachClassicLinkVpc) # AttachInternetGateway Attaches an internet gateway or a virtual private gateway to a VPC, enabling connectivity between the internet and the VPC. For more information, see [Internet gateways](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InternetGatewayId** The ID of the internet gateway. Type: String Required: Yes **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example attaches the internet gateway with the ID `igw-eaad4883` to the VPC with the ID `vpc-11ad4878`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AttachInternetGateway &InternetGatewayId=igw-eaad4883 &VpcId=vpc-11ad4878 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AttachInternetGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachInternetGateway) # AttachNetworkInterface Attaches a network interface to an instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DeviceIndex** The index of the device for the network interface attachment. Type: Integer Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EnaQueueCount** The number of ENA queues to be created with the instance. Type: Integer Required: No **EnaSrdSpecification** Configures ENA Express for the network interface that this action attaches to the instance. Type: [EnaSrdSpecification](API_EnaSrdSpecification.md) object Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **NetworkCardIndex** The index of the network card. Some instance types support multiple network cards. The primary network interface must be assigned to network card index 0. The default is network card index 0. Type: Integer Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **attachmentId** The ID of the network interface attachment. Type: String **networkCardIndex** The index of the network card. Type: Integer **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example attaches the specified network interface to the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AttachNetworkInterface &DeviceIndex=1 &InstanceId=i-1234567890abcdef0 &NetworkInterfaceId=eni-ffda3197 &AUTHPARAMS ``` #### Sample Response ``` ace8cd1e-e685-4e44-90fb-92014d907212 eni-attach-d94b09b0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AttachNetworkInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachNetworkInterface) # AttachVerifiedAccessTrustProvider Attaches the specified AWS Verified Access trust provider to the specified AWS Verified Access instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: Yes **VerifiedAccessTrustProviderId** The ID of the Verified Access trust provider. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessInstance** Details about the Verified Access instance. Type: [VerifiedAccessInstance](API_VerifiedAccessInstance.md) object **verifiedAccessTrustProvider** Details about the Verified Access trust provider. Type: [VerifiedAccessTrustProvider](API_VerifiedAccessTrustProvider.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachVerifiedAccessTrustProvider) # AttachVolume Attaches an Amazon EBS volume to a `running` or `stopped` instance, and exposes it to the instance with the specified device name. **Note** The maximum number of Amazon EBS volumes that you can attach to an instance depends on the instance type. If you exceed the volume attachment limit for an instance type, the attachment request fails with the `AttachmentLimitExceeded` error. For more information, see [Instance volume limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/volume_limits.html). After you attach an EBS volume, you must make it available for use. For more information, see [Make an EBS volume available for use](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-using-volumes.html). If a volume has an AWS Marketplace product code: + The volume can be attached only to a stopped instance. + AWS Marketplace product codes are copied from the volume to the instance. + You must be subscribed to the product. + The instance type and operating system of the instance must support the product. For example, you can't detach a volume from a Windows instance and attach it to a Linux instance. For more information, see [Attach an Amazon EBS volume to an instance](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-attaching-volume.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Device** The device name (for example, `/dev/sdh` or `xvdh`). Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EbsCardIndex** The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0. Type: Integer Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **VolumeId** The ID of the EBS volume. The volume and instance must be within the same Availability Zone. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associatedResource** The ARN of the AWS-managed resource to which the volume is attached. Type: String **attachTime** The time stamp when the attachment initiated. Type: Timestamp **deleteOnTermination** Indicates whether the EBS volume is deleted on instance termination. Type: Boolean **device** The device name. If the volume is attached to an AWS-managed resource, this parameter returns `null`. Type: String **ebsCardIndex** The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0. Type: Integer **instanceId** The ID of the instance. If the volume is attached to an AWS-managed resource, this parameter returns `null`. Type: String **instanceOwningService** The service principal of the AWS service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to AWS-managed resources. Type: String **requestId** The ID of the request. Type: String **status** The attachment state of the volume. Type: String Valid Values: `attaching | attached | detaching | detached | busy` **volumeId** The ID of the volume. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example request attaches the volume with the ID `vol-1234567890abcdef0` to the instance with the ID `i-1234567890abcdef0` and exposes it as `/dev/sdh`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AttachVolume &VolumeId=vol-1234567890abcdef0 &InstanceId=i-1234567890abcdef0 &Device=/dev/sdh &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE vol-1234567890abcdef0 i-1234567890abcdef0 /dev/sdh attaching YYYY-MM-DDTHH:MM:SS.000Z ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AttachVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AttachVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AttachVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AttachVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AttachVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AttachVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AttachVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachVolume) # AttachVpnGateway Attaches an available virtual private gateway to a VPC. You can attach one virtual private gateway to one VPC at a time. For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcId** The ID of the VPC. Type: String Required: Yes **VpnGatewayId** The ID of the virtual private gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **attachment** Information about the attachment. Type: [VpcAttachment](API_VpcAttachment.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example attaches the virtual private gateway with the ID `vgw-8db04f81` to the VPC with the ID `vpc-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AttachVpnGateway &VpnGatewayId=vgw-8db04f81 &VpcId=vpc-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vpc-1a2b3c4d attaching ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AttachVpnGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachVpnGateway) # AuthorizeClientVpnIngress Adds an ingress authorization rule to a Client VPN endpoint. Ingress authorization rules act as firewall rules that grant access to networks. You must configure ingress authorization rules to enable clients to access resources in AWS or on-premises networks. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AccessGroupId** The ID of the group to grant access to, for example, the Active Directory group or identity provider (IdP) group. Required if `AuthorizeAllGroups` is `false` or not specified. Type: String Required: No **AuthorizeAllGroups** Indicates whether to grant access to all clients. Specify `true` to grant all clients who successfully establish a VPN connection access to the network. Must be set to `true` if `AccessGroupId` is not specified. Type: Boolean Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **Description** A brief description of the authorization rule. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TargetNetworkCidr** The IPv4 address range, in CIDR notation, of the network for which access is being authorized. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **status** The current state of the authorization rule. Type: [ClientVpnAuthorizationRuleStatus](API_ClientVpnAuthorizationRuleStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example adds an authorization rule to a subnet and grants access to all users. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AuthorizeClientVpnIngress &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &TargetNetworkCidr=10.0.0.0/16 &AuthorizeAllGroups=true &AUTHPARAMS ``` #### Sample Response ``` afafad8c-274c-4584-bbd1-75a21EXAMPLE authorizing ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AuthorizeClientVpnIngress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AuthorizeClientVpnIngress) # AuthorizeSecurityGroupEgress Adds the specified outbound (egress) rules to a security group. An outbound rule permits instances to send traffic to the specified IPv4 or IPv6 address ranges, the IP address ranges specified by a prefix list, or the instances that are associated with a source security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html). You must specify exactly one of the following destinations: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP type and code. Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur. For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide*. For information about security group quotas, see [Amazon VPC quotas](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CidrIp** Not supported. Use IP permissions instead. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FromPort** Not supported. Use IP permissions instead. Type: Integer Required: No **GroupId** The ID of the security group. Type: String Required: Yes **IpPermissions.N** The permissions for the security group rules. Type: Array of [IpPermission](API_IpPermission.md) objects Required: No **IpProtocol** Not supported. Use IP permissions instead. Type: String Required: No **SourceSecurityGroupName** Not supported. Use IP permissions instead. Type: String Required: No **SourceSecurityGroupOwnerId** Not supported. Use IP permissions instead. Type: String Required: No **TagSpecification.N** The tags applied to the security group rule. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **ToPort** Not supported. Use IP permissions instead. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, returns an error. Type: Boolean **securityGroupRuleSet** Information about the outbound (egress) security group rules that were added. Type: Array of [SecurityGroupRule](API_SecurityGroupRule.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example request grants your security group with the ID `sg-1a2b3c4d` access to the `192.0.2.0/24` and `198.51.100.0/24` IPv4 address ranges on TCP port 80. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress &GroupId=sg-1a2b3c4d &IpPermissions.1.IpProtocol=tcp &IpPermissions.1.FromPort=80 &IpPermissions.1.ToPort=80 &IpPermissions.1.IpRanges.1.CidrIp=192.0.2.0/24 &IpPermissions.1.IpRanges.2.CidrIp=198.51.100.0/24 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ### Example 2 This example request grants egress access from the security group with the ID `sg-1a2b3c4d` to the security group with the ID `sg-9a8d7f5c` on TCP port 1433. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress &GroupId=sg-1a2b3c4d &IpPermissions.1.IpProtocol=tcp &IpPermissions.1.FromPort=1433 &IpPermissions.1.ToPort=1433 &IpPermissions.1.Groups.1.GroupId=sg-9a8d7f5c &AUTHPARAMS ``` ### Example 3 This example request grants your security group with the ID `sg-1a2b3c4d` access to the `2001:db8:1234:1a00::/64` IPv6 address range on TCP port 22. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress &GroupId=sg-1a2b3c4d &IpPermissions.1.IpProtocol=tcp &IpPermissions.1.FromPort=22 &IpPermissions.1.ToPort=22 &IpPermissions.1.Ipv6Ranges.1.CidrIpv6=2001:db8:1234:1a00::/64 &AUTHPARAMS ``` ### Example 4 This example grants access over port 3389 (RDP) to the `192.0.2.0/24` IPv4 address range, and includes a description for the rule to help you identify the rule later. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupEgress &GroupId=sg-112233 &IpPermissions.1.IpProtocol=tcp &IpPermissions.1.FromPort=3389 &IpPermissions.1.ToPort=3389 &IpPermissions.1.IpRanges.1.CidrIp=192.0.2.0/24 &IpPermissions.1.IpRanges.1.Description=Access to London office ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AuthorizeSecurityGroupEgress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AuthorizeSecurityGroupEgress) # AuthorizeSecurityGroupIngress Adds the specified inbound (ingress) rules to a security group. An inbound rule permits instances to receive traffic from the specified IPv4 or IPv6 address range, the IP address ranges that are specified by a prefix list, or the instances that are associated with a destination security group. For more information, see [Security group rules](https://docs.aws.amazon.com/vpc/latest/userguide/security-group-rules.html). You must specify exactly one of the following sources: an IPv4 or IPv6 address range, a prefix list, or a security group. You must specify a protocol for each rule (for example, TCP). If the protocol is TCP or UDP, you must also specify a port or port range. If the protocol is ICMP or ICMPv6, you must also specify the ICMP/ICMPv6 type and code. Rule changes are propagated to instances associated with the security group as quickly as possible. However, a small delay might occur. For examples of rules that you can add to security groups for specific access scenarios, see [Security group rules for different use cases](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-rules-reference.html) in the *Amazon EC2 User Guide*. For more information about security group quotas, see [Amazon VPC quotas](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CidrIp** The IPv4 address range, in CIDR format. AWS [canonicalizes](https://en.wikipedia.org/wiki/Canonicalization) IPv4 and IPv6 CIDRs. For example, if you specify 100.68.0.18/18 for the CIDR block, AWS canonicalizes the CIDR block to 100.68.0.0/18. Any subsequent DescribeSecurityGroups and DescribeSecurityGroupRules calls will return the canonicalized form of the CIDR block. Additionally, if you attempt to add another rule with the non-canonical form of the CIDR (such as 100.68.0.18/18) and there is already a rule for the canonicalized form of the CIDR block (such as 100.68.0.0/18), the API throws an duplicate rule error. To specify an IPv6 address range, use IP permissions instead. To specify multiple rules and descriptions for the rules, use IP permissions instead. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FromPort** If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types). To specify multiple rules and descriptions for the rules, use IP permissions instead. Type: Integer Required: No **GroupId** The ID of the security group. Type: String Required: No **GroupName** [Default VPC] The name of the security group. For security groups for a default VPC you can specify either the ID or the name of the security group. For security groups for a nondefault VPC, you must specify the ID of the security group. Type: String Required: No **IpPermissions.N** The permissions for the security group rules. Type: Array of [IpPermission](API_IpPermission.md) objects Required: No **IpProtocol** The IP protocol name (`tcp`, `udp`, `icmp`) or number (see [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). To specify all protocols, use `-1`. To specify `icmpv6`, use IP permissions instead. If you specify a protocol other than one of the supported values, traffic is allowed on all ports, regardless of any ports that you specify. To specify multiple rules and descriptions for the rules, use IP permissions instead. Type: String Required: No **SourceSecurityGroupName** [Default VPC] The name of the source security group. The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, specify a set of IP permissions instead. Type: String Required: No **SourceSecurityGroupOwnerId** The AWS account ID for the source security group, if the source security group is in a different account. The rule grants full ICMP, UDP, and TCP access. To create a rule with a specific protocol and port range, use IP permissions instead. Type: String Required: No **TagSpecification.N** The tags applied to the security group rule. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **ToPort** If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes). If the start port is -1 (all ICMP types), then the end port must be -1 (all ICMP codes). To specify multiple rules and descriptions for the rules, use IP permissions instead. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, returns an error. Type: Boolean **securityGroupRuleSet** Information about the inbound (ingress) security group rules that were added. Type: Array of [SecurityGroupRule](API_SecurityGroupRule.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example request grants TCP port 80 access from the source group `sg-2a2b3c4d` to the security group `sg-1a2b3c4d`. The source security group must be in the same VPC or in a peer VPC (requires a VPC peering connection). #### Sample Request ``` https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress &GroupId=sg-1a2b3c4d &IpPermissions.1.IpProtocol=tcp &IpPermissions.1.FromPort=80 &IpPermissions.1.ToPort=80 &IpPermissions.1.Groups.1.GroupId=sg-2a2b3c4d &AUTHPARAMS ``` ### Example 2 This example grants SSH access (port 22) from the IPv6 range `2001:db8:1234:1a00::/64`. #### Sample Request ``` https://ec2.amazonaws.com/ ?Action=AuthorizeSecurityGroupIngress &GroupId=sg-1a2b3c4d &IpPermissions.1.IpProtocol=tcp &IpPermissions.1.FromPort=22 &IpPermissions.1.ToPort=22 &IpPermissions.1.Ipv6Ranges.1.CidrIpv6=2001:db8:1234:1a00::/64 &AUTHPARAMS ``` ### Example 3 This example grants access over port 3389 (RDP) from the `192.0.2.0/24` IPv4 address range, and includes a description for the rule to help you identify the rule later. #### Sample Request ``` https://ec2.amazonaws.com/?Action=AuthorizeSecurityGroupIngress &GroupId=sg-112233 &IpPermissions.1.IpProtocol=tcp &IpPermissions.1.FromPort=3389 &IpPermissions.1.ToPort=3389 &IpPermissions.1.IpRanges.1.CidrIp=192.0.2.0/24 &IpPermissions.1.IpRanges.1.Description=Access from New York office ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/AuthorizeSecurityGroupIngress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AuthorizeSecurityGroupIngress) # BundleInstance Bundles an Amazon instance store-backed Windows instance. During bundling, only the root device volume (C:\$1) is bundled. Data on other instance store volumes is not preserved. **Note** This action is no longer supported. To create an AMI, use [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html). For more information, see [ Create an Amazon EBS-backed AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance to bundle. Default: None Type: String Required: Yes **Storage** The bucket in which to store the AMI. You can specify a bucket that you already own or a new bucket that Amazon EC2 creates on your behalf. If you specify a bucket that belongs to someone else, Amazon EC2 returns an error. Type: [Storage](API_Storage.md) object Required: Yes ## Response Elements The following elements are returned by the service. **bundleInstanceTask** Information about the bundle task. Type: [BundleTask](API_BundleTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request bundles the specified instance. Before you specify a value for your access key ID, review and follow the guidance in [Best Practices for AWS accounts](https://docs.aws.amazon.com/accounts/latest/reference/best-practices.html) in the * AWS Account Management Reference Guide*. #### Sample Request ``` https://ec2.amazonaws.com/?Action=BundleInstance &InstanceId=i-1234567890abcdef0 &Storage.S3.AWSAccessKeyId='AKIAIOSFODNN7EXAMPLE' &Storage.S3.Bucket=myawsbucket &Storage.S3.Prefix=winami &Storage.S3.UploadPolicy=eyJleHBpcmF0aW9uIjogIjIwMDgtMDgtMzBUMDg6NDk6MD laIiwiY29uZGl0aW9ucyI6IFt7ImJ1Y2tldCI6ICJteS1idWNrZXQifSxbInN0YXJ0cy13aXRoIiwgI iRrZXkiLCAibXktbmV3LWltYWdlIl0seyJhY2wiOiAiZWMyLWJ1bmRsZS1yZWFkIn1dfEXAMPLE &Storage.S3.UploadPolicySignature=fh5tyyyQD8W4COEthj3nlGNEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 bun-c1a540a8 bundling 2008-10-07T11:41:50.000Z 2008-10-07T11:51:50.000Z 70% myawsbucket winami ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/BundleInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/BundleInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BundleInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/BundleInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BundleInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/BundleInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/BundleInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/BundleInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/BundleInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BundleInstance) # CancelBundleTask Cancels a bundling operation for an instance store-backed Windows instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BundleId** The ID of the bundle task. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **bundleInstanceTask** Information about the bundle task. Type: [BundleTask](API_BundleTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request cancels the specified bundle task. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CancelBundleTask &BundleId=bun-cla322b9 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 bun-cla322b9 canceling 2008-10-07T11:41:50.000Z 2008-10-07T11:51:50.000Z 20% myawsbucket my-new-image ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelBundleTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelBundleTask) # CancelCapacityReservation Cancels the specified Capacity Reservation, releases the reserved capacity, and changes the Capacity Reservation's state to `cancelled`. You can cancel a Capacity Reservation that is in the following states: + `assessing` + `active` and there is no commitment duration or the commitment duration has elapsed. You can't cancel a future-dated Capacity Reservation during the commitment duration. **Note** You can't modify or cancel a Capacity Block. For more information, see [Capacity Blocks for ML](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-blocks.html). If a future-dated Capacity Reservation enters the `delayed` state, the commitment duration is waived, and you can cancel it as soon as it enters the `active` state. Instances running in the reserved capacity continue running until you stop them. Stopped instances that target the Capacity Reservation can no longer launch. Modify these instances to either target a different Capacity Reservation, launch On-Demand Instance capacity, or run in any open Capacity Reservation that has matching attributes and sufficient capacity. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the Capacity Reservation to be cancelled. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelCapacityReservation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelCapacityReservation) # CancelCapacityReservationFleets Cancels one or more Capacity Reservation Fleets. When you cancel a Capacity Reservation Fleet, the following happens: + The Capacity Reservation Fleet's status changes to `cancelled`. + The individual Capacity Reservations in the Fleet are cancelled. Instances running in the Capacity Reservations at the time of cancelling the Fleet continue to run in shared capacity. + The Fleet stops creating new Capacity Reservations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationFleetId.N** The IDs of the Capacity Reservation Fleets to cancel. Type: Array of strings Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **failedFleetCancellationSet** Information about the Capacity Reservation Fleets that could not be cancelled. Type: Array of [FailedCapacityReservationFleetCancellationResult](API_FailedCapacityReservationFleetCancellationResult.md) objects **requestId** The ID of the request. Type: String **successfulFleetCancellationSet** Information about the Capacity Reservation Fleets that were successfully cancelled. Type: Array of [CapacityReservationFleetCancellationState](API_CapacityReservationFleetCancellationState.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelCapacityReservationFleets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelCapacityReservationFleets) # CancelConversionTask Cancels an active conversion task. The task can be the import of an instance or volume. The action removes all artifacts of the conversion, including a partially uploaded volume or instance. If the conversion is complete or is in the process of transferring the final disk image, the command fails and returns an exception. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ConversionTaskId** The ID of the conversion task. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReasonMessage** The reason for canceling the conversion task. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request cancels the conversion task with the ID `import-i-fh95npoc`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CancelConversionTask &ConversionTaskId=import-i-fh95npoc &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelConversionTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelConversionTask) # CancelDeclarativePoliciesReport Cancels the generation of an account status report. You can only cancel a report while it has the `running` status. Reports with other statuses (`complete`, `cancelled`, or `error`) can't be canceled. For more information, see [Generating the account status report for declarative policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_declarative_status-report.html) in the * AWS Organizations User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReportId** The ID of the report. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelDeclarativePoliciesReport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelDeclarativePoliciesReport) # CancelExportTask Cancels an active export task. The request removes all artifacts of the export, including any partially-created Amazon S3 objects. If the export task is complete or is in the process of transferring the final disk image, the command fails and returns an error. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ExportTaskId** The ID of the export task. This is the ID returned by the `CreateInstanceExportTask` and `ExportImage` operations. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request cancels the export task with the ID `export-i-1234wxyz`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CancelExportTask &exportTaskId=export-i-1234wxyz &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelExportTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelExportTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelExportTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelExportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelExportTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelExportTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelExportTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelExportTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelExportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelExportTask) # CancelImageLaunchPermission Removes your AWS account from the launch permissions for the specified AMI. For more information, see [Cancel having an AMI shared with your AWS account](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cancel-sharing-an-AMI.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI that was shared with your AWS account. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelImageLaunchPermission) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelImageLaunchPermission) # CancelImportTask Cancels an in-process import virtual machine or import snapshot task. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CancelReason** The reason for canceling the task. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImportTaskId** The ID of the import image or import snapshot task to be canceled. Type: String Required: No ## Response Elements The following elements are returned by the service. **importTaskId** The ID of the task being canceled. Type: String **previousState** The current state of the task being canceled. Type: String **requestId** The ID of the request. Type: String **state** The current state of the task being canceled. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelImportTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelImportTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelImportTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelImportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelImportTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelImportTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelImportTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelImportTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelImportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelImportTask) # CancelReservedInstancesListing Cancels the specified Reserved Instance listing in the Reserved Instance Marketplace. For more information, see [Sell in the Reserved Instance Marketplace](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ReservedInstancesListingId** The ID of the Reserved Instance listing. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **reservedInstancesListingsSet** The Reserved Instance listing. Type: Array of [ReservedInstancesListing](API_ReservedInstancesListing.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request cancels a Reserved Instance listing in the Reserved Instance Marketplace. The response shows that the status is cancelled. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CancelReservedInstancesListing &ReservedInstancesListingId=3ebe97b5-f273-43b6-a204-7a18cEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` bec2cf62-98ef-434a-8a15-886fcexample 3ebe97b5-f273-43b6-a204-7a18cEXAMPLE e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE 2012-07-12T16:55:28.000Z 2012-07-12T16:55:28.000Z cancelled CANCELLED Available 0 Sold 0 Cancelled 1 Pending 0 5 166.64 USD false 4 133.32 USD false 3 99.99 USD false 2 66.66 USD false 1 33.33 USD false XqJIt1342112125076 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelReservedInstancesListing) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelReservedInstancesListing) # CancelSpotFleetRequests Cancels the specified Spot Fleet requests. After you cancel a Spot Fleet request, the Spot Fleet launches no new instances. You must also specify whether a canceled Spot Fleet request should terminate its instances. If you choose to terminate the instances, the Spot Fleet request enters the `cancelled_terminating` state. Otherwise, the Spot Fleet request enters the `cancelled_running` state and the instances continue to run until they are interrupted or you terminate them manually. **Important** **Terminating an instance is permanent and irreversible.** After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more information, see [ How instance termination works](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-ec2-instance-termination-works.html). Before you terminate an instance, ensure that you have backed up all data that you need to retain after the termination to persistent storage. **Restrictions** + You can delete up to 100 fleets in a single request. If you exceed the specified number, no fleets are deleted. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SpotFleetRequestId.N** The IDs of the Spot Fleet requests. Constraint: You can specify up to 100 IDs in a single request. Type: Array of strings Required: Yes **TerminateInstances** Indicates whether to terminate the associated instances when the Spot Fleet request is canceled. The default is to terminate the instances. To let the instances continue to run after the Spot Fleet request is canceled, specify `no-terminate-instances`. Type: Boolean Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successfulFleetRequestSet** Information about the Spot Fleet requests that are successfully canceled. Type: Array of [CancelSpotFleetRequestsSuccessItem](API_CancelSpotFleetRequestsSuccessItem.md) objects **unsuccessfulFleetRequestSet** Information about the Spot Fleet requests that are not successfully canceled. Type: Array of [CancelSpotFleetRequestsErrorItem](API_CancelSpotFleetRequestsErrorItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example cancels Spot Fleet request sfr-123f8fc2-cb31-425e-abcd-example2710 and terminates all instances that were launched by the request. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CancelSpotFleetRequests &SpotFleetRequestId.1=sfr-123f8fc2-cb31-425e-abcd-example2710 &TerminateInstances=true &AUTHPARAMS ``` #### Sample Response ``` e12d2fe5-6503-4b4b-911c-example sfr-123f8fc2-cb31-425e-abcd-example2710 cancelled_terminating active ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelSpotFleetRequests) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelSpotFleetRequests) # CancelSpotInstanceRequests Cancels one or more Spot Instance requests. **Important** Canceling a Spot Instance request does not terminate running Spot Instances associated with the request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SpotInstanceRequestId.N** The IDs of the Spot Instance requests. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **spotInstanceRequestSet** The Spot Instance requests. Type: Array of [CancelledSpotInstanceRequest](API_CancelledSpotInstanceRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example cancels the specified Spot Instance request. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CancelSpotInstanceRequests &SpotInstanceRequestId.1=sir-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE sir-1a2b3c4d cancelled ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CancelSpotInstanceRequests) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelSpotInstanceRequests) # ConfirmProductInstance Determines whether a product code is associated with an instance. This action can only be used by the owner of the product code. It is useful when a product code owner must verify whether another user's instance is eligible for support. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **ProductCode** The product code. This must be a product code that you own. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ownerId** The AWS account ID of the instance owner. This is only present if the product code is attached to the instance. Type: String **requestId** The ID of the request. Type: String **return** The return value of the request. Returns `true` if the specified product code is owned by the requester and associated with the specified instance. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example determines whether the specified product code is associated with the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ConfirmProductInstance &ProductCode=774F4FF8 &InstanceId=i-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true 111122223333 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ConfirmProductInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConfirmProductInstance) # CopyFpgaImage Copies the specified Amazon FPGA Image (AFI) to the current Region. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** The description for the new AFI. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Name** The name for the new AFI. The default is the name of the source AFI. Type: String Required: No **SourceFpgaImageId** The ID of the source AFI. Type: String Required: Yes **SourceRegion** The Region that contains the source AFI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **fpgaImageId** The ID of the new AFI. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example copies the specified AFI from the `us-east-1` Region to the current Region (`eu-west-1`). #### Sample Request ``` https://ec2.eu-west-1.amazonaws.com/?Action=CopyFpgaImage &Name=eu-afi &SourceFpgaImageId=afi-0d123eabcbfc85456 &SourceRegion=us-east-1 &AUTHPARAMS ``` #### Sample Response ``` 2d55d021-9ca9-45a1-8c5c-453example afi-06b12350a123fbabc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CopyFpgaImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CopyFpgaImage) # CopyImage Initiates an AMI copy operation. You must specify the source AMI ID and both the source and destination locations. The copy operation must be initiated in the destination Region. **CopyImage supports the following source to destination copies:** + Region to Region + Region to Outpost + Parent Region to Local Zone + Local Zone to parent Region + Between Local Zones with the same parent Region (only supported for certain Local Zones) **CopyImage does not support the following source to destination copies:** + Local Zone to non-parent Regions + Between Local Zones with different parent Regions + Local Zone to Outpost + Outpost to Local Zone + Outpost to Region + Between Outposts + Within same Outpost + Cross-partition copies (use [CreateStoreImageTask](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html) instead) **Destination specification** + Region to Region: The destination Region is the Region in which you initiate the copy operation. + Region to Outpost: Specify the destination using the `DestinationOutpostArn` parameter (the ARN of the Outpost) + Region to Local Zone, and Local Zone to Local Zone copies: Specify the destination using the `DestinationAvailabilityZone` parameter (the name of the destination Local Zone) or `DestinationAvailabilityZoneId` parameter (the ID of the destination Local Zone). **Snapshot encryption** + Region to Outpost: Backing snapshots copied to an Outpost are encrypted by default using the default encryption key for the Region or the key that you specify. Outposts do not support unencrypted snapshots. + Region to Local Zone, and Local Zone to Local Zone: Not all Local Zones require encrypted snapshots. In Local Zones that require encrypted snapshots, backing snapshots are automatically encrypted during copy. In Local Zones where encryption is not required, snapshots retain their original encryption state (encrypted or unencrypted) by default. For more information, including the required permissions for copying an AMI, see [Copy an Amazon EC2 AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/CopyingAMIs.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see [Ensuring idempotency in Amazon EC2 API requests](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html) in the *Amazon EC2 API Reference*. Type: String Required: No **CopyImageTags** Specifies whether to copy your user-defined AMI tags to the new AMI. The following tags are not be copied: + System tags (prefixed with `aws:`) + For public and shared AMIs, user-defined tags that are attached by other AWS accounts Default: Your user-defined AMI tags are not copied. Type: Boolean Required: No **Description** A description for the new AMI. Type: String Required: No **DestinationAvailabilityZone** The Local Zone for the new AMI (for example, `cn-north-1-pkx-1a`). Only one of `DestinationAvailabilityZone`, `DestinationAvailabilityZoneId`, or `DestinationOutpostArn` can be specified. Type: String Required: No **DestinationAvailabilityZoneId** The ID of the Local Zone for the new AMI (for example, `cnn1-pkx1-az1`). Only one of `DestinationAvailabilityZone`, `DestinationAvailabilityZoneId`, or `DestinationOutpostArn` can be specified. Type: String Required: No **DestinationOutpostArn** The Amazon Resource Name (ARN) of the Outpost for the new AMI. Only specify this parameter when copying an AMI from an AWS Region to an Outpost. The AMI must be in the Region of the destination Outpost. You can't copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost. For more information, see [Copy AMIs from an AWS Region to an Outpost](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-amis) in the *Amazon EBS User Guide*. Only one of `DestinationAvailabilityZone`, `DestinationAvailabilityZoneId`, or `DestinationOutpostArn` can be specified. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Encrypted** Specifies whether to encrypt the snapshots of the copied image. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) KMS key using `KmsKeyId`. For more information, see [Use encryption with EBS-backed AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html) in the *Amazon EC2 User Guide*. Type: Boolean Required: No **KmsKeyId** The identifier of the symmetric AWS Key Management Service (AWS KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your AWS managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to `true`. You can specify a KMS key using any of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. For example, alias/ExampleAlias. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails. The specified KMS key must exist in the destination Region. Amazon EBS does not support asymmetric KMS keys. Type: String Required: No **Name** The name of the new AMI. Type: String Required: Yes **SnapshotCopyCompletionDurationMinutes** Specify a completion duration, in 15 minute increments, to initiate a time-based AMI copy. The specified completion duration applies to each of the snapshots associated with the AMI. Each snapshot associated with the AMI will be completed within the specified completion duration, with copy throughput automatically adjusted for each snapshot based on its size to meet the timing target. If you do not specify a value, the AMI copy operation is completed on a best-effort basis. This parameter is not supported when copying an AMI to or from a Local Zone, or to an Outpost. For more information, see [Time-based copies for Amazon EBS snapshots and EBS-backed AMIs](https://docs.aws.amazon.com/ebs/latest/userguide/time-based-copies.html). Type: Long Required: No **SourceImageId** The ID of the AMI to copy. Type: String Required: Yes **SourceRegion** The name of the Region that contains the AMI to copy. Type: String Required: Yes **TagSpecification.N** The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both. + To tag the new AMI, the value for `ResourceType` must be `image`. + To tag the new snapshots, the value for `ResourceType` must be `snapshot`. The same tag is applied to all the new snapshots. If you specify other values for `ResourceType`, the request fails. To tag an AMI or snapshot after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **imageId** The ID of the new AMI. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request copies the AMI in `us-west-2` with the ID `ami-1a2b3c4d`, naming the new AMI `My-Standard-AMI`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CopyImage &SourceRegion=us-west-2 &SourceImageId=ami-1a2b3c4d &Name=My-Standard-AMI &Description=This%20is%20the%20new%20version%20of%20My-Standard-AMI &ClientToken=550e8400-e29b-41d4-a716-446655440000 &AUTHPARAMS ``` #### Sample Response ``` 60bc441d-fa2c-494d-b155-5d6a3EXAMPLE ami-4d3c2b1a ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CopyImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CopyImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CopyImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CopyImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CopyImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CopyImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CopyImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CopyImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CopyImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CopyImage) # CopySnapshot Creates an exact copy of an Amazon EBS snapshot. The location of the source snapshot determines whether you can copy it or not, and the allowed destinations for the snapshot copy. + If the source snapshot is in a Region, you can copy it within that Region, to another Region, to an Outpost associated with that Region, or to a Local Zone in that Region. + If the source snapshot is in a Local Zone, you can copy it within that Local Zone, to another Local Zone in the same zone group, or to the parent Region of the Local Zone. + If the source snapshot is on an Outpost, you can't copy it. When copying snapshots to a Region, the encryption outcome for the snapshot copy depends on the Amazon EBS encryption by default setting for the destination Region, the encryption status of the source snapshot, and the encryption parameters you specify in the request. For more information, see [ Encryption and snapshot copying](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-copy-snapshot.html#creating-encrypted-snapshots). Snapshots copied to an Outpost must be encrypted. Unencrypted snapshots are not supported on Outposts. For more information, [ Amazon EBS local snapshots on Outposts](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#considerations). **Note** Snapshots copies have an arbitrary source volume ID. Do not use this volume ID for any purpose. For more information, see [Copy an Amazon EBS snapshot](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-copy-snapshot.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CompletionDurationMinutes** Not supported when copying snapshots to or from Local Zones or Outposts. Specify a completion duration, in 15 minute increments, to initiate a time-based snapshot copy. Time-based snapshot copy operations complete within the specified duration. For more information, see [ Time-based copies](https://docs.aws.amazon.com/ebs/latest/userguide/time-based-copies.html). If you do not specify a value, the snapshot copy operation is completed on a best-effort basis. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2880. Required: No **Description** A description for the EBS snapshot. Type: String Required: No **DestinationAvailabilityZone** The Local Zone, for example, `cn-north-1-pkx-1a` to which to copy the snapshot. Only supported when copying a snapshot to a Local Zone. Type: String Required: No **DestinationOutpostArn** The Amazon Resource Name (ARN) of the Outpost to which to copy the snapshot. Only supported when copying a snapshot to an Outpost. For more information, see [ Copy snapshots from an AWS Region to an Outpost](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#copy-snapshots) in the *Amazon EBS User Guide*. Type: String Required: No **DestinationRegion** The destination Region to use in the `PresignedUrl` parameter of a snapshot copy operation. This parameter is only valid for specifying the destination Region in a `PresignedUrl` parameter, where it is required. The snapshot copy is sent to the regional endpoint that you sent the HTTP request to (for example, `ec2.us-east-1.amazonaws.com`). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Encrypted** To encrypt a copy of an unencrypted snapshot if encryption by default is not enabled, enable encryption using this parameter. Otherwise, omit this parameter. Copies of encrypted snapshots are encrypted, even if you omit this parameter and encryption by default is not enabled. You cannot set this parameter to false. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. Type: Boolean Required: No **KmsKeyId** The identifier of the AWS KMS key to use for Amazon EBS encryption. If this parameter is not specified, your AWS KMS key for Amazon EBS is used. If `KmsKeyId` is specified, the encrypted state must be `true`. You can specify the KMS key using any of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. For example, alias/ExampleAlias. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails. Type: String Required: No **PresignedUrl** When you copy an encrypted source snapshot using the Amazon EC2 Query API, you must supply a pre-signed URL. This parameter is optional for unencrypted snapshots. For more information, see [Query requests](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html). The `PresignedUrl` should use the snapshot source endpoint, the `CopySnapshot` action, and include the `SourceRegion`, `SourceSnapshotId`, and `DestinationRegion` parameters. The `PresignedUrl` must be signed using AWS Signature Version 4. Because EBS snapshots are stored in Amazon S3, the signing algorithm for this parameter uses the same logic that is described in [ Authenticating Requests: Using Query Parameters (AWS Signature Version 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html) in the *Amazon S3 API Reference*. An invalid or improperly signed `PresignedUrl` will cause the copy operation to fail asynchronously, and the snapshot will move to an `error` state. Type: String Required: No **SourceRegion** The ID of the Region that contains the snapshot to be copied. Type: String Required: Yes **SourceSnapshotId** The ID of the EBS snapshot to copy. Type: String Required: Yes **TagSpecification.N** The tags to apply to the new snapshot. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **snapshotId** The ID of the new snapshot. Type: String **tagSet** Any tags applied to the new snapshot. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Create copy of an unencrypted snapshot in the same Region as the original This example request copies the snapshot in the us-west-1 Region with the ID `snap-1234567890abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CopySnapshot &SourceRegion=us-west-1 &SourceSnapshotId=snap-1234567890abcdef0 &Description=My_snapshot &AUTHPARAMS ``` #### Sample Response ``` 60bc441d-fa2c-494d-b155-5d6a3EXAMPLE snap-1234567890abcdef1 This example request copies an encrypted snapshot in the us-west-1 Region to the us-east-1 Region with the ID `snap-0987654321abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?SourceSnapshotId=snap-005a01bf6eEXAMPLE &SourceRegion=us-west-1 &KmsKeyId=arn%3Aaws%3Akms%3Aus-west-2%3A210774411744%3Akey%2FfEXAMPLE-24bc-479b-a9da-7132eEXAMPLE &Action=CopySnapshot &Encrypted=true &DestinationRegion=us-east-1 &AUTHPARAMS ``` #### Sample Response ``` 256f6c57-6648-4544-a79a-35a03EXAMPLE snap-0987654321abcdef0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CopySnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CopySnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CopySnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CopySnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CopySnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CopySnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CopySnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CopySnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CopySnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CopySnapshot) # CopyVolumes Creates a crash-consistent, point-in-time copy of an existing Amazon EBS volume within the same Availability Zone. The volume copy can be attached to an Amazon EC2 instance once it reaches the `available` state. For more information, see [Copy an Amazon EBS volume](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-copying-volume.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [ Ensure Idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Iops** The number of I/O operations per second (IOPS) to provision for the volume copy. Required for `io1` and `io2` volumes. Optional for `gp3` volumes. Omit for all other volume types. Full provisioned IOPS performance can be achieved only once the volume copy is fully initialized. Valid ranges: + gp3: `3,000 `(*default*)` - 80,000` IOPS + io1: `100 - 64,000` IOPS + io2: `100 - 256,000` IOPS [ Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS. Type: Integer Required: No **MultiAttachEnabled** Indicates whether to enable Amazon EBS Multi-Attach for the volume copy. If you enable Multi-Attach, you can attach the volume to up to 16 Nitro instances in the same Availability Zone simultaneously. Supported with `io1` and `io2` volumes only. For more information, see [ Amazon EBS Multi-Attach](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html). Type: Boolean Required: No **Size** The size of the volume copy, in GiBs. The size must be equal to or greater than the size of the source volume. If not specified, the size defaults to the size of the source volume. Maximum supported sizes: + gp2: `16,384` GiB + gp3: `65,536` GiB + io1: `16,384` GiB + io2: `65,536` GiB + st1 and sc1: `16,384` GiB + standard: `1024` GiB Type: Integer Required: No **SourceVolumeId** The ID of the source EBS volume to copy. Type: String Required: Yes **TagSpecification.N** The tags to apply to the volume copy during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Throughput** The throughput to provision for the volume copy, in MiB/s. Supported for `gp3` volumes only. Omit for all other volume types. Full provisioned throughput performance can be achieved only once the volume copy is fully initialized. Valid Range: `125 - 2000` MiB/s Type: Integer Required: No **VolumeType** The volume type for the volume copy. If not specified, the volume type defaults to `gp2`. Type: String Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **volumeSet** Information about the volume copy. Type: Array of [Volume](API_Volume.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CopyVolumes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CopyVolumes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CopyVolumes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CopyVolumes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CopyVolumes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CopyVolumes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CopyVolumes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CopyVolumes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CopyVolumes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CopyVolumes) # CreateCapacityManagerDataExport Creates a new data export configuration for EC2 Capacity Manager. This allows you to automatically export capacity usage data to an S3 bucket on a scheduled basis. The exported data includes metrics for On-Demand, Spot, and Capacity Reservations usage across your organization. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see Ensure Idempotency. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **OutputFormat** The file format for the exported data. Parquet format is recommended for large datasets and better compression. Type: String Valid Values: `csv | parquet` Required: Yes **S3BucketName** The name of the S3 bucket where the capacity data export files will be delivered. The bucket must exist and you must have write permissions to it. Type: String Required: Yes **S3BucketPrefix** The S3 key prefix for the exported data files. This allows you to organize exports in a specific folder structure within your bucket. If not specified, files are placed at the bucket root. Type: String Required: No **Schedule** The frequency at which data exports are generated. Type: String Valid Values: `hourly` Required: Yes **TagSpecification.N** The tags to apply to the data export configuration. You can tag the export for organization and cost tracking purposes. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **capacityManagerDataExportId** The unique identifier for the created data export configuration. Use this ID to reference the export in other API calls. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a data export configuration that delivers hourly Parquet files to an S3 bucket. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateCapacityManagerDataExport &S3BucketName=my-capacity-exports-bucket &S3BucketPrefix=capacity-data/ &Schedule=hourly &OutputFormat=parquet &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE cmde-0abcd1234EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCapacityManagerDataExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCapacityManagerDataExport) # CreateCapacityReservation Creates a new Capacity Reservation with the specified attributes. Capacity Reservations enable you to reserve capacity for your Amazon EC2 instances in a specific Availability Zone for any duration. You can create a Capacity Reservation at any time, and you can choose when it starts. You can create a Capacity Reservation for immediate use or you can request a Capacity Reservation for a future date. For more information, see [ Reserve compute capacity with On-Demand Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide*. Your request to create a Capacity Reservation could fail if: + Amazon EC2 does not have sufficient capacity. In this case, try again at a later time, try in a different Availability Zone, or request a smaller Capacity Reservation. If your workload is flexible across instance types and sizes, try with different instance attributes. + The requested quantity exceeds your On-Demand Instance quota. In this case, increase your On-Demand Instance quota for the requested instance type and try again. For more information, see [ Amazon EC2 Service Quotas](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-resource-limits.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** The Availability Zone in which to create the Capacity Reservation. Type: String Required: No **AvailabilityZoneId** The ID of the Availability Zone in which to create the Capacity Reservation. Type: String Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **CommitmentDuration** Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter. Specify a commitment duration, in seconds, for the future-dated Capacity Reservation. The commitment duration is a minimum duration for which you commit to having the future-dated Capacity Reservation in the `active` state in your account after it has been delivered. For more information, see [ Commitment duration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-concepts.html#cr-commitment-duration). Type: Long Valid Range: Minimum value of 1. Maximum value of 200000000. Required: No **DeliveryPreference** Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter. Indicates that the requested capacity will be delivered in addition to any running instances or reserved capacity that you have in your account at the requested date and time. The only supported value is `incremental`. Type: String Valid Values: `fixed | incremental` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EbsOptimized** Indicates whether the Capacity Reservation supports EBS-optimized instances. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS- optimized instance. Type: Boolean Required: No **EndDate** The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to `expired` when it reaches its end date and time. You must provide an `EndDate` value if `EndDateType` is `limited`. Omit `EndDate` if `EndDateType` is `unlimited`. If the `EndDateType` is `limited`, the Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019. If you are requesting a future-dated Capacity Reservation, you can't specify an end date and time that is within the commitment duration. Type: Timestamp Required: No **EndDateType** Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: + `unlimited` - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an `EndDate` if the `EndDateType` is `unlimited`. + `limited` - The Capacity Reservation expires automatically at a specified date and time. You must provide an `EndDate` value if the `EndDateType` value is `limited`. Type: String Valid Values: `unlimited | limited` Required: No **EphemeralStorage** *Deprecated.* Type: Boolean Required: No **InstanceCount** The number of instances for which to reserve capacity. You can request future-dated Capacity Reservations for an instance count with a minimum of 32 vCPUs. For example, if you request a future-dated Capacity Reservation for `m5.xlarge` instances, you must request at least 8 instances (*8 \$1 m5.xlarge = 32 vCPUs*). Valid range: 1 - 1000 Type: Integer Required: Yes **InstanceMatchCriteria** Indicates the type of instance launches that the Capacity Reservation accepts. The options include: + `open` - The Capacity Reservation automatically matches all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes run in the Capacity Reservation automatically without specifying any additional parameters. + `targeted` - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. If you are requesting a future-dated Capacity Reservation, you must specify `targeted`. Default: `open` Type: String Valid Values: `open | targeted` Required: No **InstancePlatform** The type of operating system for which to reserve capacity. Type: String Valid Values: `Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Windows with SQL Server | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | RHEL with SQL Server Standard | RHEL with SQL Server Enterprise | RHEL with SQL Server Web | RHEL with HA | RHEL with HA and SQL Server Standard | RHEL with HA and SQL Server Enterprise | Ubuntu Pro` Required: Yes **InstanceType** The instance type for which to reserve capacity. You can request future-dated Capacity Reservations for instance types in the C, M, R, I, T, and G instance families only. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. Type: String Required: Yes **OutpostArn** Not supported for future-dated Capacity Reservations. The Amazon Resource Name (ARN) of the Outpost on which to create the Capacity Reservation. Type: String Pattern: `^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$` Required: No **PlacementGroupArn** Not supported for future-dated Capacity Reservations. The Amazon Resource Name (ARN) of the cluster placement group in which to create the Capacity Reservation. For more information, see [ Capacity Reservations for cluster placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cr-cpg.html) in the *Amazon EC2 User Guide*. Type: String Pattern: `^arn:aws([a-z-]+)?:ec2:[a-z\d-]+:\d{12}:placement-group/^.{1,255}$` Required: No **StartDate** Required for future-dated Capacity Reservations only. To create a Capacity Reservation for immediate use, omit this parameter. The date and time at which the future-dated Capacity Reservation should become available for use, in the ISO8601 format in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). You can request a future-dated Capacity Reservation between 5 and 120 days in advance. Type: Timestamp Required: No **TagSpecifications.N** The tags to apply to the Capacity Reservation during launch. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Tenancy** Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: + `default` - The Capacity Reservation is created on hardware that is shared with other AWS accounts. + `dedicated` - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account. Type: String Valid Values: `default | dedicated` Required: No ## Response Elements The following elements are returned by the service. **capacityReservation** Information about the Capacity Reservation. Type: [CapacityReservation](API_CapacityReservation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCapacityReservation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCapacityReservation) # CreateCapacityReservationBySplitting Create a new Capacity Reservation by splitting the capacity of the source Capacity Reservation. The new Capacity Reservation will have the same attributes as the source Capacity Reservation except for tags. The source Capacity Reservation must be `active` and owned by your AWS account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceCount** The number of instances to split from the source Capacity Reservation. Type: Integer Required: Yes **SourceCapacityReservationId** The ID of the Capacity Reservation from which you want to split the capacity. Type: String Required: Yes **TagSpecification.N** The tags to apply to the new Capacity Reservation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **destinationCapacityReservation** Information about the destination Capacity Reservation. Type: [CapacityReservation](API_CapacityReservation.md) object **instanceCount** The number of instances in the new Capacity Reservation. The number of instances in the source Capacity Reservation was reduced by this amount. Type: Integer **requestId** The ID of the request. Type: String **sourceCapacityReservation** Information about the source Capacity Reservation. Type: [CapacityReservation](API_CapacityReservation.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCapacityReservationBySplitting) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCapacityReservationBySplitting) # CreateCapacityReservationFleet Creates a Capacity Reservation Fleet. For more information, see [Create a Capacity Reservation Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-cr-fleets.html#create-crfleet) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationStrategy** The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. Currently, only the `prioritized` allocation strategy is supported. For more information, see [ Allocation strategy](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#allocation-strategy) in the *Amazon EC2 User Guide*. Valid values: `prioritized` Type: String Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndDate** The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to `expired` and all of the Capacity Reservations in the Fleet expire. The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify `5/31/2019`, `13:30:55`, the Capacity Reservation Fleet is guaranteed to expire between `13:30:55` and `14:30:55` on `5/31/2019`. Type: Timestamp Required: No **InstanceMatchCriteria** Indicates the type of instance launches that the Capacity Reservation Fleet accepts. All Capacity Reservations in the Fleet inherit this instance matching criteria. Currently, Capacity Reservation Fleets support `open` instance matching criteria only. This means that instances that have matching attributes (instance type, platform, and Availability Zone) run in the Capacity Reservations automatically. Instances do not need to explicitly target a Capacity Reservation Fleet to use its reserved capacity. Type: String Valid Values: `open` Required: No **InstanceTypeSpecification.N** Information about the instance types for which to reserve the capacity. Type: Array of [ReservationFleetInstanceSpecification](API_ReservationFleetInstanceSpecification.md) objects Required: Yes **TagSpecification.N** The tags to assign to the Capacity Reservation Fleet. The tags are automatically assigned to the Capacity Reservations in the Fleet. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Tenancy** Indicates the tenancy of the Capacity Reservation Fleet. All Capacity Reservations in the Fleet inherit this tenancy. The Capacity Reservation Fleet can have one of the following tenancy settings: + `default` - The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts. + `dedicated` - The Capacity Reservations are created on single-tenant hardware that is dedicated to a single AWS account. Type: String Valid Values: `default` Required: No **TotalTargetCapacity** The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the *Amazon EC2 User Guide*. Type: Integer Required: Yes ## Response Elements The following elements are returned by the service. **allocationStrategy** The allocation strategy used by the Capacity Reservation Fleet. Type: String **capacityReservationFleetId** The ID of the Capacity Reservation Fleet. Type: String **createTime** The date and time at which the Capacity Reservation Fleet was created. Type: Timestamp **endDate** The date and time at which the Capacity Reservation Fleet expires. Type: Timestamp **fleetCapacityReservationSet** Information about the individual Capacity Reservations in the Capacity Reservation Fleet. Type: Array of [FleetCapacityReservation](API_FleetCapacityReservation.md) objects **instanceMatchCriteria** The instance matching criteria for the Capacity Reservation Fleet. Type: String Valid Values: `open` **requestId** The ID of the request. Type: String **state** The status of the Capacity Reservation Fleet. Type: String Valid Values: `submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed` **tagSet** The tags assigned to the Capacity Reservation Fleet. Type: Array of [Tag](API_Tag.md) objects **tenancy** Indicates the tenancy of Capacity Reservation Fleet. Type: String Valid Values: `default` **totalFulfilledCapacity** The requested capacity units that have been successfully reserved. Type: Double **totalTargetCapacity** The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCapacityReservationFleet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCapacityReservationFleet) # CreateCarrierGateway Creates a carrier gateway. For more information about carrier gateways, see [Carrier gateways](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#wavelength-carrier-gateway) in the * AWS Wavelength Developer Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to associate with the carrier gateway. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC to associate with the carrier gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **carrierGateway** Information about the carrier gateway. Type: [CarrierGateway](API_CarrierGateway.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCarrierGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCarrierGateway) # CreateClientVpnEndpoint Creates a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Authentication.N** Information about the authentication method to be used to authenticate clients. Type: Array of [ClientVpnAuthenticationRequest](API_ClientVpnAuthenticationRequest.md) objects Required: Yes **ClientCidrBlock** The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12. Type: String Required: No **ClientConnectOptions** The options for managing connection authorization for new client connections. Type: [ClientConnectOptions](API_ClientConnectOptions.md) object Required: No **ClientLoginBannerOptions** Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. Type: [ClientLoginBannerOptions](API_ClientLoginBannerOptions.md) object Required: No **ClientRouteEnforcementOptions** Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel. Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations. Type: [ClientRouteEnforcementOptions](API_ClientRouteEnforcementOptions.md) object Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **ConnectionLogOptions** Information about the client connection logging options. If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: + Client connection requests + Client connection results (successful and unsuccessful) + Reasons for unsuccessful client connection requests + Client connection termination time Type: [ConnectionLogOptions](API_ConnectionLogOptions.md) object Required: Yes **Description** A brief description of the Client VPN endpoint. Type: String Required: No **DisconnectOnSessionTimeout** Indicates whether the client VPN session is disconnected after the maximum timeout specified in `SessionTimeoutHours` is reached. If `true`, users are prompted to reconnect client VPN. If `false`, client VPN attempts to reconnect automatically. The default value is `true`. Type: Boolean Required: No **DnsServers.N** Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndpointIpAddressType** The IP address type for the Client VPN endpoint. Valid values are `ipv4` (default) for IPv4 addressing only, `ipv6` for IPv6 addressing only, or `dual-stack` for both IPv4 and IPv6 addressing. When set to `dual-stack,` clients can connect to the endpoint using either IPv4 or IPv6 addresses.. Type: String Valid Values: `ipv4 | ipv6 | dual-stack` Required: No **SecurityGroupId.N** The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups. Type: Array of strings Required: No **SelfServicePortal** Specify whether to enable the self-service portal for the Client VPN endpoint. Default Value: `enabled` Type: String Valid Values: `enabled | disabled` Required: No **ServerCertificateArn** The ARN of the server certificate. For more information, see the [AWS Certificate Manager User Guide](https://docs.aws.amazon.com/acm/latest/userguide/). Type: String Required: Yes **SessionTimeoutHours** The maximum VPN session duration time in hours. Valid values: `8 | 10 | 12 | 24` Default value: `24` Type: Integer Required: No **SplitTunnel** Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. By default, split-tunnel on a VPN endpoint is disabled. For information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the * AWS Client VPN Administrator Guide*. Type: Boolean Required: No **TagSpecification.N** The tags to apply to the Client VPN endpoint during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TrafficIpAddressType** The IP address type for traffic within the Client VPN tunnel. Valid values are `ipv4` (default) for IPv4 traffic only, `ipv6` for IPv6 addressing only, or `dual-stack` for both IPv4 and IPv6 traffic. When set to `dual-stack`, clients can access both IPv4 and IPv6 resources through the VPN . Type: String Valid Values: `ipv4 | ipv6 | dual-stack` Required: No **TransportProtocol** The transport protocol to be used by the VPN session. Default value: `udp` Type: String Valid Values: `tcp | udp` Required: No **VpcId** The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied. Type: String Required: No **VpnPort** The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: `443` \$1 `1194` Default Value: `443` Type: Integer Required: No ## Response Elements The following elements are returned by the service. **clientVpnEndpointId** The ID of the Client VPN endpoint. Type: String **dnsName** The DNS name to be used by clients when establishing their VPN session. Type: String **requestId** The ID of the request. Type: String **status** The current state of the Client VPN endpoint. Type: [ClientVpnEndpointStatus](API_ClientVpnEndpointStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateClientVpnEndpoint &ClientCidrBlock=11.0.0.0/16 &ServerCertificateArn=arn:aws:acm:us-east-1:123456789098:certificate/82916b3c-7449-43cf-ab9e-EXAMPLE &Authentication.1.Type=certificate-authentication &Authentication.1.MutualAuthentication.1.ClientRootCertificateChainArn=arn:aws:acm:us-east-1:123456789098:certificate/82916b3c-7449-43cf-ab9e-EXAMPLE &ConnectionLogOptions.Enabled=false &DnsServers=11.11.0.1 &AUTHPARAMS ``` #### Sample Response ``` c11b2aa2-c48d-4711-a394-43cbe8961c46 cvpn-endpoint-00c5d11fc4729f2a5.prod.clientvpn.us-east-1.amazonaws.com pending-associate cvpn-endpoint-00c5d11fc4729f2a5 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateClientVpnEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateClientVpnEndpoint) # CreateClientVpnRoute Adds a route to a network to a Client VPN endpoint. Each Client VPN endpoint has a route table that describes the available destination network routes. Each route in the route table specifies the path for traﬃc to speciﬁc resources or networks. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **ClientVpnEndpointId** The ID of the Client VPN endpoint to which to add the route. Type: String Required: Yes **Description** A brief description of the route. Type: String Required: No **DestinationCidrBlock** The IPv4 address range, in CIDR notation, of the route destination. For example: + To add a route for Internet access, enter `0.0.0.0/0` + To add a route for a peered VPC, enter the peered VPC's IPv4 CIDR range + To add a route for an on-premises network, enter the AWS Site-to-Site VPN connection's IPv4 CIDR range + To add a route for the local network, enter the client CIDR range Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TargetVpcSubnetId** The ID of the subnet through which you want to route traffic. The specified subnet must be an existing target network of the Client VPN endpoint. Alternatively, if you're adding a route for the local network, specify `local`. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **status** The current state of the route. Type: [ClientVpnRouteStatus](API_ClientVpnRouteStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example adds a route for Internet access to the Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateClientVpnRoute &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &DestinationCidrBlock=0.0.0.0/0 &TargetVpcSubnetId=subnet-057fa0918fEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 5b301186-e6d3-436b-87d6-7c400EXAMPLE creating ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateClientVpnRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateClientVpnRoute) # CreateCoipCidr Creates a range of customer-owned IP addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** A customer-owned IP address range to create. Type: String Required: Yes **CoipPoolId** The ID of the address pool. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **coipCidr** Information about a range of customer-owned IP addresses. Type: [CoipCidr](API_CoipCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCoipCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCoipCidr) # CreateCoipPool Creates a pool of customer-owned IP (CoIP) addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableId** The ID of the local gateway route table. Type: String Required: Yes **TagSpecification.N** The tags to assign to the CoIP address pool. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **coipPool** Information about the CoIP address pool. Type: [CoipPool](API_CoipPool.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCoipPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCoipPool) # CreateCustomerGateway Provides information to AWS about your customer gateway device. The customer gateway device is the appliance at your end of the VPN connection. You must provide the IP address of the customer gateway device’s external interface. The IP address must be static and can be behind a device performing network address translation (NAT). For devices that use Border Gateway Protocol (BGP), you can also provide the device's BGP Autonomous System Number (ASN). You can use an existing ASN assigned to your network. If you don't have an ASN already, you can use a private ASN. For more information, see [Customer gateway options for your Site-to-Site VPN connection](https://docs.aws.amazon.com/vpn/latest/s2svpn/cgw-options.html) in the * AWS Site-to-Site VPN User Guide*. To create more than one customer gateway with the same VPN type, IP address, and BGP ASN, specify a unique device name for each customer gateway. An identical request returns information about the existing customer gateway; it doesn't create a new customer gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BgpAsn** For customer gateway devices that support BGP, specify the device's ASN. You must specify either `BgpAsn` or `BgpAsnExtended` when creating the customer gateway. If the ASN is larger than `2,147,483,647`, you must use `BgpAsnExtended`. Default: 65000 Valid values: `1` to `2,147,483,647` Type: Integer Required: No **BgpAsnExtended** For customer gateway devices that support BGP, specify the device's ASN. You must specify either `BgpAsn` or `BgpAsnExtended` when creating the customer gateway. If the ASN is larger than `2,147,483,647`, you must use `BgpAsnExtended`. Valid values: `2,147,483,648` to `4,294,967,295` Type: Long Required: No **CertificateArn** The Amazon Resource Name (ARN) for the customer gateway certificate. Type: String Required: No **DeviceName** A name for the customer gateway device. Length Constraints: Up to 255 characters. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpAddress** The IP address for the customer gateway device's outside interface. The address must be static. If `OutsideIpAddressType` in your VPN connection options is set to `PrivateIpv4`, you can use an RFC6598 or RFC1918 private IPv4 address. If `OutsideIpAddressType` is set to `Ipv6`, you can use an IPv6 address. Type: String Required: No **PublicIp** *This member has been deprecated.* The Internet-routable IP address for the customer gateway's outside interface. The address must be static. Type: String Required: No **TagSpecification.N** The tags to apply to the customer gateway. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Type** The type of VPN connection that this customer gateway supports (`ipsec.1`). Type: String Valid Values: `ipsec.1` Required: Yes ## Response Elements The following elements are returned by the service. **customerGateway** Information about the customer gateway. Type: [CustomerGateway](API_CustomerGateway.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a customer gateway with the name `my-device`, the IP address `12.1.2.3`, and BGP ASN `65534`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateCustomerGateway &Type=ipsec.1 &IpAddress=12.1.2.3 &BgpAsn=65534 &DeviceName=my-device &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE cgw-11223344556677abc pending ipsec.1 12.1.2.3 65534 my-device ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateCustomerGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateCustomerGateway) # CreateDefaultSubnet Creates a default subnet with a size `/20` IPv4 CIDR block in the specified Availability Zone in your default VPC. You can have only one default subnet per Availability Zone. For more information, see [Create a default subnet](https://docs.aws.amazon.com/vpc/latest/userguide/work-with-default-vpc.html#create-default-subnet) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** The Availability Zone in which to create the default subnet. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both. Type: String Required: No **AvailabilityZoneId** The ID of the Availability Zone. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Ipv6Native** Indicates whether to create an IPv6 only subnet. If you already have a default subnet for this Availability Zone, you must delete it before you can create an IPv6 only subnet. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **subnet** Information about the subnet. Type: [Subnet](API_Subnet.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a default subnet in Availability Zone `us-east-2a`. #### Sample Request ``` https://ec2.us-east-2.amazonaws.com/?Action=CreateDefaultSubnet &AvailabilityZone=us-east-2a &AUTHPARAMS ``` #### Sample Response ``` 12e2fb2e-e566-488a-926d-4655example false us-east-2a 4091 172.31.32.0/20 true true available subnet-111f7123 vpc-8eaaeabc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateDefaultSubnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateDefaultSubnet) # CreateDefaultVpc Creates a default VPC with a size `/16` IPv4 CIDR block and a default subnet in each Availability Zone. For more information about the components of a default VPC, see [Default VPCs](https://docs.aws.amazon.com/vpc/latest/userguide/default-vpc.html) in the *Amazon VPC User Guide*. You cannot specify the components of the default VPC yourself. If you deleted your previous default VPC, you can create a default VPC. You cannot have more than one default VPC per Region. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpc** Information about the VPC. Type: [Vpc](API_Vpc.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a default VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateDefaultVpc &AUTHPARAMS ``` #### Sample Response ``` 056298f3-5f3e-48fb-9221-7c0example 172.31.0.0/16 dopt-61079b07 default true pending vpc-3f139646 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateDefaultVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateDefaultVpc) # CreateDelegateMacVolumeOwnershipTask Delegates ownership of the Amazon EBS root volume for an Apple silicon Mac instance to an administrative user. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the Amazon EC2 Mac instance. Type: String Required: Yes **MacCredentials** Specifies the following credentials: + **Internal disk administrative user** + **Username** - Only the default administrative user (`aws-managed-user`) is supported and it is used by default. You can't specify a different administrative user. + **Password** - If you did not change the default password for `aws-managed-user`, specify the default password, which is *blank*. Otherwise, specify your password. + **Amazon EBS root volume administrative user** + **Username** - If you did not change the default administrative user, specify `ec2-user`. Otherwise, specify the username for your administrative user. + **Password** - Specify the password for the administrative user. The credentials must be specified in the following JSON format: `{ "internalDiskPassword":"internal-disk-admin_password", "rootVolumeUsername":"root-volume-admin_username", "rootVolumepassword":"root-volume-admin_password" }` Type: String Required: Yes **TagSpecification.N** The tags to assign to the volume ownership delegation task. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **macModificationTask** Information about the volume ownership delegation task. Type: [MacModificationTask](API_MacModificationTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateDelegateMacVolumeOwnershipTask) # CreateDhcpOptions Creates a custom set of DHCP options. After you create a DHCP option set, you associate it with a VPC. After you associate a DHCP option set with a VPC, all existing and newly launched instances in the VPC use this set of DHCP options. The following are the individual DHCP options you can specify. For more information, see [DHCP option sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the *Amazon VPC User Guide*. + `domain-name` - If you're using AmazonProvidedDNS in `us-east-1`, specify `ec2.internal`. If you're using AmazonProvidedDNS in any other Region, specify `region.compute.internal`. Otherwise, specify a custom domain name. This value is used to complete unqualified DNS hostnames. Some Linux operating systems accept multiple domain names separated by spaces. However, Windows and other Linux operating systems treat the value as a single domain, which results in unexpected behavior. If your DHCP option set is associated with a VPC that has instances running operating systems that treat the value as a single domain, specify only one domain name. + `domain-name-servers` - The IP addresses of up to four DNS servers, or AmazonProvidedDNS. To specify multiple domain name servers in a single parameter, separate the IP addresses using commas. To have your instances receive custom DNS hostnames as specified in `domain-name`, you must specify a custom DNS server. + `ntp-servers` - The IP addresses of up to eight Network Time Protocol (NTP) servers (four IPv4 addresses and four IPv6 addresses). + `netbios-name-servers` - The IP addresses of up to four NetBIOS name servers. + `netbios-node-type` - The NetBIOS node type (1, 2, 4, or 8). We recommend that you specify 2. Broadcast and multicast are not supported. For more information about NetBIOS node types, see [RFC 2132](https://www.ietf.org/rfc/rfc2132.txt). + `ipv6-address-preferred-lease-time` - A value (in seconds, minutes, hours, or years) for how frequently a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 seconds (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DhcpConfiguration.N** A DHCP configuration option. Type: Array of [NewDhcpConfiguration](API_NewDhcpConfiguration.md) objects Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to assign to the DHCP option. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **dhcpOptions** A set of DHCP options. Type: [DhcpOptions](API_DhcpOptions.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a set of DHCP options with a domain name `example.com` and two DNS servers (`10.2.5.1` and `10.2.5.2`). The DNS servers' IP addresses are specified in a single parameter, separated by commas, to preserve the order in which they are specified. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateDhcpOptions &DhcpConfiguration.1.Key=domain-name &DhcpConfiguration.1.Value.1=example.com &DhcpConfiguration.2.Key=domain-name-servers &DhcpConfiguration.2.Value.1=10.2.5.1,10.2.5.2 &DhcpConfiguration.3.Key=ipv6-address-preferred-lease-time &DhcpConfiguration.3.Value.1=140 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE dopt-096c1234cade2dabc domain-name example.com domain-name-servers 10.2.5.1 10.2.5.2 ipv6-address-preferred-lease-time 140 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateDhcpOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateDhcpOptions) # CreateEgressOnlyInternetGateway [IPv6 only] Creates an egress-only internet gateway for your VPC. An egress-only internet gateway is used to enable outbound communication over IPv6 from instances in your VPC to the internet, and prevents hosts outside of your VPC from initiating an IPv6 connection with your instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to assign to the egress-only internet gateway. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC for which to create the egress-only internet gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String **egressOnlyInternetGateway** Information about the egress-only internet gateway. Type: [EgressOnlyInternetGateway](API_EgressOnlyInternetGateway.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates an egress-only internet gateway in VPC vpc-1a2b3c4d. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateEgressOnlyInternetGateway &VpcId=vpc-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` c617595f-6c29-4a00-a941-example attached vpc-1a2b3c4d eigw-01eadbd45ecd7943f ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateEgressOnlyInternetGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateEgressOnlyInternetGateway) # CreateFleet Creates an EC2 Fleet that contains the configuration information for On-Demand Instances and Spot Instances. Instances are launched immediately if there is available capacity. A single EC2 Fleet can include multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet. For more information, see [EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **Context** Reserved. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExcessCapacityTerminationPolicy** Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. Supported only for fleets of type `maintain`. Type: String Valid Values: `no-termination | termination` Required: No **LaunchTemplateConfigs.N** The configuration for the EC2 Fleet. Type: Array of [FleetLaunchTemplateConfigRequest](API_FleetLaunchTemplateConfigRequest.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: Yes **OnDemandOptions** Describes the configuration of On-Demand Instances in an EC2 Fleet. Type: [OnDemandOptionsRequest](API_OnDemandOptionsRequest.md) object Required: No **ReplaceUnhealthyInstances** Indicates whether EC2 Fleet should replace unhealthy Spot Instances. Supported only for fleets of type `maintain`. For more information, see [EC2 Fleet health checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#ec2-fleet-health-checks) in the *Amazon EC2 User Guide*. Type: Boolean Required: No **ReservedCapacityOptions** Defines EC2 Fleet preferences for utilizing reserved capacity when DefaultTargetCapacityType is set to `reserved-capacity`. Supported only for fleets of type `instant`. Type: [ReservedCapacityOptionsRequest](API_ReservedCapacityOptionsRequest.md) object Required: No **SpotOptions** Describes the configuration of Spot Instances in an EC2 Fleet. Type: [SpotOptionsRequest](API_SpotOptionsRequest.md) object Required: No **TagSpecification.N** The key-value pair for tagging the EC2 Fleet request on creation. For more information, see [Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources). If the fleet type is `instant`, specify a resource type of `fleet` to tag the fleet or `instance` to tag the instances at launch. If the fleet type is `maintain` or `request`, specify a resource type of `fleet` to tag the fleet. You cannot specify a resource type of `instance`. To tag instances at launch, specify the tags in a [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template). Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TargetCapacitySpecification** The number of units to request. Type: [TargetCapacitySpecificationRequest](API_TargetCapacitySpecificationRequest.md) object Required: Yes **TerminateInstancesWithExpiration** Indicates whether running instances should be terminated when the EC2 Fleet expires. Type: Boolean Required: No **Type** The fleet type. The default value is `maintain`. + `maintain` - The EC2 Fleet places an asynchronous request for your desired capacity, and continues to maintain your desired Spot capacity by replenishing interrupted Spot Instances. + `request` - The EC2 Fleet places an asynchronous one-time request for your desired capacity, but does submit Spot requests in alternative capacity pools if Spot capacity is unavailable, and does not maintain Spot capacity if Spot Instances are interrupted. + `instant` - The EC2 Fleet places a synchronous one-time request for your desired capacity, and returns errors for any instances that could not be launched. For more information, see [EC2 Fleet request types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-request-type.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `request | maintain | instant` Required: No **ValidFrom** The start date and time of the request, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). The default is to start fulfilling the request immediately. Type: Timestamp Required: No **ValidUntil** The end date and time of the request, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). At this point, no new EC2 Fleet requests are placed or able to fulfill the request. If no value is specified, the request remains until you cancel it. Type: Timestamp Required: No ## Response Elements The following elements are returned by the service. **errorSet** Information about the instances that could not be launched by the fleet. Supported only for fleets of type `instant`. Type: Array of [CreateFleetError](API_CreateFleetError.md) objects **fleetId** The ID of the EC2 Fleet. Type: String **fleetInstanceSet** Information about the instances that were launched by the fleet. Supported only for fleets of type `instant`. Type: Array of [CreateFleetInstance](API_CreateFleetInstance.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateFleet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateFleet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateFleet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateFleet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateFleet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateFleet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateFleet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateFleet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateFleet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateFleet) # CreateFlowLogs Creates one or more flow logs to capture information about IP traffic for a specific network interface, subnet, or VPC. Flow log data for a monitored network interface is recorded as flow log records, which are log events consisting of fields that describe the traffic flow. For more information, see [Flow log records](https://docs.aws.amazon.com/vpc/latest/userguide/flow-log-records.html) in the *Amazon VPC User Guide*. When publishing to CloudWatch Logs, flow log records are published to a log group, and each network interface has a unique log stream in the log group. When publishing to Amazon S3, flow log records for all of the monitored network interfaces are published to a single log file object that is stored in the specified bucket. For more information, see [VPC Flow Logs](https://docs.aws.amazon.com/vpc/latest/userguide/flow-logs.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DeliverCrossAccountRole** The ARN of the IAM role that allows Amazon EC2 to publish flow logs across accounts. Type: String Required: No **DeliverLogsPermissionArn** The ARN of the IAM role that allows Amazon EC2 to publish flow logs to the log destination. This parameter is required if the destination type is `cloud-watch-logs`, or if the destination type is `kinesis-data-firehose` and the delivery stream and the resources to monitor are in different accounts. Type: String Required: No **DestinationOptions** The destination options. Type: [DestinationOptionsRequest](API_DestinationOptionsRequest.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LogDestination** The destination for the flow log data. The meaning of this parameter depends on the destination type. + If the destination type is `cloud-watch-logs`, specify the ARN of a CloudWatch Logs log group. For example: arn:aws:logs:*region*:*account\$1id*:log-group:*my\$1group* Alternatively, use the `LogGroupName` parameter. + If the destination type is `s3`, specify the ARN of an S3 bucket. For example: arn:aws:s3:::*my\$1bucket*/*my\$1subfolder*/ The subfolder is optional. Note that you can't use `AWSLogs` as a subfolder name. + If the destination type is `kinesis-data-firehose`, specify the ARN of a Kinesis Data Firehose delivery stream. For example: arn:aws:firehose:*region*:*account\$1id*:deliverystream:*my\$1stream* Type: String Required: No **LogDestinationType** The type of destination for the flow log data. Default: `cloud-watch-logs` Type: String Valid Values: `cloud-watch-logs | s3 | kinesis-data-firehose` Required: No **LogFormat** The fields to include in the flow log record. List the fields in the order in which they should appear. If you omit this parameter, the flow log is created using the default format. If you specify this parameter, you must include at least one field. For more information about the available fields, see [Flow log records](https://docs.aws.amazon.com/vpc/latest/userguide/flow-log-records.html) in the *Amazon VPC User Guide* or [Transit Gateway Flow Log records](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-flow-logs.html#flow-log-records) in the * AWS Transit Gateway Guide*. Specify the fields using the `${field-id}` format, separated by spaces. Type: String Required: No **LogGroupName** The name of a new or existing CloudWatch Logs log group where Amazon EC2 publishes your flow logs. This parameter is valid only if the destination type is `cloud-watch-logs`. Type: String Required: No **MaxAggregationInterval** The maximum interval of time during which a flow of packets is captured and aggregated into a flow log record. The possible values are 60 seconds (1 minute) or 600 seconds (10 minutes). This parameter must be 60 seconds for transit gateway resource types. When a network interface is attached to a [Nitro-based instance](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html), the aggregation interval is always 60 seconds or less, regardless of the value that you specify. Default: 600 Type: Integer Required: No **ResourceId.N** The IDs of the resources to monitor. For example, if the resource type is `VPC`, specify the IDs of the VPCs. Constraints: Maximum of 25 for transit gateway resource types. Maximum of 1000 for the other resource types. Type: Array of strings Required: Yes **ResourceType** The type of resource to monitor. Type: String Valid Values: `VPC | Subnet | NetworkInterface | TransitGateway | TransitGatewayAttachment | RegionalNatGateway` Required: Yes **TagSpecification.N** The tags to apply to the flow logs. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TrafficType** The type of traffic to monitor (accepted traffic, rejected traffic, or all traffic). This parameter is not supported for transit gateway resource types. It is required for the other resource types. Type: String Valid Values: `ACCEPT | REJECT | ALL` Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String **flowLogIdSet** The IDs of the flow logs. Type: Array of strings **requestId** The ID of the request. Type: String **unsuccessful** Information about the flow logs that could not be created successfully. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 (CloudWatch Logs) This example creates a flow log that captures all rejected traffic for network interface eni-aa22bb33 and publishes the data to an CloudWatch Logs log group named `my-flow-logs` in account `123456789101`, using the IAM role `publishFlowLogs`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateFlowLogs &ResourceType=NetworkInterface &TrafficType=REJECT &ResourceId.1=eni-aa22bb33 &DeliverLogsPermissionArn=arn:aws:iam::123456789101:role/publishFlowLogs &LogDestinationType=cloud-watch-logs &LogDestination=arn:aws:logs:us-east-1:123456789101:log-group:my-flow-logs &AUTHPARAMS ``` #### Sample Response ``` 2d96dae3-504b-4fc4-bf50-266EXAMPLE fl-1a2b3c4d ``` ### Example 2 (Amazon S3) This example creates a flow log that captures all traffic for the specified network interface and publishes the data to an Amazon S3 bucket named amzn-s3-demo-bucket. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateFlowLogs &ResourceType=NetworkInterface &TrafficType=ALL &ResourceId.1=eni-1235b8ca123456789 &LogDestinationType=s3 &LogDestination=arn:aws:s3:::amzn-s3-demo-bucket &AUTHPARAMS ``` ### Example 3 (Amazon S3) This example creates a flow log with a custom flow log format that captures the version, instance ID, network interface ID, type, packet source address, packet destination address, protocol, bytes, the start time, the end time, and the action of the traffic, in that order. The flow log is published to an Amazon S3 bucket named amzn-s3-demo-bucket. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateFlowLogs &ResourceType=NetworkInterface &TrafficType=ALL &ResourceId.1=eni-1235b8ca123456789 &LogDestinationType=s3 &LogDestination=arn:aws:s3:::amzn-s3-demo-bucket &LogFormat='${version} ${instance-id} ${interface-id} ${type} ${pkt-srcaddr} ${pkt-dstaddr} ${protocol} ${bytes} ${start} ${end} ${action}' &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateFlowLogs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateFlowLogs) # CreateFpgaImage Creates an Amazon FPGA Image (AFI) from the specified design checkpoint (DCP). The create operation is asynchronous. To verify that the AFI was successfully created and is ready for use, check the output logs. An AFI contains the FPGA bitstream that is ready to download to an FPGA. You can securely deploy an AFI on multiple FPGA-accelerated instances. For more information, see the [AWS FPGA Hardware Development Kit](https://github.com/aws/aws-fpga/). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the AFI. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InputStorageLocation** The location of the encrypted design checkpoint in Amazon S3. The input must be a tarball. Type: [StorageLocation](API_StorageLocation.md) object Required: Yes **LogsStorageLocation** The location in Amazon S3 for the output logs. Type: [StorageLocation](API_StorageLocation.md) object Required: No **Name** A name for the AFI. Type: String Required: No **TagSpecification.N** The tags to apply to the FPGA image during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **fpgaImageGlobalId** The global FPGA image identifier (AGFI ID). Type: String **fpgaImageId** The FPGA image identifier (AFI ID). Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates an AFI from the specified tarball in the specified bucket. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateFpgaImage &Name=my-afi &Description=test-afi &InputStorageLocation.Bucket=my-fpga-bucket &InputStorageLocation.Key=dcp/17_12_22-103226.Developer_CL.tar &LogsStorageLocation.Bucket=my-fpga-bucket &LogsStorageLocation.Key=logs &AUTHPARAMS ``` #### Sample Response ``` d97baa5e-d3dd-4ead-9586-c68example afi-0d123e123bfc85abc agfi-123cb27b5e84a0abc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateFpgaImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateFpgaImage) # CreateImage Creates an Amazon EBS-backed AMI from an Amazon EBS-backed instance that is either running or stopped. If you customized your instance with instance store volumes or Amazon EBS volumes in addition to the root device volume, the new AMI contains block device mapping information for those volumes. When you launch an instance from this new AMI, the instance automatically launches with those additional volumes. The location of the source instance determines where you can create the snapshots of the AMI: + If the source instance is in a Region, you must create the snapshots in the same Region as the instance. + If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent Region. For more information, see [Create an Amazon EBS-backed AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html) in the *Amazon Elastic Compute Cloud User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BlockDeviceMapping.N** The block device mappings. When using the CreateImage action: + You can't change the volume size using the VolumeSize parameter. If you want a different volume size, you must first change the volume size of the source instance. + You can't modify the encryption status of existing volumes or snapshots. To create an AMI with volumes or snapshots that have a different encryption status (for example, where the source volume and snapshots are unencrypted, and you want to create an AMI with encrypted volumes or snapshots), copy the image instead. + The only option that can be changed for existing mappings or snapshots is `DeleteOnTermination`. Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects Required: No **Description** A description for the new image. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **Name** A name for the new image. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(\$1) Type: String Required: Yes **NoReboot** Indicates whether or not the instance should be automatically rebooted before creating the image. Specify one of the following values: + `true` - The instance is not rebooted before creating the image. This creates crash-consistent snapshots that include only the data that has been written to the volumes at the time the snapshots are created. Buffered data and data in memory that has not yet been written to the volumes is not included in the snapshots. + `false` - The instance is rebooted before creating the image. This ensures that all buffered data and data in memory is written to the volumes before the snapshots are created. Default: `false` Type: Boolean Required: No **SnapshotLocation** Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter. The Amazon S3 location where the snapshots will be stored. + To create local snapshots in the same Local Zone as the source instance, specify `local`. + To create regional snapshots in the parent Region of the Local Zone, specify `regional` or omit this parameter. Default: `regional` Type: String Valid Values: `regional | local` Required: No **TagSpecification.N** The tags to apply to the AMI and snapshots on creation. You can tag the AMI, the snapshots, or both. + To tag the AMI, the value for `ResourceType` must be `image`. + To tag the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance, the value for `ResourceType` must be `snapshot`. The same tag is applied to all of the snapshots that are created. If you specify other values for `ResourceType`, the request fails. To tag an AMI or snapshot after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **imageId** The ID of the new AMI. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example request creates an AMI from the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateImage &Description=Standard+Web+Server+v1.0 &InstanceId=i-1234567890abcdef0 &Name=standard-web-server-v1.0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-4fa54026 ``` ### Example 2 This example request creates an AMI from the specified instance, and sets the NoReboot parameter to true (the instance is not rebooted before the image is created). #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateImage &Description=Standard+Web+Server+v1.0 &InstanceId=i-1234567890abcdef0 &Name=standard-web-server-v1.0 &NoReboot=true &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-4fa54026 ``` ### Example 3 This example request creates an AMI from the specified instance, and tags on creation the AMI and the snapshots that are created of the root volume and of other Amazon EBS volumes that are attached to the instance. In this example, the tag that is applied to the AMI and the snapshots is the same, with a key of `purpose` and a value of `test`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateImage &InstanceId=i-1234567890abcdef0 &TagSpecification.1.ResourceType=image &TagSpecification.1.Tag.1.Key=purpose &TagSpecification.1.Tag.1.Value=test &TagSpecification.2.ResourceType=snapshot &TagSpecification.2.Tag.1.Key=purpose &TagSpecification.2.Tag.1.Value=test &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-4fa54026 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateImage) # CreateImageUsageReport Creates a report that shows how your image is used across other AWS accounts. The report provides visibility into which accounts are using the specified image, and how many resources (EC2 instances or launch templates) are referencing it. For more information, see [View your AMI usage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/your-ec2-ami-usage.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AccountId.N** The AWS account IDs to include in the report. To include all accounts, omit this parameter. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No **ClientToken** A unique, case-sensitive identifier that you provide to ensure idempotency of the request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the image to report on. Type: String Required: Yes **ResourceType.N** The resource types to include in the report. Type: Array of [ImageUsageResourceTypeRequest](API_ImageUsageResourceTypeRequest.md) objects Required: Yes **TagSpecification.N** The tags to apply to the report on creation. The `ResourceType` must be set to `image-usage-report`; any other value will cause the report creation to fail. To tag a report after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **reportId** The ID of the report. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateImageUsageReport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateImageUsageReport) # CreateInstanceConnectEndpoint Creates an EC2 Instance Connect Endpoint. An EC2 Instance Connect Endpoint allows you to connect to an instance, without requiring the instance to have a public IPv4 or public IPv6 address. For more information, see [Connect to your instances using EC2 Instance Connect Endpoint](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Connect-using-EC2-Instance-Connect-Endpoint.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpAddressType** The IP address type of the endpoint. If no value is specified, the default value is determined by the IP address type of the subnet: + `dualstack` - If the subnet has both IPv4 and IPv6 CIDRs + `ipv4` - If the subnet has only IPv4 CIDRs + `ipv6` - If the subnet has only IPv6 CIDRs `PreserveClientIp` is only supported on IPv4 EC2 Instance Connect Endpoints. To use `PreserveClientIp`, the value for `IpAddressType` must be `ipv4`. Type: String Valid Values: `ipv4 | dualstack | ipv6` Required: No **PreserveClientIp** Indicates whether the client IP address is preserved as the source. The following are the possible values. + `true` - Use the client IP address as the source. + `false` - Use the network interface IP address as the source. `PreserveClientIp` is only supported on IPv4 EC2 Instance Connect Endpoints. To use `PreserveClientIp`, the value for `IpAddressType` must be `ipv4`. Default: `false` Type: Boolean Required: No **SecurityGroupId.N** One or more security groups to associate with the endpoint. If you don't specify a security group, the default security group for your VPC will be associated with the endpoint. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 16 items. Required: No **SubnetId** The ID of the subnet in which to create the EC2 Instance Connect Endpoint. Type: String Required: Yes **TagSpecification.N** The tags to apply to the EC2 Instance Connect Endpoint during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive idempotency token provided by the client in the the request. Type: String **instanceConnectEndpoint** Information about the EC2 Instance Connect Endpoint. Type: [Ec2InstanceConnectEndpoint](API_Ec2InstanceConnectEndpoint.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example: Create an EC2 Instance Connect Endpoint This example creates an EC2 Instance Connect Endpoint in the specified subnet. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateInstanceConnectEndpoint &SubnetId=subnet-0123456789example &AUTHPARAMS ``` #### Sample Response ``` a9effc88-e86c-4730-b1e8-30ba091babd1 2023-06-06T20:01:31.000Z arn:aws:ec2:region:account-id:instance-connect-endpoint/eice-0123456789example eice-0123456789example account-id false sg-0123456789example create-in-progress subnet-0123456789example vpc-0123456789example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateInstanceConnectEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateInstanceConnectEndpoint) # CreateInstanceEventWindow Creates an event window in which scheduled events for the associated Amazon EC2 instances can run. You can define either a set of time ranges or a cron expression when creating the event window, but not both. All event window times are in UTC. You can create up to 200 event windows per AWS Region. When you create the event window, targets (instance IDs, Dedicated Host IDs, or tags) are not yet associated with it. To ensure that the event window can be used, you must associate one or more targets with it by using the [AssociateInstanceEventWindow](API_AssociateInstanceEventWindow.md) API. **Important** Event windows are applicable only for scheduled events that stop, reboot, or terminate instances. Event windows are *not* applicable for: Expedited scheduled events and network maintenance events. Unscheduled maintenance such as AutoRecovery and unplanned reboots. For more information, see [Define event windows for scheduled events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CronExpression** The cron expression for the event window, for example, `* 0-4,20-23 * * 1,5`. If you specify a cron expression, you can't specify a time range. Constraints: + Only hour and day of the week values are supported. + For day of the week values, you can specify either integers `0` through `6`, or alternative single values `SUN` through `SAT`. + The minute, month, and year must be specified by `*`. + The hour value must be one or a multiple range, for example, `0-4` or `0-4,20-23`. + Each hour range must be >= 2 hours, for example, `0-2` or `20-23`. + The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours. For more information about cron expressions, see [cron](https://en.wikipedia.org/wiki/Cron) on the *Wikipedia website*. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Name** The name of the event window. Type: String Required: No **TagSpecification.N** The tags to apply to the event window. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TimeRange.N** The time range for the event window. If you specify a time range, you can't specify a cron expression. Type: Array of [InstanceEventWindowTimeRangeRequest](API_InstanceEventWindowTimeRangeRequest.md) objects Required: No ## Response Elements The following elements are returned by the service. **instanceEventWindow** Information about the event window. Type: [InstanceEventWindow](API_InstanceEventWindow.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateInstanceEventWindow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateInstanceEventWindow) # CreateInstanceExportTask Exports a running or stopped instance to an Amazon S3 bucket. For information about the prerequisites for your Amazon S3 bucket, supported operating systems, image formats, and known limitations for the types of instances you can export, see [Exporting an instance as a VM Using VM Import/Export](https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html) in the *VM Import/Export User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** A description for the conversion task or the resource being exported. The maximum length is 255 characters. Type: String Required: No **ExportToS3** The format and location for an export instance task. Type: [ExportToS3TaskSpecification](API_ExportToS3TaskSpecification.md) object Required: Yes **InstanceId** The ID of the instance. Type: String Required: Yes **TagSpecification.N** The tags to apply to the export instance task during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TargetEnvironment** The target virtualization environment. Type: String Valid Values: `citrix | vmware | microsoft` Required: Yes ## Response Elements The following elements are returned by the service. **exportTask** Information about the export instance task. Type: [ExportTask](API_ExportTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request creates an Export VM task that makes a Windows instance available as an OVA. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateInstanceExportTask &Description=Example%20for%20docs &InstanceId=i-1234567890abcdef0 &TargetEnvironment=VMWare &ExportToS3.DiskImageFormat=VMDK &ExportToS3.ContainerFormat=OVA &ExportToS3.S3bucket=amzn-s3-demo-for-exported-vm &ExportToS3.S3prefix=my-exports/ &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE export-i-1234wxyz Example for docs active Running i-1234567890abcdef0 VMWare VMDK OVA amzn-s3-demo-for-exported-vm my-exports/ export-i-1234wxyz.ova ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateInstanceExportTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateInstanceExportTask) # CreateInternetGateway Creates an internet gateway for use with a VPC. After creating the internet gateway, you attach it to a VPC using [AttachInternetGateway](API_AttachInternetGateway.md). For more information, see [Internet gateways](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Internet_Gateway.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to assign to the internet gateway. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **internetGateway** Information about the internet gateway. Type: [InternetGateway](API_InternetGateway.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates an internet gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateInternetGateway &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE igw-eaad4883 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateInternetGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateInternetGateway) # CreateInterruptibleCapacityReservationAllocation Creates an interruptible Capacity Reservation by specifying the number of unused instances you want to allocate from your source reservation. This helps you make unused capacity available for other workloads within your account while maintaining control to reclaim it. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the source Capacity Reservation from which to create the interruptible Capacity Reservation. Your Capacity Reservation must be in active state with no end date set and have available capacity for allocation. Type: String Required: Yes **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. Type: Boolean Required: No **InstanceCount** The number of instances to allocate from your source reservation. You can only allocate available instances (also called unused capacity). Type: Integer Required: Yes **TagSpecification.N** The tags to apply to the interruptible Capacity Reservation during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **interruptionType** The type of interruption applied to the interruptible reservation. Type: String Valid Values: `adhoc` **requestId** The ID of the request. Type: String **sourceCapacityReservationId** The ID of the source Capacity Reservation from which the interruptible Capacity Reservation was created. Type: String **status** The current status of the allocation request (creating, active, updating). Type: String Valid Values: `pending | active | updating | canceling | canceled | failed` **targetInstanceCount** The number of instances allocated to the interruptible reservation. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateInterruptibleCapacityReservationAllocation) # CreateIpam Create an IPAM. Amazon VPC IP Address Manager (IPAM) is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see [Create an IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the IPAM. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EnablePrivateGua** Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. Type: Boolean Required: No **MeteredAccount** A metered account is an AWS account that is charged for active IP addresses managed in IPAM. For more information, see [Enable cost distribution](https://docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html) in the *Amazon VPC IPAM User Guide*. Possible values: + `ipam-owner` (default): The AWS account which owns the IPAM is charged for all active IP addresses managed in IPAM. + `resource-owner`: The AWS account that owns the IP address is charged for the active IP address. Type: String Valid Values: `ipam-owner | resource-owner` Required: No **OperatingRegion.N** The operating Regions for the IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions. For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: Array of [AddIpamOperatingRegion](API_AddIpamOperatingRegion.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No **TagSpecification.N** The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Tier** IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see [Amazon VPC pricing > IPAM tab](http://aws.amazon.com/vpc/pricing/). Type: String Valid Values: `free | advanced` Required: No ## Response Elements The following elements are returned by the service. **ipam** Information about the IPAM created. Type: [Ipam](API_Ipam.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpam) # CreateIpamExternalResourceVerificationToken Create a verification token. A verification token is an AWS-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to AWS (BYOIP). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamId** The ID of the IPAM that will create the token. Type: String Required: Yes **TagSpecification.N** Token tags. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamExternalResourceVerificationToken** The verification token. Type: [IpamExternalResourceVerificationToken](API_IpamExternalResourceVerificationToken.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpamExternalResourceVerificationToken) # CreateIpamPolicy Creates an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. For more information, see [Define public IPv4 allocation strategy with IPAM policies](https://docs.aws.amazon.com/vpc/latest/ipam/define-public-ipv4-allocation-strategy-with-ipam-policies.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive identifier to ensure the idempotency of the request. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamId** The ID of the IPAM for which you're creating the policy. Type: String Required: Yes **TagSpecification.N** The tags to assign to the IPAM policy. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamPolicy** Information about the created IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. Type: [IpamPolicy](API_IpamPolicy.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpamPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpamPolicy) # CreateIpamPool Create an IP address pool for Amazon VPC IP Address Manager (IPAM). In IPAM, a pool is a collection of contiguous IP addresses CIDRs. Pools enable you to organize your IP addresses according to your routing and security needs. For example, if you have separate routing and security needs for development and production applications, you can create a pool for each. For more information, see [Create a top-level pool](https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddressFamily** The IP protocol assigned to this IPAM pool. You must choose either IPv4 or IPv6 protocol for a pool. Type: String Valid Values: `ipv4 | ipv6` Required: Yes **AllocationDefaultNetmaskLength** The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16. Type: Integer Valid Range: Minimum value of 0. Maximum value of 128. Required: No **AllocationMaxNetmaskLength** The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. The maximum netmask length must be greater than the minimum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. Type: Integer Valid Range: Minimum value of 0. Maximum value of 128. Required: No **AllocationMinNetmaskLength** The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. The minimum netmask length must be less than the maximum netmask length. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. Type: Integer Valid Range: Minimum value of 0. Maximum value of 128. Required: No **AllocationResourceTag.N** Tags that are required for resources that use CIDRs from this IPAM pool. Resources that do not have these tags will not be allowed to allocate space from the pool. If the resources have their tags changed after they have allocated space or if the allocation tagging requirements are changed on the pool, the resource may be marked as noncompliant. Type: Array of [RequestIpamResourceTag](API_RequestIpamResourceTag.md) objects Required: No **AutoImport** If selected, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. A locale must be set on the pool for this feature to work. Type: Boolean Required: No **AwsService** Limits which service in AWS that the pool can be used in. "ec2", for example, allows users to use space for Elastic IP addresses and VPCs. Type: String Valid Values: `ec2 | global-services` Required: No **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the IPAM pool. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamScopeId** The ID of the scope in which you would like to create the IPAM pool. Type: String Required: Yes **Locale** The locale for the pool should be one of the following: + An AWS Region where you want this IPAM pool to be available for allocations. + The network border group for an AWS Local Zone where you want this IPAM pool to be available for allocations ([supported Local Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail)). This option is only available for IPAM IPv4 pools in the public scope. Possible values: Any AWS Region or supported AWS Local Zone. Default is `none` and means any locale. Type: String Required: No **PublicIpSource** The IP address source for pools in the public scope. Only used for provisioning IP address CIDRs to pools in the public scope. Default is `byoip`. For more information, see [Create IPv6 pools](https://docs.aws.amazon.com/vpc/latest/ipam/intro-create-ipv6-pools.html) in the *Amazon VPC IPAM User Guide*. By default, you can add only one Amazon-provided IPv6 CIDR block to a top-level IPv6 pool if PublicIpSource is `amazon`. For information on increasing the default limit, see [ Quotas for your IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: String Valid Values: `amazon | byoip` Required: No **PubliclyAdvertisable** Determines if the pool is publicly advertisable. The request can only contain `PubliclyAdvertisable` if `AddressFamily` is `ipv6` and `PublicIpSource` is `byoip`. Type: Boolean Required: No **SourceIpamPoolId** The ID of the source IPAM pool. Use this option to create a pool within an existing pool. Note that the CIDR you provision for the pool within the source pool must be available in the source pool's CIDR range. Type: String Required: No **SourceResource** The resource used to provision CIDRs to a resource planning pool. Type: [IpamPoolSourceResourceRequest](API_IpamPoolSourceResourceRequest.md) object Required: No **TagSpecification.N** The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamPool** Information about the IPAM pool created. Type: [IpamPool](API_IpamPool.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpamPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpamPool) # CreateIpamPrefixListResolver Creates an IPAM prefix list resolver. An IPAM prefix list resolver is a component that manages the synchronization between IPAM's CIDR selection rules and customer-managed prefix lists. It automates connectivity configurations by selecting CIDRs from IPAM's database based on your business logic and synchronizing them with prefix lists used in resources such as VPC route tables and security groups. For more information about IPAM prefix list resolver, see [Automate prefix list updates with IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/automate-prefix-list-updates.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddressFamily** The address family for the IPAM prefix list resolver. Valid values are `ipv4` and `ipv6`. You must create separate resolvers for IPv4 and IPv6 CIDRs as they cannot be mixed in the same resolver. Type: String Valid Values: `ipv4 | ipv6` Required: Yes **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the IPAM prefix list resolver to help you identify its purpose and configuration. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamId** The ID of the IPAM that will serve as the source of the IP address database for CIDR selection. The IPAM must be in the Advanced tier to use this feature. Type: String Required: Yes **Rule.N** The CIDR selection rules for the resolver. CIDR selection rules define the business logic for selecting CIDRs from IPAM. If a CIDR matches any of the rules, it will be included. If a rule has multiple conditions, the CIDR has to match every condition of that rule. You can create a prefix list resolver without any CIDR selection rules, but it will generate empty versions (containing no CIDRs) until you add rules. Type: Array of [IpamPrefixListResolverRuleRequest](API_IpamPrefixListResolverRuleRequest.md) objects Required: No **TagSpecification.N** The tags to apply to the IPAM prefix list resolver during creation. Tags help you organize and manage your AWS resources. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamPrefixListResolver** Information about the IPAM prefix list resolver that was created. Type: [IpamPrefixListResolver](API_IpamPrefixListResolver.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpamPrefixListResolver) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpamPrefixListResolver) # CreateIpamPrefixListResolverTarget Creates an IPAM prefix list resolver target. An IPAM prefix list resolver target is an association between a specific customer-managed prefix list and an IPAM prefix list resolver. The target enables the resolver to synchronize CIDRs selected by its rules into the specified prefix list, which can then be referenced in AWS resources. For more information about IPAM prefix list resolver, see [Automate prefix list updates with IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/automate-prefix-list-updates.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DesiredVersion** The specific version of the prefix list to target. If not specified, the resolver will target the latest version. Type: Long Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPrefixListResolverId** The ID of the IPAM prefix list resolver that will manage the synchronization of CIDRs to the target prefix list. Type: String Required: Yes **PrefixListId** The ID of the managed prefix list that will be synchronized with CIDRs selected by the IPAM prefix list resolver. This prefix list becomes an IPAM managed prefix list. An IPAM-managed prefix list is a customer-managed prefix list that has been associated with an IPAM prefix list resolver target. When a prefix list becomes IPAM managed, its CIDRs are automatically synchronized based on the IPAM prefix list resolver's CIDR selection rules, and direct CIDR modifications are restricted. Type: String Required: Yes **PrefixListRegion** The AWS Region where the prefix list is located. This is required when referencing a prefix list in a different Region. Type: String Required: Yes **TagSpecification.N** The tags to apply to the IPAM prefix list resolver target during creation. Tags help you organize and manage your AWS resources. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TrackLatestVersion** Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version of the prefix list. Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention. Type: Boolean Required: Yes ## Response Elements The following elements are returned by the service. **ipamPrefixListResolverTarget** Information about the IPAM prefix list resolver target that was created. Type: [IpamPrefixListResolverTarget](API_IpamPrefixListResolverTarget.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpamPrefixListResolverTarget) # CreateIpamResourceDiscovery Creates an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A client token for the IPAM resource discovery. Type: String Required: No **Description** A description for the IPAM resource discovery. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **OperatingRegion.N** Operating Regions for the IPAM resource discovery. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions. Type: Array of [AddIpamOperatingRegion](API_AddIpamOperatingRegion.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No **TagSpecification.N** Tag specifications for the IPAM resource discovery. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamResourceDiscovery** An IPAM resource discovery. Type: [IpamResourceDiscovery](API_IpamResourceDiscovery.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpamResourceDiscovery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpamResourceDiscovery) # CreateIpamScope Create an IPAM scope. In IPAM, a scope is the highest-level container within IPAM. An IPAM contains two default scopes. Each scope represents the IP space for a single network. The private scope is intended for all private IP address space. The public scope is intended for all public IP address space. Scopes enable you to reuse IP addresses across multiple unconnected networks without causing IP address overlap or conflict. For more information, see [Add a scope](https://docs.aws.amazon.com/vpc/latest/ipam/add-scope-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the scope you're creating. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExternalAuthorityConfiguration** The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system. In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to AWS while using Amazon VPC IPAM to manage subnets within those ranges. Type: [ExternalAuthorityConfiguration](API_ExternalAuthorityConfiguration.md) object Required: No **IpamId** The ID of the IPAM for which you're creating this scope. Type: String Required: Yes **TagSpecification.N** The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamScope** Information about the created scope. Type: [IpamScope](API_IpamScope.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateIpamScope) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateIpamScope) # CreateKeyPair Creates an ED25519 or 2048-bit RSA key pair with the specified name and in the specified format. Amazon EC2 stores the public key and displays the private key for you to save to a file. The private key is returned as an unencrypted PEM encoded PKCS\$11 private key or an unencrypted PPK formatted private key for use with PuTTY. If a key with the specified name already exists, Amazon EC2 returns an error. The key pair returned to you is available only in the AWS Region in which you create it. If you prefer, you can create your own key pair using a third-party tool and upload it to any Region using [ImportKeyPair](API_ImportKeyPair.md). You can have up to 5,000 key pairs per AWS Region. For more information, see [Amazon EC2 key pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **KeyFormat** The format of the key pair. Default: `pem` Type: String Valid Values: `pem | ppk` Required: No **KeyName** A unique name for the key pair. Constraints: Up to 255 ASCII characters Type: String Required: Yes **KeyType** The type of key pair. Note that ED25519 keys are not supported for Windows instances. Default: `rsa` Type: String Valid Values: `rsa | ed25519` Required: No **TagSpecification.N** The tags to apply to the new key pair. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **keyFingerprint** + For RSA key pairs, the key fingerprint is the SHA-1 digest of the DER encoded private key. + For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with OpenSSH 6.8. Type: String **keyMaterial** An unencrypted PEM encoded RSA or ED25519 private key. Type: String **keyName** The name of the key pair. Type: String **keyPairId** The ID of the key pair. Type: String **requestId** The ID of the request. Type: String **tagSet** Any tags applied to the key pair. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request creates a key pair named `my-key-pair`, and applies a tag with a key of `purpose` and a value of `production`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateKeyPair &KeyName=my-key-pair &TagSpecification.1.ResourceType=key-pair &TagSpecification.1.Tag.1.Key=purpose &TagSpecification.1.Tag.1.Value=production &AUTHPARAMS ``` #### Sample Response ``` 1b5b5bcf-3670-4c16-83d7-c2c9example my-key-pair key-abcd12345eEXAMPLE 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f ---- BEGIN RSA PRIVATE KEY ---- MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE -----END RSA PRIVATE KEY----- purpose production ``` ### Saving the file Create a file named `my-key-pair.pem` and paste the entire key from the response into this file. Keep this file in a safe place; it is required to decrypt login information when you connect to an instance that you launched using this key pair. If you're using an SSH client on a Linux computer to connect to your instance, use the following command to set the permissions of your private key file so that only you can read it. #### Sample Request ``` chmod 400 my-key-pair.pem ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateKeyPair) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateKeyPair) # CreateLaunchTemplate Creates a launch template. A launch template contains the parameters to launch an instance. When you launch an instance using [RunInstances](API_RunInstances.md), you can specify a launch template instead of providing the launch parameters in the request. For more information, see [Store instance launch parameters in Amazon EC2 launch templates](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*. To clone an existing launch template as the basis for a new launch template, use the Amazon EC2 console. The API, SDKs, and CLI do not support cloning a template. For more information, see [Create a launch template from an existing launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-launch-template.html#create-launch-template-from-existing-launch-template) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Constraint: Maximum 128 ASCII characters. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LaunchTemplateData** The information for the launch template. Type: [RequestLaunchTemplateData](API_RequestLaunchTemplateData.md) object Required: Yes **LaunchTemplateName** A name for the launch template. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: `[a-zA-Z0-9\.\-/_]+` Required: Yes **Operator** Reserved for internal use. Type: [OperatorRequest](API_OperatorRequest.md) object Required: No **TagSpecification.N** The tags to apply to the launch template on creation. To tag the launch template, the resource type must be `launch-template`. To specify the tags for the resources that are created when an instance is launched, you must use the `TagSpecifications` parameter in the [launch template data](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestLaunchTemplateData.html) structure. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VersionDescription** A description for the first version of the launch template. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ## Response Elements The following elements are returned by the service. **launchTemplate** Information about the launch template. Type: [LaunchTemplate](API_LaunchTemplate.md) object **requestId** The ID of the request. Type: String **warning** If the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found. Type: [ValidationWarning](API_ValidationWarning.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 The following example creates a launch template that specifies AMI `ami-1a2b3c4d` and an instance type of `t2.micro`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateLaunchTemplate &LaunchTemplateName=MyLaunchTemplate &VersionDescription=FirstVersion &LaunchTemplateData.ImageId=ami-1a2b3c4d &LaunchTemplateData.InstanceType=t2.micro &AUTHPARAMS ``` #### Sample Response ``` 39f602bc-7580-4239-a6d8-af56example 2017-10-31T11:38:52.000Z arn:aws:iam::123456789012:root 1 1 lt-0a20c965061f64abc MyLaunchTemplate ``` ### Example 2 The following example creates a launch template that specifies the subnet in which to launch the instance (`subnet-7b16de0c`), assigns a public IP address and an IPv6 address to the instance, and creates a tag for the instance (`Name=webserver`). #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateLaunchTemplate &LaunchTemplateName=TemplateForWebServer &VersionDescription=WebVersion1 &LaunchTemplateData.ImageId=ami-8c1be5f6 &LaunchTemplateData.InstanceType=t2.micro &LaunchTemplateData.NetworkInterface.1.AssociatePublicIpAddress=true &LaunchTemplateData.NetworkInterface.1.DeviceIndex=0 &LaunchTemplateData.NetworkInterface.1.SubnetId=subnet-7b16de0c &LaunchTemplateData.NetworkInterface.1.Ipv6AddressCount=1 &LaunchTemplateData.TagSpecification.1.ResourceType=instance &LaunchTemplateData.TagSpecification.1.Tag.1.Key=Name &LaunchTemplateData.TagSpecification.1.Tag.1.Value=webserver &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLaunchTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLaunchTemplate) # CreateLaunchTemplateVersion Creates a new version of a launch template. You must specify an existing launch template, either by name or ID. You can determine whether the new version inherits parameters from a source version, and add or overwrite parameters as needed. Launch template versions are numbered in the order in which they are created. You can't specify, change, or replace the numbering of launch template versions. Launch templates are immutable; after you create a launch template, you can't modify it. Instead, you can create a new version of the launch template that includes the changes that you require. For more information, see [Modify a launch template (manage launch template versions)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-launch-template-versions.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Constraint: Maximum 128 ASCII characters. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LaunchTemplateData** The information for the launch template. Type: [RequestLaunchTemplateData](API_RequestLaunchTemplateData.md) object Required: Yes **LaunchTemplateId** The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Required: No **LaunchTemplateName** The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: `[a-zA-Z0-9\.\-/_]+` Required: No **ResolveAlias** If `true`, and if a Systems Manager parameter is specified for `ImageId`, the AMI ID is displayed in the response for `imageID`. For more information, see [Use a Systems Manager parameter instead of an AMI ID](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-launch-template.html#use-an-ssm-parameter-instead-of-an-ami-id) in the *Amazon EC2 User Guide*. Default: `false` Type: Boolean Required: No **SourceVersion** The version of the launch template on which to base the new version. Snapshots applied to the block device mapping are ignored when creating a new version unless they are explicitly included. If you specify this parameter, the new version inherits the launch parameters from the source version. If you specify additional launch parameters for the new version, they overwrite any corresponding launch parameters inherited from the source version. If you omit this parameter, the new version contains only the launch parameters that you specify for the new version. Type: String Required: No **VersionDescription** A description for the version of the launch template. Type: String Length Constraints: Minimum length of 0. Maximum length of 255. Required: No ## Response Elements The following elements are returned by the service. **launchTemplateVersion** Information about the launch template version. Type: [LaunchTemplateVersion](API_LaunchTemplateVersion.md) object **requestId** The ID of the request. Type: String **warning** If the new version of the launch template contains parameters or parameter combinations that are not valid, an error code and an error message are returned for each issue that's found. Type: [ValidationWarning](API_ValidationWarning.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example The following example creates a new launch template version for launch template `MyLaunchTemplate` and uses version 2 of the launch template as the base for the new version. The new launch template uses `ami-aabbccdd`. All other launch template data is inherited from the source version. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateLaunchTemplate &SourceVersion=2 &LaunchTemplateName=MyLaunchTemplate &VersionDescription=VersionWithNewAMI &LaunchTemplateData.ImageId=ami-aabbccdd &AUTHPARAMS ``` #### Sample Response ``` 6657423a-2616-461a-9ce5-3c65example 2017-10-31T11:56:00.000Z arn:aws:iam::123456789012:root false ami-aabbccdd t2.micro lt-0a20c965061f6454a MyLaunchTemplate VersionWithNewAMI 4 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLaunchTemplateVersion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLaunchTemplateVersion) # CreateLocalGatewayRoute Creates a static route for the specified local gateway route table. You must specify one of the following targets: + `LocalGatewayVirtualInterfaceGroupId` + `NetworkInterfaceId` ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The CIDR range used for destination matches. Routing decisions are based on the most specific match. Type: String Required: No **DestinationPrefixListId** The ID of the prefix list. Use a prefix list in place of `DestinationCidrBlock`. You cannot use `DestinationPrefixListId` and `DestinationCidrBlock` in the same request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableId** The ID of the local gateway route table. Type: String Required: Yes **LocalGatewayVirtualInterfaceGroupId** The ID of the virtual interface group. Type: String Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **route** Information about the route. Type: [LocalGatewayRoute](API_LocalGatewayRoute.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLocalGatewayRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLocalGatewayRoute) # CreateLocalGatewayRouteTable Creates a local gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayId** The ID of the local gateway. Type: String Required: Yes **Mode** The mode of the local gateway route table. Type: String Valid Values: `direct-vpc-routing | coip` Required: No **TagSpecification.N** The tags assigned to the local gateway route table. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **localGatewayRouteTable** Information about the local gateway route table. Type: [LocalGatewayRouteTable](API_LocalGatewayRouteTable.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLocalGatewayRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLocalGatewayRouteTable) # CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation Creates a local gateway route table virtual interface group association. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableId** The ID of the local gateway route table. Type: String Required: Yes **LocalGatewayVirtualInterfaceGroupId** The ID of the local gateway route table virtual interface group association. Type: String Required: Yes **TagSpecification.N** The tags assigned to the local gateway route table virtual interface group association. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **localGatewayRouteTableVirtualInterfaceGroupAssociation** Information about the local gateway route table virtual interface group association. Type: [LocalGatewayRouteTableVirtualInterfaceGroupAssociation](API_LocalGatewayRouteTableVirtualInterfaceGroupAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLocalGatewayRouteTableVirtualInterfaceGroupAssociation) # CreateLocalGatewayRouteTableVpcAssociation Associates the specified VPC with the specified local gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableId** The ID of the local gateway route table. Type: String Required: Yes **TagSpecification.N** The tags to assign to the local gateway route table VPC association. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **localGatewayRouteTableVpcAssociation** Information about the association. Type: [LocalGatewayRouteTableVpcAssociation](API_LocalGatewayRouteTableVpcAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLocalGatewayRouteTableVpcAssociation) # CreateLocalGatewayVirtualInterface Create a virtual interface for a local gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalAddress** The IP address assigned to the local gateway virtual interface on the Outpost side. Only IPv4 is supported. Type: String Required: Yes **LocalGatewayVirtualInterfaceGroupId** The ID of the local gateway virtual interface group. Type: String Required: Yes **OutpostLagId** References the Link Aggregation Group (LAG) that connects the Outpost to on-premises network devices. Type: String Required: Yes **PeerAddress** The peer IP address for the local gateway virtual interface. Only IPv4 is supported. Type: String Required: Yes **PeerBgpAsn** The Autonomous System Number (ASN) of the Border Gateway Protocol (BGP) peer. Type: Integer Required: No **PeerBgpAsnExtended** The extended 32-bit ASN of the BGP peer for use with larger ASN values. Type: Long Required: No **TagSpecification.N** The tags to apply to a resource when the local gateway virtual interface is being created. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Vlan** The virtual local area network (VLAN) used for the local gateway virtual interface. Type: Integer Required: Yes ## Response Elements The following elements are returned by the service. **localGatewayVirtualInterface** Information about the local gateway virtual interface. Type: [LocalGatewayVirtualInterface](API_LocalGatewayVirtualInterface.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLocalGatewayVirtualInterface) # CreateLocalGatewayVirtualInterfaceGroup Create a local gateway virtual interface group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalBgpAsn** The Autonomous System Number(ASN) for the local Border Gateway Protocol (BGP). Type: Integer Required: No **LocalBgpAsnExtended** The extended 32-bit ASN for the local BGP configuration. Type: Long Required: No **LocalGatewayId** The ID of the local gateway. Type: String Required: Yes **TagSpecification.N** The tags to apply to the local gateway virtual interface group when the resource is being created. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **localGatewayVirtualInterfaceGroup** Information about the created local gateway virtual interface group. Type: [LocalGatewayVirtualInterfaceGroup](API_LocalGatewayVirtualInterfaceGroup.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateLocalGatewayVirtualInterfaceGroup) # CreateMacSystemIntegrityProtectionModificationTask Creates a System Integrity Protection (SIP) modification task to configure the SIP settings for an x86 Mac instance or Apple silicon Mac instance. For more information, see [ Configure SIP for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/mac-sip-settings.html#mac-sip-configure) in the *Amazon EC2 User Guide*. When you configure the SIP settings for your instance, you can either enable or disable all SIP settings, or you can specify a custom SIP configuration that selectively enables or disables specific SIP settings. **Note** If you implement a custom configuration, [ connect to the instance and verify the settings](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/mac-sip-settings.html#mac-sip-check-settings) to ensure that your requirements are properly implemented and functioning as intended. SIP configurations might change with macOS updates. We recommend that you review custom SIP settings after any macOS version upgrade to ensure continued compatibility and proper functionality of your security configurations. To enable or disable all SIP settings, use the **MacSystemIntegrityProtectionStatus** parameter only. For example, to enable all SIP settings, specify the following: + `MacSystemIntegrityProtectionStatus=enabled` To specify a custom configuration that selectively enables or disables specific SIP settings, use the **MacSystemIntegrityProtectionStatus** parameter to enable or disable all SIP settings, and then use the **MacSystemIntegrityProtectionConfiguration** parameter to specify exceptions. In this case, the exceptions you specify for **MacSystemIntegrityProtectionConfiguration** override the value you specify for **MacSystemIntegrityProtectionStatus**. For example, to enable all SIP settings, except `NvramProtections`, specify the following: + `MacSystemIntegrityProtectionStatus=enabled` + `MacSystemIntegrityProtectionConfigurationRequest "NvramProtections=disabled"` ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the Amazon EC2 Mac instance. Type: String Required: Yes **MacCredentials** **[Apple silicon Mac instances only]** Specifies the following credentials: + **Internal disk administrative user** + **Username** - Only the default administrative user (`aws-managed-user`) is supported and it is used by default. You can't specify a different administrative user. + **Password** - If you did not change the default password for `aws-managed-user`, specify the default password, which is *blank*. Otherwise, specify your password. + **Amazon EBS root volume administrative user** + **Username** - If you did not change the default administrative user, specify `ec2-user`. Otherwise, specify the username for your administrative user. + **Password** - Specify the password for the administrative user. The credentials must be specified in the following JSON format: `{ "internalDiskPassword":"internal-disk-admin_password", "rootVolumeUsername":"root-volume-admin_username", "rootVolumepassword":"root-volume-admin_password" }` Type: String Required: No **MacSystemIntegrityProtectionConfiguration** Specifies the overrides to selectively enable or disable individual SIP settings. The individual settings you specify here override the overall SIP status you specify for **MacSystemIntegrityProtectionStatus**. Type: [MacSystemIntegrityProtectionConfigurationRequest](API_MacSystemIntegrityProtectionConfigurationRequest.md) object Required: No **MacSystemIntegrityProtectionStatus** Specifies the overall SIP status for the instance. To enable all SIP settings, specify `enabled`. To disable all SIP settings, specify `disabled`. Type: String Valid Values: `enabled | disabled` Required: Yes **TagSpecification.N** Specifies tags to apply to the SIP modification task. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **macModificationTask** Information about the SIP modification task. Type: [MacModificationTask](API_MacModificationTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateMacSystemIntegrityProtectionModificationTask) # CreateManagedPrefixList Creates a managed prefix list. You can specify entries for the prefix list. Each entry consists of a CIDR block and an optional description. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddressFamily** The IP address type. Valid Values: `IPv4` \$1 `IPv6` Type: String Required: Yes **ClientToken** Unique, case-sensitive identifier you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Constraints: Up to 255 UTF-8 characters in length. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Entry.N** One or more entries for the prefix list. Type: Array of [AddPrefixListEntry](API_AddPrefixListEntry.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. Required: No **MaxEntries** The maximum number of entries for the prefix list. Type: Integer Required: Yes **PrefixListName** A name for the prefix list. Constraints: Up to 255 characters in length. The name cannot start with `com.amazonaws`. Type: String Required: Yes **TagSpecification.N** The tags to apply to the prefix list during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **prefixList** Information about the prefix list. Type: [ManagedPrefixList](API_ManagedPrefixList.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a managed prefix list with a maximum of 10 entries, and adds 2 entries. The prefix list support IPv4 CIDR blocks. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateManagedPrefixList &PrefixListName=tgw-attachments &Entry.1.Cidr=10.0.0.0/16 &Entry.1.Description=vpc-a &Entry.2.Cidr=10.2.0.0/16 &Entry.2.Description=vpc-b &MaxEntries=10 &AddressFamily=IPv4 &AUTHPARAMS ``` #### Sample Response ``` 2989de6e-5305-49c7-809a-example IPv4 10 123456789012 arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123abcd pl-0123123123123abcd tgw-attachments create-in-progress 1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateManagedPrefixList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateManagedPrefixList) # CreateNatGateway Creates a NAT gateway in the specified subnet. This action creates a network interface in the specified subnet with a private IP address from the IP address range of the subnet. You can create either a public NAT gateway or a private NAT gateway. With a public NAT gateway, internet-bound traffic from a private subnet can be routed to the NAT gateway, so that instances in a private subnet can connect to the internet. With a private NAT gateway, private communication is routed across VPCs and on-premises networks through a transit gateway or virtual private gateway. Common use cases include running large workloads behind a small pool of allowlisted IPv4 addresses, preserving private IPv4 addresses, and communicating between overlapping networks. For more information, see [NAT gateways](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-nat-gateway.html) in the *Amazon VPC User Guide*. **Important** When you create a public NAT gateway and assign it an EIP or secondary EIPs, the network border group of the EIPs must match the network border group of the Availability Zone (AZ) that the public NAT gateway is in. If it's not the same, the NAT gateway will fail to launch. You can see the network border group for the subnet's AZ by viewing the details of the subnet. Similarly, you can view the network border group of an EIP by viewing the details of the EIP address. For more information about network border groups and EIPs, see [Allocate an Elastic IP address](https://docs.aws.amazon.com/vpc/latest/userguide/WorkWithEIPs.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId** [Public NAT gateways only] The allocation ID of an Elastic IP address to associate with the NAT gateway. You cannot specify an Elastic IP address with a private NAT gateway. If the Elastic IP address is associated with another resource, you must first disassociate it. Type: String Required: No **AvailabilityMode** Specifies whether to create a zonal (single-AZ) or regional (multi-AZ) NAT gateway. Defaults to `zonal`. A zonal NAT gateway is a NAT Gateway that provides redundancy and scalability within a single availability zone. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region. For more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*. Type: String Valid Values: `zonal | regional` Required: No **AvailabilityZoneAddress.N** For regional NAT gateways only: Specifies which Availability Zones you want the NAT gateway to support and the Elastic IP addresses (EIPs) to use in each AZ. The regional NAT gateway uses these EIPs to handle outbound NAT traffic from their respective AZs. If not specified, the NAT gateway will automatically expand to new AZs and associate EIPs upon detection of an elastic network interface. If you specify this parameter, auto-expansion is disabled and you must manually manage AZ coverage. A regional NAT gateway is a single NAT Gateway that works across multiple availability zones (AZs) in your VPC, providing redundancy, scalability and availability across all the AZs in a Region. For more information, see [Regional NAT gateways for automatic multi-AZ expansion](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateways-regional.html) in the *Amazon VPC User Guide*. Type: Array of [AvailabilityZoneAddress](API_AvailabilityZoneAddress.md) objects Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Constraint: Maximum 64 ASCII characters. Type: String Required: No **ConnectivityType** Indicates whether the NAT gateway supports public or private connectivity. The default is public connectivity. Type: String Valid Values: `private | public` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PrivateIpAddress** The private IPv4 address to assign to the NAT gateway. If you don't provide an address, a private IPv4 address will be automatically assigned. Type: String Required: No **SecondaryAllocationId.N** Secondary EIP allocation IDs. For more information, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*. Type: Array of strings Required: No **SecondaryPrivateIpAddress.N** Secondary private IPv4 addresses. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*. Type: Array of strings Required: No **SecondaryPrivateIpAddressCount** [Private NAT gateway only] The number of secondary private IPv4 addresses you want to assign to the NAT gateway. For more information about secondary addresses, see [Create a NAT gateway](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html) in the *Amazon VPC User Guide*. Type: Integer Valid Range: Minimum value of 1. Maximum value of 31. Required: No **SubnetId** The ID of the subnet in which to create the NAT gateway. Type: String Required: No **TagSpecification.N** The tags to assign to the NAT gateway. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC where you want to create a regional NAT gateway. Type: String Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. Type: String **natGateway** Information about the NAT gateway. Type: [NatGateway](API_NatGateway.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a public NAT gateway in the specified subnet and associates the Elastic IP address with the specified allocation ID to the NAT gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNatGateway &SubnetId=subnet-1234567890abcdef0 &AllocationId=eipalloc-0abcdef1234567890 &AUTHPARAMS ``` #### Sample Response ``` 1b74dc5c-bcda-403f-867d-example subnet-1234567890abcdef0 eipalloc-0abcdef1234567890 eni-0123abc456def7890 10.0.0.191 203.0.113.5 2019-11-25T14:00:55.416Z vpc-0598c7d356eba48d7 nat-04e77a5e9c34432f9 public pending ``` ### Example 2 This example creates a private NAT gateway in the specified subnet. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNatGateway &SubnetId=subnet-1234567890abcdef0 &ConnectivityType=private &AUTHPARAMS ``` #### Sample Response ``` 1b74dc5c-bcda-403f-867d-example subnet-1234567890abcdef0 eni-1a2b3c4d5e6f78901 10.0.1.26 2021-06-05T14:00:55.416Z vpc-0598c7d356eba48d7 nat-04e77a5e9c34432f9 private pending ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateNatGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateNatGateway) # CreateNetworkAcl Creates a network ACL in a VPC. Network ACLs provide an optional layer of security (in addition to security groups) for the instances in your VPC. For more information, see [Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to assign to the network ACL. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. Type: String **networkAcl** Information about the network ACL. Type: [NetworkAcl](API_NetworkAcl.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a network ACL in the specified IPv6-enabled VPC. The response includes default IPv4 and IPv6 entries for egress and ingress traffic, each with a high rule number. These are the last entries we process to decide whether traffic is allowed in or out of an associated subnet. If the traffic doesn't match any rules with a lower rule number, then these default entries ultimately deny the traffic. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkAcl &VpcId=vpc-11ad4878 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE acl-5fb85d36 vpc-11ad4878 false 32767 all deny true 0.0.0.0/0 32767 all deny false 0.0.0.0/0 32768 all deny true ::/0 32768 all deny false ::/0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateNetworkAcl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateNetworkAcl) # CreateNetworkAclEntry Creates an entry (a rule) in a network ACL with the specified rule number. Each network ACL has a set of numbered ingress rules and a separate set of numbered egress rules. When determining whether a packet should be allowed in or out of a subnet associated with the ACL, we process the entries in the ACL according to the rule numbers, in ascending order. Each network ACL has a set of ingress rules and a separate set of egress rules. We recommend that you leave room between the rule numbers (for example, 100, 110, 120, ...), and not number them one right after the other (for example, 101, 102, 103, ...). This makes it easier to add a rule between existing ones without having to renumber the rules. After you add an entry, you can't modify it; you must either replace it, or create an entry and delete the old one. For more information about network ACLs, see [Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CidrBlock** The IPv4 network range to allow or deny, in CIDR notation (for example `172.16.0.0/24`). We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18`, we modify it to `100.68.0.0/18`. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Egress** Indicates whether this is an egress rule (rule is applied to traffic leaving the subnet). Type: Boolean Required: Yes **Icmp** ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block. Type: [IcmpTypeCode](API_IcmpTypeCode.md) object Required: No **Ipv6CidrBlock** The IPv6 network range to allow or deny, in CIDR notation (for example `2001:db8:1234:1a00::/64`). Type: String Required: No **NetworkAclId** The ID of the network ACL. Type: String Required: Yes **PortRange** TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP). Type: [PortRange](API_PortRange.md) object Required: No **Protocol** The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code. Type: String Required: Yes **RuleAction** Indicates whether to allow or deny the traffic that matches the rule. Type: String Valid Values: `allow | deny` Required: Yes **RuleNumber** The rule number for the entry (for example, 100). ACL entries are processed in ascending order by rule number. Constraints: Positive integer from 1 to 32766. The range 32767 to 65535 is reserved for internal use. Type: Integer Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates an entry with rule number 110 in the specified network ACL. The rule allows ingress traffic from any IPv4 address (`0.0.0.0/0`) on UDP port 53. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkAclEntry &NetworkAclId=acl-2cb85d45 &RuleNumber=110 &Protocol="17" &RuleAction=allow &Egress=false &CidrBlock=0.0.0.0/0 &PortRange.From=53 &PortRange.To=53 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ### Example 2 This example creates an entry with rule number 120 in the specified network ACL. The rule allows ingress traffic from any IPv6 address (`::/0`) on TCP port 80. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkAclEntry &NetworkAclId=acl-2cb85d45 &RuleNumber=120 &Protocol="6" &RuleAction=allow &Egress=false &Ipv6CidrBlock=::/0 &PortRange.From=80 &PortRange.To=80 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateNetworkAclEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateNetworkAclEntry) # CreateNetworkInsightsAccessScope Creates a Network Access Scope. AWS Network Access Analyzer enables cloud networking and cloud operations teams to verify that their networks on AWS conform to their network security and governance objectives. For more information, see the [AWS Network Access Analyzer Guide](https://docs.aws.amazon.com/vpc/latest/network-access-analyzer/). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExcludePath.N** The paths to exclude. Type: Array of [AccessScopePathRequest](API_AccessScopePathRequest.md) objects Required: No **MatchPath.N** The paths to match. Type: Array of [AccessScopePathRequest](API_AccessScopePathRequest.md) objects Required: No **TagSpecification.N** The tags to apply. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **networkInsightsAccessScope** The Network Access Scope. Type: [NetworkInsightsAccessScope](API_NetworkInsightsAccessScope.md) object **networkInsightsAccessScopeContent** The Network Access Scope content. Type: [NetworkInsightsAccessScopeContent](API_NetworkInsightsAccessScopeContent.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateNetworkInsightsAccessScope) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateNetworkInsightsAccessScope) # CreateNetworkInsightsPath Creates a path to analyze for reachability. Reachability Analyzer enables you to analyze and debug network reachability between two resources in your virtual private cloud (VPC). For more information, see the [Reachability Analyzer Guide](https://docs.aws.amazon.com/vpc/latest/reachability/). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: Yes **Destination** The ID or ARN of the destination. If the resource is in another account, you must specify an ARN. Type: String Required: No **DestinationIp** The IP address of the destination. Type: String Length Constraints: Minimum length of 0. Maximum length of 15. Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$` Required: No **DestinationPort** The destination port. Type: Integer Valid Range: Minimum value of 0. Maximum value of 65535. Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FilterAtDestination** Scopes the analysis to network paths that match specific filters at the destination. If you specify this parameter, you can't specify the parameter for the destination IP address. Type: [PathRequestFilter](API_PathRequestFilter.md) object Required: No **FilterAtSource** Scopes the analysis to network paths that match specific filters at the source. If you specify this parameter, you can't specify the parameters for the source IP address or the destination port. Type: [PathRequestFilter](API_PathRequestFilter.md) object Required: No **Protocol** The protocol. Type: String Valid Values: `tcp | udp` Required: Yes **Source** The ID or ARN of the source. If the resource is in another account, you must specify an ARN. Type: String Required: Yes **SourceIp** The IP address of the source. Type: String Length Constraints: Minimum length of 0. Maximum length of 15. Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$` Required: No **TagSpecification.N** The tags to add to the path. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **networkInsightsPath** Information about the path. Type: [NetworkInsightsPath](API_NetworkInsightsPath.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateNetworkInsightsPath) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateNetworkInsightsPath) # CreateNetworkInterface Creates a network interface in the specified subnet. The number of IP addresses you can assign to a network interface varies by instance type. For more information about network interfaces, see [Elastic network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **ConnectionTrackingSpecification** A connection tracking specification for the network interface. Type: [ConnectionTrackingSpecificationRequest](API_ConnectionTrackingSpecificationRequest.md) object Required: No **Description** A description for the network interface. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EnablePrimaryIpv6** If you’re creating a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. AWS will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address. Type: Boolean Required: No **InterfaceType** The type of network interface. The default is `interface`. If you specify `efa-only`, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses. Type: String Valid Values: `interface | efa | efa-only | trunk` Required: No **Ipv4Prefix.N** The IPv4 prefixes assigned to the network interface. You can't specify IPv4 prefixes if you've specified one of the following: a count of IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses. Type: Array of [Ipv4PrefixSpecificationRequest](API_Ipv4PrefixSpecificationRequest.md) objects Required: No **Ipv4PrefixCount** The number of IPv4 prefixes that AWS automatically assigns to the network interface. You can't specify a count of IPv4 prefixes if you've specified one of the following: specific IPv4 prefixes, specific private IPv4 addresses, or a count of private IPv4 addresses. Type: Integer Required: No **Ipv6AddressCount** The number of IPv6 addresses to assign to a network interface. Amazon EC2 automatically selects the IPv6 addresses from the subnet range. You can't specify a count of IPv6 addresses using this parameter if you've specified one of the following: specific IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes. If your subnet has the `AssignIpv6AddressOnCreation` attribute set, you can override that setting by specifying 0 as the IPv6 address count. Type: Integer Required: No **Ipv6Addresses.N** The IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't specify IPv6 addresses using this parameter if you've specified one of the following: a count of IPv6 addresses, specific IPv6 prefixes, or a count of IPv6 prefixes. Type: Array of [InstanceIpv6Address](API_InstanceIpv6Address.md) objects Required: No **Ipv6Prefix.N** The IPv6 prefixes assigned to the network interface. You can't specify IPv6 prefixes if you've specified one of the following: a count of IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. Type: Array of [Ipv6PrefixSpecificationRequest](API_Ipv6PrefixSpecificationRequest.md) objects Required: No **Ipv6PrefixCount** The number of IPv6 prefixes that AWS automatically assigns to the network interface. You can't specify a count of IPv6 prefixes if you've specified one of the following: specific IPv6 prefixes, specific IPv6 addresses, or a count of IPv6 addresses. Type: Integer Required: No **Operator** Reserved for internal use. Type: [OperatorRequest](API_OperatorRequest.md) object Required: No **PrivateIpAddress** The primary private IPv4 address of the network interface. If you don't specify an IPv4 address, Amazon EC2 selects one for you from the subnet's IPv4 CIDR range. If you specify an IP address, you cannot indicate any IP addresses specified in `privateIpAddresses` as primary (only one IP address can be designated as primary). Type: String Required: No **PrivateIpAddresses.N** The private IPv4 addresses. You can't specify private IPv4 addresses if you've specified one of the following: a count of private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes. Type: Array of [PrivateIpAddressSpecification](API_PrivateIpAddressSpecification.md) objects Required: No **SecondaryPrivateIpAddressCount** The number of secondary private IPv4 addresses to assign to a network interface. When you specify a number of secondary IPv4 addresses, Amazon EC2 selects these IP addresses within the subnet's IPv4 CIDR range. You can't specify this option and specify more than one private IP address using `privateIpAddresses`. You can't specify a count of private IPv4 addresses if you've specified one of the following: specific private IPv4 addresses, specific IPv4 prefixes, or a count of IPv4 prefixes. Type: Integer Required: No **SecurityGroupId.N** The IDs of the security groups. Type: Array of strings Required: No **SubnetId** The ID of the subnet to associate with the network interface. Type: String Required: Yes **TagSpecification.N** The tags to apply to the new network interface. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **networkInterface** Information about the network interface. Type: [NetworkInterface](API_NetworkInterface.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a network interface in the specified subnet with a primary IPv4 address that is automatically selected by Amazon EC2. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkInterface &SubnetId=subnet-b2a249da &AUTHPARAMS ``` #### Sample Response ``` 8dbe591e-5a22-48cb-b948-example eni-cfca76a6 subnet-b2a249da vpc-c31dafaa ap-southeast-1b 251839141158 false available 02:74:b0:72:79:61 10.0.2.157 ip-10-0-2-157.ap-southeast-1.compute.internal true sg-1a2b3c4d default 10.0.2.157 ip-10-0-2-157.ap-southeast-1.compute.internal true ``` ### Example 2 This example creates a network interface in the specified subnet with a primary IPv4 address of `10.0.2.140` and four secondary private IPv4 addresses that are automatically selected by Amazon EC2. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkInterface &PrivateIpAddresses.1.Primary=true &PrivateIpAddresses.1.PrivateIpAddress=10.0.2.140 &SecondaryPrivateIpAddressCount=4 &SubnetId=subnet-a61dafcf &AUTHPARAMS ``` #### Sample Response ``` bd78c839-0895-4fac-a17f-example eni-1bcb7772 subnet-a61dafcf vpc-c31dafaa ap-southeast-1b 251839141158 false pending 02:74:b0:70:7f:1a 10.0.2.140 true sg-1a2b3c4d default 10.0.2.140 true 10.0.2.172 false 10.0.2.169 false 10.0.2.170 false 10.0.2.171 false ``` ### Example 3 This example creates a network interface with a primary private IPv4 address of 10.0.2.130 and two secondary IPv4 addresses of 10.0.2.132 and 10.0.2.133. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkInterface &PrivateIpAddresses.1.Primary=true &PrivateIpAddresses.1.PrivateIpAddress=10.0.2.130 &PrivateIpAddresses.2.Primary=false &PrivateIpAddresses.2.PrivateIpAddress=10.0.2.132 &PrivateIpAddresses.3.Primary=false &PrivateIpAddresses.3.PrivateIpAddress=10.0.2.133 &SubnetId=subnet-a61dafcf &AUTHPARAMS ``` ### Example 4 This example creates a network interface with a primary private IPv4 address of 10.0.2.130 and two IPv6 addresses that are selected by Amazon EC2. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkInterface &PrivateIpAddresses.1.Primary=true &PrivateIpAddresses.1.PrivateIpAddress=10.0.2.130 &Ipv6AddressCount=2 &SubnetId=subnet-a61dafcf &AUTHPARAMS ``` #### Sample Response ``` a9565f4c-f928-4113-859b-example eni-41c47828 subnet-a61dafcf vpc-c31dafaa ap-southeast-1b 251839141158 false pending 02:74:b0:78:bf:ab 10.0.2.130 true sg-188d9f74 default 10.0.2.130 true 2001:db8:1234:1a00::123 2001:db8:1234:1a00::456 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateNetworkInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateNetworkInterface) # CreateNetworkInterfacePermission Grants an AWS-authorized account permission to attach the specified network interface to an instance in their account. You can grant permission to a single AWS account only, and only one account at a time. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AwsAccountId** The AWS account ID. Type: String Required: No **AwsService** The AWS service. Currently not supported. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: Yes **Permission** The type of permission to grant. Type: String Valid Values: `INSTANCE-ATTACH | EIP-ASSOCIATE` Required: Yes ## Response Elements The following elements are returned by the service. **interfacePermission** Information about the permission for the network interface. Type: [NetworkInterfacePermission](API_NetworkInterfacePermission.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example grants permission to account `123456789012` to attach network interface `eni-1a2b3c4d` to an instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateNetworkInterfacePermission &NetworkInterfaceId=eni-1a2b3c4d &AwsAccountId=123456789012 &Permission=INSTANCE-ATTACH &AUTHPARAMS ``` #### Sample Response ``` e9633d41-093e-4944-981b-ca7example 123456789012 eni-1a2b3c4d eni-perm-06fd19020ede149ea INSTANCE-ATTACH GRANTED ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateNetworkInterfacePermission) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateNetworkInterfacePermission) # CreatePlacementGroup Creates a placement group in which to launch instances. The strategy of the placement group determines how the instances are organized within the group. A `cluster` placement group is a logical grouping of instances within a single Availability Zone that benefit from low network latency, high network throughput. A `spread` placement group places instances on distinct hardware. A `partition` placement group places groups of instances in different partitions, where instances in one partition do not share the same hardware with instances in another partition. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupName** A name for the placement group. Must be unique within the scope of your account for the Region. Constraints: Up to 255 ASCII characters Type: String Required: No **LinkedGroupId** Reserved for future use. Type: String Required: No **Operator** Reserved for internal use. Type: [OperatorRequest](API_OperatorRequest.md) object Required: No **PartitionCount** The number of partitions. Valid only when **Strategy** is set to `partition`. Type: Integer Required: No **SpreadLevel** Determines how placement groups spread instances. + Host – You can use `host` only with Outpost placement groups. + Rack – No usage restrictions. Type: String Valid Values: `host | rack` Required: No **Strategy** The placement strategy. Type: String Valid Values: `cluster | spread | partition` Required: No **TagSpecification.N** The tags to apply to the new placement group. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **placementGroup** Information about the placement group. Type: [PlacementGroup](API_PlacementGroup.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a cluster placement group named `XYZ-cluster`, and applies a tag with a key of `purpose` and a value of `production`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreatePlacementGroup &GroupName=XYZ-cluster &Strategy=cluster &TagSpecification.1.ResourceType=placement-group &TagSpecification.1.Tag.1.Key=purpose &TagSpecification.1.Tag.1.Value=production &AUTHPARAMS ``` #### Sample Response ``` 1bbcaf48-7155-4154-a7ac-c6031EXAMPLE true XYZ-cluster pg-0bea00ad0bexample cluster available purpose production ``` ### Example This example creates a partition placement group named `HDFS-Group-A` with five partitions. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreatePlacementGroup &GroupName=HDFS-Group-A &Strategy=partition &PartitionCount=5 &AUTHPARAMS ``` #### Sample Response ``` 1bbcaf48-7155-4154-a7ac-c6031EXAMPLE true HDFS-Group-A pg-0fc13f6eb3example partition available 5 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreatePlacementGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreatePlacementGroup) # CreatePublicIpv4Pool Creates a public IPv4 address pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to AWS to manage with IPAM. IPv6 addresses you bring to AWS, however, use IPAM pools only. To monitor the status of pool creation, use [DescribePublicIpv4Pools](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribePublicIpv4Pools.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkBorderGroup** The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see [Local Zone availability](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail) in the *Amazon EC2 User Guide*. Type: String Required: No **TagSpecification.N** The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **poolId** The ID of the public IPv4 pool. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreatePublicIpv4Pool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreatePublicIpv4Pool) # CreateReplaceRootVolumeTask Replaces the EBS-backed root volume for a `running` instance with a new volume that is restored to the original root volume's launch state, that is restored to a specific snapshot taken from the original root volume, or that is restored from an AMI that has the same key characteristics as that of the instance. For more information, see [Replace a root volume](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DeleteReplacedRootVolume** Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify `true`. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it. Type: Boolean Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance. If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter. Type: String Required: No **InstanceId** The ID of the instance for which to replace the root volume. Type: String Required: Yes **SnapshotId** The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume. If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter. Type: String Required: No **TagSpecification.N** The tags to apply to the root volume replacement task. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VolumeInitializationRate** Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the replacement root volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. Omit this parameter if: + You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. **Note** If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. + You want to create a volume that is initialized at the default rate. For more information, see [ Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*. Valid range: 100 - 300 MiB/s Type: Long Required: No ## Response Elements The following elements are returned by the service. **replaceRootVolumeTask** Information about the root volume replacement task. Type: [ReplaceRootVolumeTask](API_ReplaceRootVolumeTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateReplaceRootVolumeTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateReplaceRootVolumeTask) # CreateReservedInstancesListing Creates a listing for Amazon EC2 Standard Reserved Instances to be sold in the Reserved Instance Marketplace. You can submit one Standard Reserved Instance listing at a time. To get a list of your Standard Reserved Instances, you can use the [DescribeReservedInstances](API_DescribeReservedInstances.md) operation. **Note** Only Standard Reserved Instances can be sold in the Reserved Instance Marketplace. Convertible Reserved Instances cannot be sold. The Reserved Instance Marketplace matches sellers who want to resell Standard Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. To sell your Standard Reserved Instances, you must first register as a seller in the Reserved Instance Marketplace. After completing the registration process, you can create a Reserved Instance Marketplace listing of some or all of your Standard Reserved Instances, and specify the upfront price to receive for them. Your Standard Reserved Instance listings then become available for purchase. To view the details of your Standard Reserved Instance listing, you can use the [DescribeReservedInstancesListings](API_DescribeReservedInstancesListings.md) operation. For more information, see [Sell in the Reserved Instance Marketplace](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier you provide to ensure idempotency of your listings. This helps avoid duplicate listings. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: Yes **InstanceCount** The number of instances that are a part of a Reserved Instance account to be listed in the Reserved Instance Marketplace. This number should be less than or equal to the instance count associated with the Reserved Instance ID specified in this call. Type: Integer Required: Yes **PriceSchedules.N** A list specifying the price of the Standard Reserved Instance for each month remaining in the Reserved Instance term. Type: Array of [PriceScheduleSpecification](API_PriceScheduleSpecification.md) objects Required: Yes **ReservedInstancesId** The ID of the active Standard Reserved Instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **reservedInstancesListingsSet** Information about the Standard Reserved Instance listing. Type: Array of [ReservedInstancesListing](API_ReservedInstancesListing.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a Reserved Instance Marketplace listing from the specified Standard Reserved Instance, which has 11 months remaining in its term. In this example, we set the upfront price at \$12.50, and the price drops over the course of the 11-month term if the instance is still not sold. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateReservedInstancesListing &ClientToken=myIdempToken1 &InstanceCount=1 &PriceSchedules.1.Price=2.5 &PriceSchedules.1.Term=11 &PriceSchedules.2.Price=2.0 &PriceSchedules.2.Term=8 &PriceSchedules.3.Price=1.5 &PriceSchedules.3.Term=5 &PriceSchedules.4.Price=0.7 &PriceSchedules.4.Term=3 &PriceSchedules.5.Price=0.1 &PriceSchedules.5.Term=1 &ReservedInstancesId=e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` a42481af-335a-4e9e-b291-bd18dexample 5ec28771-05ff-4b9b-aa31-9e57dEXAMPLE e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE 2012-07-17T17:11:09.449Z 2012-07-17T17:11:09.468Z active ACTIVE Available 1 Sold 0 Cancelled 0 Pending 0 11 2.5 USD true 10 2.5 USD false 9 2.5 USD false 8 2.0 USD false 7 2.0 USD false 6 2.0 USD false 5 1.5 USD false 4 1.5 USD false 3 0.7 USD false 2 0.7 USD false 1 0.1 USD false myIdempToken1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateReservedInstancesListing) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateReservedInstancesListing) # CreateRestoreImageTask Starts a task that restores an AMI from an Amazon S3 object that was previously created by using [CreateStoreImageTask](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateStoreImageTask.html). To use this API, you must have the required permissions. For more information, see [Permissions for storing and restoring AMIs using S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-ami-store-restore.html#ami-s3-permissions) in the *Amazon EC2 User Guide*. For more information, see [Store and restore an AMI using S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Bucket** The name of the Amazon S3 bucket that contains the stored AMI object. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Name** The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI. Type: String Required: No **ObjectKey** The name of the stored AMI object in the bucket. Type: String Required: Yes **TagSpecification.N** The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both. + To tag the AMI, the value for `ResourceType` must be `image`. + To tag the snapshots, the value for `ResourceType` must be `snapshot`. The same tag is applied to all of the snapshots that are created. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **imageId** The AMI ID. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateRestoreImageTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateRestoreImageTask) # CreateRoute Creates a route in a route table within a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address `192.0.2.3`, and the route table includes the following two IPv4 routes: + `192.0.2.0/24` (goes to some target A) + `192.0.2.0/28` (goes to some target B) Both routes apply to the traffic destined for `192.0.2.3`. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CarrierGatewayId** The ID of the carrier gateway. You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone. Type: String Required: No **CoreNetworkArn** The Amazon Resource Name (ARN) of the core network. Type: String Required: No **DestinationCidrBlock** The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18`, we modify it to `100.68.0.0/18`. Type: String Required: No **DestinationIpv6CidrBlock** The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. Type: String Required: No **DestinationPrefixListId** The ID of a prefix list used for the destination match. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EgressOnlyInternetGatewayId** [IPv6 traffic only] The ID of an egress-only internet gateway. Type: String Required: No **GatewayId** The ID of an internet gateway or virtual private gateway attached to your VPC. Type: String Required: No **InstanceId** The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. Type: String Required: No **LocalGatewayId** The ID of the local gateway. Type: String Required: No **NatGatewayId** [IPv4 traffic only] The ID of a NAT gateway. Type: String Required: No **NetworkInterfaceId** The ID of a network interface. Type: String Required: No **OdbNetworkArn** The Amazon Resource Name (ARN) of the ODB network. Type: String Required: No **RouteTableId** The ID of the route table for the route. Type: String Required: Yes **TransitGatewayId** The ID of a transit gateway. Type: String Required: No **VpcEndpointId** The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. Type: String Required: No **VpcPeeringConnectionId** The ID of a VPC peering connection. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a route in the route table with the ID `rtb-1122334455667788a`. The route matches all IPv4 traffic (`0.0.0.0/0`) and routes it to the internet gateway with the ID `igw-eaad4883`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateRoute &RouteTableId=rtb-1122334455667788a &DestinationCidrBlock=0.0.0.0/0 &GatewayId=igw-eaad4883 &AUTHPARAMS ``` ### Example 2 This example creates a route in the route table with the ID `rtb-1122334455667788a`. The route sends all IPv4 traffic (`0.0.0.0/0`) to the NAT instance with the ID `i-1234567890abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateRoute &RouteTableId=rtb-1122334455667788a &DestinationCidrBlock=0.0.0.0/0 &InstanceId=i-1234567890abcdef0 &AUTHPARAMS ``` ### Example 3 This example creates a route in route table `rtb-1122334455667788a`. The route matches traffic for the IPv4 CIDR block `10.0.0.0/16` and routes it to VPC peering connection, `pcx-111aaa22`. This route enables IPv4 traffic to be directed to the other peered VPC in the VPC peering connection. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateRoute &RouteTableId=rtb-1122334455667788a&DestinationCidrBlock=10.0.0.0/16 &vpcPeeringConnectionId=pcx-111aaa22 &AUTHPARAMS ``` ### Example 4 This example creates a route in route table `rtb-1122334455667788a`. The route sends all IPv6 traffic `::/0` to an egress-only internet gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateRoute &RouteTableId=rtb-1122334455667788a &DestinationIpv6CidrBlock=::/0 &EgressOnlyInternetGatewayId=eigw-1234567890abc1234 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateRoute) # CreateRouteServer Creates a new route server to manage dynamic routing in a VPC. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: + VPC route tables not associated with subnets + Subnet route tables + Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html). For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AmazonSideAsn** The private Autonomous System Number (ASN) for the Amazon side of the BGP session. Valid values are from 1 to 4294967295. We recommend using a private ASN in the 64512–65534 (16-bit ASN) or 4200000000–4294967294 (32-bit ASN) range. Type: Long Required: Yes **ClientToken** Unique, case-sensitive identifier to ensure idempotency of the request. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PersistRoutes** Indicates whether routes should be persisted after all BGP sessions are terminated. Type: String Valid Values: `enable | disable | reset` Required: No **PersistRoutesDuration** The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is `enabled`. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes. Type: Long Required: No **SnsNotificationsEnabled** Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS. Type: Boolean Required: No **TagSpecification.N** The tags to apply to the route server during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServer** Information about the created route server. Type: [RouteServer](API_RouteServer.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateRouteServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateRouteServer) # CreateRouteServerEndpoint Creates a new endpoint for a route server in a specified subnet. A route server endpoint is an AWS-managed component inside a subnet that facilitates [BGP (Border Gateway Protocol)](https://en.wikipedia.org/wiki/Border_Gateway_Protocol) connections between your route server and your BGP peers. For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier to ensure idempotency of the request. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The ID of the route server for which to create an endpoint. Type: String Required: Yes **SubnetId** The ID of the subnet in which to create the route server endpoint. Type: String Required: Yes **TagSpecification.N** The tags to apply to the route server endpoint during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerEndpoint** Information about the created route server endpoint. Type: [RouteServerEndpoint](API_RouteServerEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateRouteServerEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateRouteServerEndpoint) # CreateRouteServerPeer Creates a new BGP peer for a specified route server endpoint. A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: + Have an elastic network interface in the VPC + Support BGP (Border Gateway Protocol) + Can initiate BGP sessions For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BgpOptions** The BGP options for the peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings. Type: [RouteServerBgpOptionsRequest](API_RouteServerBgpOptionsRequest.md) object Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PeerAddress** The IPv4 address of the peer device. Type: String Required: Yes **RouteServerEndpointId** The ID of the route server endpoint for which to create a peer. Type: String Required: Yes **TagSpecification.N** The tags to apply to the route server peer during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerPeer** Information about the created route server peer. Type: [RouteServerPeer](API_RouteServerPeer.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateRouteServerPeer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateRouteServerPeer) # CreateRouteTable Creates a route table for the specified VPC. After you create a route table, you can add routes and associate the table with a subnet. For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to assign to the route table. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. Type: String **requestId** The ID of the request. Type: String **routeTable** Information about the route table. Type: [RouteTable](API_RouteTable.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a route table for the VPC with the ID `vpc-1122334455667788a`. By default, every route table includes a local route that enables traffic to flow within the VPC. The following response shows that route. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateRouteTable &VpcId=vpc-1122334455667788a &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE rtb-029e01e661a8fffd9 vpc-11ad4878 10.0.0.0/22 local active ``` ### Example 2 This example creates a route table for a VPC that has an associated IPv6 CIDR block. The route table includes a local route that enables IPv6 traffic to flow within the VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateRouteTable &VpcId=vpc-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE rtb-8bda6cef vpc-1a2b3c4d 10.0.0.0/16 local active CreateRouteTable 2001:db8:1234:1a00::/56 local active CreateRouteTable ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateRouteTable) # CreateSecondaryNetwork Creates a secondary network. The allowed size for a secondary network CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Ipv4CidrBlock** The IPv4 CIDR block for the secondary network. The CIDR block size must be between /12 and /28. Type: String Required: Yes **NetworkType** The type of secondary network. Type: String Valid Values: `rdma` Required: Yes **TagSpecification.N** The tags to assign to the secondary network. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. Type: String **requestId** The ID of the request. Type: String **secondaryNetwork** Information about the secondary network. Type: [SecondaryNetwork](API_SecondaryNetwork.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a rdma secondary network with a /16 CIDR block. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSecondaryNetwork &Ipv4CidrBlock=10.0.0.0/16 &NetworkType=rdma &ClientToken=550e8400-e29b-41d4-a716-446655440000 &TagSpecification.1.ResourceType=secondary-network &TagSpecification.1.Tag.1.Key=Name &TagSpecification.1.Tag.1.Value=Prod%20Secondary%20Network &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE sn-0123456789abcdef0 arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0123456789abcdef0 123456789012 rdma create-in-progress sn-cidr-assoc-56789901234abcdef0 10.0.0.0/16 associating Name Prod Secondary Network 550e8400-e29b-41d4-a716-446655440000 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSecondaryNetwork) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSecondaryNetwork) # CreateSecondarySubnet Creates a secondary subnet in a secondary network. A secondary subnet CIDR block must not overlap with the CIDR block of an existing secondary subnet in the secondary network. After you create a secondary subnet, you can't change its CIDR block. The allowed size for a secondary subnet CIDR block is between /28 netmask (16 IP addresses) and /12 netmask (1,048,576 IP addresses). Amazon reserves the first four IP addresses and the last IP address in each secondary subnet for internal use. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** The Availability Zone for the secondary subnet. You cannot specify both `AvailabilityZone` and `AvailabilityZoneId` in the same request. Type: String Required: No **AvailabilityZoneId** The ID of the Availability Zone for the secondary subnet. This option is preferred over `AvailabilityZone` as it provides a consistent identifier across AWS accounts. You cannot specify both `AvailabilityZone` and `AvailabilityZoneId` in the same request. Type: String Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Ipv4CidrBlock** The IPv4 CIDR block for the secondary subnet. The CIDR block size must be between /12 and /28. Type: String Required: Yes **SecondaryNetworkId** The ID of the secondary network in which to create the secondary subnet. Type: String Required: Yes **TagSpecification.N** The tags to assign to the secondary subnet. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. Type: String **requestId** The ID of the request. Type: String **secondarySubnet** Information about the secondary subnet. Type: [SecondarySubnet](API_SecondarySubnet.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a secondary subnet with a /24 CIDR block in the specified secondary network and Availability Zone. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSecondarySubnet &SecondaryNetworkId=sn-0123456789abcdef0 &Ipv4CidrBlock=10.0.0.0/24 &AvailabilityZoneId=use2-az1 &ClientToken=550e8400-e29b-41d4-a716-446655440000 &TagSpecification.1.ResourceType=secondary-subnet &TagSpecification.1.Tag.1.Key=Name &TagSpecification.1.Tag.1.Value=Prod%20Secondary%20Subnet &TagSpecification.1.Tag.2.Key=Environment &TagSpecification.1.Tag.2.Value=Production &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ss-0123456789abcdef0 arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0123456789abcdef0 sn-0123456789abcdef0 rdma 123456789012 use2-az1 us-east-2a ss-cidr-assoc-56789901234abcdef0 10.0.0.0/24 associating create-in-progress Name Prod Secondary Subnet Environment Production 550e8400-e29b-41d4-a716-446655440000 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSecondarySubnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSecondarySubnet) # CreateSecurityGroup Creates a security group. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. For more information, see [Amazon EC2 security groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html) in the *Amazon EC2 User Guide* and [Security groups for your VPC](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_SecurityGroups.html) in the *Amazon VPC User Guide*. When you create a security group, you specify a friendly name of your choice. You can't have two security groups for the same VPC with the same name. You have a default security group for use in your VPC. If you don't specify a security group when you launch an instance, the instance is launched into the appropriate default security group. A default security group includes a default rule that grants instances unrestricted network access to each other. You can add or remove rules from your security groups using [AuthorizeSecurityGroupIngress](API_AuthorizeSecurityGroupIngress.md), [AuthorizeSecurityGroupEgress](API_AuthorizeSecurityGroupEgress.md), [RevokeSecurityGroupIngress](API_RevokeSecurityGroupIngress.md), and [RevokeSecurityGroupEgress](API_RevokeSecurityGroupEgress.md). For more information about VPC security group limits, see [Amazon VPC Limits](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupDescription** A description for the security group. Constraints: Up to 255 characters in length Valid characters: a-z, A-Z, 0-9, spaces, and .\$1-:/()\$1,@[]\$1=&;\$1\$1\$1\$1\$1 Type: String Required: Yes **GroupName** The name of the security group. Names are case-insensitive and must be unique within the VPC. Constraints: Up to 255 characters in length. Can't start with `sg-`. Valid characters: a-z, A-Z, 0-9, spaces, and .\$1-:/()\$1,@[]\$1=&;\$1\$1\$1\$1\$1 Type: String Required: Yes **TagSpecification.N** The tags to assign to the security group. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC. Required for a nondefault VPC. Type: String Required: No ## Response Elements The following elements are returned by the service. **groupId** The ID of the security group. Type: String **requestId** The ID of the request. Type: String **securityGroupArn** The security group ARN. Type: String **tagSet** The tags assigned to the security group. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a security group named `WebServerSG` for the specified VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSecurityGroup &GroupName=WebServerSG &GroupDescription=Web Servers &VpcId=vpc-3325caf2 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true sg-0a42d66a ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSecurityGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSecurityGroup) # CreateSnapshot Creates a snapshot of an EBS volume and stores it in Amazon S3. You can use snapshots for backups, to make copies of EBS volumes, and to save data before shutting down an instance. The location of the source EBS volume determines where you can create the snapshot. + If the source volume is in a Region, you must create the snapshot in the same Region as the volume. + If the source volume is in a Local Zone, you can create the snapshot in the same Local Zone or in its parent AWS Region. + If the source volume is on an Outpost, you can create the snapshot on the same Outpost or in its parent AWS Region. When a snapshot is created, any AWS Marketplace product codes that are associated with the source volume are propagated to the snapshot. You can take a snapshot of an attached volume that is in use. However, snapshots only capture data that has been written to your Amazon EBS volume at the time the snapshot command is issued; this might exclude any data that has been cached by any applications or the operating system. If you can pause any file systems on the volume long enough to take a snapshot, your snapshot should be complete. However, if you cannot pause all file writes to the volume, you should unmount the volume from within the instance, issue the snapshot command, and then remount the volume to ensure a consistent and complete snapshot. You may remount and use your volume while the snapshot status is `pending`. When you create a snapshot for an EBS volume that serves as a root device, we recommend that you stop the instance before taking the snapshot. Snapshots that are taken from encrypted volumes are automatically encrypted. Volumes that are created from encrypted snapshots are also automatically encrypted. Your encrypted volumes and any associated snapshots always remain protected. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** A description for the snapshot. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Location** Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter. + To create a local snapshot in the same Local Zone as the source volume, specify `local`. + To create a regional snapshot in the parent Region of the Local Zone, specify `regional` or omit this parameter. Default value: `regional` Type: String Valid Values: `regional | local` Required: No **OutpostArn** Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter. + To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume. + To create the snapshot in the parent Region of the Outpost, omit this parameter. For more information, see [Create local snapshots from volumes on an Outpost](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot) in the *Amazon EBS User Guide*. Type: String Required: No **TagSpecification.N** The tags to apply to the snapshot during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VolumeId** The ID of the Amazon EBS volume. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **availabilityZone** The Availability Zone or Local Zone of the snapshot. For example, `us-west-1a` (Availability Zone) or `us-west-2-lax-1a` (Local Zone). Type: String **completionDurationMinutes** Only for snapshot copies created with time-based snapshot copy operations. The completion duration requested for the time-based snapshot copy operation. Type: Integer **completionTime** The time stamp when the snapshot was completed. Type: Timestamp **dataEncryptionKeyId** The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy. Because data encryption keys are inherited by volumes created from snapshots, and vice versa, if snapshots share the same data encryption key identifier, then they belong to the same volume/snapshot lineage. This parameter is only returned by [DescribeSnapshots](API_DescribeSnapshots.md). Type: String **description** The description for the snapshot. Type: String **encrypted** Indicates whether the snapshot is encrypted. Type: Boolean **fullSnapshotSizeInBytes** The full size of the snapshot, in bytes. This is **not** the incremental size of the snapshot. This is the full snapshot size and represents the size of all the blocks that were written to the source volume at the time the snapshot was created. Type: Long **kmsKeyId** The Amazon Resource Name (ARN) of the AWS KMS key that was used to protect the volume encryption key for the parent volume. Type: String **outpostArn** The ARN of the Outpost on which the snapshot is stored. For more information, see [Amazon EBS local snapshots on Outposts](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html) in the *Amazon EBS User Guide*. Type: String **ownerAlias** The AWS owner alias, from an Amazon-maintained list (`amazon`). This is not the user-configured AWS account alias set using the IAM console. Type: String **ownerId** The ID of the AWS account that owns the EBS snapshot. Type: String **progress** The progress of the snapshot, as a percentage. Type: String **requestId** The ID of the request. Type: String **restoreExpiryTime** Only for archived snapshots that are temporarily restored. Indicates the date and time when a temporarily restored snapshot will be automatically re-archived. Type: Timestamp **snapshotId** The ID of the snapshot. Each snapshot receives a unique identifier when it is created. Type: String **sseType** Reserved for future use. Type: String Valid Values: `sse-ebs | sse-kms | none` **startTime** The time stamp when the snapshot was initiated. Type: Timestamp **status** The snapshot state. Type: String Valid Values: `pending | completed | error | recoverable | recovering` **statusMessage** Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS KMS permissions are not obtained) this field displays error state details to help you diagnose why the error occurred. This parameter is only returned by [DescribeSnapshots](API_DescribeSnapshots.md). Type: String **storageTier** The storage tier in which the snapshot is stored. `standard` indicates that the snapshot is stored in the standard snapshot storage tier and that it is ready for use. `archive` indicates that the snapshot is currently archived and that it must be restored before it can be used. Type: String Valid Values: `archive | standard` **tagSet** Any tags assigned to the snapshot. Type: Array of [Tag](API_Tag.md) objects **transferType** Only for snapshot copies. Indicates whether the snapshot copy was created with a standard or time-based snapshot copy operation. Time-based snapshot copy operations complete within the completion duration specified in the request. Standard snapshot copy operations are completed on a best-effort basis. + `standard` - The snapshot copy was created with a standard snapshot copy operation. + `time-based` - The snapshot copy was created with a time-based snapshot copy operation. Type: String Valid Values: `time-based | standard` **volumeId** The ID of the volume that was used to create the snapshot. Snapshots created by a copy snapshot operation have an arbitrary volume ID that you should not use for any purpose. Type: String **volumeSize** The size of the volume, in GiB. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a snapshot of the volume with the ID `vol-1234567890abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSnapshot &VolumeId=vol-1234567890abcdef0 &Description=Daily+Backup &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE snap-1234567890abcdef0 vol-1234567890abcdef0 pending YYYY-MM-DDTHH:MM:SS.000Z 60% 111122223333 30 Daily Backup ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSnapshot) # CreateSnapshots Creates crash-consistent snapshots of multiple EBS volumes attached to an Amazon EC2 instance. Volumes are chosen by specifying an instance. Each volume attached to the specified instance will produce one snapshot that is crash-consistent across the instance. You can include all of the volumes currently attached to the instance, or you can exclude the root volume or specific data (non-root) volumes from the multi-volume snapshot set. The location of the source instance determines where you can create the snapshots. + If the source instance is in a Region, you must create the snapshots in the same Region as the instance. + If the source instance is in a Local Zone, you can create the snapshots in the same Local Zone or in its parent AWS Region. + If the source instance is on an Outpost, you can create the snapshots on the same Outpost or in its parent AWS Region. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CopyTagsFromSource** Copies the tags from the specified volume to corresponding snapshot. Type: String Valid Values: `volume` Required: No **Description** A description propagated to every snapshot specified by the instance. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceSpecification** The instance to specify which volumes should be included in the snapshots. Type: [InstanceSpecification](API_InstanceSpecification.md) object Required: Yes **Location** Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter. + To create local snapshots in the same Local Zone as the source instance, specify `local`. + To create regional snapshots in the parent Region of the Local Zone, specify `regional` or omit this parameter. Default value: `regional` Type: String Valid Values: `regional | local` Required: No **OutpostArn** Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter. + To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance. + To create the snapshots in the parent Region of the Outpost, omit this parameter. For more information, see [ Create local snapshots from volumes on an Outpost](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot) in the *Amazon EBS User Guide*. Type: String Required: No **TagSpecification.N** Tags to apply to every snapshot specified by the instance. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **snapshotSet** List of snapshots. Type: Array of [SnapshotInfo](API_SnapshotInfo.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSnapshots) # CreateSpotDatafeedSubscription Creates a data feed for Spot Instances, enabling you to view Spot Instance usage logs. You can create one data feed per AWS account. For more information, see [Spot Instance data feed](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Bucket** The name of the Amazon S3 bucket in which to store the Spot Instance data feed. For more information about bucket names, see [Bucket naming rules](https://docs.aws.amazon.com/AmazonS3/latest/userguide/bucketnamingrules.html) in the *Amazon S3 User Guide*. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Prefix** The prefix for the data feed file names. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **spotDatafeedSubscription** The Spot Instance data feed subscription. Type: [SpotDatafeedSubscription](API_SpotDatafeedSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a Spot Instance data feed for the account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSpotDatafeedSubscription &Bucket=amzn-s3-demo-bucket &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE 123456789012 amzn-s3-demo-bucket spotdata_ Active ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSpotDatafeedSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSpotDatafeedSubscription) # CreateStoreImageTask Stores an AMI as a single object in an Amazon S3 bucket. To use this API, you must have the required permissions. For more information, see [Permissions for storing and restoring AMIs using S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-ami-store-restore.html#ami-s3-permissions) in the *Amazon EC2 User Guide*. For more information, see [Store and restore an AMI using S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Bucket** The name of the Amazon S3 bucket in which the AMI object will be stored. The bucket must be in the Region in which the request is being made. The AMI object appears in the bucket only after the upload task has completed. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes **S3ObjectTag.N** The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. Type: Array of [S3ObjectTag](API_S3ObjectTag.md) objects Required: No ## Response Elements The following elements are returned by the service. **objectKey** The name of the stored AMI object in the S3 bucket. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateStoreImageTask) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateStoreImageTask) # CreateSubnet Creates a subnet in the specified VPC. For an IPv4 only subnet, specify an IPv4 CIDR block. If the VPC has an IPv6 CIDR block, you can create an IPv6 only subnet or a dual stack subnet instead. For an IPv6 only subnet, specify an IPv6 CIDR block. For a dual stack subnet, specify both an IPv4 CIDR block and an IPv6 CIDR block. A subnet CIDR block must not overlap the CIDR block of an existing subnet in the VPC. After you create a subnet, you can't change its CIDR block. The allowed size for an IPv4 subnet is between a /28 netmask (16 IP addresses) and a /16 netmask (65,536 IP addresses). AWS reserves both the first four and the last IPv4 address in each subnet's CIDR block. They're not available for your use. If you've associated an IPv6 CIDR block with your VPC, you can associate an IPv6 CIDR block with a subnet when you create it. If you add more than one subnet to a VPC, they're set up in a star topology with a logical router in the middle. When you stop an instance in a subnet, it retains its private IPv4 address. It's therefore possible to have a subnet with no running instances (they're all stopped), but no remaining IP addresses available. For more information, see [Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** The Availability Zone or Local Zone for the subnet. Default: AWS selects one for you. If you create more than one subnet in your VPC, we do not necessarily select a different zone for each subnet. To create a subnet in a Local Zone, set this value to the Local Zone ID, for example `us-west-2-lax-1a`. For information about the Regions that support Local Zones, see [Available Local Zones](https://docs.aws.amazon.com/local-zones/latest/ug/available-local-zones.html). To create a subnet in an Outpost, set this value to the Availability Zone for the Outpost and specify the Outpost ARN. Type: String Required: No **AvailabilityZoneId** The AZ ID or the Local Zone ID of the subnet. Type: String Required: No **CidrBlock** The IPv4 network range for the subnet, in CIDR notation. For example, `10.0.0.0/24`. We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18`, we modify it to `100.68.0.0/18`. This parameter is not supported for an IPv6 only subnet. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Ipv4IpamPoolId** An IPv4 IPAM pool ID for the subnet. Type: String Required: No **Ipv4NetmaskLength** An IPv4 netmask length for the subnet. Type: Integer Required: No **Ipv6CidrBlock** The IPv6 network range for the subnet, in CIDR notation. This parameter is required for an IPv6 only subnet. Type: String Required: No **Ipv6IpamPoolId** An IPv6 IPAM pool ID for the subnet. Type: String Required: No **Ipv6Native** Indicates whether to create an IPv6 only subnet. Type: Boolean Required: No **Ipv6NetmaskLength** An IPv6 netmask length for the subnet. Type: Integer Required: No **OutpostArn** The Amazon Resource Name (ARN) of the Outpost. If you specify an Outpost ARN, you must also specify the Availability Zone of the Outpost subnet. Type: String Required: No **TagSpecification.N** The tags to assign to the subnet. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **subnet** Information about the subnet. Type: [Subnet](API_Subnet.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a subnet with CIDR block `10.0.1.0/24` in the VPC with the ID `vpc-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSubnet &VpcId=vpc-1a2b3c4d &CidrBlock=10.0.1.0/24 &AUTHPARAMS ``` #### Sample Response ``` e6cb93f0-eb09-40ee-b9aa-16db90a0524f subnet-0397b6c47c42e4dc0 arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0397b6c47cEXAMPLE pending 111122223333 vpc-06b7830650EXAMPLE 10.0.0.0/24 251 us-east-2a use2-az1 false false false ``` ### Example 2 This example creates a subnet with an IPv6 CIDR block in the VPC `vpc-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSubnet &VpcId=vpc-07e8ffd50fEXAMPLE &CidrBlock=10.0.1.0/24 &Ipv6CidrBlock=2600:1f16:115:200::/64 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE subnet-02bf4c428bEXAMPLE arn:aws:ec2:us-east-2:111122223333:subnet/subnet-02bf4c428bEXAMPLE available 111122223333 vpc-07e8ffd50fEXAMPLE 10.0.0.0/24 2600:1f16:115:200::/64 subnet-cidr-assoc-002afb9f3cEXAMPLE associated 251 us-east-2b use2-az2 false false false ``` ### Example 3 This example creates a subnet with an IPv6 CIDR block in the specified Local Zone. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateSubnet &VpcId=vpc-07e8ffd50fEXAMPLE &CidrBlock=10.0.1.0/24 &Ipv6CidrBlock=2600:1f16:115:200::/64 &AvailabilityZone=us-west-2-lax-1a &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE subnet-093cb4a1ecEXAMPLE arn:aws:ec2:us-west-2:111122223333:subnet/subnet-093cb4a1ecEXAMPLE available 111122223333 vpc-07d80fe1a43298172 10.0.0.0/24 2600:1f16:115:200::/64 subnet-cidr-assoc-002afb9f3cEXAMPLE associated 251 us-west-2-lax-1a usw2-lax1-az1 false false false ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSubnet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSubnet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSubnet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSubnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSubnet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSubnet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSubnet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSubnet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSubnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSubnet) # CreateSubnetCidrReservation Creates a subnet CIDR reservation. For more information, see [Subnet CIDR reservations](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-cidr-reservation.html) in the *Amazon VPC User Guide* and [Manage prefixes for your network interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-prefixes.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The IPv4 or IPV6 CIDR range to reserve. Type: String Required: Yes **Description** The description to assign to the subnet CIDR reservation. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReservationType** The type of reservation. The reservation type determines how the reserved IP addresses are assigned to resources. + `prefix` - AWS assigns the reserved IP addresses to network interfaces. + `explicit` - You assign the reserved IP addresses to network interfaces. Type: String Valid Values: `prefix | explicit` Required: Yes **SubnetId** The ID of the subnet. Type: String Required: Yes **TagSpecification.N** The tags to assign to the subnet CIDR reservation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **subnetCidrReservation** Information about the created subnet CIDR reservation. Type: [SubnetCidrReservation](API_SubnetCidrReservation.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateSubnetCidrReservation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateSubnetCidrReservation) # CreateTags Adds or overwrites only the specified tags for the specified Amazon EC2 resource or resources. When you specify an existing tag key, the value is overwritten with the new value. Each resource can have a maximum of 50 tags. Each tag consists of a key and optional value. Tag keys must be unique per resource. For more information about tags, see [Tag your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon Elastic Compute Cloud User Guide*. For more information about creating IAM policies that control users' access to resources based on tags, see [Supported resource-level permissions for Amazon EC2 API actions](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-iam-actions-resources.html) in the *Amazon Elastic Compute Cloud User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ResourceId.N** The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches. Type: Array of strings Required: Yes **Tag.N** The tags. The `value` parameter is required, but if you don't want the tag to have a value, specify the parameter with no value, and we set the value to an empty string. Type: Array of [Tag](API_Tag.md) objects Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request adds (or overwrites) two tags for an AMI and an instance. One of the tags is a key (`webserver`), with no value (we set the value to an empty string). The other tag consists of a key (`stack`) and value (`Production`). #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateTags &ResourceId.1=ami-1a2b3c4d &ResourceId.2=i-1234567890abcdef0 &Tag.1.Key=webserver &Tag.1.Value= &Tag.2.Key=stack &Tag.2.Value=Production &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTags) # CreateTrafficMirrorFilter Creates a Traffic Mirror filter. A Traffic Mirror filter is a set of rules that defines the traffic to mirror. By default, no traffic is mirrored. To mirror traffic, use [CreateTrafficMirrorFilterRule](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilterRule.htm) to add Traffic Mirror rules to the filter. The rules you add define what traffic gets mirrored. You can also use [ModifyTrafficMirrorFilterNetworkServices](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyTrafficMirrorFilterNetworkServices.html) to mirror supported network services. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** The description of the Traffic Mirror filter. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to assign to a Traffic Mirror filter. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String **requestId** The ID of the request. Type: String **trafficMirrorFilter** Information about the Traffic Mirror filter. Type: [TrafficMirrorFilter](API_TrafficMirrorFilter.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTrafficMirrorFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTrafficMirrorFilter) # CreateTrafficMirrorFilterRule Creates a Traffic Mirror filter rule. A Traffic Mirror rule defines the Traffic Mirror source traffic to mirror. You need the Traffic Mirror filter ID when you create the rule. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** The description of the Traffic Mirror rule. Type: String Required: No **DestinationCidrBlock** The destination CIDR block to assign to the Traffic Mirror rule. Type: String Required: Yes **DestinationPortRange** The destination port range. Type: [TrafficMirrorPortRangeRequest](API_TrafficMirrorPortRangeRequest.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Protocol** The protocol, for example UDP, to assign to the Traffic Mirror rule. For information about the protocol value, see [Protocol Numbers](https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml) on the Internet Assigned Numbers Authority (IANA) website. Type: Integer Required: No **RuleAction** The action to take on the filtered traffic. Type: String Valid Values: `accept | reject` Required: Yes **RuleNumber** The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number. Type: Integer Required: Yes **SourceCidrBlock** The source CIDR block to assign to the Traffic Mirror rule. Type: String Required: Yes **SourcePortRange** The source port range. Type: [TrafficMirrorPortRangeRequest](API_TrafficMirrorPortRangeRequest.md) object Required: No **TagSpecification.N** Traffic Mirroring tags specifications. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TrafficDirection** The type of traffic. Type: String Valid Values: `ingress | egress` Required: Yes **TrafficMirrorFilterId** The ID of the filter that this rule is associated with. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String **requestId** The ID of the request. Type: String **trafficMirrorFilterRule** The Traffic Mirror rule. Type: [TrafficMirrorFilterRule](API_TrafficMirrorFilterRule.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTrafficMirrorFilterRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTrafficMirrorFilterRule) # CreateTrafficMirrorSession Creates a Traffic Mirror session. A Traffic Mirror session actively copies packets from a Traffic Mirror source to a Traffic Mirror target. Create a filter, and then assign it to the session to define a subset of the traffic to mirror, for example all TCP traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in a different VPC connected via VPC peering or a transit gateway. By default, no traffic is mirrored. Use [CreateTrafficMirrorFilter](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorFilter.html) to create filter rules that specify the traffic to mirror. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** The description of the Traffic Mirror session. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInterfaceId** The ID of the source network interface. Type: String Required: Yes **PacketLength** The number of bytes in each packet to mirror. These are bytes after the VXLAN header. Do not specify this parameter when you want to mirror the entire packet. To mirror a subset of the packet, set this to the length (in bytes) that you want to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. If you do not want to mirror the entire packet, use the `PacketLength` parameter to specify the number of bytes in each packet to mirror. For sessions with Network Load Balancer (NLB) Traffic Mirror targets the default `PacketLength` will be set to 8500. Valid values are 1-8500. Setting a `PacketLength` greater than 8500 will result in an error response. Type: Integer Required: No **SessionNumber** The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. Valid values are 1-32766. Type: Integer Required: Yes **TagSpecification.N** The tags to assign to a Traffic Mirror session. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TrafficMirrorFilterId** The ID of the Traffic Mirror filter. Type: String Required: Yes **TrafficMirrorTargetId** The ID of the Traffic Mirror target. Type: String Required: Yes **VirtualNetworkId** The VXLAN ID for the Traffic Mirror session. For more information about the VXLAN protocol, see [RFC 7348](https://datatracker.ietf.org/doc/html/rfc7348). If you do not specify a `VirtualNetworkId`, an account-wide unique ID is chosen at random. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String **requestId** The ID of the request. Type: String **trafficMirrorSession** Information about the Traffic Mirror session. Type: [TrafficMirrorSession](API_TrafficMirrorSession.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTrafficMirrorSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTrafficMirrorSession) # CreateTrafficMirrorTarget Creates a target for your Traffic Mirror session. A Traffic Mirror target is the destination for mirrored traffic. The Traffic Mirror source and the Traffic Mirror target (monitoring appliances) can be in the same VPC, or in different VPCs connected via VPC peering or a transit gateway. A Traffic Mirror target can be a network interface, a Network Load Balancer, or a Gateway Load Balancer endpoint. To use the target in a Traffic Mirror session, use [CreateTrafficMirrorSession](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTrafficMirrorSession.htm). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** The description of the Traffic Mirror target. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GatewayLoadBalancerEndpointId** The ID of the Gateway Load Balancer endpoint. Type: String Required: No **NetworkInterfaceId** The network interface ID that is associated with the target. Type: String Required: No **NetworkLoadBalancerArn** The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the target. Type: String Required: No **TagSpecification.N** The tags to assign to the Traffic Mirror target. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String **requestId** The ID of the request. Type: String **trafficMirrorTarget** Information about the Traffic Mirror target. Type: [TrafficMirrorTarget](API_TrafficMirrorTarget.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTrafficMirrorTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTrafficMirrorTarget) # CreateTransitGateway Creates a transit gateway. You can use a transit gateway to interconnect your virtual private clouds (VPC) and on-premises networks. After the transit gateway enters the `available` state, you can attach your VPCs and VPN connections to the transit gateway. To attach your VPCs, use [CreateTransitGatewayVpcAttachment](API_CreateTransitGatewayVpcAttachment.md). To attach a VPN connection, use [CreateCustomerGateway](API_CreateCustomerGateway.md) to create a customer gateway and specify the ID of the customer gateway and the ID of the transit gateway in a call to [CreateVpnConnection](API_CreateVpnConnection.md). When you create a transit gateway, we create a default transit gateway route table and use it as the default association route table and the default propagation route table. You can use [CreateTransitGatewayRouteTable](API_CreateTransitGatewayRouteTable.md) to create additional transit gateway route tables. If you disable automatic route propagation, we do not create a default transit gateway route table. You can use [EnableTransitGatewayRouteTablePropagation](API_EnableTransitGatewayRouteTablePropagation.md) to propagate routes from a resource attachment to a transit gateway route table. If you disable automatic associations, you can use [AssociateTransitGatewayRouteTable](API_AssociateTransitGatewayRouteTable.md) to associate a resource attachment with a transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** A description of the transit gateway. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** The transit gateway options. Type: [TransitGatewayRequestOptions](API_TransitGatewayRequestOptions.md) object Required: No **TagSpecification.N** The tags to apply to the transit gateway. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGateway** Information about the transit gateway. Type: [TransitGateway](API_TransitGateway.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGateway) # CreateTransitGatewayConnect Creates a Connect attachment from a specified transit gateway attachment. A Connect attachment is a GRE-based tunnel attachment that you can use to establish a connection between a transit gateway and an appliance. A Connect attachment uses an existing VPC or AWS Direct Connect attachment as the underlying transport mechanism. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** The Connect attachment options. Type: [CreateTransitGatewayConnectRequestOptions](API_CreateTransitGatewayConnectRequestOptions.md) object Required: Yes **TagSpecification.N** The tags to apply to the Connect attachment. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransportTransitGatewayAttachmentId** The ID of the transit gateway attachment. You can specify a VPC attachment or AWS Direct Connect attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayConnect** Information about the Connect attachment. Type: [TransitGatewayConnect](API_TransitGatewayConnect.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayConnect) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayConnect) # CreateTransitGatewayConnectPeer Creates a Connect peer for a specified transit gateway Connect attachment between a transit gateway and an appliance. The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6). For more information, see [Connect peers](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html#tgw-connect-peer) in the * AWS Transit Gateways Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BgpOptions** The BGP options for the Connect peer. Type: [TransitGatewayConnectRequestBgpOptions](API_TransitGatewayConnectRequestBgpOptions.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InsideCidrBlocks.N** The range of inside IP addresses that are used for BGP peering. You must specify a size /29 IPv4 CIDR block from the `169.254.0.0/16` range. The first address from the range must be configured on the appliance as the BGP IP address. You can also optionally specify a size /125 IPv6 CIDR block from the `fd00::/8` range. Type: Array of strings Required: Yes **PeerAddress** The peer IP address (GRE outer IP address) on the appliance side of the Connect peer. Type: String Required: Yes **TagSpecification.N** The tags to apply to the Connect peer. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayAddress** The peer IP address (GRE outer IP address) on the transit gateway side of the Connect peer, which must be specified from a transit gateway CIDR block. If not specified, Amazon automatically assigns the first available IP address from the transit gateway CIDR block. Type: String Required: No **TransitGatewayAttachmentId** The ID of the Connect attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayConnectPeer** Information about the Connect peer. Type: [TransitGatewayConnectPeer](API_TransitGatewayConnectPeer.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayConnectPeer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayConnectPeer) # CreateTransitGatewayMeteringPolicy Creates a metering policy for a transit gateway to track and measure network traffic. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MiddleboxAttachmentId.N** The IDs of the middlebox attachments to include in the metering policy. Type: Array of strings Required: No **TagSpecifications.N** The tags to assign to the metering policy. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway for which to create the metering policy. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayMeteringPolicy** Information about the created transit gateway metering policy. Type: [TransitGatewayMeteringPolicy](API_TransitGatewayMeteringPolicy.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicy) # CreateTransitGatewayMeteringPolicyEntry Creates an entry in a transit gateway metering policy to define traffic measurement rules. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The destination CIDR block for traffic matching. Type: String Required: No **DestinationPortRange** The destination port range for traffic matching. Type: String Required: No **DestinationTransitGatewayAttachmentId** The ID of the destination transit gateway attachment for traffic matching. Type: String Required: No **DestinationTransitGatewayAttachmentType** The type of the destination transit gateway attachment for traffic matching. Note that the `tgw-peering` resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type. Type: String Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MeteredAccount** The AWS account ID to which the metered traffic should be attributed. Type: String Valid Values: `source-attachment-owner | destination-attachment-owner | transit-gateway-owner` Required: Yes **PolicyRuleNumber** The rule number for the metering policy entry. Rules are processed in order from lowest to highest number. Type: Integer Required: Yes **Protocol** The protocol for traffic matching (1, 6, 17, etc.). Type: String Required: No **SourceCidrBlock** The source CIDR block for traffic matching. Type: String Required: No **SourcePortRange** The source port range for traffic matching. Type: String Required: No **SourceTransitGatewayAttachmentId** The ID of the source transit gateway attachment for traffic matching. Type: String Required: No **SourceTransitGatewayAttachmentType** The type of the source transit gateway attachment for traffic matching. Note that the `tgw-peering` resource type has been deprecated. To configure metering policies for Connect, use the transport attachment type. Type: String Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering` Required: No **TransitGatewayMeteringPolicyId** The ID of the transit gateway metering policy to add the entry to. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayMeteringPolicyEntry** Information about the created transit gateway metering policy entry. Type: [TransitGatewayMeteringPolicyEntry](API_TransitGatewayMeteringPolicyEntry.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayMeteringPolicyEntry) # CreateTransitGatewayMulticastDomain Creates a multicast domain using the specified transit gateway. The transit gateway must be in the available state before you create a domain. Use [DescribeTransitGateways](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeTransitGateways.html) to see the state of transit gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** The options for the transit gateway multicast domain. Type: [CreateTransitGatewayMulticastDomainRequestOptions](API_CreateTransitGatewayMulticastDomainRequestOptions.md) object Required: No **TagSpecification.N** The tags for the transit gateway multicast domain. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayMulticastDomain** Information about the transit gateway multicast domain. Type: [TransitGatewayMulticastDomain](API_TransitGatewayMulticastDomain.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a multicast domain for the specified transit gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateTransitMulticastDomain &TransitGatewayId=tgw-0d88d2d0d5EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 763fb04b-258f-4710-8f91-b202aEXAMPLE 2019-11-20T22:02:03.000Z pending tgw-0d88d2d0d5EXAMPLE tgw-mcast-domain-02bb79002EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayMulticastDomain) # CreateTransitGatewayPeeringAttachment Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter). The peer transit gateway can be in your account or a different AWS account. After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** Requests a transit gateway peering attachment. Type: [CreateTransitGatewayPeeringAttachmentRequestOptions](API_CreateTransitGatewayPeeringAttachmentRequestOptions.md) object Required: No **PeerAccountId** The ID of the AWS account that owns the peer transit gateway. Type: String Required: Yes **PeerRegion** The Region where the peer transit gateway is located. Type: String Required: Yes **PeerTransitGatewayId** The ID of the peer transit gateway with which to create the peering attachment. Type: String Required: Yes **TagSpecification.N** The tags to apply to the transit gateway peering attachment. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPeeringAttachment** The transit gateway peering attachment. Type: [TransitGatewayPeeringAttachment](API_TransitGatewayPeeringAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a transit gateway peering attachment for the specified transit gateways. The accepter (peer) transit gateway is in the `us-west-2` Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateTransitGatewayPeeringAttachment &TransitGatewayId=tgw-11223344aabbcc112 &PeerTransitGatewayId=tgw-1234567890abc1234 &PeerAccountId=123456789012 &PeerRegion=us-west-2 &AUTHPARAMS ``` #### Sample Response ``` 701859fa-6a57-4e55-858c-e63example 123456789012 us-west-2 tgw-1234567890abc1234 2019-11-11T11:36:30.000Z 123456789012 us-east-1 tgw-11223344aabbcc112 initiatingRequest tgw-attach-0a73702c5c7123123 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayPeeringAttachment) # CreateTransitGatewayPolicyTable Creates a transit gateway policy table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecifications.N** The tags specification for the transit gateway policy table created during the request. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway used for the policy table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPolicyTable** Describes the created transit gateway policy table. Type: [TransitGatewayPolicyTable](API_TransitGatewayPolicyTable.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayPolicyTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayPolicyTable) # CreateTransitGatewayPrefixListReference Creates a reference (route) to a prefix list in a specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Blackhole** Indicates whether to drop traffic that matches this route. Type: Boolean Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PrefixListId** The ID of the prefix list that is used for destination matches. Type: String Required: Yes **TransitGatewayAttachmentId** The ID of the attachment to which traffic is routed. Type: String Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPrefixListReference** Information about the prefix list reference. Type: [TransitGatewayPrefixListReference](API_TransitGatewayPrefixListReference.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a reference to a prefix list in the specified transit gateway route table. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateTransitGatewayPrefixListReference &TransitGatewayRouteTableId=tgw-rtb-0f98a0a5d09abcabc &PrefixListId=pl-001122334455aabbc &TransitGatewayAttachmentId=tgw-attach-01234567abcabcabc &AUTHPARAMS ``` #### Sample Response ``` 326fdc31-cd8d-491a-824a-example false pl-001122334455aabbc 123456789012 pending vpn-12312312312312312 vpn tgw-attach-01234567abcabcabc tgw-rtb-0f98a0a5d09abcabc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayPrefixListReference) # CreateTransitGatewayRoute Creates a static route for the specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Blackhole** Indicates whether to drop traffic that matches this route. Type: Boolean Required: No **DestinationCidrBlock** The CIDR range used for destination matches. Routing decisions are based on the most specific match. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **route** Information about the route. Type: [TransitGatewayRoute](API_TransitGatewayRoute.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayRoute) # CreateTransitGatewayRouteTable Creates a route table for the specified transit gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecifications.N** The tags to apply to the transit gateway route table. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayRouteTable** Information about the transit gateway route table. Type: [TransitGatewayRouteTable](API_TransitGatewayRouteTable.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a transit gateway route table for the specified transit gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateTransitGatewayRouteTable &TransitGatewayId=tgw-02f776b1a7EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 9c6751fa-a1ee-4006-92a8-c6cc1816a0f5 2019-07-17T20:27:26.000Z false false pending tgw-02f776b1a7EXAMPLE tgw-rtb-0b6f6aaa01EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayRouteTable) # CreateTransitGatewayRouteTableAnnouncement Advertises a new transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PeeringAttachmentId** The ID of the peering attachment. Type: String Required: Yes **TagSpecification.N** The tags specifications applied to the transit gateway route table announcement. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayRouteTableAnnouncement** Provides details about the transit gateway route table announcement. Type: [TransitGatewayRouteTableAnnouncement](API_TransitGatewayRouteTableAnnouncement.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayRouteTableAnnouncement) # CreateTransitGatewayVpcAttachment Attaches the specified VPC to the specified transit gateway. If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table. To send VPC traffic to an attached transit gateway, add a route to the VPC route table using [CreateRoute](API_CreateRoute.md). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** The VPC attachment options. Type: [CreateTransitGatewayVpcAttachmentRequestOptions](API_CreateTransitGatewayVpcAttachmentRequestOptions.md) object Required: No **SubnetIds.N** The IDs of one or more subnets. You can specify only one subnet per Availability Zone. You must specify at least one subnet, but we recommend that you specify two subnets for better availability. The transit gateway uses one IP address from each specified subnet. Type: Array of strings Required: Yes **TagSpecifications.N** The tags to apply to the VPC attachment. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway. Type: String Required: Yes **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayVpcAttachment** Information about the VPC attachment. Type: [TransitGatewayVpcAttachment](API_TransitGatewayVpcAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a transit gateway VPC attachment for the specified transit gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateTransitGatewayVpcAttachment &TransitGatewayId=tgw-02f776b1a7EXAMPLE &VpcID=vpc-0065acced4EXAMPLE &SubnetIds.1=subnet-0187aff814EXAMPLE &Options.DnsSupport=enable &Options.Ipv6Support=disable &AUTHPARAMS ``` #### Sample Response ``` 374ab4fd-5ccd-4d98-93f5-034c80f67d79 2019-07-17T16:04:27.000Z enable disable pending subnet-0187aff814EXAMPLE tgw-attach-0d2c54bdb3EXAMPLE tgw-02f776b1a7EXAMPLE vpc-0065acced4EXAMPLE 111122223333 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayVpcAttachment) # CreateVerifiedAccessEndpoint An AWS Verified Access endpoint is where you define your application along with an optional endpoint-level access policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ApplicationDomain** The DNS name for users to reach your application. Type: String Required: No **AttachmentType** The type of attachment. Type: String Valid Values: `vpc` Required: Yes **CidrOptions** The CIDR options. This parameter is required if the endpoint type is `cidr`. Type: [CreateVerifiedAccessEndpointCidrOptions](API_CreateVerifiedAccessEndpointCidrOptions.md) object Required: No **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access endpoint. Type: String Required: No **DomainCertificateArn** The ARN of the public TLS/SSL certificate in AWS Certificate Manager to associate with the endpoint. The CN in the certificate must match the DNS name your end users will use to reach your application. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndpointDomainPrefix** A custom identifier that is prepended to the DNS name that is generated for the endpoint. Type: String Required: No **EndpointType** The type of Verified Access endpoint to create. Type: String Valid Values: `load-balancer | network-interface | rds | cidr` Required: Yes **LoadBalancerOptions** The load balancer details. This parameter is required if the endpoint type is `load-balancer`. Type: [CreateVerifiedAccessEndpointLoadBalancerOptions](API_CreateVerifiedAccessEndpointLoadBalancerOptions.md) object Required: No **NetworkInterfaceOptions** The network interface details. This parameter is required if the endpoint type is `network-interface`. Type: [CreateVerifiedAccessEndpointEniOptions](API_CreateVerifiedAccessEndpointEniOptions.md) object Required: No **PolicyDocument** The Verified Access policy document. Type: String Required: No **RdsOptions** The RDS details. This parameter is required if the endpoint type is `rds`. Type: [CreateVerifiedAccessEndpointRdsOptions](API_CreateVerifiedAccessEndpointRdsOptions.md) object Required: No **SecurityGroupId.N** The IDs of the security groups to associate with the Verified Access endpoint. Required if `AttachmentType` is set to `vpc`. Type: Array of strings Required: No **SseSpecification** The options for server side encryption. Type: [VerifiedAccessSseSpecificationRequest](API_VerifiedAccessSseSpecificationRequest.md) object Required: No **TagSpecification.N** The tags to assign to the Verified Access endpoint. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VerifiedAccessGroupId** The ID of the Verified Access group to associate the endpoint with. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessEndpoint** Details about the Verified Access endpoint. Type: [VerifiedAccessEndpoint](API_VerifiedAccessEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVerifiedAccessEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessEndpoint) # CreateVerifiedAccessGroup An AWS Verified Access group is a collection of AWS Verified Access endpoints who's associated applications have similar security requirements. Each instance within a Verified Access group shares an Verified Access policy. For example, you can group all Verified Access instances associated with "sales" applications together and use one common Verified Access policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access group. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PolicyDocument** The Verified Access policy document. Type: String Required: No **SseSpecification** The options for server side encryption. Type: [VerifiedAccessSseSpecificationRequest](API_VerifiedAccessSseSpecificationRequest.md) object Required: No **TagSpecification.N** The tags to assign to the Verified Access group. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessGroup** Details about the Verified Access group. Type: [VerifiedAccessGroup](API_VerifiedAccessGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVerifiedAccessGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessGroup) # CreateVerifiedAccessInstance An AWS Verified Access instance is a regional entity that evaluates application requests and grants access only when your security requirements are met. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CidrEndpointsCustomSubDomain** The custom subdomain. Type: String Required: No **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access instance. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FIPSEnabled** Enable or disable support for Federal Information Processing Standards (FIPS) on the instance. Type: Boolean Required: No **TagSpecification.N** The tags to assign to the Verified Access instance. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessInstance** Details about the Verified Access instance. Type: [VerifiedAccessInstance](API_VerifiedAccessInstance.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVerifiedAccessInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessInstance) # CreateVerifiedAccessTrustProvider A trust provider is a third-party entity that creates, maintains, and manages identity information for users and devices. When an application request is made, the identity information sent by the trust provider is evaluated by Verified Access before allowing or denying the application request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access trust provider. Type: String Required: No **DeviceOptions** The options for a device-based trust provider. This parameter is required when the provider type is `device`. Type: [CreateVerifiedAccessTrustProviderDeviceOptions](API_CreateVerifiedAccessTrustProviderDeviceOptions.md) object Required: No **DeviceTrustProviderType** The type of device-based trust provider. This parameter is required when the provider type is `device`. Type: String Valid Values: `jamf | crowdstrike | jumpcloud` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NativeApplicationOidcOptions** The OpenID Connect (OIDC) options. Type: [CreateVerifiedAccessNativeApplicationOidcOptions](API_CreateVerifiedAccessNativeApplicationOidcOptions.md) object Required: No **OidcOptions** The options for a OpenID Connect-compatible user-identity trust provider. This parameter is required when the provider type is `user`. Type: [CreateVerifiedAccessTrustProviderOidcOptions](API_CreateVerifiedAccessTrustProviderOidcOptions.md) object Required: No **PolicyReferenceName** The identifier to be used when working with policy rules. Type: String Required: Yes **SseSpecification** The options for server side encryption. Type: [VerifiedAccessSseSpecificationRequest](API_VerifiedAccessSseSpecificationRequest.md) object Required: No **TagSpecification.N** The tags to assign to the Verified Access trust provider. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TrustProviderType** The type of trust provider. Type: String Valid Values: `user | device` Required: Yes **UserTrustProviderType** The type of user-based trust provider. This parameter is required when the provider type is `user`. Type: String Valid Values: `iam-identity-center | oidc` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessTrustProvider** Details about the Verified Access trust provider. Type: [VerifiedAccessTrustProvider](API_VerifiedAccessTrustProvider.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessTrustProvider) # CreateVolume Creates an EBS volume that can be attached to an instance in the same Availability Zone. You can create a new empty volume or restore a volume from an EBS snapshot. Any AWS Marketplace product codes from the snapshot are propagated to the volume. You can create encrypted volumes. Encrypted volumes must be attached to instances that support Amazon EBS encryption. Volumes that are created from encrypted snapshots are also automatically encrypted. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. You can tag your volumes during creation. For more information, see [Tag your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon EC2 User Guide*. For more information, see [Create an Amazon EBS volume](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-creating-volume.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** The ID of the Availability Zone in which to create the volume. For example, `us-east-1a`. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both. Type: String Required: No **AvailabilityZoneId** The ID of the Availability Zone in which to create the volume. For example, `use1-az1`. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both. Type: String Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Encrypted** Indicates whether the volume should be encrypted. The effect of setting the encryption state to `true` depends on the volume origin (new or from a snapshot), starting encryption state, ownership, and whether encryption by default is enabled. For more information, see [Encryption by default](https://docs.aws.amazon.com/ebs/latest/userguide/work-with-ebs-encr.html#encryption-by-default) in the *Amazon EBS User Guide*. Encrypted Amazon EBS volumes must be attached to instances that support Amazon EBS encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances). Type: Boolean Required: No **Iops** The number of I/O operations per second (IOPS) to provision for the volume. Required for `io1` and `io2` volumes. Optional for `gp3` volumes. Omit for all other volume types. Valid ranges: + gp3: `3,000 `(*default*)` - 80,000` IOPS + io1: `100 - 64,000` IOPS + io2: `100 - 256,000` IOPS [ Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS. Type: Integer Required: No **KmsKeyId** The identifier of the AWS KMS key to use for Amazon EBS encryption. If this parameter is not specified, your AWS KMS key for Amazon EBS is used. If `KmsKeyId` is specified, the encrypted state must be `true`. You can specify the KMS key using any of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. For example, alias/ExampleAlias. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails. Type: String Required: No **MultiAttachEnabled** Indicates whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 [Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) in the same Availability Zone. This parameter is supported with `io1` and `io2` volumes only. For more information, see [ Amazon EBS Multi-Attach](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html) in the *Amazon EBS User Guide*. Type: Boolean Required: No **Operator** Reserved for internal use. Type: [OperatorRequest](API_OperatorRequest.md) object Required: No **OutpostArn** The Amazon Resource Name (ARN) of the Outpost on which to create the volume. If you intend to use a volume with an instance running on an outpost, then you must create the volume on the same outpost as the instance. You can't use a volume created in an AWS Region with an instance on an AWS outpost, or the other way around. Type: String Required: No **Size** The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. If you specify a snapshot, the default is the snapshot size, and you can specify a volume size that is equal to or larger than the snapshot size. Valid sizes: + gp2: `1 - 16,384` GiB + gp3: `1 - 65,536` GiB + io1: `4 - 16,384` GiB + io2: `4 - 65,536` GiB + st1 and sc1: `125 - 16,384` GiB + standard: `1 - 1024` GiB Type: Integer Required: No **SnapshotId** The snapshot from which to create the volume. You must specify either a snapshot ID or a volume size. Type: String Required: No **TagSpecification.N** The tags to apply to the volume during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Throughput** The throughput to provision for the volume, in MiB/s. Supported for `gp3` volumes only. Omit for all other volume types. Valid Range: `125 - 2000` MiB/s Type: Integer Required: No **VolumeInitializationRate** Specifies the Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate), in MiB/s, at which to download the snapshot blocks from Amazon S3 to the volume. This is also known as *volume initialization*. Specifying a volume initialization rate ensures that the volume is initialized at a predictable and consistent rate after creation. This parameter is supported only for volumes created from snapshots. Omit this parameter if: + You want to create the volume using fast snapshot restore. You must specify a snapshot that is enabled for fast snapshot restore. In this case, the volume is fully initialized at creation. **Note** If you specify a snapshot that is enabled for fast snapshot restore and a volume initialization rate, the volume will be initialized at the specified rate instead of fast snapshot restore. + You want to create a volume that is initialized at the default rate. For more information, see [ Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html) in the *Amazon EC2 User Guide*. Valid range: 100 - 300 MiB/s Type: Integer Required: No **VolumeType** The volume type. This parameter can be one of the following values: + General Purpose SSD: `gp2` \$1 `gp3` + Provisioned IOPS SSD: `io1` \$1 `io2` + Throughput Optimized HDD: `st1` + Cold HDD: `sc1` + Magnetic: `standard` Throughput Optimized HDD (`st1`) and Cold HDD (`sc1`) volumes can't be used as boot volumes. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*. Default: `gp2` Type: String Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3` Required: No ## Response Elements The following elements are returned by the service. **attachmentSet** This parameter is not returned by CreateVolume. Information about the volume attachments. Type: Array of [VolumeAttachment](API_VolumeAttachment.md) objects **availabilityZone** The Availability Zone for the volume. Type: String **availabilityZoneId** The ID of the Availability Zone for the volume. Type: String **createTime** The time stamp when volume creation was initiated. Type: Timestamp **encrypted** Indicates whether the volume is encrypted. Type: Boolean **fastRestored** This parameter is not returned by CreateVolume. Indicates whether the volume was created using fast snapshot restore. Type: Boolean **iops** The number of I/O operations per second (IOPS). For `gp3`, `io1`, and `io2` volumes, this represents the number of IOPS that are provisioned for the volume. For `gp2` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. Type: Integer **kmsKeyId** The Amazon Resource Name (ARN) of the AWS KMS key that was used to protect the volume encryption key for the volume. Type: String **multiAttachEnabled** Indicates whether Amazon EBS Multi-Attach is enabled. Type: Boolean **operator** The service provider that manages the volume. Type: [OperatorResponse](API_OperatorResponse.md) object **outpostArn** The Amazon Resource Name (ARN) of the Outpost. Type: String **requestId** The ID of the request. Type: String **size** The size of the volume, in GiBs. Type: Integer **snapshotId** The snapshot from which the volume was created, if applicable. Type: String **sourceVolumeId** The ID of the source volume from which the volume copy was created. Only for volume copies. Type: String **sseType** This parameter is not returned by CreateVolume. Reserved for future use. Type: String Valid Values: `sse-ebs | sse-kms | none` **status** The volume state. Type: String Valid Values: `creating | available | in-use | deleting | deleted | error` **tagSet** Any tags assigned to the volume. Type: Array of [Tag](API_Tag.md) objects **throughput** The throughput that the volume supports, in MiB/s. Type: Integer **volumeId** The ID of the volume. Type: String **volumeInitializationRate** The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume during creation, in MiB/s. If no volume initialization rate was specified, the value is `null`. Type: Integer **volumeType** The volume type. Type: String Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example request creates an 150 GiB Multi-Attach enabled `io1` volume in the `us-east-1a` Availability Zone. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVolume &VolumeType=io1 &Size=150 &Iops=7500 &AvailabilityZone=us-east-1a &MultiAttachEnabled=true &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE vol-1234567890abcdef0 150 7500 us-east-1a creating YYYY-MM-DDTHH:MM:SS.000Z io1; true true ``` ### Example 2 This example request creates an 80 GiB encrypted volume in the Availability Zone `us-east-1a`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVolume &Size=80 &AvailabilityZone=us-east-1a &Encrypted=true &AUTHPARAMS ``` #### Sample Response ``` 248f69ab-c7a9-4ad2-8e7c-b7556EXAMPLE vol-08bf1d00afabcdef0 80 us-east-1a creating 2020-11-30T10:39:56.000Z gp2 189 true arn:aws:kms:us-east-1:123456789012:key/237eb1a7-2fa1-44dc-b95e-6c526EXAMPLE false ``` ### Example 3 This example request creates a volume and applies a tag with a key of `stack` and a value of `production`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVolume &Size=80 &AvailabilityZone=us-east-1a &TagSpecification.1.ResourceType=volume &TagSpecification.1.Tag.1.Key=stack &TagSpecification.1.Tag.1.Value=production &AUTHPARAMS ``` #### Sample Response ``` bb216d10-54b9-4bc2-958d-fcfe2EXAMPLE vol-043c91f2fa4abcdef 80 us-east-1a creating 2020-11-30T10:47:43.000Z gp2 189 true arn:aws:kms:us-east-1:123456789012:key/237eb1a7-2fa1-44dc-b95e-6c526EXAMPLE stack production false ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVolume) # CreateVpc Creates a VPC with the specified CIDR blocks. A VPC must have an associated IPv4 CIDR block. You can choose an IPv4 CIDR block or an IPAM-allocated IPv4 CIDR block. You can optionally associate an IPv6 CIDR block with a VPC. You can choose an IPv6 CIDR block, an Amazon-provided IPv6 CIDR block, an IPAM-allocated IPv6 CIDR block, or an IPv6 CIDR block that you brought to AWS. For more information, see [IP addressing for your VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-ip-addressing.html) in the *Amazon VPC User Guide*. By default, each instance that you launch in the VPC has the default DHCP options, which include only a default DNS server that we provide (AmazonProvidedDNS). For more information, see [DHCP option sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the *Amazon VPC User Guide*. You can specify DNS options and tenancy for a VPC when you create it. You can't change the tenancy of a VPC after you create it. For more information, see [VPC configuration options](https://docs.aws.amazon.com/vpc/latest/userguide/create-vpc-options.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AmazonProvidedIpv6CidrBlock** Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. Type: Boolean Required: No **CidrBlock** The IPv4 network range for the VPC, in CIDR notation. For example, `10.0.0.0/16`. We modify the specified CIDR block to its canonical form; for example, if you specify `100.68.0.18/18`, we modify it to `100.68.0.0/18`. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceTenancy** The tenancy options for instances launched into the VPC. For `default`, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. For `dedicated`, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy of `dedicated` or `host` into a dedicated tenancy VPC. **Important:** The `host` value cannot be used with this parameter. Use the `default` or `dedicated` values only. Default: `default` Type: String Valid Values: `default | dedicated | host` Required: No **Ipv4IpamPoolId** The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: String Required: No **Ipv4NetmaskLength** The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: Integer Required: No **Ipv6CidrBlock** The IPv6 CIDR block from the IPv6 address pool. You must also specify `Ipv6Pool` in the request. To let Amazon choose the IPv6 CIDR block for you, omit this parameter. Type: String Required: No **Ipv6CidrBlockNetworkBorderGroup** The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location. You must set `AmazonProvidedIpv6CidrBlock` to `true` to use this parameter. Type: String Required: No **Ipv6IpamPoolId** The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across AWS Regions and accounts throughout your AWS Organization. For more information, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: String Required: No **Ipv6NetmaskLength** The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: Integer Required: No **Ipv6Pool** The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block. Type: String Required: No **TagSpecification.N** The tags to assign to the VPC. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcEncryptionControl** Specifies the encryption control configuration to apply to the VPC during creation. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements. For more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*. Type: [VpcEncryptionControlConfiguration](API_VpcEncryptionControlConfiguration.md) object Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpc** Information about the VPC. Type: [Vpc](API_Vpc.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a VPC with the IPv4 CIDR block `10.0.0.0/16` and a tag with the key set to `tag` and the value set to `example`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpc &CidrBlock=10.0.0.0/16 &TagSpecification.1.ResourceType=vpc &TagSpecification.1.Key=vpc &TagSpecification.1.Value=example &AUTHPARAMS ``` #### Sample Response ``` 63c5a2ed-4195-4445-b841-294629e7d8bd vpc-06b7830650EXAMPLE 111122223333 pending 10.0.0.0/16 10.0.0.0/16 vpc-cidr-assoc-017043e963EXAMPLE associated dopt-19edf471 default false example tag ``` ### Example 2 This example creates a VPC with the `dedicated` tenancy option. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpc &CidrBlock=10.32.0.0/16 &InstanceTenancy=dedicated &AUTHPARAMS ``` #### Sample Response ``` 1d536f17-5a03-4030-95b4-4d051e65e7bb vpc-07ddea827dEXAMPLE 111122223333 pending 10.32.0.0/16 10.32.0.0/16 vpc-cidr-assoc-0cc7b90dfeEXAMPLE associated dopt-19edf471 dedicated false ``` ### Example 3 This example creates a VPC and requests an IPv6 CIDR block for the VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpc &CidrBlock=10.0.0.0/16 &AmazonProvidedIpv6CidrBlock=true &AUTHPARAMS ``` #### Sample Response ``` b1a2b2b5-5806-4e24-824b-0c8996c608c1 vpc-03914afb3ed6c7632 111122223333 pending 10.0.0.0/16 10.0.0.0/16 vpc-cidr-assoc-03ca48bbbeEXAMPLE associated vpc-cidr-assoc-0bd6cc7621EXAMPLE associating dopt-19edf471 default false ``` ### Example 4 This example creates a VPC and requests an IPv6 CIDR block for the VPC for the specified Network Border Group. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpc &CidrBlock=10.0.0.0/16 &AmazonProvidedIpv6CidrBlock=true &Ipv6CidrBlockNetworkBorderGroup=us-west-2-lax-1 &AUTHPARAMS ``` #### Sample Response ``` b1a2b2b5-5806-4e24-824b-0c8996c608c1 vpc-03914afb3ed6c7632 111122223333 pending 10.0.0.0/16 10.0.0.0/16 vpc-cidr-assoc-03ca48bbbeEXAMPLE associated vpc-cidr-assoc-0bd6cc7621EXAMPLE associating us-west-2-lax-1 dopt-19edf471 default false us-west-2-lax-1a ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpc) # CreateVpcBlockPublicAccessExclusion Create a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InternetGatewayExclusionMode** The exclusion mode for internet gateway traffic. + `allow-bidirectional`: Allow all internet traffic to and from the excluded VPCs and subnets. + `allow-egress`: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to Bidirectional. Type: String Valid Values: `allow-bidirectional | allow-egress` Required: Yes **SubnetId** A subnet ID. Type: String Required: No **TagSpecification.N** `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** A VPC ID. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcBlockPublicAccessExclusion** Details about an exclusion. Type: [VpcBlockPublicAccessExclusion](API_VpcBlockPublicAccessExclusion.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpcBlockPublicAccessExclusion) # CreateVpcEncryptionControl Creates a VPC Encryption Control configuration for a specified VPC. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements for standards like HIPAA, FedRAMP, and PCI DSS. For more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to apply to the VPC Encryption Control resource. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the VPC for which to create the encryption control configuration. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcEncryptionControl** Information about the VPC Encryption Control configuration. Type: [VpcEncryptionControl](API_VpcEncryptionControl.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpcEncryptionControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpcEncryptionControl) # CreateVpcEndpoint Creates a VPC endpoint. A VPC endpoint provides a private connection between the specified VPC and the specified endpoint service. You can use an endpoint service provided by AWS, an AWS Marketplace Partner, or another AWS account. For more information, see the [AWS PrivateLink User Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/). Use [DescribeVpcEndpointServices](API_DescribeVpcEndpointServices.md) to list the supported services. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DnsOptions** The DNS options for the endpoint. Type: [DnsOptionsSpecification](API_DnsOptionsSpecification.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpAddressType** The IP address type for the endpoint. Type: String Valid Values: `ipv4 | dualstack | ipv6` Required: No **PolicyDocument** (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. If this parameter is not specified, we attach a default policy that allows full access to the service. Type: String Required: No **PrivateDnsEnabled** (Interface endpoint) Indicates whether to associate a private hosted zone with the specified VPC. The private hosted zone contains a record set for the default public DNS name for the service for the Region (for example, `kinesis.us-east-1.amazonaws.com`), which resolves to the private IP addresses of the endpoint network interfaces in the VPC. This enables you to make requests to the default public DNS name for the service instead of the public DNS names that are automatically generated by the VPC endpoint service. To use a private hosted zone, you must set the following VPC attributes to `true`: `enableDnsHostnames` and `enableDnsSupport`. Use [ModifyVpcAttribute](API_ModifyVpcAttribute.md) to set the VPC attributes. Type: Boolean Required: No **ResourceConfigurationArn** The Amazon Resource Name (ARN) of a resource configuration that will be associated with the VPC endpoint of type resource. Type: String Required: No **RouteTableId.N** (Gateway endpoint) The route table IDs. Type: Array of strings Required: No **SecurityGroupId.N** (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. If this parameter is not specified, we use the default security group for the VPC. Type: Array of strings Required: No **ServiceName** The name of the endpoint service. Type: String Required: No **ServiceNetworkArn** The Amazon Resource Name (ARN) of a service network that will be associated with the VPC endpoint of type service-network. Type: String Required: No **ServiceRegion** The Region where the service is hosted. The default is the current Region. Type: String Required: No **SubnetConfiguration.N** The subnet configurations for the endpoint. Type: Array of [SubnetConfiguration](API_SubnetConfiguration.md) objects Required: No **SubnetId.N** (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to create endpoint network interfaces. For a Gateway Load Balancer endpoint, you can specify only one subnet. Type: Array of strings Required: No **TagSpecification.N** The tags to associate with the endpoint. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcEndpointType** The type of endpoint. Default: Gateway Type: String Valid Values: `Interface | Gateway | GatewayLoadBalancer | Resource | ServiceNetwork` Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String **requestId** The ID of the request. Type: String **vpcEndpoint** Information about the endpoint. Type: [VpcEndpoint](API_VpcEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a gateway endpoint between `vpc-1a2b3c4d` and Amazon S3 in us-east-1, and associates route table `rtb-11aa22bb` with the endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcEndpoint &VpcId=vpc-1a2b3c4d &ServiceName=com.amazonaws.us-east-1.s3 &RouteTableId.1=rtb-11aa22bb &AUTHPARAMS ``` #### Sample Response ``` vpc-1a2b3c4d available rtb-11aa22bb vpce-abc12345 2015-02-20T16:46:40Z {"Version":"2008-10-17", "Statement":[{"Sid":"","Effect":"Allow","Principal":"*","Action":"*","Resource":"*"}]} com.amazonaws.us-west-1.s3 4b373100-473a-46a0-9006-example ``` ### Example 2 This example creates an interface endpoint between `vpc-1a2b3c4d` and Elastic Load Balancing in us-east-1 in subnet `subnet-1a2b3c4d`, and associates security group `sg-11aa22bb` with the network interface. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcEndpoint &VpcId=vpc-1a2b3c4d &ServiceName=com.amazonaws.us-east-1.elasticloadbalancing &VpcEndpointType=Interface &SubnetId.1=subnet-1a2b3c4d &SecurityGroupId.1=sg-11aa22bb &AUTHPARAMS ``` #### Sample Response ``` bf5a49f9-4c36-41c9-a4be-13dexample { "Statement": [ { "Action": "*", "Effect": "Allow", "Principal": "*", "Resource": "*" } ] } Z7HUB22UULQXV vpce-0324151a02f327ff5-3k8nfxtt.elasticloadbalancing.us-east-1.vpce.amazonaws.com Z7HUB22UULQXV vpce-0324151a02f327ff5-3k8nfxtt-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com Z2THV5YBYUN78V elasticloadbalancing.us-east-1.amazonaws.com com.amazonaws.us-east-1.elasticloadbalancing true default sg-11aa22bb vpce-0324151a02f327ff5 subnet-1a2b3c4d eni-cd1a3319 Interface vpc-1a2b3c4d 2017-09-05T20:57:46.307Z pending ``` ### Example 3 This example creates a Gateway Load Balancer endpoint between `vpc-11122223333344445` and a VPC endpoint service that's configured using a Gateway Load Balancer. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcEndpoint &VpcId=vpc-11122223333344445 &ServiceName=com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123 &VpcEndpointType=GatewayLoadBalancer &SubnetId.1=subnet-aaaa1111bbbb22233 &AUTHPARAMS ``` #### Sample Response ``` bf5a49f9-4c36-41c9-a4be-13dexample 123456789012 false com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123 vpce-bbbbbb2222222333 subnet-aaaa1111bbbb22233 eni-11111111222222aaa GatewayLoadBalancer vpc-11122223333344445 2020-11-11T08:06:03.522Z pending ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpcEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpcEndpoint) # CreateVpcEndpointConnectionNotification Creates a connection notification for a specified VPC endpoint or VPC endpoint service. A connection notification notifies you of specific endpoint events. You must create an SNS topic to receive notifications. For more information, see [Creating an Amazon SNS topic](https://docs.aws.amazon.com/sns/latest/dg/CreateTopic.html) in the *Amazon SNS Developer Guide*. You can create a connection notification for interface endpoints only. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **ConnectionEvents.N** The endpoint events for which to receive notifications. Valid values are `Accept`, `Connect`, `Delete`, and `Reject`. Type: Array of strings Required: Yes **ConnectionNotificationArn** The ARN of the SNS topic for the notifications. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ServiceId** The ID of the endpoint service. Type: String Required: No **VpcEndpointId** The ID of the endpoint. Type: String Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String **connectionNotification** Information about the notification. Type: [ConnectionNotification](API_ConnectionNotification.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a notification for the endpoint `vpce-1234151a02f327123`. The notification is sent when the endpoint is rejected or deleted. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcEndpointConnectionNotification &VpcEndpointId=vpce-1234151a02f327123 &ConnectionNotificationArn=arn:aws:sns:us-east-1:123456789012:endpointtopic &ConnectionEvents.1=Reject &ConnectionEvents.2=Delete &AUTHPARAMS ``` #### Sample Response ``` 6bf51e2a-a99e-4839-af31-a0d72example arn:aws:sns:us-east-1:123456789012:endpointtopic Delete Reject Topic Enabled vpce-nfn-04bcb952bc8af759b vpce-1234151a02f327123 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpcEndpointConnectionNotification) # CreateVpcEndpointServiceConfiguration Creates a VPC endpoint service to which service consumers (AWS accounts, users, and IAM roles) can connect. Before you create an endpoint service, you must create one of the following for your service: + A [Network Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/). Service consumers connect to your service using an interface endpoint. + A [Gateway Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/gateway/). Service consumers connect to your service using a Gateway Load Balancer endpoint. If you set the private DNS name, you must prove that you own the private DNS domain name. For more information, see the [AWS PrivateLink Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AcceptanceRequired** Indicates whether requests from service consumers to create an endpoint to your service must be accepted manually. To accept a request manually, use [AcceptVpcEndpointConnections](API_AcceptVpcEndpointConnections.md). To reject a request, use [RejectVpcEndpointConnections](API_RejectVpcEndpointConnections.md). Type: Boolean Required: No **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GatewayLoadBalancerArn.N** The Amazon Resource Names (ARNs) of the Gateway Load Balancers. Type: Array of strings Required: No **NetworkLoadBalancerArn.N** The Amazon Resource Names (ARNs) of the Network Load Balancers. Type: Array of strings Required: No **PrivateDnsName** (Interface endpoint configuration) The private DNS name to assign to the VPC endpoint service. Type: String Required: No **SupportedIpAddressType.N** The supported IP address types. The possible values are `ipv4` and `ipv6`. Type: Array of strings Required: No **SupportedRegion.N** The Regions from which service consumers can access the service. Type: Array of strings Required: No **TagSpecification.N** The tags to associate with the service. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String **requestId** The ID of the request. Type: String **serviceConfiguration** Information about the service configuration. Type: [ServiceConfiguration](API_ServiceConfiguration.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a VPC endpoint service configuration using the specified Network Load Balancer. This example also specifies that requests to connect to the service through a VPC endpoint must be accepted or rejected manually. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcEndpointServiceConfiguration &NetworkLoadBalancerArn.1=arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-nlb/e94221227f1ba532 &AcceptanceRequired=true &AUTHPARAMS ``` #### Sample Response ``` 1b2f25d4-9d9f-4256-a8e3-297f7example Available Interface vpce-svc-0552b9c1298c4f123.us-east-1.vpce.amazonaws.com true us-east-1d vpce-svc-0552b9c1298c4f123 com.amazonaws.vpce.us-east-1.vpce-svc-0552b9c1298c4f123 arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-nlb/e94221227f1ba532 ``` ### Example 2 This example creates a VPC endpoint service configuration using the specified Gateway Load Balancer. This example also specifies that all requests to connect to the service are accepted automatically. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcEndpointServiceConfiguration &GatewayLoadBalancerArn.1=arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/abc210844e429abc &AcceptanceRequired=false &AUTHPARAMS ``` #### Sample Response ``` 1b2f25d4-9d9f-4256-a8e3-297f7example Available GatewayLoadBalancer false us-east-1d vpce-svc-123abcc1298abc123 com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123 arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/abc210844e429abc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpcEndpointServiceConfiguration) # CreateVpcPeeringConnection Requests a VPC peering connection between two VPCs: a requester VPC that you own and an accepter VPC with which to create the connection. The accepter VPC can belong to another AWS account and can be in a different Region to the requester VPC. The requester VPC and accepter VPC cannot have overlapping CIDR blocks. **Note** Limitations and rules apply to a VPC peering connection. For more information, see the [VPC peering limitations](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations) in the *VPC Peering Guide*. The owner of the accepter VPC must accept the peering request to activate the peering connection. The VPC peering connection request expires after 7 days, after which it cannot be accepted or rejected. If you create a VPC peering connection request between VPCs with overlapping CIDR blocks, the VPC peering connection has a status of `failed`. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PeerOwnerId** The AWS account ID of the owner of the accepter VPC. Default: Your AWS account ID Type: String Required: No **PeerRegion** The Region code for the accepter VPC, if the accepter VPC is located in a Region other than the Region in which you make the request. Default: The Region in which you make the request. Type: String Required: No **PeerVpcId** The ID of the VPC with which you are creating the VPC peering connection. You must specify this parameter in the request. Type: String Required: No **TagSpecification.N** The tags to assign to the peering connection. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **VpcId** The ID of the requester VPC. You must specify this parameter in the request. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcPeeringConnection** Information about the VPC peering connection. Type: [VpcPeeringConnection](API_VpcPeeringConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example requests a peering connection between your VPC (`vpc-1a2b3c4d`), and a VPC (`vpc-a1b2c3d4`) that belongs to AWS account 123456789012. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcPeeringConnection &VpcId=vpc-1a2b3c4d &PeerVpcId=vpc-a1b2c3d4 &PeerOwnerId=123456789012 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE pcx-73a5401a 777788889999 vpc-1a2b3c4d 10.0.0.0/28 false false false 123456789012 vpc-a1b2c3d4 initiating-request Initiating Request to 123456789012 2014-02-18T14:37:25.000Z ``` ### Example 2 This example requests a peering connection between your VPCs `vpc-1a2b3c4d` and `vpc-11122233`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcPeeringConnection &VpcId=vpc-1a2b3c4d &PeerVpcId=vpc-11122233 &AUTHPARAMS ``` ### Example 3 This example requests an inter-region peering connection between two VPCs in your account. VPC `vpc-1a2b3c4d` is located in the US East (N. Virginia) Region (`us-east-1`), and accepter VPC `vpc-a1b2c3d4` is located in the US West (Oregon) Region (`us-west-2`). The VPC peering connection must be accepted in the `us-west-2` Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpcPeeringConnection &VpcId=vpc-1a2b3c4d &PeerVpcId=vpc-a1b2c3d4 &PeerRegion=us-west-2 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpcPeeringConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpcPeeringConnection) # CreateVpnConcentrator Creates a VPN concentrator that aggregates multiple VPN connections to a transit gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to apply to the VPN concentrator during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway to attach the VPN concentrator to. Type: String Required: No **Type** The type of VPN concentrator to create. Type: String Valid Values: `ipsec.1` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConcentrator** Information about the VPN concentrator. Type: [VpnConcentrator](API_VpnConcentrator.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a VPN Concentrator on the Transit Gateway `tgw-0eae06e326d7c27d8`. #### Sample Request ``` https://ec2.us-east-1.amazonaws.com/?Version=2016-11-15&Action=CreateVpnConcentrator &Type=ipsec.1 &TransitGatewayId=tgw-0eae06e326d7c27d8 ``` #### Sample Response ``` c875a725-2eb7-4deb-ad8f-4445c071460f pending tgw-attach-04a445da95a6814cc tgw-0eae06e326d7c27d8 ipsec.1 vcn-0767cb7521c5c4945 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpnConcentrator) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpnConcentrator) # CreateVpnConnection Creates a VPN connection between an existing virtual private gateway or transit gateway and a customer gateway. The supported connection type is `ipsec.1`. The response includes information that you need to give to your network administrator to configure your customer gateway. **Important** We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway device. If you decide to shut down your VPN connection for any reason and later create a new VPN connection, you must reconfigure your customer gateway with the new information returned from this call. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CustomerGatewayId** The ID of the customer gateway. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** The options for the VPN connection. Type: [VpnConnectionOptionsSpecification](API_VpnConnectionOptionsSpecification.md) object Required: No **PreSharedKeyStorage** Specifies the storage mode for the pre-shared key (PSK). Valid values are `Standard`" (stored in the Site-to-Site VPN service) or `SecretsManager` (stored in AWS Secrets Manager). Type: String Required: No **TagSpecification.N** The tags to apply to the VPN connection. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TransitGatewayId** The ID of the transit gateway. If you specify a transit gateway, you cannot specify a virtual private gateway. Type: String Required: No **Type** The type of VPN connection (`ipsec.1`). Type: String Required: Yes **VpnConcentratorId** The ID of the VPN concentrator to associate with the VPN connection. Type: String Required: No **VpnGatewayId** The ID of the virtual private gateway. If you specify a virtual private gateway, you cannot specify a transit gateway. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConnection** Information about the VPN connection. Type: [VpnConnection](API_VpnConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a VPN connection between the specified virtual private gateway and the specified customer gateway. The response includes configuration information for configuring the customer gateway device. Because it's a long set of information, we haven't included the complete response here. To see an example of the configuration information, see the [Your customer gateway device](https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html). #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpnConnection &Type=ipsec.1 &CustomerGatewayId=cgw-112233445566aabbc &VpnGatewayId=vgw-aabbccddee1234567 &AUTHPARAMS ``` #### Sample Response ``` 22896b9b-e2fe-4574-9a20-example vpn-01234abcabc123456 pending ...Customer gateway configuration data in escaped XML format... cgw-112233445566aabbc vgw-aabbccddee1234567 false false 0.0.0.0/0 0.0.0.0/0 ipv4 VPN ``` ### Example 2 This example creates a VPN connection with the static routes option between the virtual private gateway with the ID `vgw-8db04f81`, and the customer gateway with the ID `cgw-b4dc3961`, for a device that does not support the Border Gateway Protocol (BGP). #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpnConnection &Type=ipsec.1 &CustomerGatewayId=cgw-b4dc3961 &VpnGatewayId=vgw-8db04f81 &Options.StaticRoutesOnly=true &AUTHPARAMS ``` ### Example 3 This example creates a VPN connection between the virtual private gateway with the ID `vgw-8db04f81` and the customer gateway with the ID `cgw-b4dc3961` and specifies the inside IP address CIDR block and a custom pre-shared key for each tunnel. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpnConnection &Type=ipsec.1 &CustomerGatewayId=cgw-b4dc3961 &VpnGatewayId=vgw-8db04f81 &Options.TunnelOptions.1.PreSharedKey=wMp_IGfO1d1o9AT4lF6tJLFN4EXAMPLE &Options.TunnelOptions.1.TunnelInsideCidr=169.254.44.110/30 &Options.TunnelOptions.2.PreSharedKey=HAM8lcnFYEvfl6gUrOatJLFN4EXAMPLE &Options.TunnelOptions.2.TunnelInsideCidr=169.254.44.240/30 &AUTHPARAMS ``` ### Example 4 This example creates a VPN connection between the specified transit gateway and the specified customer gateway. The VPN connection processes IPv6 traffic inside the tunnels, and the tunnel options for both tunnels specify that AWS must initiate the IKE negotiation. A tag with a key of `Location` and a value of `NewYorkVPN` is applied to the VPN connection. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpnConnection &Type=ipsec.1 &CustomerGatewayId=cgw-112233445566aabbc &TransitGatewayId=tgw-0123f96e7b3f5babc &Options.StaticRoutesOnly=false &Options.TunnelInsideIpVersion=ipv6 &Options.TunnelOptions.1.StartupAction=start &Options.TunnelOptions.2.StartupAction=start &TagSpecification.1.ResourceType=vpn-connection &TagSpecification.1.Tag.1.Key=Location &TagSpecification.1.Tag.1.Value=NewYorkVPN &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpnConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpnConnection) # CreateVpnConnectionRoute Creates a static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The CIDR block associated with the local subnet of the customer network. Type: String Required: Yes **VpnConnectionId** The ID of the VPN connection. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates a static route to the VPN connection for the VPN connection with the ID `vpn-83ad48ea` to the destination CIDR block `11.12.0.0/16`. Note that when using the Query API the "/" is denoted as "%2F". #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpnConnectionRoute &DestinationCidrBlock=11.12.0.0%2F16 &VpnConnectionId=vpn-83ad48ea &AUTHPARAMS ``` #### Sample Response ``` 4f35a1b2-c2c3-4093-b51f-abb9d7311990 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpnConnectionRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpnConnectionRoute) # CreateVpnGateway Creates a virtual private gateway. A virtual private gateway is the endpoint on the VPC side of your VPN connection. You can create a virtual private gateway before creating the VPC itself. For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AmazonSideAsn** A private Autonomous System Number (ASN) for the Amazon side of a BGP session. If you're using a 16-bit ASN, it must be in the 64512 to 65534 range. If you're using a 32-bit ASN, it must be in the 4200000000 to 4294967294 range. Default: 64512 Type: Long Required: No **AvailabilityZone** The Availability Zone for the virtual private gateway. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TagSpecification.N** The tags to apply to the virtual private gateway. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **Type** The type of VPN connection this virtual private gateway supports. Type: String Valid Values: `ipsec.1` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnGateway** Information about the virtual private gateway. Type: [VpnGateway](API_VpnGateway.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example creates a virtual private gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpnGateway &Type=ipsec.1 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vgw-fe4aa197 available ipsec.1 64512 ``` ### Example 2 This example creates a virtual private gateway and specifies a private ASN of 65001 for the Amazon side of the gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=CreateVpnGateway &Type=ipsec.1 &AmazonSideAsn=65001 &AUTHPARAMS ``` #### Sample Response ``` fe90b404-d4e5-4153-8677-31dexample vgw-f74aa19e available ipsec.1 65001 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/CreateVpnGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVpnGateway) # DeleteCapacityManagerDataExport Deletes an existing Capacity Manager data export configuration. This stops future scheduled exports but does not delete previously exported files from S3. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityManagerDataExportId** The unique identifier of the data export configuration to delete. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **capacityManagerDataExportId** The unique identifier of the deleted data export configuration. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes a data export configuration. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteCapacityManagerDataExport &CapacityManagerDataExportId=cmde-0abcd1234EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE cmde-0abcd1234EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteCapacityManagerDataExport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteCapacityManagerDataExport) # DeleteCarrierGateway Deletes a carrier gateway. **Important** If you do not delete the route that contains the carrier gateway as the Target, the route is a blackhole route. For information about how to delete a route, see [DeleteRoute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeleteRoute.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CarrierGatewayId** The ID of the carrier gateway. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **carrierGateway** Information about the carrier gateway. Type: [CarrierGateway](API_CarrierGateway.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteCarrierGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteCarrierGateway) # DeleteClientVpnEndpoint Deletes the specified Client VPN endpoint. You must disassociate all target networks before you can delete a Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN to be deleted. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **status** The current state of the Client VPN endpoint. Type: [ClientVpnEndpointStatus](API_ClientVpnEndpointStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example applies a security group to a Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteClientVpnEndpoint &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` f1e0fdfc-96a4-4d7d-bc78-22eb0EXAMPLE deleting ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteClientVpnEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteClientVpnEndpoint) # DeleteClientVpnRoute Deletes a route from a Client VPN endpoint. You can only delete routes that you manually added using the **CreateClientVpnRoute** action. You cannot delete routes that were automatically added when associating a subnet. To remove routes that have been automatically added, disassociate the target subnet from the Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN endpoint from which the route is to be deleted. Type: String Required: Yes **DestinationCidrBlock** The IPv4 address range, in CIDR notation, of the route to be deleted. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TargetVpcSubnetId** The ID of the target subnet used by the route. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **status** The current state of the route. Type: [ClientVpnRouteStatus](API_ClientVpnRouteStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes a route from a Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteClientVpnRoute &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &DestinationCidrBlock=0.0.0.0/0 &TargetVpcSubnetId=subnet-057fa0918fEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 00d80748-708d-40f7-8635-f34acEXAMPLE deleting ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteClientVpnRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteClientVpnRoute) # DeleteCoipCidr Deletes a range of customer-owned IP addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** A customer-owned IP address range that you want to delete. Type: String Required: Yes **CoipPoolId** The ID of the customer-owned address pool. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **coipCidr** Information about a range of customer-owned IP addresses. Type: [CoipCidr](API_CoipCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteCoipCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteCoipCidr) # DeleteCoipPool Deletes a pool of customer-owned IP (CoIP) addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CoipPoolId** The ID of the CoIP pool that you want to delete. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **coipPool** Information about the CoIP address pool. Type: [CoipPool](API_CoipPool.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteCoipPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteCoipPool) # DeleteCustomerGateway Deletes the specified customer gateway. You must delete the VPN connection before you can delete the customer gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CustomerGatewayId** The ID of the customer gateway. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified customer gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteCustomerGateway &CustomerGatewayId=cgw-b4dc3961 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteCustomerGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteCustomerGateway) # DeleteDhcpOptions Deletes the specified set of DHCP options. You must disassociate the set of DHCP options before you can delete it. You can disassociate the set of DHCP options by associating either a new set of options or the default set of options with the VPC. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DhcpOptionsId** The ID of the DHCP options set. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified set of DHCP options. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteDhcpOptions &DhcpOptionsId=dopt-7a8b9c2d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteDhcpOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteDhcpOptions) # DeleteEgressOnlyInternetGateway Deletes an egress-only internet gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EgressOnlyInternetGatewayId** The ID of the egress-only internet gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **returnCode** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified egress-only internet gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteEgressOnlyInternetGateway &EgressOnlyInternetGatewayId=eigw-015e0e244e24dfe8a &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteEgressOnlyInternetGateway) # DeleteFleets Deletes the specified EC2 Fleet request. After you delete an EC2 Fleet request, it launches no new instances. You must also specify whether a deleted EC2 Fleet request should terminate its instances. If you choose to terminate the instances, the EC2 Fleet request enters the `deleted_terminating` state. Otherwise, it enters the `deleted_running` state, and the instances continue to run until they are interrupted or you terminate them manually. A deleted `instant` fleet with running instances is not supported. When you delete an `instant` fleet, Amazon EC2 automatically terminates all its instances. For fleets with more than 1000 instances, the deletion request might fail. If your fleet has more than 1000 instances, first terminate most of the instances manually, leaving 1000 or fewer. Then delete the fleet, and the remaining instances will be terminated automatically. **Important** **Terminating an instance is permanent and irreversible.** After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more information, see [ How instance termination works](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-ec2-instance-termination-works.html). Before you terminate an instance, ensure that you have backed up all data that you need to retain after the termination to persistent storage. **Restrictions** + You can delete up to 25 fleets of type `instant` in a single request. + You can delete up to 100 fleets of type `maintain` or `request` in a single request. + You can delete up to 125 fleets in a single request, provided you do not exceed the quota for each fleet type, as specified above. + If you exceed the specified number of fleets to delete, no fleets are deleted. For more information, see [Delete an EC2 Fleet request and the instances in the fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/delete-fleet.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FleetId.N** The IDs of the EC2 Fleets. Constraints: In a single request, you can specify up to 25 `instant` fleet IDs and up to 100 `maintain` or `request` fleet IDs. Type: Array of strings Required: Yes **TerminateInstances** Indicates whether to terminate the associated instances when the EC2 Fleet is deleted. The default is to terminate the instances. To let the instances continue to run after the EC2 Fleet is deleted, specify `no-terminate-instances`. Supported only for fleets of type `maintain` and `request`. For `instant` fleets, you cannot specify `NoTerminateInstances`. A deleted `instant` fleet with running instances is not supported. Type: Boolean Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successfulFleetDeletionSet** Information about the EC2 Fleets that are successfully deleted. Type: Array of [DeleteFleetSuccessItem](API_DeleteFleetSuccessItem.md) objects **unsuccessfulFleetDeletionSet** Information about the EC2 Fleets that are not successfully deleted. Type: Array of [DeleteFleetErrorItem](API_DeleteFleetErrorItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteFleets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteFleets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteFleets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteFleets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteFleets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteFleets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteFleets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteFleets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteFleets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteFleets) # DeleteFlowLogs Deletes one or more flow logs. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FlowLogId.N** One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **unsuccessful** Information about the flow logs that could not be deleted successfully. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes flow log fl-1a2b3c4d. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteFlowLogs &FlowLogId.1=fl-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` c5c4f51f-f4e9-42bc-8700-EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteFlowLogs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteFlowLogs) # DeleteFpgaImage Deletes the specified Amazon FPGA Image (AFI). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FpgaImageId** The ID of the AFI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified AFI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteFpgaImage &FpgaImageId=afi-0d123e21abcc85abc &AUTHPARAMS ``` #### Sample Response ``` dd3bf051-468e-4490-ad8a-2ffexample true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteFpgaImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteFpgaImage) # DeleteImageUsageReport Deletes the specified image usage report. For more information, see [View your AMI usage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/your-ec2-ami-usage.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReportId** The ID of the report to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteImageUsageReport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteImageUsageReport) # DeleteInstanceConnectEndpoint Deletes the specified EC2 Instance Connect Endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceConnectEndpointId** The ID of the EC2 Instance Connect Endpoint to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **instanceConnectEndpoint** Information about the EC2 Instance Connect Endpoint. Type: [Ec2InstanceConnectEndpoint](API_Ec2InstanceConnectEndpoint.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example: Delete an EC2 Instance Connect Endpoint This example deletes the specified EC2 Instance Connect Endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteInstanceConnectEndpoint &InstanceConnectEndpointId=eice-0123456789example &AUTHPARAMS ``` #### Sample Response ``` d732c12a-2f0c-49b4-b2a9-f2922e5f5635 availability-zone availability-zone-id 2023-06-06T20:01:31.000Z arn:aws:ec2:region:account-id:instance-connect-endpoint/eice-0123456789example eice-0123456789example account-id false sg-0123456789example delete-in-progress subnet-0123456789example vpc-0123456789example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteInstanceConnectEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteInstanceConnectEndpoint) # DeleteInstanceEventWindow Deletes the specified event window. For more information, see [Define event windows for scheduled events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ForceDelete** Specify `true` to force delete the event window. Use the force delete parameter if the event window is currently associated with targets. Type: Boolean Required: No **InstanceEventWindowId** The ID of the event window. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **instanceEventWindowState** The state of the event window. Type: [InstanceEventWindowStateChange](API_InstanceEventWindowStateChange.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteInstanceEventWindow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteInstanceEventWindow) # DeleteInternetGateway Deletes the specified internet gateway. You must detach the internet gateway from the VPC before you can delete it. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InternetGatewayId** The ID of the internet gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified internet gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteInternetGateway &InternetGatewayId=igw-eaad4883 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteInternetGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteInternetGateway) # DeleteIpam Delete an IPAM. Deleting an IPAM removes all monitored data associated with the IPAM including the historical data for CIDRs. For more information, see [Delete an IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/delete-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cascade** Enables you to quickly delete an IPAM, private scopes, pools in private scopes, and any allocations in the pools in private scopes. You cannot delete the IPAM with this option if there is a pool in your public scope. If you use this option, IPAM does the following: + Deallocates any CIDRs allocated to VPC resources (such as VPCs) in pools in private scopes. **Note** No VPC resources are deleted as a result of enabling this option. The CIDR associated with the resource will no longer be allocated from an IPAM pool, but the CIDR itself will remain unchanged. + Deprovisions all IPv4 CIDRs provisioned to IPAM pools in private scopes. + Deletes all IPAM pools in private scopes. + Deletes all non-default private scopes in the IPAM. + Deletes the default public and private scopes and the IPAM. Type: Boolean Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamId** The ID of the IPAM to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipam** Information about the results of the deletion. Type: [Ipam](API_Ipam.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpam) # DeleteIpamExternalResourceVerificationToken Delete a verification token. A verification token is an AWS-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to AWS (BYOIP). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamExternalResourceVerificationTokenId** The token ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamExternalResourceVerificationToken** The verification token. Type: [IpamExternalResourceVerificationToken](API_IpamExternalResourceVerificationToken.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpamExternalResourceVerificationToken) # DeleteIpamPolicy Deletes an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPolicyId** The ID of the IPAM policy to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamPolicy** Information about the deleted IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. Type: [IpamPolicy](API_IpamPolicy.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpamPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpamPolicy) # DeleteIpamPool Delete an IPAM pool. **Note** You cannot delete an IPAM pool if there are allocations in it or CIDRs provisioned to it. To release allocations, see [ReleaseIpamPoolAllocation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html). To deprovision pool CIDRs, see [DeprovisionIpamPoolCidr](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeprovisionIpamPoolCidr.html). For more information, see [Delete a pool](https://docs.aws.amazon.com/vpc/latest/ipam/delete-pool-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cascade** Enables you to quickly delete an IPAM pool and all resources within that pool, including provisioned CIDRs, allocations, and other pools. You can only use this option to delete pools in the private scope or pools in the public scope with a source resource. A source resource is a resource used to provision CIDRs to a resource planning pool. Type: Boolean Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPoolId** The ID of the pool to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamPool** Information about the results of the deletion. Type: [IpamPool](API_IpamPool.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpamPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpamPool) # DeleteIpamPrefixListResolver Deletes an IPAM prefix list resolver. Before deleting a resolver, you must first delete all resolver targets associated with it. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPrefixListResolverId** The ID of the IPAM prefix list resolver to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamPrefixListResolver** Information about the IPAM prefix list resolver that was deleted. Type: [IpamPrefixListResolver](API_IpamPrefixListResolver.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpamPrefixListResolver) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpamPrefixListResolver) # DeleteIpamPrefixListResolverTarget Deletes an IPAM prefix list resolver target. This removes the association between the resolver and the managed prefix list, stopping automatic CIDR synchronization. For more information about IPAM prefix list resolver, see [Automate prefix list updates with IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/automate-prefix-list-updates.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPrefixListResolverTargetId** The ID of the IPAM prefix list resolver target to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamPrefixListResolverTarget** Information about the IPAM prefix list resolver target that was deleted. Type: [IpamPrefixListResolverTarget](API_IpamPrefixListResolverTarget.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpamPrefixListResolverTarget) # DeleteIpamResourceDiscovery Deletes an IPAM resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamResourceDiscoveryId** The IPAM resource discovery ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamResourceDiscovery** The IPAM resource discovery. Type: [IpamResourceDiscovery](API_IpamResourceDiscovery.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpamResourceDiscovery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpamResourceDiscovery) # DeleteIpamScope Delete the scope for an IPAM. You cannot delete the default scopes. For more information, see [Delete a scope](https://docs.aws.amazon.com/vpc/latest/ipam/delete-scope-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamScopeId** The ID of the scope to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamScope** Information about the results of the deletion. Type: [IpamScope](API_IpamScope.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteIpamScope) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteIpamScope) # DeleteKeyPair Deletes the specified key pair, by removing the public key from Amazon EC2. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **KeyName** The name of the key pair. Type: String Required: No **KeyPairId** The ID of the key pair. Type: String Required: No ## Response Elements The following elements are returned by the service. **keyPairId** The ID of the key pair. Type: String **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example request deletes the key pair named `my-key-pair`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteKeyPair &KeyName=my-key-pair &AUTHPARAMS ``` #### Sample Response ``` true key-12345abcdeEXAMPLE ``` ### Example 2 This example request deletes a key pair with the ID `key-abcd12345eEXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteKeyPair &KeyPairId=key-abcd12345eEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` true key-abcd12345eEXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteKeyPair) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteKeyPair) # DeleteLaunchTemplate Deletes a launch template. Deleting a launch template deletes all of its versions. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LaunchTemplateId** The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Required: No **LaunchTemplateName** The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: `[a-zA-Z0-9\.\-/_]+` Required: No ## Response Elements The following elements are returned by the service. **launchTemplate** Information about the launch template. Type: [LaunchTemplate](API_LaunchTemplate.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes launch template `lt-0a20c965061f64abc`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteLaunchTemplate &LaunchTemplateId=lt-0a20c965061f64abc &AUTHPARAMS ``` #### Sample Response ``` c12605de-c470-4eaa-a4d0-ab4dexample 2017-10-31T11:38:52.000Z arn:aws:iam::123456789012:root 2 2 lt-0a20c965061f64abc MyLaunchTemplate ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLaunchTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLaunchTemplate) # DeleteLaunchTemplateVersions Deletes one or more versions of a launch template. You can't delete the default version of a launch template; you must first assign a different version as the default. If the default version is the only version for the launch template, you must delete the entire launch template using [DeleteLaunchTemplate](API_DeleteLaunchTemplate.md). You can delete up to 200 launch template versions in a single request. To delete more than 200 versions in a single request, use [DeleteLaunchTemplate](API_DeleteLaunchTemplate.md), which deletes the launch template and all of its versions. For more information, see [Delete a launch template version](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/delete-launch-template.html#delete-launch-template-version) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LaunchTemplateId** The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Required: No **LaunchTemplateName** The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: `[a-zA-Z0-9\.\-/_]+` Required: No **LaunchTemplateVersion.N** The version numbers of one or more launch template versions to delete. You can specify up to 200 launch template version numbers. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successfullyDeletedLaunchTemplateVersionSet** Information about the launch template versions that were successfully deleted. Type: Array of [DeleteLaunchTemplateVersionsResponseSuccessItem](API_DeleteLaunchTemplateVersionsResponseSuccessItem.md) objects **unsuccessfullyDeletedLaunchTemplateVersionSet** Information about the launch template versions that could not be deleted. Type: Array of [DeleteLaunchTemplateVersionsResponseErrorItem](API_DeleteLaunchTemplateVersionsResponseErrorItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes version 3 of launch template `lt-0a20c965061f64abc`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteLaunchTemplateVersions &LaunchTemplateId=lt-0a20c965061f64abc &LaunchTemplateVersion.1=3 &AUTHPARAMS ``` #### Sample Response ``` 67fc746a-1b3f-467e-8583-7061cexample lt-0a20c965061f64abc MyLaunchTemplate 3 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLaunchTemplateVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLaunchTemplateVersions) # DeleteLocalGatewayRoute Deletes the specified route from the specified local gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The CIDR range for the route. This must match the CIDR for the route exactly. Type: String Required: No **DestinationPrefixListId** Use a prefix list in place of `DestinationCidrBlock`. You cannot use `DestinationPrefixListId` and `DestinationCidrBlock` in the same request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableId** The ID of the local gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **route** Information about the route. Type: [LocalGatewayRoute](API_LocalGatewayRoute.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLocalGatewayRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLocalGatewayRoute) # DeleteLocalGatewayRouteTable Deletes a local gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableId** The ID of the local gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **localGatewayRouteTable** Information about the local gateway route table. Type: [LocalGatewayRouteTable](API_LocalGatewayRouteTable.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLocalGatewayRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLocalGatewayRouteTable) # DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation Deletes a local gateway route table virtual interface group association. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableVirtualInterfaceGroupAssociationId** The ID of the local gateway route table virtual interface group association. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **localGatewayRouteTableVirtualInterfaceGroupAssociation** Information about the association. Type: [LocalGatewayRouteTableVirtualInterfaceGroupAssociation](API_LocalGatewayRouteTableVirtualInterfaceGroupAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVirtualInterfaceGroupAssociation) # DeleteLocalGatewayRouteTableVpcAssociation Deletes the specified association between a VPC and local gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableVpcAssociationId** The ID of the association. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **localGatewayRouteTableVpcAssociation** Information about the association. Type: [LocalGatewayRouteTableVpcAssociation](API_LocalGatewayRouteTableVpcAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLocalGatewayRouteTableVpcAssociation) # DeleteLocalGatewayVirtualInterface Deletes the specified local gateway virtual interface. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayVirtualInterfaceId** The ID of the local virtual interface to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **localGatewayVirtualInterface** Information about the deleted local gateway virtual interface. Type: [LocalGatewayVirtualInterface](API_LocalGatewayVirtualInterface.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterface) # DeleteLocalGatewayVirtualInterfaceGroup Delete the specified local gateway interface group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayVirtualInterfaceGroupId** The ID of the local gateway virtual interface group to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **localGatewayVirtualInterfaceGroup** Information about the deleted local gateway virtual interface group. Type: [LocalGatewayVirtualInterfaceGroup](API_LocalGatewayVirtualInterfaceGroup.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLocalGatewayVirtualInterfaceGroup) # DeleteManagedPrefixList Deletes the specified managed prefix list. You must first remove all references to the prefix list in your resources. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PrefixListId** The ID of the prefix list. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **prefixList** Information about the prefix list. Type: [ManagedPrefixList](API_ManagedPrefixList.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified prefix list. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteManagedPrefixList &PrefixListId=pl-0123123123123aabb &AUTHPARAMS ``` #### Sample Response ``` 06152571-575a-49aa-af95-example IPv6 25 123456789012 arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123aabb pl-0123123123123aabb test-pl delete-in-progress 1 ' ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteManagedPrefixList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteManagedPrefixList) # DeleteNatGateway Deletes the specified NAT gateway. Deleting a public NAT gateway disassociates its Elastic IP address, but does not release the address from your account. Deleting a NAT gateway does not delete any NAT gateway routes in your route tables. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NatGatewayId** The ID of the NAT gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **natGatewayId** The ID of the NAT gateway. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes NAT gateway nat-04ae55e711cec5680. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteNatGateway &NatGatewayId=nat-04ae55e711cec5680 &AUTHPARAMS ``` #### Sample Response ``` 741fc8ab-6ebe-452b-b92b-example nat-04ae55e711cec5680 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNatGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNatGateway) # DeleteNetworkAcl Deletes the specified network ACL. You can't delete the ACL if it's associated with any subnets. You can't delete the default network ACL. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkAclId** The ID of the network ACL. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified network ACL. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteNetworkAcl &NetworkAclId=acl-2cb85d45 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkAcl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkAcl) # DeleteNetworkAclEntry Deletes the specified ingress or egress entry (rule) from the specified network ACL. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Egress** Indicates whether the rule is an egress rule. Type: Boolean Required: Yes **NetworkAclId** The ID of the network ACL. Type: String Required: Yes **RuleNumber** The rule number of the entry to delete. Type: Integer Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes ingress rule number 100 from the specified network ACL. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteNetworkAclEntry &NetworkAclId=acl-2cb85d45 &RuleNumber=100 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkAclEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkAclEntry) # DeleteNetworkInsightsAccessScope Deletes the specified Network Access Scope. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInsightsAccessScopeId** The ID of the Network Access Scope. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **networkInsightsAccessScopeId** The ID of the Network Access Scope. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkInsightsAccessScope) # DeleteNetworkInsightsAccessScopeAnalysis Deletes the specified Network Access Scope analysis. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInsightsAccessScopeAnalysisId** The ID of the Network Access Scope analysis. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **networkInsightsAccessScopeAnalysisId** The ID of the Network Access Scope analysis. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkInsightsAccessScopeAnalysis) # DeleteNetworkInsightsAnalysis Deletes the specified network insights analysis. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInsightsAnalysisId** The ID of the network insights analysis. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **networkInsightsAnalysisId** The ID of the network insights analysis. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkInsightsAnalysis) # DeleteNetworkInsightsPath Deletes the specified path. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInsightsPathId** The ID of the path. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **networkInsightsPathId** The ID of the path. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkInsightsPath) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkInsightsPath) # DeleteNetworkInterface Deletes the specified network interface. You must detach the network interface before you can delete it. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified network interface. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteNetworkInterface &NetworkInterfaceId=eni-ffda3197 &AUTHPARAMS ``` #### Sample Response ``` e1c6d73b-edaa-4e62-9909-6611404e1739 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkInterface) # DeleteNetworkInterfacePermission Deletes a permission for a network interface. By default, you cannot delete the permission if the account for which you're removing the permission has attached the network interface to an instance. However, you can force delete the permission, regardless of any attachment. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Force** Specify `true` to remove the permission even if the network interface is attached to an instance. Type: Boolean Required: No **NetworkInterfacePermissionId** The ID of the network interface permission. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified network interface permission. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteNetworkInterfacePermission &NetworkInterfacePermissionId=eni-perm-06fd19020ede149ea &AUTHPARAMS ``` #### Sample Response ``` 7a296942-8fa0-45a3-8406-09e9example true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteNetworkInterfacePermission) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteNetworkInterfacePermission) # DeletePlacementGroup Deletes the specified placement group. You must terminate all instances in the placement group before you can delete the placement group. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupName** The name of the placement group. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the placement group named `XYZ-cluster`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeletePlacementGroup &GroupName=XYZ-cluster &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeletePlacementGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeletePlacementGroup) # DeletePublicIpv4Pool Delete a public IPv4 pool. A public IPv4 pool is an EC2 IP address pool required for the public IPv4 CIDRs that you own and bring to AWS to manage with IPAM. IPv6 addresses you bring to AWS, however, use IPAM pools only. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkBorderGroup** The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see [Local Zone availability](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail) in the *Amazon EC2 User Guide*. Type: String Required: No **PoolId** The ID of the public IPv4 pool you want to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **returnValue** Information about the result of deleting the public IPv4 pool. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeletePublicIpv4Pool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeletePublicIpv4Pool) # DeleteQueuedReservedInstances Deletes the queued purchases for the specified Reserved Instances. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReservedInstancesId.N** The IDs of the Reserved Instances. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 100 items. Required: Yes ## Response Elements The following elements are returned by the service. **failedQueuedPurchaseDeletionSet** Information about the queued purchases that could not be deleted. Type: Array of [FailedQueuedPurchaseDeletion](API_FailedQueuedPurchaseDeletion.md) objects **requestId** The ID of the request. Type: String **successfulQueuedPurchaseDeletionSet** Information about the queued purchases that were successfully deleted. Type: Array of [SuccessfulQueuedPurchaseDeletion](API_SuccessfulQueuedPurchaseDeletion.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteQueuedReservedInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteQueuedReservedInstances) # DeleteRoute Deletes the specified route from the specified route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The IPv4 CIDR range for the route. The value you specify must match the CIDR for the route exactly. Type: String Required: No **DestinationIpv6CidrBlock** The IPv6 CIDR range for the route. The value you specify must match the CIDR for the route exactly. Type: String Required: No **DestinationPrefixListId** The ID of the prefix list for the route. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteTableId** The ID of the route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example deletes the route with destination IPv4 CIDR `172.16.1.0/24` from the specified route table. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteRoute &RouteTableId=rtb-1122334455667788a &DestinationCidrBlock=172.16.1.0/24 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ### Example 2 This example deletes the route with destination IPv6 CIDR `::/0` from the specified route table. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteRoute &RouteTableId=rtb-1122334455667788a &DestinationIpv6CidrBlock=::/0 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteRoute) # DeleteRouteServer Deletes the specified route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: + VPC route tables not associated with subnets + Subnet route tables + Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html). For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The ID of the route server to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServer** Information about the deleted route server. Type: [RouteServer](API_RouteServer.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteRouteServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteRouteServer) # DeleteRouteServerEndpoint Deletes the specified route server endpoint. A route server endpoint is an AWS-managed component inside a subnet that facilitates [BGP (Border Gateway Protocol)](https://en.wikipedia.org/wiki/Border_Gateway_Protocol) connections between your route server and your BGP peers. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerEndpointId** The ID of the route server endpoint to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerEndpoint** Information about the deleted route server endpoint. Type: [RouteServerEndpoint](API_RouteServerEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteRouteServerEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteRouteServerEndpoint) # DeleteRouteServerPeer Deletes the specified BGP peer from a route server. A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: + Have an elastic network interface in the VPC + Support BGP (Border Gateway Protocol) + Can initiate BGP sessions ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerPeerId** The ID of the route server peer to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerPeer** Information about the deleted route server peer. Type: [RouteServerPeer](API_RouteServerPeer.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteRouteServerPeer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteRouteServerPeer) # DeleteRouteTable Deletes the specified route table. You must disassociate the route table from any subnets before you can delete it. You can't delete the main route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteTableId** The ID of the route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified route table. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteRouteTable &RouteTableId=rtb-1122334455667788a &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteRouteTable) # DeleteSecondaryNetwork Deletes a secondary network. You must delete all secondary subnets in the secondary network before you can delete the secondary network. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SecondaryNetworkId** The ID of the secondary network. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. Type: String **requestId** The ID of the request. Type: String **secondaryNetwork** Information about the secondary network. Type: [SecondaryNetwork](API_SecondaryNetwork.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes a secondary network. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteSecondaryNetwork &SecondaryNetworkId=sn-0123456789abcdef0 &ClientToken=550e8400-e29b-41d4-a716-446655440000 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE sn-0123456789abcdef0 arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0123456789abcdef0 123456789012 rdma delete-in-progress sn-cidr-assoc-56789901234abcdef0 10.0.0.0/16 disassociating Name Prod Secondary Network 550e8400-e29b-41d4-a716-446655440000 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteSecondaryNetwork) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSecondaryNetwork) # DeleteSecondarySubnet Deletes a secondary subnet. A secondary subnet must not contain any secondary interfaces prior to deletion. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SecondarySubnetId** The ID of the secondary subnet to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier to ensure the idempotency of the request. Only returned if a client token was provided in the request. Type: String **requestId** The ID of the request. Type: String **secondarySubnet** Information about the secondary subnet being deleted. Type: [SecondarySubnet](API_SecondarySubnet.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes a secondary subnet. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteSecondarySubnet &SecondarySubnetId=ss-0123456789abcdef0 &ClientToken=550e8400-e29b-41d4-a716-446655440000 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ss-0123456789abcdef0 arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0123456789abcdef0 sn-0123456789abcdef0 rdma 123456789012 use2-az1 us-east-2a ss-cidr-assoc-56789901234abcdef0 10.0.0.0/24 disassociating delete-in-progress Name Prod Secondary Subnet 550e8400-e29b-41d4-a716-446655440000 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteSecondarySubnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSecondarySubnet) # DeleteSecurityGroup Deletes a security group. If you attempt to delete a security group that is associated with an instance or network interface, is referenced by another security group in the same VPC, or has a VPC association, the operation fails with `DependencyViolation`. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupId** The ID of the security group. Type: String Required: No **GroupName** [Default VPC] The name of the security group. You can specify either the security group name or the security group ID. For security groups in a nondefault VPC, you must specify the security group ID. Type: String Required: No ## Response Elements The following elements are returned by the service. **groupId** The ID of the deleted security group. Type: String **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified security group. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteSecurityGroup &GroupId=sg-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteSecurityGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSecurityGroup) # DeleteSnapshot Deletes the specified snapshot. When you make periodic snapshots of a volume, the snapshots are incremental, and only the blocks on the device that have changed since your last snapshot are saved in the new snapshot. When you delete a snapshot, only the data not needed for any other snapshot is removed. So regardless of which prior snapshots have been deleted, all active snapshots will have access to all the information needed to restore the volume. You cannot delete a snapshot of the root device of an EBS volume used by a registered AMI. You must first deregister the AMI before you can delete the snapshot. For more information, see [Delete an Amazon EBS snapshot](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-deleting-snapshot.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SnapshotId** The ID of the EBS snapshot. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request deletes the snapshot with the ID `snap-1234567890abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteSnapshot &SnapshotId.1=snap-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSnapshot) # DeleteSpotDatafeedSubscription Deletes the data feed for Spot Instances. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request deletes the data feed for the AWS account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteSpotDatafeedSubscription &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteSpotDatafeedSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSpotDatafeedSubscription) # DeleteSubnet Deletes the specified subnet. You must terminate all running instances in the subnet before you can delete the subnet. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SubnetId** The ID of the subnet. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified subnet. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteSubnet &SubnetId=subnet-9d4a7b6c &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteSubnet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSubnet) # DeleteSubnetCidrReservation Deletes a subnet CIDR reservation. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SubnetCidrReservationId** The ID of the subnet CIDR reservation. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **deletedSubnetCidrReservation** Information about the deleted subnet CIDR reservation. Type: [SubnetCidrReservation](API_SubnetCidrReservation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteSubnetCidrReservation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSubnetCidrReservation) # DeleteTags Deletes the specified set of tags from the specified set of resources. To list the current tags, use [DescribeTags](API_DescribeTags.md). For more information about tags, see [Tag your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon Elastic Compute Cloud User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ResourceId.N** The IDs of the resources, separated by spaces. Constraints: Up to 1000 resource IDs. We recommend breaking up this request into smaller batches. Type: Array of strings Required: Yes **Tag.N** The tags to delete. Specify a tag key and an optional tag value to delete specific tags. If you specify a tag key without a tag value, we delete any tag with this key regardless of its value. If you specify a tag key with an empty string as the tag value, we delete the tag only if its value is an empty string. If you omit this parameter, we delete all user-defined tags for the specified resources. We do not delete AWS-generated tags (tags that have the `aws:` prefix). Constraints: Up to 1000 tags. Type: Array of [Tag](API_Tag.md) objects Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes all the user-defined tags for the AMI with the ID `ami-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteTags &ResourceId.1=ami-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ### Example This example deletes the `stack` and `webserver` tags for two particular instances. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteTags &ResourceId.1=i-1234567890abcdef0 &ResourceId.2=i-0598c7d356eba48d7 &Tag.1.Key=stack &Tag.2.Key=webserver &AUTHPARAMS ``` ### Example You can specify a tag key without a corresponding tag value to delete the tag regardless of its value. This example request deletes all tags that have a key of `Purpose`, regardless of the tag value. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteTags &ResourceId.1=i-0598c7d356eba48d7 &Tag.1.Key=Purpose &AUTHPARAMS ``` ### Example When you create a tag, you can set the tag value to the empty string. Correspondingly, you can delete only tags that have a specific key and whose value is the empty string. This example request deletes all tags for the specified instance where the key is `Purpose` and the tag value is the empty string. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteTags &ResourceId.1=i-1234567890abcdef0 &Tag.1.Key=Purpose &Tag.2.Value= &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTags) # DeleteTrafficMirrorFilter Deletes the specified Traffic Mirror filter. You cannot delete a Traffic Mirror filter that is in use by a Traffic Mirror session. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TrafficMirrorFilterId** The ID of the Traffic Mirror filter. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **trafficMirrorFilterId** The ID of the Traffic Mirror filter. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTrafficMirrorFilter) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTrafficMirrorFilter) # DeleteTrafficMirrorFilterRule Deletes the specified Traffic Mirror rule. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TrafficMirrorFilterRuleId** The ID of the Traffic Mirror rule. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **trafficMirrorFilterRuleId** The ID of the deleted Traffic Mirror rule. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTrafficMirrorFilterRule) # DeleteTrafficMirrorSession Deletes the specified Traffic Mirror session. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TrafficMirrorSessionId** The ID of the Traffic Mirror session. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **trafficMirrorSessionId** The ID of the deleted Traffic Mirror session. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTrafficMirrorSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTrafficMirrorSession) # DeleteTrafficMirrorTarget Deletes the specified Traffic Mirror target. You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TrafficMirrorTargetId** The ID of the Traffic Mirror target. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **trafficMirrorTargetId** The ID of the deleted Traffic Mirror target. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTrafficMirrorTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTrafficMirrorTarget) # DeleteTransitGateway Deletes the specified transit gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayId** The ID of the transit gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGateway** Information about the deleted transit gateway. Type: [TransitGateway](API_TransitGateway.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGateway) # DeleteTransitGatewayConnect Deletes the specified Connect attachment. You must first delete any Connect peers for the attachment. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the Connect attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayConnect** Information about the deleted Connect attachment. Type: [TransitGatewayConnect](API_TransitGatewayConnect.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayConnect) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayConnect) # DeleteTransitGatewayConnectPeer Deletes the specified Connect peer. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayConnectPeerId** The ID of the Connect peer. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayConnectPeer** Information about the deleted Connect peer. Type: [TransitGatewayConnectPeer](API_TransitGatewayConnectPeer.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayConnectPeer) # DeleteTransitGatewayMeteringPolicy Deletes a transit gateway metering policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayMeteringPolicyId** The ID of the transit gateway metering policy to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayMeteringPolicy** Information about the deleted transit gateway metering policy. Type: [TransitGatewayMeteringPolicy](API_TransitGatewayMeteringPolicy.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicy) # DeleteTransitGatewayMeteringPolicyEntry Deletes an entry from a transit gateway metering policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PolicyRuleNumber** The rule number of the metering policy entry to delete. Type: Integer Required: Yes **TransitGatewayMeteringPolicyId** The ID of the transit gateway metering policy containing the entry to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayMeteringPolicyEntry** Information about the deleted transit gateway metering policy entry. Type: [TransitGatewayMeteringPolicyEntry](API_TransitGatewayMeteringPolicyEntry.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayMeteringPolicyEntry) # DeleteTransitGatewayMulticastDomain Deletes the specified transit gateway multicast domain. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayMulticastDomain** Information about the deleted transit gateway multicast domain. Type: [TransitGatewayMulticastDomain](API_TransitGatewayMulticastDomain.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example deletes the multicast domain `tgw-mcast-domain-0c4905cef7EXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteTransitGatewayMulticastDomain &TransitGatewayMulticastDomainId=tgw-mcast-domain-02bb79002bEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 19914ba0-eb6c-43aa-9381-0bdafEXAMPLE 2019-11-20T22:02:03.000Z deleting tgw-0d88d2d0d5EXAMPLE tgw-mcast-domain-02bb79002bEXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayMulticastDomain) # DeleteTransitGatewayPeeringAttachment Deletes a transit gateway peering attachment. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the transit gateway peering attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPeeringAttachment** The transit gateway peering attachment. Type: [TransitGatewayPeeringAttachment](API_TransitGatewayPeeringAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified transit gateway peering attachment by specifying its attachment ID. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteTransitGatewayPeeringAttachment &TransitGatewayAttachmentId=tgw-attach-12345678901abcd12 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayPeeringAttachment) # DeleteTransitGatewayPolicyTable Deletes the specified transit gateway policy table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayPolicyTableId** The transit gateway policy table to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPolicyTable** Provides details about the deleted transit gateway policy table. Type: [TransitGatewayPolicyTable](API_TransitGatewayPolicyTable.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayPolicyTable) # DeleteTransitGatewayPrefixListReference Deletes a reference (route) to a prefix list in a specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PrefixListId** The ID of the prefix list. Type: String Required: Yes **TransitGatewayRouteTableId** The ID of the route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPrefixListReference** Information about the deleted prefix list reference. Type: [TransitGatewayPrefixListReference](API_TransitGatewayPrefixListReference.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified prefix list reference in the specified transit gateway route table. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteTransitGatewayPrefixListReference &TransitGatewayRouteTableId=tgw-rtb-0f98a0a5d09abcabc &PrefixListId=pl-001122334455aabbc &AUTHPARAMS ``` #### Sample Response ``` 482823e8-8165-4312-86ee-example false pl-001122334455aabbc 123456789012 deleting tgw-rtb-0f98a0a5d09abcabc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayPrefixListReference) # DeleteTransitGatewayRoute Deletes the specified route from the specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The CIDR range for the route. This must match the CIDR for the route exactly. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **route** Information about the route. Type: [TransitGatewayRoute](API_TransitGatewayRoute.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayRoute) # DeleteTransitGatewayRouteTable Deletes the specified transit gateway route table. If there are any route tables associated with the transit gateway route table, you must first run [DisassociateRouteTable](API_DisassociateRouteTable.md) before you can delete the transit gateway route table. This removes any route tables associated with the transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayRouteTable** Information about the deleted transit gateway route table. Type: [TransitGatewayRouteTable](API_TransitGatewayRouteTable.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayRouteTable) # DeleteTransitGatewayRouteTableAnnouncement Advertises to the transit gateway that a transit gateway route table is deleted. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayRouteTableAnnouncementId** The transit gateway route table ID that's being deleted. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayRouteTableAnnouncement** Provides details about a deleted transit gateway route table. Type: [TransitGatewayRouteTableAnnouncement](API_TransitGatewayRouteTableAnnouncement.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayRouteTableAnnouncement) # DeleteTransitGatewayVpcAttachment Deletes the specified VPC attachment. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayVpcAttachment** Information about the deleted VPC attachment. Type: [TransitGatewayVpcAttachment](API_TransitGatewayVpcAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteTransitGatewayVpcAttachment) # DeleteVerifiedAccessEndpoint Delete an AWS Verified Access endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessEndpointId** The ID of the Verified Access endpoint. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessEndpoint** Details about the Verified Access endpoint. Type: [VerifiedAccessEndpoint](API_VerifiedAccessEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVerifiedAccessEndpoint) # DeleteVerifiedAccessGroup Delete an AWS Verified Access group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessGroupId** The ID of the Verified Access group. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessGroup** Details about the Verified Access group. Type: [VerifiedAccessGroup](API_VerifiedAccessGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVerifiedAccessGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVerifiedAccessGroup) # DeleteVerifiedAccessInstance Delete an AWS Verified Access instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessInstance** Details about the Verified Access instance. Type: [VerifiedAccessInstance](API_VerifiedAccessInstance.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVerifiedAccessInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVerifiedAccessInstance) # DeleteVerifiedAccessTrustProvider Delete an AWS Verified Access trust provider. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessTrustProviderId** The ID of the Verified Access trust provider. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessTrustProvider** Details about the Verified Access trust provider. Type: [VerifiedAccessTrustProvider](API_VerifiedAccessTrustProvider.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVerifiedAccessTrustProvider) # DeleteVolume Deletes the specified EBS volume. The volume must be in the `available` state (not attached to an instance). The volume can remain in the `deleting` state for several minutes. For more information, see [Delete an Amazon EBS volume](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-deleting-volume.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VolumeId** The ID of the volume. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request deletes the volume with the ID `vol-1234567890abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVolume &VolumeId=vol-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVolume) # DeleteVpc Deletes the specified VPC. You must detach or delete all gateways and resources that are associated with the VPC before you can delete it. For example, you must terminate all instances running in the VPC, delete all security groups associated with the VPC (except the default one), delete all route tables associated with the VPC (except the default one), and so on. When you delete the VPC, it deletes the default security group, network ACL, and route table for the VPC. If you created a flow log for the VPC that you are deleting, note that flow logs for deleted VPCs are eventually automatically removed. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpc &VpcId=vpc-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpc) # DeleteVpcBlockPublicAccessExclusion Delete a VPC Block Public Access (BPA) exclusion. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExclusionId** The ID of the exclusion. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcBlockPublicAccessExclusion** Details about an exclusion. Type: [VpcBlockPublicAccessExclusion](API_VpcBlockPublicAccessExclusion.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpcBlockPublicAccessExclusion) # DeleteVpcEncryptionControl Deletes a VPC Encryption Control configuration. This removes the encryption policy enforcement from the specified VPC. For more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcEncryptionControlId** The ID of the VPC Encryption Control resource to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcEncryptionControl** Information about the deleted VPC Encryption Control configuration. Type: [VpcEncryptionControl](API_VpcEncryptionControl.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpcEncryptionControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpcEncryptionControl) # DeleteVpcEndpointConnectionNotifications Deletes the specified VPC endpoint connection notifications. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ConnectionNotificationId.N** The IDs of the notifications. Type: Array of strings Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **unsuccessful** Information about the notifications that could not be deleted successfully. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes connection notification `vpce-nfn-04bcb952bc8af7123`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpcEndpointConnectionNotifications &ConnectionNotificationId.1=vpce-nfn-04bcb952bc8af7123 &AUTHPARAMS ``` #### Sample Response ``` 2bf45d2e-a871-4375-9a93-f4188example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpcEndpointConnectionNotifications) # DeleteVpcEndpoints Deletes the specified VPC endpoints. When you delete a gateway endpoint, we delete the endpoint routes in the route tables for the endpoint. When you delete a Gateway Load Balancer endpoint, we delete its endpoint network interfaces. You can only delete Gateway Load Balancer endpoints when the routes that are associated with the endpoint are deleted. When you delete an interface endpoint, we delete its endpoint network interfaces. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcEndpointId.N** The IDs of the VPC endpoints. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **unsuccessful** Information about the VPC endpoints that were not successfully deleted. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes endpoint `vpce-aa22bb33`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpcEndpoints &VpcEndpointId.1=vpce-aa22bb33 &AUTHPARAMS ``` #### Sample Response ``` b59c2643-789a-4bf7-aac4-example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpcEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpcEndpoints) # DeleteVpcEndpointServiceConfigurations Deletes the specified VPC endpoint service configurations. Before you can delete an endpoint service configuration, you must reject any `Available` or `PendingAcceptance` interface endpoint connections that are attached to the service. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ServiceId.N** The IDs of the services. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **unsuccessful** Information about the service configurations that were not deleted, if applicable. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes your VPC endpoint service configuration `vpce-svc-03d5ebb7d9579a2b3`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpcEndpointServiceConfigurations ServiceId.1=vpce-svc-03d5ebb7d9579a2b3 &AUTHPARAMS ``` #### Sample Response ``` 12345d2e-a871-4375-9a93-f4188example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpcEndpointServiceConfigurations) # DeleteVpcPeeringConnection Deletes a VPC peering connection. Either the owner of the requester VPC or the owner of the accepter VPC can delete the VPC peering connection if it's in the `active` state. The owner of the requester VPC can delete a VPC peering connection in the `pending-acceptance` state. You cannot delete a VPC peering connection that's in the `failed` or `rejected` state. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcPeeringConnectionId** The ID of the VPC peering connection. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified VPC peering connection. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpcPeeringConnection &vpcPeeringConnectionId=pcx-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpcPeeringConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpcPeeringConnection) # DeleteVpnConcentrator Deletes the specified VPN concentrator. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpnConcentratorId** The ID of the VPN concentrator to delete. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes VPN Concentrator `vcn-0767cb7521c5c4945`. #### Sample Request ``` https://ec2.us-east-1.amazonaws.com/?Version=2016-11-15&Action=DeleteVpnConcentrator &VpnConcentratorId=vcn-0767cb7521c5c4945 ``` #### Sample Response ``` 2912d285-2e87-4e3b-aa4b-80772cc5913b true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpnConcentrator) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpnConcentrator) # DeleteVpnConnection Deletes the specified VPN connection. If you're deleting the VPC and its associated components, we recommend that you detach the virtual private gateway from the VPC and delete the VPC before deleting the VPN connection. If you believe that the tunnel credentials for your VPN connection have been compromised, you can delete the VPN connection and create a new one that has new keys, without needing to delete the VPC or virtual private gateway. If you create a new VPN connection, you must reconfigure the customer gateway device using the new configuration information returned with the new VPN connection ID. For certificate-based authentication, delete all AWS Certificate Manager (ACM) private certificates used for the AWS-side tunnel endpoints for the VPN connection before deleting the VPN connection. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpnConnectionId** The ID of the VPN connection. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified VPN connection. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpnConnection &vpnConnectionId=vpn-44a8938f &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpnConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpnConnection) # DeleteVpnConnectionRoute Deletes the specified static route associated with a VPN connection between an existing virtual private gateway and a VPN customer gateway. The static route allows traffic to be routed from the virtual private gateway to the VPN customer gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The CIDR block associated with the local subnet of the customer network. Type: String Required: Yes **VpnConnectionId** The ID of the VPN connection. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes a static route to the destination CIDR block `11.12.0.0/16` associated with the VPN connection with the ID `vpn-83ad48ea`. Note that when using the Query API, the "/" is denoted as "%2F". #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpnConnectionRoute &DestinationCidrBlock=11.12.0.0%2F16 &VpnConnectionId=vpn-83ad48ea &AUTHPARAMS ``` #### Sample Response ``` 4f35a1b2-c2c3-4093-b51f-abb9d7311990 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpnConnectionRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpnConnectionRoute) # DeleteVpnGateway Deletes the specified virtual private gateway. You must first detach the virtual private gateway from the VPC. Note that you don't need to delete the virtual private gateway if you plan to delete and recreate the VPN connection between your VPC and your network. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpnGatewayId** The ID of the virtual private gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deletes the specified virtual private gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeleteVpnGateway &vpnGatewayId=vgw-8db04f81 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeleteVpnGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteVpnGateway) # DeprovisionByoipCidr Releases the specified address range that you provisioned for use with your AWS resources through bring your own IP addresses (BYOIP) and deletes the corresponding address pool. Before you can release an address range, you must stop advertising it and you must not have any IP addresses allocated from its address range. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The address range, in CIDR notation. The prefix must be the same prefix that you specified when you provisioned the address range. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **byoipCidr** Information about the address range. Type: [ByoipCidr](API_ByoipCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeprovisionByoipCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeprovisionByoipCidr) # DeprovisionIpamByoasn Deprovisions your Autonomous System Number (ASN) from your AWS account. This action can only be called after any BYOIP CIDR associations are removed from your AWS account with [DisassociateIpamByoasn](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DisassociateIpamByoasn.html). For more information, see [Tutorial: Bring your ASN to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) in the *Amazon VPC IPAM guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Asn** An ASN. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamId** The IPAM ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **byoasn** An ASN and BYOIP CIDR association. Type: [Byoasn](API_Byoasn.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeprovisionIpamByoasn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeprovisionIpamByoasn) # DeprovisionIpamPoolCidr Deprovision a CIDR provisioned from an IPAM pool. If you deprovision a CIDR from a pool that has a source pool, the CIDR is recycled back into the source pool. For more information, see [Deprovision pool CIDRs](https://docs.aws.amazon.com/vpc/latest/ipam/depro-pool-cidr-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The CIDR which you want to deprovision from the pool. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPoolId** The ID of the pool that has the CIDR you want to deprovision. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamPoolCidr** The deprovisioned pool CIDR. Type: [IpamPoolCidr](API_IpamPoolCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeprovisionIpamPoolCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeprovisionIpamPoolCidr) # DeprovisionPublicIpv4PoolCidr Deprovision a CIDR from a public IPv4 pool. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The CIDR you want to deprovision from the pool. Type: String Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PoolId** The ID of the pool that you want to deprovision the CIDR from. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **deprovisionedAddressSet** The deprovisioned CIDRs. Type: Array of strings **poolId** The ID of the pool that you deprovisioned the CIDR from. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeprovisionPublicIpv4PoolCidr) # DeregisterImage Deregisters the specified AMI. A deregistered AMI can't be used to launch new instances. If a deregistered EBS-backed AMI matches a Recycle Bin retention rule, it moves to the Recycle Bin for the specified retention period. It can be restored before its retention period expires, after which it is permanently deleted. If the deregistered AMI doesn't match a retention rule, it is permanently deleted immediately. For more information, see [Recover deleted Amazon EBS snapshots and EBS-backed AMIs with Recycle Bin](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) in the *Amazon EBS User Guide*. When deregistering an EBS-backed AMI, you can optionally delete its associated snapshots at the same time. However, if a snapshot is associated with multiple AMIs, it won't be deleted even if specified for deletion, although the AMI will still be deregistered. Deregistering an AMI does not delete the following: + Instances already launched from the AMI. You'll continue to incur usage costs for the instances until you terminate them. + For EBS-backed AMIs: Snapshots that are associated with multiple AMIs. You'll continue to incur snapshot storage costs. + For instance store-backed AMIs: The files uploaded to Amazon S3 during AMI creation. You'll continue to incur S3 storage costs. For more information, see [Deregister an Amazon EC2 AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/deregister-ami.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DeleteAssociatedSnapshots** Specifies whether to delete the snapshots associated with the AMI during deregistration. If a snapshot is associated with multiple AMIs, it is not deleted, regardless of this setting. Default: The snapshots are not deleted. Type: Boolean Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **deleteSnapshotResultSet** The deletion result for each snapshot associated with the AMI, including the snapshot ID and its success or error code. Type: Array of [DeleteSnapshotReturnCode](API_DeleteSnapshotReturnCode.md) objects **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request deregisters the specified AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeregisterImage &ImageId=ami-4fa54026 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeregisterImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeregisterImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeregisterImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeregisterImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeregisterImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeregisterImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeregisterImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeregisterImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeregisterImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeregisterImage) # DeregisterInstanceEventNotificationAttributes Deregisters tag keys to prevent tags that have the specified tag keys from being included in scheduled event notifications for resources in the Region. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceTagAttribute** Information about the tag keys to deregister. Type: [DeregisterInstanceTagAttributeRequest](API_DeregisterInstanceTagAttributeRequest.md) object Required: No ## Response Elements The following elements are returned by the service. **instanceTagAttribute** The resulting set of tag keys. Type: [InstanceTagNotificationAttribute](API_InstanceTagNotificationAttribute.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeregisterInstanceEventNotificationAttributes) # DeregisterTransitGatewayMulticastGroupMembers Deregisters the specified members (network interfaces) from the transit gateway multicast group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupIpAddress** The IP address assigned to the transit gateway multicast group. Type: String Required: No **NetworkInterfaceIds.N** The IDs of the group members' network interfaces. Type: Array of strings Required: No **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: No ## Response Elements The following elements are returned by the service. **deregisteredMulticastGroupMembers** Information about the deregistered members. Type: [TransitGatewayMulticastDeregisteredGroupMembers](API_TransitGatewayMulticastDeregisteredGroupMembers.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example deregisters the network interface as a group member `eni-0e246d3269EXAMPLE` from the multicast domain `tgw-mcast-domain-0c4905cef7EXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeregisterTransitGatewayMulticastGroupMembers &TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef7EXAMPLE &NetworkInterfaceIds=eni-0e246d3269EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 6f4167cd-0870-4858-8872-f1c34EXAMPLE 224.0.1.0 eni-0e246d3269EXAMPLE tgw-mcast-domain-0c4905cef7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupMembers) # DeregisterTransitGatewayMulticastGroupSources Deregisters the specified sources (network interfaces) from the transit gateway multicast group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupIpAddress** The IP address assigned to the transit gateway multicast group. Type: String Required: No **NetworkInterfaceIds.N** The IDs of the group sources' network interfaces. Type: Array of strings Required: No **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: No ## Response Elements The following elements are returned by the service. **deregisteredMulticastGroupSources** Information about the deregistered group sources. Type: [TransitGatewayMulticastDeregisteredGroupSources](API_TransitGatewayMulticastDeregisteredGroupSources.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example deregisters the network interface as a group source `eni-07f290fc3cEXAMPLE` from the multicast domain `tgw-mcast-domain-0c4905cef7EXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DeregisterTransitGatewayMulticastGroupSources &TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef7EXAMPLE &NetworkInterfaceIds=eni-07f290fc3cEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 1ca916e8-a4b5-4ff8-9fc3-3052dEXAMPLE eni-07f290fc3cEXAMPLE 224.0.1.0 tgw-mcast-domain-0c4905cef7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeregisterTransitGatewayMulticastGroupSources) # DescribeAccountAttributes Describes attributes of your AWS account. The following are the supported account attributes: + `default-vpc`: The ID of the default VPC for your account, or `none`. + `max-instances`: This attribute is no longer supported. The returned value does not reflect your actual vCPU limit for running On-Demand Instances. For more information, see [On-Demand Instance Limits](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-on-demand-instances.html#ec2-on-demand-instances-limits) in the *Amazon Elastic Compute Cloud User Guide*. + `max-elastic-ips`: The maximum number of Elastic IP addresses that you can allocate. + `supported-platforms`: This attribute is deprecated. + `vpc-max-elastic-ips`: The maximum number of Elastic IP addresses that you can allocate. + `vpc-max-security-groups-per-interface`: The maximum number of security groups that you can assign to a network interface. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AttributeName.N** The account attribute names. Type: Array of strings Valid Values: `supported-platforms | default-vpc` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **accountAttributeSet** Information about the account attributes. Type: Array of [AccountAttribute](API_AccountAttribute.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeAccountAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeAccountAttributes) # DescribeAddresses Describes the specified Elastic IP addresses or all of your Elastic IP addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId.N** Information about the allocation IDs. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `allocation-id` - The allocation ID for the address. + `association-id` - The association ID for the address. + `instance-id` - The ID of the instance the address is associated with, if any. + `network-border-group` - A unique set of Availability Zones, Local Zones, or Wavelength Zones from where AWS advertises IP addresses. + `network-interface-id` - The ID of the network interface that the address is associated with, if any. + `network-interface-owner-id` - The AWS account ID of the owner. + `private-ip-address` - The private IP address associated with the Elastic IP address. + `public-ip` - The Elastic IP address, or the carrier IP address. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **PublicIp.N** One or more Elastic IP addresses. Default: Describes all your Elastic IP addresses. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **addressesSet** Information about the Elastic IP addresses. Type: Array of [Address](API_Address.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request describes a specific Elastic IP address allocated to your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeAddresses &AllocationId.1= eipalloc-08229861 &AUTHPARAMS ``` #### Sample Response ``` f7de5e98-491a-4c19-a92d-908d6EXAMPLE 203.0.113.41 eipalloc-08229861 vpc i-0598c7d356eba48d7 eipassoc-f0229899 eni-ef229886 053230519467 10.0.0.228 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeAddresses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeAddresses) # DescribeAddressesAttribute Describes the attributes of the specified Elastic IP addresses. For requirements, see [Using reverse DNS for email applications](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId.N** [EC2-VPC] The allocation IDs. Type: Array of strings Required: No **Attribute** The attribute of the IP address. Type: String Valid Values: `domain-name` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **addressSet** Information about the IP addresses. Type: Array of [AddressAttribute](API_AddressAttribute.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeAddressesAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeAddressesAttribute) # DescribeAddressTransfers Describes an Elastic IP address transfer. For more information, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon VPC User Guide*. When you transfer an Elastic IP address, there is a two-step handshake between the source and transfer AWS accounts. When the source account starts the transfer, the transfer account has seven days to accept the Elastic IP address transfer. During those seven days, the source account can view the pending transfer by using this action. After seven days, the transfer expires and ownership of the Elastic IP address returns to the source account. Accepted transfers are visible to the source account for 14 days after the transfers have been accepted. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId.N** The allocation IDs of Elastic IP addresses. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of address transfers to return in one page of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** Specify the pagination token from a previous request to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **addressTransferSet** The Elastic IP address transfer. Type: Array of [AddressTransfer](API_AddressTransfer.md) objects **nextToken** Specify the pagination token from a previous request to retrieve the next page of results. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeAddressTransfers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeAddressTransfers) # DescribeAggregateIdFormat Describes the longer ID format settings for all resource types in a specific Region. This request is useful for performing a quick audit to determine whether a specific Region is fully opted in for longer IDs (17-character IDs). This request only returns information about resource types that support longer IDs. The following resource types support longer IDs: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **statusSet** Information about each resource's ID format. Type: Array of [IdFormat](API_IdFormat.md) objects **useLongIdsAggregated** Indicates whether all resource types in the Region are configured to use longer IDs. This value is only `true` if all users are configured to use longer IDs for all resources types in the Region. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the overall ID format settings for the default Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeAggregateIdFormat &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true security-group true route-table-association true vpc true flow-log true vpc-peering-connection true elastic-ip-association true vpc-cidr-block-association true network-interface true subnet true 2016-12-15T14:00:00.000Z volume true vpc-ipv6-cidr-block-association true network-acl-association true dhcp-options true 2016-12-15T14:00:00.000Z snapshot true subnet-ipv6-cidr-block-association true network-interface-attachment true elastic-ip-allocation true internet-gateway true 2016-12-15T14:00:00.000Z reservation true 2016-12-15T14:00:00.000Z instance true route-table true network-acl true customer-gateway true vpc-endpoint true vpn-connection true vpn-gateway true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeAggregateIdFormat) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeAggregateIdFormat) # DescribeAvailabilityZones Describes the Availability Zones, Local Zones, and Wavelength Zones that are available to you. For more information about Availability Zones, Local Zones, and Wavelength Zones, see [Regions and zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html) in the *Amazon EC2 User Guide*. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllAvailabilityZones** Include all Availability Zones, Local Zones, and Wavelength Zones regardless of your opt-in status. If you do not use this parameter, the results include only the zones for the Regions where you have chosen the option to opt in. Type: Boolean Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `group-long-name` - The long name of the zone group for the Availability Zone (for example, `US West (Oregon) 1`), the Local Zone (for example, for Zone group `us-west-2-lax-1`, it is `US West (Los Angeles)`, or the Wavelength Zone (for example, for Zone group `us-east-1-wl1`, it is `US East (Verizon)`. + `group-name` - The name of the zone group for the Availability Zone (for example, `us-east-1-zg-1`), the Local Zone (for example, `us-west-2-lax-1`), or the Wavelength Zone (for example, `us-east-1-wl1`). + `message` - The Zone message. + `opt-in-status` - The opt-in status (`opted-in` \$1 `not-opted-in` \$1 `opt-in-not-required`). + `parent-zone-id` - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. + `parent-zone-name` - The ID of the zone that handles some of the Local Zone and Wavelength Zone control plane operations, such as API calls. + `region-name` - The name of the Region for the Zone (for example, `us-east-1`). + `state` - The state of the Availability Zone, the Local Zone, or the Wavelength Zone (`available` \$1 `unavailable` \$1 `constrained`). + `zone-id` - The ID of the Availability Zone (for example, `use1-az1`), the Local Zone (for example, `usw2-lax1-az1`), or the Wavelength Zone (for example, `us-east-1-wl1-bos-wlz-1`). + `zone-name` - The name of the Availability Zone (for example, `us-east-1a`), the Local Zone (for example, `us-west-2-lax-1a`), or the Wavelength Zone (for example, `us-east-1-wl1-bos-wlz-1`). + `zone-type` - The type of zone (`availability-zone` \$1 `local-zone` \$1 `wavelength-zone`). Type: Array of [Filter](API_Filter.md) objects Required: No **ZoneId.N** The IDs of the Availability Zones, Local Zones, and Wavelength Zones. Type: Array of strings Required: No **ZoneName.N** The names of the Availability Zones, Local Zones, and Wavelength Zones. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **availabilityZoneInfo** Information about the Availability Zones, Local Zones, and Wavelength Zones. Type: Array of [AvailabilityZone](API_AvailabilityZone.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example request describes the zones in the current Region that are enabled for your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeAvailabilityZones &AUTHPARAMS ``` #### Sample Response ``` e23c5a54-a29c-43ee-8b55-0c13c26e9e01 us-west-2-zg-1 opt-in-not-required us-west-2a usw2-az1 available availability-zone us-west-2 us-west-2 US West (Oregon) 1 United States of America Oregon us-west-2-zg-1 opt-in-not-required us-west-2b usw2-az2 available availability-zone us-west-2 us-west-2 US West (Oregon) 1 United States of America Oregon us-west-2-zg-1 opt-in-not-required us-west-2c usw2-az3 available availability-zone us-west-2 us-west-2 US West (Oregon) 1 United States of America Oregon us-west-2-zg-1 opt-in-not-required us-west-2d usw2-az4 available availability-zone us-west-2 us-west-2 US West (Oregon) 1 United States of America Oregon ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeAvailabilityZones) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeAvailabilityZones) # DescribeAwsNetworkPerformanceMetricSubscriptions Describes the current Infrastructure Performance metric subscriptions. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 0. Maximum value of 100. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **subscriptionSet** Describes the current Infrastructure Performance subscriptions. Type: Array of [Subscription](API_Subscription.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeAwsNetworkPerformanceMetricSubscriptions) # DescribeBundleTasks Describes the specified bundle tasks or all of your bundle tasks. **Note** Completed bundle tasks are listed for only a limited time. If your bundle task is no longer in the list, you can still register an AMI from it. Just use `RegisterImage` with the Amazon S3 bucket name and image manifest name you provided to the bundle task. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BundleId.N** The bundle task IDs. Default: Describes all your bundle tasks. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `bundle-id` - The ID of the bundle task. + `error-code` - If the task failed, the error code returned. + `error-message` - If the task failed, the error message returned. + `instance-id` - The ID of the instance. + `progress` - The level of task completion, as a percentage (for example, 20%). + `s3-bucket` - The Amazon S3 bucket to store the AMI. + `s3-prefix` - The beginning of the AMI name. + `start-time` - The time the task started (for example, 2013-09-15T17:15:20.000Z). + `state` - The state of the task (`pending` \$1 `waiting-for-shutdown` \$1 `bundling` \$1 `storing` \$1 `cancelling` \$1 `complete` \$1 `failed`). + `update-time` - The time of the most recent update for the task. Type: Array of [Filter](API_Filter.md) objects Required: No ## Response Elements The following elements are returned by the service. **bundleInstanceTasksSet** Information about the bundle tasks. Type: Array of [BundleTask](API_BundleTask.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the status of the specified bundle task. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeBundleTasks &bundleId.1=bun-c1a540a8 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 bun-c1a540a8 cancelling 2008-10-07T11:41:50.000Z 2008-10-07T11:51:50.000Z myawsbucket winami 20% ``` ### Example 2 This example filters the response to include only bundle tasks whose state is either `complete` or `failed`, and in addition are targeted for the Amazon S3 bucket named `myawsbucket`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeBundleTasks &Filter.1.Name=s3-bucket &Filter.1.Value.1=myawsbucket &Filter.2.Name=state &Filter.2.Name.1=complete &Filter.2.Name.2=failed &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeBundleTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeBundleTasks) # DescribeByoipCidrs Describes the IP address ranges that were provisioned for use with AWS resources through through bring your own IP addresses (BYOIP). To describe the address pools that were created when you provisioned the address ranges, use [DescribePublicIpv4Pools](API_DescribePublicIpv4Pools.md) or [DescribeIpv6Pools](API_DescribeIpv6Pools.md). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: Yes **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **byoipCidrSet** Information about your address ranges. Type: Array of [ByoipCidr](API_ByoipCidr.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeByoipCidrs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeByoipCidrs) # DescribeCapacityBlockExtensionHistory Describes the events for the specified Capacity Block extension during the specified time. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId.N** The IDs of Capacity Block reservations that you want to display the history for. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters + `availability-zone` - The Availability Zone of the extension. + `availability-zone-id` - The Availability Zone ID of the extension. + `capacity-block-extension-offering-id` - The ID of the extension offering. + `capacity-block-extension-status` - The status of the extension (`payment-pending` \$1 `payment-failed` \$1 `payment-succeeded`). + `capacity-reservation-id` - The reservation ID of the extension. + `instance-type` - The instance type of the extension. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityBlockExtensionSet** Describes one or more of your Capacity Block extensions. The results describe only the Capacity Block extensions in the AWS Region that you're currently using. Type: Array of [CapacityBlockExtension](API_CapacityBlockExtension.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityBlockExtensionHistory) # DescribeCapacityBlockExtensionOfferings Describes Capacity Block extension offerings available for purchase in the AWS Region that you're currently using. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityBlockExtensionDurationHours** The duration of the Capacity Block extension offering in hours. Type: Integer Required: Yes **CapacityReservationId** The ID of the Capacity reservation to be extended. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityBlockExtensionOfferingSet** The recommended Capacity Block extension offerings for the dates specified. Type: Array of [CapacityBlockExtensionOffering](API_CapacityBlockExtensionOffering.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityBlockExtensionOfferings) # DescribeCapacityBlockOfferings Describes Capacity Block offerings available for purchase in the AWS Region that you're currently using. With Capacity Blocks, you can purchase a specific GPU instance type or EC2 UltraServer for a period of time. To search for an available Capacity Block offering, you specify a reservation duration and instance count. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllAvailabilityZones** Include all Availability Zones and Local Zones, regardless of your opt-in status. If you do not use this parameter, the results include available offerings from all Availability Zones in the AWS Region and Local Zones you are opted into. Type: Boolean Required: No **CapacityDurationHours** The reservation duration for the Capacity Block, in hours. You must specify the duration in 1-day increments up 14 days, and in 7-day increments up to 182 days. Type: Integer Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndDateRange** The latest end date for the Capacity Block offering. Type: Timestamp Required: No **InstanceCount** The number of instances for which to reserve capacity. Each Capacity Block can have up to 64 instances, and you can have up to 256 instances across Capacity Blocks. Type: Integer Required: No **InstanceType** The type of instance for which the Capacity Block offering reserves capacity. Type: String Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No **StartDateRange** The earliest start date for the Capacity Block offering. Type: Timestamp Required: No **UltraserverCount** The number of EC2 UltraServers in the offerings. Type: Integer Required: No **UltraserverType** The EC2 UltraServer type of the Capacity Block offerings. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityBlockOfferingSet** The recommended Capacity Block offering for the dates specified. Type: Array of [CapacityBlockOffering](API_CapacityBlockOffering.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityBlockOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityBlockOfferings) # DescribeCapacityBlocks Describes details about Capacity Blocks in the AWS Region that you're currently using. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityBlockId.N** The IDs of the Capacity Blocks. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `capacity-block-id` - The ID of the Capacity Block. + `ultraserver-type` - The Capacity Block type. The type can be `instances` or `ultraservers`. + `availability-zone` - The Availability Zone of the Capacity Block. + `start-date` - The date and time at which the Capacity Block was started. + `end-date` - The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated. + `create-date` - The date and time at which the Capacity Block was created. + `state` - The state of the Capacity Block (`active` \$1 `expired` \$1 `unavailable` \$1 `cancelled` \$1 `failed` \$1 `scheduled` \$1 `payment-pending` \$1 `payment-failed`). + `tags` - The tags assigned to the Capacity Block. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityBlockSet** The Capacity Blocks. Type: Array of [CapacityBlock](API_CapacityBlock.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityBlocks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityBlocks) # DescribeCapacityBlockStatus Describes the availability of capacity for the specified Capacity blocks, or all of your Capacity Blocks. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityBlockId.N** The ID of the Capacity Block. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `interconnect-status` - The status of the interconnect for the Capacity Block (`ok` \$1 `impaired` \$1 `insufficient-data`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityBlockStatusSet** The availability of capacity for a Capacity Block. Type: Array of [CapacityBlockStatus](API_CapacityBlockStatus.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityBlockStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityBlockStatus) # DescribeCapacityManagerDataExports Describes one or more Capacity Manager data export configurations. Returns information about export settings, delivery status, and recent export activity. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityManagerDataExportId.N** The IDs of the data export configurations to describe. If not specified, all export configurations are returned. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to narrow the results. Supported filters include export status, creation date, and S3 bucket name. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return in a single call. If not specified, up to 1000 results are returned. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Use this value in a subsequent call to retrieve additional results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityManagerDataExportSet** Information about the data export configurations, including export settings, delivery status, and recent activity. Type: Array of [CapacityManagerDataExportResponse](API_CapacityManagerDataExportResponse.md) objects **nextToken** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes a specific data export configuration. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeCapacityManagerDataExports &CapacityManagerDataExportId.1=cmde-0abcd1234EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE cmde-0abcd1234EXAMPLE my-capacity-exports-bucket capacity-data/ hourly parquet 2024-01-15T10:30:00.000Z delivered 2024-01-16T02:00:00.000Z s3://my-capacity-exports-bucket/capacity-data/20240116.parquet ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityManagerDataExports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityManagerDataExports) # DescribeCapacityReservationBillingRequests Describes a request to assign the billing of the unused capacity of a Capacity Reservation. For more information, see [ Billing assignment for shared Amazon EC2 Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/transfer-billing.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId.N** The ID of the Capacity Reservation. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `status` - The state of the request (`pending` \$1 `accepted` \$1 `rejected` \$1 `cancelled` \$1 `revoked` \$1 `expired`). + `requested-by` - The account ID of the Capacity Reservation owner that initiated the request. Not supported if you specify `requested-by` for **Role**. + `unused-reservation-billing-owner` - The ID of the consumer account to which the request was sent. Not supported if you specify `unused-reservation-billing-owner` for **Role**. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No **Role** Specify one of the following: + `odcr-owner` - If you are the Capacity Reservation owner, specify this value to view requests that you have initiated. Not supported with the `requested-by` filter. + `unused-reservation-billing-owner` - If you are the consumer account, specify this value to view requests that have been sent to you. Not supported with the `unused-reservation-billing-owner` filter. Type: String Valid Values: `odcr-owner | unused-reservation-billing-owner` Required: Yes ## Response Elements The following elements are returned by the service. **capacityReservationBillingRequestSet** Information about the request. Type: Array of [CapacityReservationBillingRequest](API_CapacityReservationBillingRequest.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityReservationBillingRequests) # DescribeCapacityReservationFleets Describes one or more Capacity Reservation Fleets. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationFleetId.N** The IDs of the Capacity Reservation Fleets to describe. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `state` - The state of the Fleet (`submitted` \$1 `modifying` \$1 `active` \$1 `partially_fulfilled` \$1 `expiring` \$1 `expired` \$1 `cancelling` \$1 `cancelled` \$1 `failed`). + `instance-match-criteria` - The instance matching criteria for the Fleet. Only `open` is supported. + `tenancy` - The tenancy of the Fleet (`default` \$1 `dedicated`). + `allocation-strategy` - The allocation strategy used by the Fleet. Only `prioritized` is supported. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityReservationFleetSet** Information about the Capacity Reservation Fleets. Type: Array of [CapacityReservationFleet](API_CapacityReservationFleet.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityReservationFleets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityReservationFleets) # DescribeCapacityReservations Describes one or more of your Capacity Reservations. The results describe only the Capacity Reservations in the AWS Region that you're currently using. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId.N** The ID of the Capacity Reservation. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `instance-type` - The type of instance for which the Capacity Reservation reserves capacity. + `owner-id` - The ID of the AWS account that owns the Capacity Reservation. + `instance-platform` - The type of operating system for which the Capacity Reservation reserves capacity. + `availability-zone` - The Availability Zone of the Capacity Reservation. + `tenancy` - Indicates the tenancy of the Capacity Reservation. A Capacity Reservation can have one of the following tenancy settings: + `default` - The Capacity Reservation is created on hardware that is shared with other AWS accounts. + `dedicated` - The Capacity Reservation is created on single-tenant hardware that is dedicated to a single AWS account. + `outpost-arn` - The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created. + `state` - The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: + `active`- The Capacity Reservation is active and the capacity is available for your use. + `expired` - The Capacity Reservation expired automatically at the date and time specified in your request. The reserved capacity is no longer available for your use. + `cancelled` - The Capacity Reservation was cancelled. The reserved capacity is no longer available for your use. + `pending` - The Capacity Reservation request was successful but the capacity provisioning is still pending. + `failed` - The Capacity Reservation request has failed. A request might fail due to invalid request parameters, capacity constraints, or instance limit constraints. Failed requests are retained for 60 minutes. + `start-date` - The date and time at which the Capacity Reservation was started. + `end-date` - The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to expired when it reaches its end date and time. + `end-date-type` - Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: + `unlimited` - The Capacity Reservation remains active until you explicitly cancel it. + `limited` - The Capacity Reservation expires automatically at a specified date and time. + `instance-match-criteria` - Indicates the type of instance launches that the Capacity Reservation accepts. The options include: + `open` - The Capacity Reservation accepts all instances that have matching attributes (instance type, platform, and Availability Zone). Instances that have matching attributes launch into the Capacity Reservation automatically without specifying any additional parameters. + `targeted` - The Capacity Reservation only accepts instances that have matching attributes (instance type, platform, and Availability Zone), and explicitly target the Capacity Reservation. This ensures that only permitted instances can use the reserved capacity. + `placement-group-arn` - The ARN of the cluster placement group in which the Capacity Reservation was created. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityReservationSet** Information about the Capacity Reservations. Type: Array of [CapacityReservation](API_CapacityReservation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityReservations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityReservations) # DescribeCapacityReservationTopology Describes a tree-based hierarchy that represents the physical host placement of your pending or active Capacity Reservations within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your capacity within the AWS network before it is launched and use this information to allocate capacity together to support your tightly coupled workloads. Capacity Reservation topology is supported for specific instance types only. For more information, see [Prerequisites for Amazon EC2 instance topology](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology-prerequisites.html) in the *Amazon EC2 User Guide*. **Note** The Amazon EC2 API follows an eventual consistency model due to the distributed nature of the system supporting it. As a result, when you call the DescribeCapacityReservationTopology API command immediately after launching instances, the response might return a `null` value for `capacityBlockId` because the data might not have fully propagated across all subsystems. For more information, see [Eventual consistency in the Amazon EC2 API](https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html) in the *Amazon EC2 Developer Guide*. For more information, see [Amazon EC2 topology](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId.N** The Capacity Reservation IDs. Default: Describes all your Capacity Reservations. Constraints: Maximum 100 explicitly specified Capacity Reservation IDs. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone` - The name of the Availability Zone (for example, `us-west-2a`) or Local Zone (for example, `us-west-2-lax-1b`) that the Capacity Reservation is in. + `instance-type` - The instance type (for example, `p4d.24xlarge`) or instance family (for example, `p4d*`). You can use the `*` wildcard to match zero or more characters, or the `?` wildcard to match zero or one character. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). You can't specify this parameter and the Capacity Reservation IDs parameter in the same request. Default: `10` Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityReservationSet** Information about the topology of each Capacity Reservation. Type: Array of [CapacityReservationTopology](API_CapacityReservationTopology.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCapacityReservationTopology) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCapacityReservationTopology) # DescribeCarrierGateways Describes one or more of your carrier gateways. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CarrierGatewayId.N** One or more carrier gateway IDs. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `carrier-gateway-id` - The ID of the carrier gateway. + `state` - The state of the carrier gateway (`pending` \$1 `failed` \$1 `available` \$1 `deleting` \$1 `deleted`). + `owner-id` - The AWS account ID of the owner of the carrier gateway. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC associated with the carrier gateway. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **carrierGatewaySet** Information about the carrier gateway. Type: Array of [CarrierGateway](API_CarrierGateway.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCarrierGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCarrierGateways) # DescribeClassicLinkInstances **Note** This action is deprecated. Describes your linked EC2-Classic instances. This request only returns information about EC2-Classic instances linked to a VPC through ClassicLink. You cannot use this request to return information about other instances. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `group-id` - The ID of a VPC security group that's associated with the instance. + `instance-id` - The ID of the instance. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC to which the instance is linked. Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceId.N** The instance IDs. Must be instances linked to a VPC through ClassicLink. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Constraint: If the value is greater than 1000, we return only 1000 items. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instancesSet** Information about one or more linked EC2-Classic instances. Type: Array of [ClassicLinkInstance](API_ClassicLinkInstance.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeClassicLinkInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeClassicLinkInstances) # DescribeClientVpnAuthorizationRules Describes the authorization rules for a specified Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `description` - The description of the authorization rule. + `destination-cidr` - The CIDR of the network to which the authorization rule applies. + `group-id` - The ID of the Active Directory group to which the authorization rule grants access. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **authorizationRule** Information about the authorization rules. Type: Array of [AuthorizationRule](API_AuthorizationRule.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the authorization rules for a specific Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeClientVpnAuthorizationRules &ClientVpnEndpointId.1=cvpn-endpoint-EXAMPLEc8db8d3536 &AUTHPARAMS ``` #### Sample Response ``` 9d5c69db-763e-4b63-88ee-EXAMPLE true auth-rule-one 10.0.0.0/16 cvpn-endpoint-EXAMPLEc8db8d3536 active ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeClientVpnAuthorizationRules) # DescribeClientVpnConnections Describes active client connections and connections that have been terminated within the last 60 minutes for the specified Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `connection-id` - The ID of the connection. + `username` - For Active Directory client authentication, the user name of the client who established the client connection. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **connections** Information about the active and terminated client connections. Type: Array of [ClientVpnConnection](API_ClientVpnConnection.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes Client VPN endpoint connections. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeClientVpnConnections &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &TargetNetworkCidr=10.0.0.0/16 &RevokeAllGroups=true &AUTHPARAMS ``` #### Sample Response ``` 7263df00-d3ed-4f32-a3b9-88177EXAMPLE 11.0.0.98 client1 2018-12-13 18:38:10 2018-12-13 18:32:49 cvpn-connection-010b1282b7EXAMPLE 14891 309 cvpn-endpoint-00c5d11fc4EXAMPLE 14947 285 terminated 2018-12-13 18:38:10 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeClientVpnConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeClientVpnConnections) # DescribeClientVpnEndpoints Describes one or more Client VPN endpoints in the account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId.N** The ID of the Client VPN endpoint. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `endpoint-id` - The ID of the Client VPN endpoint. + `transport-protocol` - The transport protocol (`tcp` \$1 `udp`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **clientVpnEndpoint** Information about the Client VPN endpoints. Type: Array of [ClientVpnEndpoint](API_ClientVpnEndpoint.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the Client VPN endpoints in your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeClientVpnEndpointsResponse &AUTHPARAMS ``` #### Sample Response ``` e69f64d5-e763-4cf5-844e-c278b1946ddf arn:aws:acm:us-east-1:724145273726:certificate/82916b3c-7449-43cf-ab9e-31c18ef401c6 certificate-authentication 10.0.0.0/24 false 2018-12-11T13:14:10 ash-test cvpn-endpoint-0043a94c5c27c7997.prod.clientvpn.us-east-1.amazonaws.com cvpn-endpoint-0043a94c5c27c7997 pending-associate arn:aws:acm:us-east-1:724145273726:certificate/82916b3c-7449-43cf-ab9e-31c18ef401c6 false tcp openvpn ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeClientVpnEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeClientVpnEndpoints) # DescribeClientVpnRoutes Describes the routes for the specified Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `destination-cidr` - The CIDR of the route destination. + `origin` - How the route was associated with the Client VPN endpoint (`associate` \$1 `add-route`). + `target-subnet` - The ID of the subnet through which traffic is routed. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **routes** Information about the Client VPN endpoint routes. Type: Array of [ClientVpnRoute](API_ClientVpnRoute.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the routes for a specific Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeClientVpnRoutes &ClientVpnEndpointId.1=cvpn-endpoint-EXAMPLEc8db8d3536 &AUTHPARAMS ``` #### Sample Response ``` 08fb643f-4d8f-443b-b853-EXAMPLE9cc8c 10.0.0.0/16 cvpn-endpoint-EXAMPLEc8db8d3536 associate active subnet-EXAMPLE18f440ab91 Nat 10.0.1.128/28 cvpn-endpoint-EXAMPLEc8db8d3536 add-route active EXAMPLE18f440ab91 Nat ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeClientVpnRoutes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeClientVpnRoutes) # DescribeClientVpnTargetNetworks Describes the target networks associated with the specified Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationIds.N** The IDs of the target network associations. Type: Array of strings Required: No **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `association-id` - The ID of the association. + `target-network-id` - The ID of the subnet specified as the target network. + `vpc-id` - The ID of the VPC in which the target network is located. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the nextToken value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **clientVpnTargetNetworks** Information about the associated target networks. Type: Array of [TargetNetwork](API_TargetNetwork.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the target networks associated with a Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeClientVpnTargetNetworks &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 1f92d56a-4494-4cbe-ad85-d9387EXAMPLE cvpn-assoc-0822b0983cEXAMPLE cvpn-endpoint-00c5d11fc4EXAMPLE subnet-057fa0918fEXAMPLE sg-123456EXAMPLE associated vpc-3db97056EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeClientVpnTargetNetworks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeClientVpnTargetNetworks) # DescribeCoipPools Describes the specified customer-owned address pools or all of your customer-owned address pools. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `coip-pool.local-gateway-route-table-id` - The ID of the local gateway route table. + `coip-pool.pool-id` - The ID of the address pool. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PoolId.N** The IDs of the address pools. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **coipPoolSet** Information about the address pools. Type: Array of [CoipPool](API_CoipPool.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCoipPools) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCoipPools) # DescribeConversionTasks Describes the specified conversion tasks or all your conversion tasks. For more information, see the [VM Import/Export User Guide](https://docs.aws.amazon.com/vm-import/latest/userguide/). For information about the import manifest referenced by this API action, see [VM Import Manifest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ConversionTaskId.N** The conversion task IDs. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **conversionTasks** Information about the conversion tasks. Type: Array of [ConversionTask](API_ConversionTask.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all your conversion tasks. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeConversionTasks &AUTHPARAMS ``` #### Sample Response ``` import-i-fh95npoc 2010-12-22T12:01Z 1000 us-east-1a VDMK 128696320 https://s3.amazonaws.com/amzn-s3-demo-bucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D 8 vol-1234567890abcdef0 active ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeConversionTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeConversionTasks) # DescribeCustomerGateways Describes one or more of your VPN customer gateways. For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CustomerGatewayId.N** One or more customer gateway IDs. Default: Describes all your customer gateways. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `bgp-asn` - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). + `customer-gateway-id` - The ID of the customer gateway. + `ip-address` - The IP address of the customer gateway device's external interface. + `state` - The state of the customer gateway (`pending` \$1 `available` \$1 `deleting` \$1 `deleted`). + `type` - The type of customer gateway. Currently, the only supported type is `ipsec.1`. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No ## Response Elements The following elements are returned by the service. **customerGatewaySet** Information about one or more customer gateways. Type: Array of [CustomerGateway](API_CustomerGateway.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example request describes the specified customer gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &CustomerGatewayId.1=cgw-b4dc3961 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE cgw-b4dc3961 available ipsec.1 12.1.2.3 65534 ``` ### Example 2 This example request uses filters to describe any customer gateway you own whose IP address is `12.1.2.3`, and whose state is either `pending` or `available`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeCustomerGateways &Filter.1.Name=ip-address &Filter.1.Value.1=12.1.2.3 &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeCustomerGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeCustomerGateways) # DescribeDeclarativePoliciesReports Describes the metadata of an account status report, including the status of the report. To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the `complete` status. Reports with other statuses (`running`, `cancelled`, or `error`) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see [Downloading objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/download-objects.html) in the *Amazon Simple Storage Service User Guide*. For more information, see [Generating the account status report for declarative policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_declarative_status-report.html) in the * AWS Organizations User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **ReportId.N** One or more report IDs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **reportSet** The report metadata. Type: Array of [DeclarativePoliciesReport](API_DeclarativePoliciesReport.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeDeclarativePoliciesReports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeDeclarativePoliciesReports) # DescribeDhcpOptions Describes your DHCP option sets. The default is to describe all your DHCP option sets. Alternatively, you can specify specific DHCP option set IDs or filter the results to include only the DHCP option sets that match specific criteria. For more information, see [DHCP option sets](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_DHCP_Options.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DhcpOptionsId.N** The IDs of DHCP option sets. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `dhcp-options-id` - The ID of a DHCP options set. + `key` - The key for one of the options (for example, `domain-name`). + `value` - The value for one of the options. + `owner-id` - The ID of the AWS account that owns the DHCP options set. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **dhcpOptionsSet** Information about the DHCP options sets. Type: Array of [DhcpOptions](API_DhcpOptions.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes all of your DHCP option sets. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeDhcpOptions &AUTHPARAMS ``` #### Sample Response ``` a0d78ea6-7bc7-4cb8-b827-c5ff0aff0140 dopt-1EXAMPLE 111122223333 domain-name us-east-2.compute.internal domain-name-servers AmazonProvidedDNS dopt-fEXAMPLE 111122223333 domain-name us-east-2.compute.internal domain-name-servers AmazonProvidedDNS ``` ### Example 2 This example uses filters to describe any DHCP option sets that include a `domain-name` option whose value includes the string `example`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeDhcpOptions &Filter.1.Name=key &Filter.1.Value.1=domain-name &Filter.2.Name=value &Filter.2.Value.1=*example* &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeDhcpOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeDhcpOptions) # DescribeEgressOnlyInternetGateways Describes your egress-only internet gateways. The default is to describe all your egress-only internet gateways. Alternatively, you can specify specific egress-only internet gateway IDs or filter the results to include only the egress-only internet gateways that match specific criteria. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EgressOnlyInternetGatewayId.N** The IDs of the egress-only internet gateways. Type: Array of strings Required: No **Filter.N** The filters. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 255. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **egressOnlyInternetGatewaySet** Information about the egress-only internet gateways. Type: Array of [EgressOnlyInternetGateway](API_EgressOnlyInternetGateway.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your egress-only internet gateways. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeEgressOnlyInternetGateways &AUTHPARAMS ``` #### Sample Response ``` ec441b4c-357f-4483-b4a7-example attached vpc-0c62a468 eigw-015e0e244e24dfe8a ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeEgressOnlyInternetGateways) # DescribeElasticGpus **Note** Amazon Elastic Graphics reached end of life on January 8, 2024. Describes the Elastic Graphics accelerator associated with your instances. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ElasticGpuId.N** The Elastic Graphics accelerator IDs. Type: Array of strings Required: No **Filter.N** The filters. + `availability-zone` - The Availability Zone in which the Elastic Graphics accelerator resides. + `elastic-gpu-health` - The status of the Elastic Graphics accelerator (`OK` \$1 `IMPAIRED`). + `elastic-gpu-state` - The state of the Elastic Graphics accelerator (`ATTACHED`). + `elastic-gpu-type` - The type of Elastic Graphics accelerator; for example, `eg1.medium`. + `instance-id` - The ID of the instance to which the Elastic Graphics accelerator is associated. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned `NextToken` value. This value can be between 5 and 1000. Type: Integer Valid Range: Minimum value of 10. Maximum value of 1000. Required: No **NextToken** The token to request the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **elasticGpuSet** Information about the Elastic Graphics accelerators. Type: Array of [ElasticGpus](API_ElasticGpus.md) objects **maxResults** The total number of items to return. If the total number of items available is more than the value specified in max-items then a Next-Token will be provided in the output that you can use to resume pagination. Type: Integer **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of the Elastic Graphics accelerators associated with your instances. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeElasticGpus &AUTHPARAMS ``` #### Sample Response ``` 450268ba-0e1d-4401-958e-9a3example egpu-0833fd743e7227123 us-east-1a eg1.small OK ATTACHED i-1234567890abc1234 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeElasticGpus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeElasticGpus) # DescribeExportImageTasks Describes the specified export image tasks or all of your export image tasks. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExportImageTaskId.N** The IDs of the export image tasks. Type: Array of strings Required: No **Filter.N** Filter tasks using the `task-state` filter and one of the following values: `active`, `completed`, `deleting`, or `deleted`. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 500. Required: No **NextToken** A token that indicates the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **exportImageTaskSet** Information about the export image tasks. Type: Array of [ExportImageTask](API_ExportImageTask.md) objects **nextToken** The token to use to get the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeExportImageTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeExportImageTasks) # DescribeExportTasks Describes the specified export instance tasks or all of your export instance tasks. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ExportTaskId.N** The export task IDs. Type: Array of strings Required: No **Filter.N** the filters for the export tasks. Type: Array of [Filter](API_Filter.md) objects Required: No ## Response Elements The following elements are returned by the service. **exportTaskSet** Information about the export tasks. Type: Array of [ExportTask](API_ExportTask.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes a single export task. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeExportTasks &exportTaskId.1=export-i-1234wxyz &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE export-i-1234wxyz Example for docs active Running i-12345678 VMWare VMDK OVA amzn-s3-demo-for-exported-vm my-exports/ export-i-1234wxyz.ova ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeExportTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeExportTasks) # DescribeFastLaunchImages Describe details for Windows AMIs that are configured for Windows fast launch. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Use the following filters to streamline results. + `resource-type` - The resource type for pre-provisioning. + `owner-id` - The owner ID for the pre-provisioning resource. + `state` - The current state of fast launching for the Windows AMI. Type: Array of [Filter](API_Filter.md) objects Required: No **ImageId.N** Specify one or more Windows AMI image IDs for the request. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 0. Maximum value of 200. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **fastLaunchImageSet** A collection of details about the fast-launch enabled Windows images that meet the requested criteria. Type: Array of [DescribeFastLaunchImagesSuccessItem](API_DescribeFastLaunchImagesSuccessItem.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFastLaunchImages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFastLaunchImages) # DescribeFastSnapshotRestores Describes the state of fast snapshot restores for your snapshots. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. The possible values are: + `availability-zone`: The Availability Zone of the snapshot. For example, `us-east-2a`. + `availability-zone-id`: The ID of the Availability Zone of the snapshot. For example, `use2-az1`. + `owner-id`: The ID of the AWS account that enabled fast snapshot restore on the snapshot. + `snapshot-id`: The ID of the snapshot. + `state`: The state of fast snapshot restores for the snapshot (`enabling` \$1 `optimizing` \$1 `enabled` \$1 `disabling` \$1 `disabled`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 0. Maximum value of 200. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **fastSnapshotRestoreSet** Information about the state of fast snapshot restores. Type: Array of [DescribeFastSnapshotRestoreSuccessItem](API_DescribeFastSnapshotRestoreSuccessItem.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFastSnapshotRestores) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFastSnapshotRestores) # DescribeFleetHistory Describes the events for the specified EC2 Fleet during the specified time. EC2 Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. EC2 Fleet events are available for 48 hours. For more information, see [Monitor fleet events using Amazon EventBridge](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EventType** The type of events to describe. By default, all events are described. Type: String Valid Values: `instance-change | fleet-change | service-error` Required: No **FleetId** The ID of the EC2 Fleet. Type: String Required: Yes **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **StartTime** The start date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Type: Timestamp Required: Yes ## Response Elements The following elements are returned by the service. **fleetId** The ID of the EC Fleet. Type: String **historyRecordSet** Information about the events in the history of the EC2 Fleet. Type: Array of [HistoryRecordEntry](API_HistoryRecordEntry.md) objects **lastEvaluatedTime** The last date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). All records up to this time were retrieved. If `nextToken` indicates that there are more items, this value is not present. Type: Timestamp **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **startTime** The start date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFleetHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFleetHistory) # DescribeFleetInstances Describes the running instances for the specified EC2 Fleet. **Note** Currently, `DescribeFleetInstances` does not support fleets of type `instant`. Instead, use `DescribeFleets`, specifying the `instant` fleet ID in the request. For more information, see [Describe your EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `instance-type` - The instance type. Type: Array of [Filter](API_Filter.md) objects Required: No **FleetId** The ID of the EC2 Fleet. Type: String Required: Yes **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **activeInstanceSet** The running instances. This list is refreshed periodically and might be out of date. Type: Array of [ActiveInstance](API_ActiveInstance.md) objects **fleetId** The ID of the EC2 Fleet. Type: String **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFleetInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFleetInstances) # DescribeFleets Describes the specified EC2 Fleet or all of your EC2 Fleets. **Important** If a fleet is of type `instant`, you must specify the fleet ID in the request, otherwise the fleet does not appear in the response. For more information, see [Describe your EC2 Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/manage-ec2-fleet.html#monitor-ec2-fleet) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `activity-status` - The progress of the EC2 Fleet ( `error` \$1 `pending-fulfillment` \$1 `pending-termination` \$1 `fulfilled`). + `excess-capacity-termination-policy` - Indicates whether to terminate running instances if the target capacity is decreased below the current EC2 Fleet size (`true` \$1 `false`). + `fleet-state` - The state of the EC2 Fleet (`submitted` \$1 `active` \$1 `deleted` \$1 `failed` \$1 `deleted-running` \$1 `deleted-terminating` \$1 `modifying`). + `replace-unhealthy-instances` - Indicates whether EC2 Fleet should replace unhealthy instances (`true` \$1 `false`). + `type` - The type of request (`instant` \$1 `request` \$1 `maintain`). Type: Array of [Filter](API_Filter.md) objects Required: No **FleetId.N** The IDs of the EC2 Fleets. If a fleet is of type `instant`, you must specify the fleet ID, otherwise it does not appear in the response. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **fleetSet** Information about the EC2 Fleets. Type: Array of [FleetData](API_FleetData.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFleets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFleets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFleets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFleets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFleets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFleets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFleets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFleets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFleets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFleets) # DescribeFlowLogs Describes one or more flow logs. To view the published flow log records, you must view the log destination. For example, the CloudWatch Logs log group, the Amazon S3 bucket, or the Kinesis Data Firehose delivery stream. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `deliver-log-status` - The status of the logs delivery (`SUCCESS` \$1 `FAILED`). + `log-destination-type` - The type of destination for the flow log data (`cloud-watch-logs` \$1 `s3` \$1 `kinesis-data-firehose`). + `flow-log-id` - The ID of the flow log. + `log-group-name` - The name of the log group. + `resource-id` - The ID of the VPC, subnet, or network interface. + `traffic-type` - The type of traffic (`ACCEPT` \$1 `REJECT` \$1 `ALL`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **FlowLogId.N** One or more flow log IDs. Constraint: Maximum of 1000 flow log IDs. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token to request the next page of items. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **flowLogSet** Information about the flow logs. Type: Array of [FlowLog](API_FlowLog.md) objects **nextToken** The token to request the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your flow logs. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeFlowLogs &AUTHPARAMS ``` #### Sample Response ``` 3cb46f23-099e-4bf0-891c-EXAMPLE arn:aws:s3:::my-log-bucket/my-logs/ vpc-001234183afc7cabc s3 2020-02-04T11:46:13.831Z ALL SUCCESS ${version} ${instance-id} ${interface-id} ${type} ${pkt-srcaddr} ${pkt-dstaddr} ${protocol} ${bytes} ${start} ${end} ${action} ACTIVE fl-1234c5499532dbabc 60 Name FlowsForVpcA vpc-1122e8183afc74455 cloud-watch-logs arn:aws:iam::123456789101:role/flowlogsrole 2019-07-24T13:11:42.383Z ALL SUCCESS ${version} ${account-id} ${interface-id} ${srcaddr} ${dstaddr} ${srcport} ${dstport} ${protocol} ${packets} ${bytes} ${start} ${end} ${action} ${log-status} ACTIVE FlowLogsForSubnetB fl-0abc1235983d13123 600 Name FlowsForVpcB ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFlowLogs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFlowLogs) # DescribeFpgaImageAttribute Describes the specified attribute of the specified Amazon FPGA Image (AFI). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The AFI attribute. Type: String Valid Values: `description | name | loadPermission | productCodes` Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FpgaImageId** The ID of the AFI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **fpgaImageAttribute** Information about the attribute. Type: [FpgaImageAttribute](API_FpgaImageAttribute.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the load permissions for the specified AFI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeFpgaImageAttribute &FpgaImageId=afi-0d123e21abcc85abc &Attribute=loadPermission &AUTHPARAMS ``` #### Sample Response ``` 19106033-3723-481e-8cc4-aedexample afi-0d123e21abcc85abc 123456789012 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFpgaImageAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFpgaImageAttribute) # DescribeFpgaImages Describes the Amazon FPGA Images (AFIs) available to you. These include public AFIs, private AFIs that you own, and AFIs owned by other AWS accounts for which you have load permissions. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `create-time` - The creation time of the AFI. + `fpga-image-id` - The FPGA image identifier (AFI ID). + `fpga-image-global-id` - The global FPGA image identifier (AGFI ID). + `name` - The name of the AFI. + `owner-id` - The AWS account ID of the AFI owner. + `product-code` - The product code. + `shell-version` - The version of the AWS Shell that was used to create the bitstream. + `state` - The state of the AFI (`pending` \$1 `failed` \$1 `available` \$1 `unavailable`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `update-time` - The time of the most recent update. Type: Array of [Filter](API_Filter.md) objects Required: No **FpgaImageId.N** The AFI IDs. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No **Owner.N** Filters the AFI by owner. Specify an AWS account ID, `self` (owner is the sender of the request), or an AWS owner alias (valid values are `amazon` \$1 `aws-marketplace`). Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **fpgaImageSet** Information about the FPGA images. Type: Array of [FpgaImage](API_FpgaImage.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes AFIs that are owned by account `123456789012`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeFpgaImages &Filter.1.Name=owner-id &Filter.1.Value.1=123456789012 &AUTHPARAMS ``` #### Sample Response ``` c984bf72-784e-43b0-be87-d7903example 2017-12-22T11:43:33.000Z my-afi agfi-05fabc8e7fcca8abc afi-0feabc187988f4abc false my-afi 123456789012 0xf000 0x1d51 0xfedd 0x1d0f 0x071417d3 available 2017-12-22T12:09:14.000Z 2017-12-22T11:44:54.000Z my-afi-2 agfi-0312327b5e84a0123 afi-0d0123214bfc85123 false my-afi-2 123456789012 0xf000 0x1d51 0xfedd 0x1d0f 0x071417d3 available 2017-12-22T12:10:24.000Z ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeFpgaImages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFpgaImages) # DescribeHostReservationOfferings Describes the Dedicated Host reservations that are available to purchase. The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see [Dedicated Hosts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** The filters. + `instance-family` - The instance family of the offering (for example, `m4`). + `payment-option` - The payment option (`NoUpfront` \$1 `PartialUpfront` \$1 `AllUpfront`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxDuration** This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years. Type: Integer Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned `nextToken` value. This value can be between 5 and 500. If `maxResults` is given a larger value than 500, you receive an error. Type: Integer Valid Range: Minimum value of 5. Maximum value of 500. Required: No **MinDuration** This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year. Type: Integer Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No **OfferingId** The ID of the reservation offering. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **offeringSet** Information about the offerings. Type: Array of [HostOffering](API_HostOffering.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes all of the Dedicated Host Reservation offerings. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeHostReservationOfferings &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-84c3-4ea5-gtyk-a9cc3EXAMPLE 94608000 28396.000 AllUpfront m4 hro-0875903788203856fg 0.000 31536000 13603.000 AllUpfront r3 hro-08ddfitlb8990hhkmp 0.000 94608000 57382.000 PartialUpfront x1 hro-0875903788207657fg 2.183 ``` ### Example 2 This example describes all of the Dedicated Host reservation offerings, with a maximum duration of three years, that are available to purchase. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeHostReservationOfferings &MaxDuration=94608000 &AUTHPARAMS ``` #### Sample Response ``` d4905678-84c3-4ea5-gtyk-a9cc3EXAMPLE 31536000 4879.000 PartialUpfront c3 hro-7890903788203856fg 0.557 94608000 18892.000 AllUpfront c4 hro-1092903788203856fg 0.000 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeHostReservationOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeHostReservationOfferings) # DescribeHostReservations Describes reservations that are associated with Dedicated Hosts in your account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** The filters. + `instance-family` - The instance family (for example, `m4`). + `payment-option` - The payment option (`NoUpfront` \$1 `PartialUpfront` \$1 `AllUpfront`). + `state` - The state of the reservation (`payment-pending` \$1 `payment-failed` \$1 `active` \$1 `retired`). + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **HostReservationIdSet.N** The host reservation IDs. Type: Array of strings Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned `nextToken` value. This value can be between 5 and 500. If `maxResults` is given a larger value than 500, you receive an error. Type: Integer Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **hostReservationSet** Details about the reservation's configuration. Type: Array of [HostReservation](API_HostReservation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of the Dedicated Host reservations in your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeHostReservations &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-84c3-4ea5-gtyk-a9983EXAMPLE 0.000 2 2016-08-01T15:43:15Z m4 hro-0875903778903856fg 31536000 NoUpfront 2017-08-01T15:43:15Z hr-0875903778903856fg active 1.990 h-0897086hfkttn h-0891346hytrtn ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeHostReservations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeHostReservations) # DescribeHosts Describes the specified Dedicated Hosts or all your Dedicated Hosts. The results describe only the Dedicated Hosts in the Region you're currently using. All listed instances consume capacity on your Dedicated Host. Dedicated Hosts that have recently been released are listed with the state `released`. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** The filters. + `auto-placement` - Whether auto-placement is enabled or disabled (`on` \$1 `off`). + `availability-zone` - The Availability Zone of the host. + `client-token` - The idempotency token that you provided when you allocated the host. + `host-reservation-id` - The ID of the reservation assigned to this host. + `instance-type` - The instance type size that the Dedicated Host is configured to support. + `state` - The allocation state of the Dedicated Host (`available` \$1 `under-assessment` \$1 `permanent-failure` \$1 `released` \$1 `released-permanent-failure`). + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **HostId.N** The IDs of the Dedicated Hosts. The IDs are used for targeted instance launches. Type: Array of strings Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned `nextToken` value. This value can be between 5 and 500. If `maxResults` is given a larger value than 500, you receive an error. You cannot specify this parameter and the host IDs parameter in the same request. Type: Integer Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **hostSet** Information about the Dedicated Hosts. Type: Array of [Host](API_Host.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the Dedicated Hosts in your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeHosts &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE 96 48 48 m5.large off off h-05abcdd96ee9ca123 2018-01-23T12:33:31.692Z available 96 48 2 m5.large us-east-1a ``` ### Example 2 This example describes a released Dedicated Host in your account using the `state` filter to show only hosts with a state of `released`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeHosts &Filter.1.Name=state &Filter.1.Value=released &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9983EXAMPLE item> 2018-04-06T14:48:40.068Z on off h-0abcd595047722123 released 2018-01-23T12:23:01.501Z 96 48 2 m5.large us-east-1a ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeHosts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeHosts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeHosts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeHosts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeHosts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeHosts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeHosts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeHosts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeHosts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeHosts) # DescribeIamInstanceProfileAssociations Describes your IAM instance profile associations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId.N** The IAM instance profile associations. Type: Array of strings Required: No **Filter.N** The filters. + `instance-id` - The ID of the instance. + `state` - The state of the association (`associating` \$1 `associated` \$1 `disassociating`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **iamInstanceProfileAssociationSet** Information about the IAM instance profile associations. Type: Array of [IamInstanceProfileAssociation](API_IamInstanceProfileAssociation.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your IAM instance profile associations. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeIamInstanceProfileAssociations &AUTHPARAMS ``` #### Sample Response ``` 84c2d2a6-12dc-491f-a9ee-example iip-assoc-08049da59357d598c arn:aws:iam::123456789012:instance-profile/AdminProfile AIPAJEDNCAA64SSD265D6 i-1234567890abcdef0 associated ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIamInstanceProfileAssociations) # DescribeIdentityIdFormat Describes the ID format settings for resources for the specified IAM user, IAM role, or root user. For example, you can view the resource types that are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. For more information, see [Resource IDs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) in the *Amazon Elastic Compute Cloud User Guide*. The following resource types support longer IDs: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. These settings apply to the principal specified in the request. They do not apply to the principal that makes the request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **PrincipalArn** The ARN of the principal, which can be an IAM role, IAM user, or the root user. Type: String Required: Yes **Resource** The type of resource: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway` Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **statusSet** Information about the ID format for the resources. Type: Array of [IdFormat](API_IdFormat.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the ID format for the IAM role 'EC2Role'. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeIdentityIdFormat &PrincipalArn=arn:aws:iam::123456789012:role/EC2Role &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true 2016-12-15T12:00:00Z reservation true 2016-12-15T12:00:00Z instance true 2016-12-15T12:00:00Z volume true 2016-12-15T12:00:00Z snapshot true network-interface-attachment true network-interface true elastic-ip-allocation true elastic-ip-association true vpc true subnet true route-table true route-table-association true network-acl true network-acl-association true dhcp-options true internet-gateway false vpc-cidr-block-association false vpc-ipv6-cidr-block-association true subnet-ipv6-cidr-block-association false vpc-peering-connection true security-group true flow-log true customer-gateway true vpc-endpoint true vpn-connection true vpn-gateway ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIdentityIdFormat) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIdentityIdFormat) # DescribeIdFormat Describes the ID format settings for your resources on a per-Region basis, for example, to view which resource types are enabled for longer IDs. This request only returns information about resource types whose ID formats can be modified; it does not return information about other resource types. The following resource types support longer IDs: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. These settings apply to the IAM user who makes the request; they do not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user, unless they explicitly override the settings by running the [ModifyIdFormat](API_ModifyIdFormat.md) command. Resources created with longer IDs are visible to all IAM users, regardless of these settings and provided that they have permission to use the relevant `Describe` command for the resource type. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Resource** The type of resource: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway` Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **statusSet** Information about the ID format for the resource. Type: Array of [IdFormat](API_IdFormat.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the ID format for all resources that support longer IDs. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeIdFormat &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE reservation true 2016-12-15T12:00:00.000Z instance true 2016-12-15T12:00:00.000Z volume true 2016-12-15T12:00:00.000Z snapshot true 2016-12-15T12:00:00.000Z network-interface-attachment true network-interface true elastic-ip-allocation true elastic-ip-association true vpc true subnet true route-table true route-table-association true network-acl true network-acl-association true dhcp-options true internet-gateway true vpc-cidr-block-association true vpc-ipv6-cidr-block-association true subnet-ipv6-cidr-block-association true vpc-peering-connection true security-group true flow-log true customer-gateway true vpc-endpoint true vpn-connection true vpn-gateway true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIdFormat) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIdFormat) # DescribeImageAttribute Describes the specified attribute of the specified AMI. You can specify only one attribute at a time. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The AMI attribute. **Note**: The `blockDeviceMapping` attribute is deprecated. Using this attribute returns the `Client.AuthFailure` error. To get information about the block device mappings for an AMI, describe the image instead. Type: String Valid Values: `description | kernel | ramdisk | launchPermission | productCodes | blockDeviceMapping | sriovNetSupport | bootMode | tpmSupport | uefiData | lastLaunchedTime | imdsSupport | deregistrationProtection` Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **blockDeviceMapping** The block device mapping entries. Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects **bootMode** The boot mode. Type: [AttributeValue](API_AttributeValue.md) object **deregistrationProtection** Indicates whether deregistration protection is enabled for the AMI. Type: [AttributeValue](API_AttributeValue.md) object **description** A description for the AMI. Type: [AttributeValue](API_AttributeValue.md) object **imageId** The ID of the AMI. Type: String **imdsSupport** If `v2.0`, it indicates that IMDSv2 is specified in the AMI. Instances launched from this AMI will have `HttpTokens` automatically set to `required` so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, `HttpPutResponseHopLimit` is set to `2`. For more information, see [Configure the AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) in the *Amazon EC2 User Guide*. Type: [AttributeValue](API_AttributeValue.md) object **kernel** The kernel ID. Type: [AttributeValue](API_AttributeValue.md) object **lastLaunchedTime** The date and time, in [ISO 8601 date-time format](http://www.iso.org/iso/iso8601), when the AMI was last used to launch an EC2 instance. When the AMI is used to launch an instance, there is a 24-hour delay before that usage is reported. `lastLaunchedTime` data is available starting April 2017. Type: [AttributeValue](API_AttributeValue.md) object **launchPermission** The launch permissions. Type: Array of [LaunchPermission](API_LaunchPermission.md) objects **productCodes** The product codes. Type: Array of [ProductCode](API_ProductCode.md) objects **ramdisk** The RAM disk ID. Type: [AttributeValue](API_AttributeValue.md) object **requestId** The ID of the request. Type: String **sriovNetSupport** Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. Type: [AttributeValue](API_AttributeValue.md) object **tpmSupport** If the image is configured for NitroTPM support, the value is `v2.0`. Type: [AttributeValue](API_AttributeValue.md) object **uefiData** Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the [GetInstanceUefiData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData) command. You can inspect and modify the UEFI data by using the [python-uefivars tool](https://github.com/awslabs/python-uefivars) on GitHub. For more information, see [UEFI Secure Boot for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) in the *Amazon EC2 User Guide*. Type: [AttributeValue](API_AttributeValue.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example lists the launch permissions for the specified AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeImageAttribute &ImageId=ami-61a54008 &Attribute=launchPermission &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-61a54008 all 495219933132 ``` ### Example 2 This example lists the product codes for the specified AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeImageAttribute &ImageId=ami-2bb65342 &Attribute=productCodes &AUTHPARAMS ``` #### Sample Response ``` For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeImageAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeImageAttribute) # DescribeImageReferences Describes your AWS resources that are referencing the specified images. For more information, see [Identify your resources referencing specified AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-ami-references.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId.N** The IDs of the images to check for resource references. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Required: Yes **IncludeAllResourceTypes** Specifies whether to check all supported AWS resource types for image references. When specified, default values are applied for `ResourceTypeOptions`. For the default values, see [How AMI reference checks work](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-ami-references.html#how-ami-references-works) in the *Amazon EC2 User Guide*. If you also specify `ResourceTypes` with `ResourceTypeOptions`, your specified values override the default values. Supported resource types: `ec2:Instance` \$1 `ec2:LaunchTemplate` \$1 `ssm:Parameter` \$1 `imagebuilder:ImageRecipe` \$1 `imagebuilder:ContainerRecipe` Either `IncludeAllResourceTypes` or `ResourceTypes` must be specified. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **ResourceType.N** The AWS resource types to check for image references. Either `IncludeAllResourceTypes` or `ResourceTypes` must be specified. Type: Array of [ResourceTypeRequest](API_ResourceTypeRequest.md) objects Required: No ## Response Elements The following elements are returned by the service. **imageReferenceSet** The resources that are referencing the specified images. Type: Array of [ImageReference](API_ImageReference.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeImageReferences) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeImageReferences) # DescribeImages Describes the specified images (AMIs, AKIs, and ARIs) available to you or all of the images available to you. The images available to you include public images, private images that you own, and private images owned by other AWS accounts for which you have explicit launch permissions. Recently deregistered images appear in the returned results for a short interval and then return empty results. After all instances that reference a deregistered AMI are terminated, specifying the ID of the image will eventually return an error indicating that the AMI ID cannot be found. When Allowed AMIs is set to `enabled`, only allowed images are returned in the results, with the `imageAllowed` field set to `true` for each image. In `audit-mode`, the `imageAllowed` field is set to `true` for images that meet the account's Allowed AMIs criteria, and `false` for images that don't meet the criteria. For more information, see [Allowed AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html). The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see [Eventual consistency in the Amazon EC2 API](https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html) in the *Amazon EC2 Developer Guide*. **Important** We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExecutableBy.N** Scopes the images by users with explicit launch permissions. Specify an AWS account ID, `self` (the sender of the request), or `all` (public AMIs). + If you specify an AWS account ID that is not your own, only AMIs shared with that specific AWS account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned. + If you specify `self` or your own AWS account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned. + If you specify `all`, all public AMIs are returned. Type: Array of strings Required: No **Filter.N** The filters. + `architecture` - The image architecture (`i386` \$1 `x86_64` \$1 `arm64` \$1 `x86_64_mac` \$1 `arm64_mac`). + `block-device-mapping.delete-on-termination` - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination. + `block-device-mapping.device-name` - The device name specified in the block device mapping (for example, `/dev/sdh` or `xvdh`). + `block-device-mapping.snapshot-id` - The ID of the snapshot used for the Amazon EBS volume. + `block-device-mapping.volume-size` - The volume size of the Amazon EBS volume, in GiB. + `block-device-mapping.volume-type` - The volume type of the Amazon EBS volume (`io1` \$1 `io2` \$1 `gp2` \$1 `gp3` \$1 `sc1 `\$1 `st1` \$1 `standard`). + `block-device-mapping.encrypted` - A Boolean that indicates whether the Amazon EBS volume is encrypted. + `creation-date` - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, `2021-09-29T11:04:43.305Z`. You can use a wildcard (`*`), for example, `2021-09-29T*`, which matches an entire day. + `description` - The description of the image (provided during image creation). + `ena-support` - A Boolean that indicates whether enhanced networking with ENA is enabled. + `free-tier-eligible` - A Boolean that indicates whether this image can be used under the AWS Free Tier (`true` \$1 `false`). + `hypervisor` - The hypervisor type (`ovm` \$1 `xen`). + `image-allowed` - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. + `image-id` - The ID of the image. + `image-type` - The image type (`machine` \$1 `kernel` \$1 `ramdisk`). + `is-public` - A Boolean that indicates whether the image is public. + `kernel-id` - The kernel ID. + `manifest-location` - The location of the image manifest. + `name` - The name of the AMI (provided during image creation). + `owner-alias` - The owner alias (`amazon` \$1 `aws-backup-vault` \$1 `aws-marketplace`). The valid aliases are defined in an Amazon-maintained list. This is not the AWS account alias that can be set using the IAM console. We recommend that you use the **Owner** request parameter instead of this filter. + `owner-id` - The AWS account ID of the owner. We recommend that you use the **Owner** request parameter instead of this filter. + `platform` - The platform. The only supported value is `windows`. + `product-code` - The product code. + `product-code.type` - The type of the product code (`marketplace`). + `ramdisk-id` - The RAM disk ID. + `root-device-name` - The device name of the root device volume (for example, `/dev/sda1`). + `root-device-type` - The type of the root device volume (`ebs` \$1 `instance-store`). + `source-image-id` - The ID of the source AMI from which the AMI was created. + `source-image-region` - The Region of the source AMI. + `source-instance-id` - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html). + `state` - The state of the image (`available` \$1 `pending` \$1 `failed`). + `state-reason-code` - The reason code for the state change. + `state-reason-message` - The message for the state change. + `sriov-net-support` - A value of `simple` indicates that enhanced networking with the Intel 82599 VF interface is enabled. + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `virtualization-type` - The virtualization type (`paravirtual` \$1 `hvm`). Type: Array of [Filter](API_Filter.md) objects Required: No **ImageId.N** The image IDs. Default: Describes all images available to you. Type: Array of strings Required: No **IncludeDeprecated** Specifies whether to include deprecated AMIs. Default: No deprecated AMIs are included in the response. If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter. Type: Boolean Required: No **IncludeDisabled** Specifies whether to include disabled AMIs. Default: No disabled AMIs are included in the response. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **Owner.N** Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, `self`, `amazon`, `aws-backup-vault`, and `aws-marketplace`. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **imagesSet** Information about the images. Type: Array of [Image](API_Image.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the specified AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeImages &ImageId.1=ami-1234567890EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE hvm Provided by Red Hat, Inc. Red Hat Enterprise Linux true xen available simple ami-1234567890EXAMPLE RunInstances:0010 /dev/sda1 snap-1234567890abcdef0 15 false standard x86_64 123456789012/RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2 ebs 123456789012 /dev/sda1 2019-05-10T13:17:12.000Z true machine RHEL-8.0.0_HVM-20190618-x86_64-1-Hourly2-GP2 ``` ### Example 2 This example filters the response to include only public Windows images with an `x86_64` architecture. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeImages &Filter.1.Name=is-public &Filter.1.Value.1=true &Filter.2.Name=architecture &Filter.2.Value.1=x86_64 &Filter.3.Name=platform &Filter.3.Value.1=windows &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-1a2b3c4d ec2-public-windows-images/Server2003r2-x86_64-Win-v1.07.manifest.xml available 123456789012 true x86_64 machine windows amazon instance-store hvm xen ... ``` ### Example 3 This example returns the results to display images where the owner is `aws-marketplace`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeImages &Owner.1=aws-marketplace &AUTHPARAMS ``` #### Sample Response ``` 4a4a27a2-2e7c-475d-b35b-ca822EXAMPLE ami-1a2b3c4d aws-marketplace/example-marketplace-amzn-ami.1 available 123456789012 true a1b2c3d4e5f6g7h8i9j10k11 marketplace i386 machine aki-1a2b3c4d aws-marketplace example-marketplace-amzn-ami.1 Amazon Linux AMI i386 EBS ebs /dev/sda1 /dev/sda1 snap-1234567890abcdef0 8 true paravirtual xen ... ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeImages) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeImages) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeImages) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeImages) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeImages) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeImages) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeImages) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeImages) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeImages) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeImages) # DescribeImageUsageReportEntries Describes the entries in image usage reports, showing how your images are used across other AWS accounts. For more information, see [View your AMI usage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/your-ec2-ami-usage.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `account-id` - A 12-digit AWS account ID. + `creation-time` - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, `2025-11-29T11:04:43.305Z`. You can use a wildcard (`*`), for example, `2025-11-29T*`, which matches an entire day. + `resource-type` - The resource type (`ec2:Instance` \$1 `ec2:LaunchTemplate`). Type: Array of [Filter](API_Filter.md) objects Required: No **ImageId.N** The IDs of the images for filtering the report entries. If specified, only report entries containing these images are returned. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **ReportId.N** The IDs of the usage reports. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Elements The following elements are returned by the service. **imageUsageReportEntrySet** The content of the usage reports. Type: Array of [ImageUsageReportEntry](API_ImageUsageReportEntry.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeImageUsageReportEntries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeImageUsageReportEntries) # DescribeImageUsageReports Describes the configuration and status of image usage reports, filtered by report IDs or image IDs. For more information, see [View your AMI usage](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/your-ec2-ami-usage.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `creation-time` - The time when the report was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, `2025-11-29T11:04:43.305Z`. You can use a wildcard (`*`), for example, `2025-11-29T*`, which matches an entire day. + `state` - The state of the report (`available` \$1 `pending` \$1 `error`). + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **ImageId.N** The IDs of the images for filtering the reports. If specified, only reports containing these images are returned. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **ReportId.N** The IDs of the image usage reports. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 200 items. Required: No ## Response Elements The following elements are returned by the service. **imageUsageReportSet** The image usage reports. Type: Array of [ImageUsageReport](API_ImageUsageReport.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeImageUsageReports) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeImageUsageReports) # DescribeImportImageTasks Displays details about an import virtual machine or import snapshot tasks that are already created. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filters.N** Filter tasks using the `task-state` filter and one of the following values: `active`, `completed`, `deleting`, or `deleted`. Type: Array of [Filter](API_Filter.md) objects Required: No **ImportTaskId.N** The IDs of the import image tasks. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in a single call. Type: Integer Required: No **NextToken** A token that indicates the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **importImageTaskSet** A list of zero or more import image tasks that are currently active or were completed or canceled in the previous 7 days. Type: Array of [ImportImageTask](API_ImportImageTask.md) objects **nextToken** The token to use to get the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeImportImageTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeImportImageTasks) # DescribeImportSnapshotTasks Describes your import snapshot tasks. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filters.N** The filters. Type: Array of [Filter](API_Filter.md) objects Required: No **ImportTaskId.N** A list of import snapshot task IDs. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned `NextToken` value. Type: Integer Required: No **NextToken** A token that indicates the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **importSnapshotTaskSet** A list of zero or more import snapshot tasks that are currently active or were completed or canceled in the previous 7 days. Type: Array of [ImportSnapshotTask](API_ImportSnapshotTask.md) objects **nextToken** The token to use to get the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeImportSnapshotTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeImportSnapshotTasks) # DescribeInstanceAttribute Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The instance attribute. Note that the `enaSupport` attribute is not supported. Type: String Valid Values: `instanceType | kernel | ramdisk | userData | disableApiTermination | instanceInitiatedShutdownBehavior | rootDeviceName | blockDeviceMapping | productCodes | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | enclaveOptions | disableApiStop` Required: Yes **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **blockDeviceMapping** The block device mapping of the instance. Type: Array of [InstanceBlockDeviceMapping](API_InstanceBlockDeviceMapping.md) objects **disableApiStop** Indicates whether stop protection is enabled for the instance. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **disableApiTermination** Indicates whether termination protection is enabled. If the value is `true`, you can't terminate the instance using the Amazon EC2 console, command line tools, or API. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **ebsOptimized** Indicates whether the instance is optimized for Amazon EBS I/O. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **enaSupport** Indicates whether enhanced networking with ENA is enabled. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **enclaveOptions** Indicates whether the instance is enabled for AWS Nitro Enclaves. Type: [EnclaveOptions](API_EnclaveOptions.md) object **groupSet** The security groups associated with the instance. Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects **instanceId** The ID of the instance. Type: String **instanceInitiatedShutdownBehavior** Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Type: [AttributeValue](API_AttributeValue.md) object **instanceType** The instance type. Type: [AttributeValue](API_AttributeValue.md) object **kernel** The kernel ID. Type: [AttributeValue](API_AttributeValue.md) object **productCodes** The product codes. Type: Array of [ProductCode](API_ProductCode.md) objects **ramdisk** The RAM disk ID. Type: [AttributeValue](API_AttributeValue.md) object **requestId** The ID of the request. Type: String **rootDeviceName** The device name of the root device volume (for example, `/dev/sda1`). Type: [AttributeValue](API_AttributeValue.md) object **sourceDestCheck** Indicates whether source/destination checks are enabled. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **sriovNetSupport** Indicates whether enhanced networking with the Intel 82599 Virtual Function interface is enabled. Type: [AttributeValue](API_AttributeValue.md) object **userData** The user data. Type: [AttributeValue](API_AttributeValue.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example lists the instance type of the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute &InstanceId=i-1234567890abcdef0 &Attribute=instanceType &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 t1.micro ``` ### Example 2 This example lists the current value of the `InstanceInitiatedShutdownBehavior` attribute for the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute &InstanceId=i-1234567890abcdef0 &Attribute=instanceInitiatedShutdownBehavior &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 stop ``` ### Example 3 This example lists the current value of the `DisableApiTermination` attribute for the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstanceAttribute &InstanceId=i-1234567890abcdef0 &Attribute=disableApiTermination &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 false ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceAttribute) # DescribeInstanceConnectEndpoints Describes the specified EC2 Instance Connect Endpoints or all EC2 Instance Connect Endpoints. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `instance-connect-endpoint-id` - The ID of the EC2 Instance Connect Endpoint. + `state` - The state of the EC2 Instance Connect Endpoint (`create-in-progress` \$1 `create-complete` \$1 `create-failed` \$1 `delete-in-progress` \$1 `delete-complete` \$1 `delete-failed`). + `subnet-id` - The ID of the subnet in which the EC2 Instance Connect Endpoint was created. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `tag-value` - The value of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific value, regardless of tag key. + `vpc-id` - The ID of the VPC in which the EC2 Instance Connect Endpoint was created. Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceConnectEndpointId.N** One or more EC2 Instance Connect Endpoint IDs. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceConnectEndpointSet** Information about the EC2 Instance Connect Endpoints. Type: Array of [Ec2InstanceConnectEndpoint](API_Ec2InstanceConnectEndpoint.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceConnectEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceConnectEndpoints) # DescribeInstanceCreditSpecifications Describes the credit option for CPU usage of the specified burstable performance instances. The credit options are `standard` and `unlimited`. If you do not specify an instance ID, Amazon EC2 returns burstable performance instances with the `unlimited` credit option, as well as instances that were previously configured as T2, T3, and T3a with the `unlimited` credit option. For example, if you resize a T2 instance, while it is configured as `unlimited`, to an M4 instance, Amazon EC2 returns the M4 instance. If you specify one or more instance IDs, Amazon EC2 returns the credit option (`standard` or `unlimited`) of those instances. If you specify an instance ID that is not valid, such as an instance that is not a burstable performance instance, an error is returned. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If an Availability Zone is experiencing a service disruption and you specify instance IDs in the affected zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs in an unaffected zone, the call works normally. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `instance-id` - The ID of the instance. Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceId.N** The instance IDs. Default: Describes all your instances. Constraints: Maximum 1000 explicitly specified instance IDs. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). You cannot specify this parameter and the instance IDs parameter in the same call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceCreditSpecificationSet** Information about the credit option for CPU usage of an instance. Type: Array of [InstanceCreditSpecification](API_InstanceCreditSpecification.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This request describes the current credit option for CPU usage of the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstanceCreditSpecifications &InstanceId.1=i-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 1b234b5c-d6ef-7gh8-90i1-j2345678901 unlimited i-1234567890abcdef0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceCreditSpecifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceCreditSpecifications) # DescribeInstanceEventNotificationAttributes Describes the tag keys that are registered to appear in scheduled event notifications for resources in the current Region. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **instanceTagAttribute** Information about the registered tag keys. Type: [InstanceTagNotificationAttribute](API_InstanceTagNotificationAttribute.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceEventNotificationAttributes) # DescribeInstanceEventWindows Describes the specified event windows or all event windows. If you specify event window IDs, the output includes information for only the specified event windows. If you specify filters, the output includes information for only those event windows that meet the filter criteria. If you do not specify event windows IDs or filters, the output includes information for all event windows, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. For more information, see [Define event windows for scheduled events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `dedicated-host-id` - The event windows associated with the specified Dedicated Host ID. + `event-window-name` - The event windows associated with the specified names. + `instance-id` - The event windows associated with the specified instance ID. + `instance-tag` - The event windows associated with the specified tag and value. + `instance-tag-key` - The event windows associated with the specified tag key, regardless of the value. + `instance-tag-value` - The event windows associated with the specified tag value, regardless of the key. + `tag:` - The key/value combination of a tag assigned to the event window. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `CMX`, specify `tag:Owner` for the filter name and `CMX` for the filter value. + `tag-key` - The key of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific key, regardless of the tag value. + `tag-value` - The value of a tag assigned to the event window. Use this filter to find all event windows that have a tag with a specific value, regardless of the tag key. Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceEventWindowId.N** The IDs of the event windows. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned `NextToken` value. This value can be between 20 and 500. You cannot specify this parameter and the event window IDs parameter in the same call. Type: Integer Valid Range: Minimum value of 20. Maximum value of 500. Required: No **NextToken** The token to request the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceEventWindowSet** Information about the event windows. Type: Array of [InstanceEventWindow](API_InstanceEventWindow.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceEventWindows) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceEventWindows) # DescribeInstanceImageMetadata Describes the AMI that was used to launch an instance, even if the AMI is deprecated, deregistered, made private (no longer public or shared with your account), or not allowed. If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. If you specify an instance ID that is not valid, an instance that doesn't exist, or an instance that you do not own, an error (`InvalidInstanceID.NotFound`) is returned. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. In the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected Availability Zone, or do not specify any instance IDs at all, the call fails. If you specify only instance IDs that are in an unaffected Availability Zone, the call works normally. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone` - The name of the Availability Zone (for example, `us-west-2a`) or Local Zone (for example, `us-west-2-lax-1b`) of the instance. + `instance-id` - The ID of the instance. + `image-allowed` - A Boolean that indicates whether the image meets the criteria specified for Allowed AMIs. + `instance-state-name` - The state of the instance (`pending` \$1 `running` \$1 `shutting-down` \$1 `terminated` \$1 `stopping` \$1 `stopped`). + `instance-type` - The type of instance (for example, `t3.micro`). + `launch-time` - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, `2023-09-29T11:04:43.305Z`. You can use a wildcard (`*`), for example, `2023-09-29T*`, which matches an entire day. + `owner-alias` - The owner alias (`amazon` \$1 `aws-marketplace` \$1 `aws-backup-vault`). The valid aliases are defined in an Amazon-maintained list. This is not the AWS account alias that can be set using the IAM console. We recommend that you use the `Owner` request parameter instead of this filter. + `owner-id` - The AWS account ID of the owner. We recommend that you use the `Owner` request parameter instead of this filter. + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `zone-id` - The ID of the Availability Zone (for example, `usw2-az2`) or Local Zone (for example, `usw2-lax1-az1`) of the instance. Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceId.N** The instance IDs. If you don't specify an instance ID or filters, the output includes information for all instances. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Default: 1000 Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceImageMetadataSet** Information about the instance and the AMI used to launch the instance. Type: Array of [InstanceImageMetadata](API_InstanceImageMetadata.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceImageMetadata) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceImageMetadata) # DescribeInstances Describes the specified instances or all instances. If you specify instance IDs, the output includes information for only the specified instances. If you specify filters, the output includes information for only those instances that meet the filter criteria. If you do not specify instance IDs or filters, the output includes information for all instances, which can affect performance. We recommend that you use pagination to ensure that the operation returns quickly and successfully. The response includes SQL license exemption status information for instances registered with the SQL LE service, providing visibility into license exemption configuration and status. If you specify an instance ID that is not valid, an error is returned. If you specify an instance that you do not own, it is not included in the output. Recently terminated instances might appear in the returned results. This interval is usually less than one hour. If you describe instances in the rare case where an Availability Zone is experiencing a service disruption and you specify instance IDs that are in the affected zone, or do not specify any instance IDs at all, the call fails. If you describe instances and specify only instance IDs that are in an unaffected zone, the call works normally. The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see [Eventual consistency in the Amazon EC2 API](https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html) in the *Amazon EC2 Developer Guide*. **Important** We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `affinity` - The affinity setting for an instance running on a Dedicated Host (`default` \$1 `host`). + `architecture` - The instance architecture (`i386` \$1 `x86_64` \$1 `arm64`). + `availability-zone` - The Availability Zone of the instance. + `availability-zone-id` - The ID of the Availability Zone of the instance. + `block-device-mapping.attach-time` - The attach time for an EBS volume mapped to the instance, for example, `2022-09-15T17:15:20.000Z`. + `block-device-mapping.delete-on-termination` - A Boolean that indicates whether the EBS volume is deleted on instance termination. + `block-device-mapping.device-name` - The device name specified in the block device mapping (for example, `/dev/sdh` or `xvdh`). + `block-device-mapping.status` - The status for the EBS volume (`attaching` \$1 `attached` \$1 `detaching` \$1 `detached`). + `block-device-mapping.volume-id` - The volume ID of the EBS volume. + `boot-mode` - The boot mode that was specified by the AMI (`legacy-bios` \$1 `uefi` \$1 `uefi-preferred`). + `capacity-reservation-id` - The ID of the Capacity Reservation into which the instance was launched. + `capacity-reservation-specification.capacity-reservation-preference` - The instance's Capacity Reservation preference (`open` \$1 `none`). + `capacity-reservation-specification.capacity-reservation-target.capacity-reservation-id` - The ID of the targeted Capacity Reservation. + `capacity-reservation-specification.capacity-reservation-target.capacity-reservation-resource-group-arn` - The ARN of the targeted Capacity Reservation group. + `client-token` - The idempotency token you provided when you launched the instance. + `current-instance-boot-mode` - The boot mode that is used to launch the instance at launch or start (`legacy-bios` \$1 `uefi`). + `dns-name` - The public DNS name of the instance. + `ebs-optimized` - A Boolean that indicates whether the instance is optimized for Amazon EBS I/O. + `ena-support` - A Boolean that indicates whether the instance is enabled for enhanced networking with ENA. + `enclave-options.enabled` - A Boolean that indicates whether the instance is enabled for AWS Nitro Enclaves. + `hibernation-options.configured` - A Boolean that indicates whether the instance is enabled for hibernation. A value of `true` means that the instance is enabled for hibernation. + `host-id` - The ID of the Dedicated Host on which the instance is running, if applicable. + `hypervisor` - The hypervisor type of the instance (`ovm` \$1 `xen`). The value `xen` is used for both Xen and Nitro hypervisors. + `iam-instance-profile.arn` - The instance profile associated with the instance. Specified as an ARN. + `iam-instance-profile.id` - The instance profile associated with the instance. Specified as an ID. + `image-id` - The ID of the image used to launch the instance. + `instance-id` - The ID of the instance. + `instance-lifecycle` - Indicates whether this is a Spot Instance, a Scheduled Instance, or a Capacity Block (`spot` \$1 `scheduled` \$1 `capacity-block`). + `instance-state-code` - The state of the instance, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are: 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). + `instance-state-name` - The state of the instance (`pending` \$1 `running` \$1 `shutting-down` \$1 `terminated` \$1 `stopping` \$1 `stopped`). + `instance-type` - The type of instance (for example, `t2.micro`). + `instance.group-id` - The ID of the security group for the instance. + `instance.group-name` - The name of the security group for the instance. + `ip-address` - The public IPv4 address of the instance. + `ipv6-address` - The IPv6 address of the instance. + `kernel-id` - The kernel ID. + `key-name` - The name of the key pair used when the instance was launched. + `launch-index` - When launching multiple instances, this is the index for the instance in the launch group (for example, 0, 1, 2, and so on). + `launch-time` - The time when the instance was launched, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, `2021-09-29T11:04:43.305Z`. You can use a wildcard (`*`), for example, `2021-09-29T*`, which matches an entire day. + `maintenance-options.auto-recovery` - The current automatic recovery behavior of the instance (`disabled` \$1 `default`). + `metadata-options.http-endpoint` - The status of access to the HTTP metadata endpoint on your instance (`enabled` \$1 `disabled`) + `metadata-options.http-protocol-ipv4` - Indicates whether the IPv4 endpoint is enabled (`disabled` \$1 `enabled`). + `metadata-options.http-protocol-ipv6` - Indicates whether the IPv6 endpoint is enabled (`disabled` \$1 `enabled`). + `metadata-options.http-put-response-hop-limit` - The HTTP metadata request put response hop limit (integer, possible values `1` to `64`) + `metadata-options.http-tokens` - The metadata request authorization state (`optional` \$1 `required`) + `metadata-options.instance-metadata-tags` - The status of access to instance tags from the instance metadata (`enabled` \$1 `disabled`) + `metadata-options.state` - The state of the metadata option changes (`pending` \$1 `applied`). + `monitoring-state` - Indicates whether detailed monitoring is enabled (`disabled` \$1 `enabled`). + `network-interface.addresses.association.allocation-id` - The allocation ID. + `network-interface.addresses.association.association-id` - The association ID. + `network-interface.addresses.association.carrier-ip` - The carrier IP address. + `network-interface.addresses.association.customer-owned-ip` - The customer-owned IP address. + `network-interface.addresses.association.ip-owner-id` - The owner ID of the private IPv4 address associated with the network interface. + `network-interface.addresses.association.public-dns-name` - The public DNS name. + `network-interface.addresses.association.public-ip` - The ID of the association of an Elastic IP address (IPv4) with a network interface. + `network-interface.addresses.primary` - Specifies whether the IPv4 address of the network interface is the primary private IPv4 address. + `network-interface.addresses.private-dns-name` - The private DNS name. + `network-interface.addresses.private-ip-address` - The private IPv4 address associated with the network interface. + `network-interface.association.allocation-id` - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. + `network-interface.association.association-id` - The association ID returned when the network interface was associated with an IPv4 address. + `network-interface.association.carrier-ip` - The customer-owned IP address. + `network-interface.association.customer-owned-ip` - The customer-owned IP address. + `network-interface.association.ip-owner-id` - The owner of the Elastic IP address (IPv4) associated with the network interface. + `network-interface.association.public-dns-name` - The public DNS name. + `network-interface.association.public-ip` - The address of the Elastic IP address (IPv4) bound to the network interface. + `network-interface.attachment.attach-time` - The time that the network interface was attached to an instance. + `network-interface.attachment.attachment-id` - The ID of the interface attachment. + `network-interface.attachment.delete-on-termination` - Specifies whether the attachment is deleted when an instance is terminated. + `network-interface.attachment.device-index` - The device index to which the network interface is attached. + `network-interface.attachment.instance-id` - The ID of the instance to which the network interface is attached. + `network-interface.attachment.instance-owner-id` - The owner ID of the instance to which the network interface is attached. + `network-interface.attachment.network-card-index` - The index of the network card. + `network-interface.attachment.status` - The status of the attachment (`attaching` \$1 `attached` \$1 `detaching` \$1 `detached`). + `network-interface.availability-zone` - The Availability Zone for the network interface. + `network-interface.deny-all-igw-traffic` - A Boolean that indicates whether a network interface with an IPv6 address is unreachable from the public internet. + `network-interface.description` - The description of the network interface. + `network-interface.group-id` - The ID of a security group associated with the network interface. + `network-interface.group-name` - The name of a security group associated with the network interface. + `network-interface.ipv4-prefixes.ipv4-prefix` - The IPv4 prefixes that are assigned to the network interface. + `network-interface.ipv6-address` - The IPv6 address associated with the network interface. + `network-interface.ipv6-addresses.ipv6-address` - The IPv6 address associated with the network interface. + `network-interface.ipv6-addresses.is-primary-ipv6` - A Boolean that indicates whether this is the primary IPv6 address. + `network-interface.ipv6-native` - A Boolean that indicates whether this is an IPv6 only network interface. + `network-interface.ipv6-prefixes.ipv6-prefix` - The IPv6 prefix assigned to the network interface. + `network-interface.mac-address` - The MAC address of the network interface. + `network-interface.network-interface-id` - The ID of the network interface. + `network-interface.operator.managed` - A Boolean that indicates whether the instance has a managed network interface. + `network-interface.operator.principal` - The principal that manages the network interface. Only valid for instances with managed network interfaces, where `managed` is `true`. + `network-interface.outpost-arn` - The ARN of the Outpost. + `network-interface.owner-id` - The ID of the owner of the network interface. + `network-interface.private-dns-name` - The private DNS name of the network interface. + `network-interface.private-ip-address` - The private IPv4 address. + `network-interface.public-dns-name` - The public DNS name. + `network-interface.requester-id` - The requester ID for the network interface. + `network-interface.requester-managed` - Indicates whether the network interface is being managed by AWS. + `network-interface.status` - The status of the network interface (`available`) \$1 `in-use`). + `network-interface.source-dest-check` - Whether the network interface performs source/destination checking. A value of `true` means that checking is enabled, and `false` means that checking is disabled. The value must be `false` for the network interface to perform network address translation (NAT) in your VPC. + `network-interface.subnet-id` - The ID of the subnet for the network interface. + `network-interface.tag-key` - The key of a tag assigned to the network interface. + `network-interface.tag-value` - The value of a tag assigned to the network interface. + `network-interface.vpc-id` - The ID of the VPC for the network interface. + `network-performance-options.bandwidth-weighting` - Where the performance boost is applied, if applicable. Valid values: `default`, `vpc-1`, `ebs-1`. + `operator.managed` - A Boolean that indicates whether this is a managed instance. + `operator.principal` - The principal that manages the instance. Only valid for managed instances, where `managed` is `true`. + `outpost-arn` - The Amazon Resource Name (ARN) of the Outpost. + `owner-id` - The AWS account ID of the instance owner. + `placement-group-name` - The name of the placement group for the instance. + `placement-partition-number` - The partition in which the instance is located. + `platform` - The platform. To list only Windows instances, use `windows`. + `platform-details` - The platform (`Linux/UNIX` \$1 `Red Hat BYOL Linux` \$1 ` Red Hat Enterprise Linux` \$1 `Red Hat Enterprise Linux with HA` \$1 `Red Hat Enterprise Linux with High Availability` \$1 `Red Hat Enterprise Linux with SQL Server Standard and HA` \$1 `Red Hat Enterprise Linux with SQL Server Enterprise and HA` \$1 `Red Hat Enterprise Linux with SQL Server Standard` \$1 `Red Hat Enterprise Linux with SQL Server Web` \$1 `Red Hat Enterprise Linux with SQL Server Enterprise` \$1 `SQL Server Enterprise` \$1 `SQL Server Standard` \$1 `SQL Server Web` \$1 `SUSE Linux` \$1 `Ubuntu Pro` \$1 `Windows` \$1 `Windows BYOL` \$1 `Windows with SQL Server Enterprise` \$1 `Windows with SQL Server Standard` \$1 `Windows with SQL Server Web`). + `private-dns-name` - The private IPv4 DNS name of the instance. + `private-dns-name-options.enable-resource-name-dns-a-record` - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS A records. + `private-dns-name-options.enable-resource-name-dns-aaaa-record` - A Boolean that indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. + `private-dns-name-options.hostname-type` - The type of hostname (`ip-name` \$1 `resource-name`). + `private-ip-address` - The private IPv4 address of the instance. This can only be used to filter by the primary IP address of the network interface attached to the instance. To filter by additional IP addresses assigned to the network interface, use the filter `network-interface.addresses.private-ip-address`. + `product-code` - The product code associated with the AMI used to launch the instance. + `product-code.type` - The type of product code (`devpay` \$1 `marketplace`). + `ramdisk-id` - The RAM disk ID. + `reason` - The reason for the current state of the instance (for example, shows "User Initiated [date]" when you stop or terminate the instance). Similar to the state-reason-code filter. + `requester-id` - The ID of the entity that launched the instance on your behalf (for example, AWS Management Console, Auto Scaling, and so on). + `reservation-id` - The ID of the instance's reservation. A reservation ID is created any time you launch an instance. A reservation ID has a one-to-one relationship with an instance launch request, but can be associated with more than one instance if you launch multiple instances using the same launch request. For example, if you launch one instance, you get one reservation ID. If you launch ten instances using the same launch request, you also get one reservation ID. + `root-device-name` - The device name of the root device volume (for example, `/dev/sda1`). + `root-device-type` - The type of the root device volume (`ebs` \$1 `instance-store`). + `source-dest-check` - Indicates whether the instance performs source/destination checking. A value of `true` means that checking is enabled, and `false` means that checking is disabled. The value must be `false` for the instance to perform network address translation (NAT) in your VPC. + `spot-instance-request-id` - The ID of the Spot Instance request. + `state-reason-code` - The reason code for the state change. + `state-reason-message` - A message that describes the state change. + `subnet-id` - The ID of the subnet for the instance. + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. + `tenancy` - The tenancy of an instance (`dedicated` \$1 `default` \$1 `host`). + `tpm-support` - Indicates if the instance is configured for NitroTPM support (`v2.0`). + `usage-operation` - The usage operation value for the instance (`RunInstances` \$1 `RunInstances:00g0` \$1 `RunInstances:0010` \$1 `RunInstances:1010` \$1 `RunInstances:1014` \$1 `RunInstances:1110` \$1 `RunInstances:0014` \$1 `RunInstances:0210` \$1 `RunInstances:0110` \$1 `RunInstances:0100` \$1 `RunInstances:0004` \$1 `RunInstances:0200` \$1 `RunInstances:000g` \$1 `RunInstances:0g00` \$1 `RunInstances:0002` \$1 `RunInstances:0800` \$1 `RunInstances:0102` \$1 `RunInstances:0006` \$1 `RunInstances:0202`). + `usage-operation-update-time` - The time that the usage operation was last updated, for example, `2022-09-15T17:15:20.000Z`. + `virtualization-type` - The virtualization type of the instance (`paravirtual` \$1 `hvm`). + `vpc-id` - The ID of the VPC that the instance is running in. Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceId.N** The instance IDs. Default: Describes all your instances. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). You cannot specify this parameter and the instance IDs parameter in the same request. Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **reservationSet** Information about the reservations. Type: Array of [Reservation](API_Reservation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1: Describe all instances This example describes all instances owned by your AWS account in the current Region. It uses pagination. The first example request gets the first page of results. The second example request uses the token returned by the previous request. Continue until there are no more results. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &MaxResults=10 &AUTHPARAMS ``` #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &MaxResults=10 &NextToken=eyJOZXh0VG9rZW4iOiBudWxsLCAiYm90b190cnVuY2F0ZV9hbW91bnQiEXAMPLE= &AUTHPARAMS ``` ### Example 2: Describe an instance This example describes the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &InstanceId.1=i-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 8f7724cf-496f-496e-8fe3-example r-1234567890abcdef0 123456789012 i-1234567890abcdef0 ami-bff32ccc 16 running ip-192-168-1-88.eu-west-1.compute.internal ec2-54-194-252-215.eu-west-1.compute.amazonaws.com my_keypair 0 t2.micro 2018-05-08T16:46:19.000Z eu-west-1c default disabled subnet-56f5f633 vpc-11112222 192.168.1.88 54.194.252.215 true sg-e4076980 SecurityGroup1 x86_64 ebs /dev/xvda /dev/xvda vol-1234567890abcdef0 attached 2015-12-22T10:44:09.000Z true hvm xMcwG14507example Name Server_1 xen eni-551ba033 subnet-56f5f633 vpc-11112222 Primary network interface 123456789012 in-use 02:dd:2c:5e:01:69 192.168.1.88 ip-192-168-1-88.eu-west-1.compute.internal true sg-e4076980 SecurityGroup1 eni-attach-39697adc 0 attached 2018-05-08T16:46:19.000Z true 54.194.252.215 ec2-54-194-252-215.eu-west-1.compute.amazonaws.com amazon 192.168.1.88 ip-192-168-1-88.eu-west-1.compute.internal true 54.194.252.215 ec2-54-194-252-215.eu-west-1.compute.amazonaws.com amazon 2001:db8:1234:1a2b::123 arn:aws:iam::123456789012:instance-profile/AdminRole ABCAJEDNCAA64SSD123AB false 1 1 ``` ### Example 3: Filter by instance type This example describes only the instances that have the `m1.small` or `m1.large` instance type and an attached Amazon EBS volume to be deleted on termination. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.1.Name=instance-type &Filter.1.Value.1=m1.small &Filter.1.Value.2=m1.large &Filter.2.Name=block-device-mapping.status &Filter.2.Value.1=attached &Filter.3.Name=block-device-mapping.delete-on-termination &Filter.3.Value.1=true &AUTHPARAMS ``` ### Example 4: Filter by VPC This example describes all instances that are running in the specified VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.1.Name=vpc-id &Filter.1.Value.1=* &AUTHPARAMS ``` ### Example 5: Filter by tag key This example describes any instances that have a tag with the key `Owner`, regardless of the value of the tag. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.1.Name=tag-key &Filter.1.Value.1=Owner &AUTHPARAMS ``` ### Example 6: Filter by tag key and value This example lists only the instances that have a tag with the key `Owner` and the value `DbAdmin`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.1.Name=tag:Owner &Filter.1.Value.1=DbAdmin &AUTHPARAMS ``` ### Example 7: Filter by placement group This example describes any instances that are in the placement group with the name `HDFS-Group-A`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.1.Name=placement-group-name &Filter.1.Value=HDFS-Group-A &AUTHPARAMS ``` ### Example 8: Filter by placement group partition This example describes only the instances that are in partition `2` of the placement group with the name `HDFS-Group-A`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.1.Name=placement-group-name &Filter.1.Value=HDFS-Group-A &Filter.2.Name=placement-partition-number &Filter.2.Value=2 &AUTHPARAMS ``` ### Example 9: Filter by metadata authentication The following example displays details about your instances that are not using any token header authentication requirement to access instance metadata. The response is truncated to show only the relevant pieces. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.Name=metadata-options.http-tokens &Filter.Values=optional &AUTHPARAMS ``` #### Sample Response ``` i-1234567890abcdef0 applied optional 1 enabled ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstances) # DescribeInstanceSqlHaHistoryStates Describes the historical SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndTime** The end data and time of the period for which to get historical SQL Server High Availability states. If omitted, the API returns historical states up to the current date and time. Timezone: UTC Format: `YYYY-MM-DDThh:mm:ss.sssZ` Type: Timestamp Required: No **Filter.N** One or more filters to apply to the results. Supported filters include: + `tag:` - The tag key and value pair assigned to the instance. For example, to find all instances tagged with `Owner:TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The tag key assigned to the instance. + `haStatus` - The SQL Server High Availability status of the SQL Server High Availability instance (`processing` \$1 `active` \$1 `standby` \$1 `invalid`). + `sqlServerLicenseUsage` - The license type for the SQL Server license (`full` \$1 `waived`). Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceId.N** The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns historical states for all SQL Server High Availability instances. Type: Array of strings Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No **StartTime** The start data and time of the period for which to get the historical SQL Server High Availability states. If omitted, the API returns all available historical states. Timezone: UTC Format: `YYYY-MM-DDThh:mm:ss.sssZ` Type: Timestamp Required: No ## Response Elements The following elements are returned by the service. **instanceSet** Information about the historical SQL Server High Availability states of the SQL Server High Availability instances. Type: Array of [RegisteredInstance](API_RegisteredInstance.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceSqlHaHistoryStates) # DescribeInstanceSqlHaStates Describes the SQL Server High Availability states for Amazon EC2 instances that are enabled for Amazon EC2 High Availability for SQL Server monitoring. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to apply to the results. Supported filters include: + `tag:` - The tag key and value pair assigned to the instance. For example, to find all instances tagged with `Owner:TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The tag key assigned to the instance. + `haStatus` - The SQL Server High Availability status of the SQL Server High Availability instance (`processing` \$1 `active` \$1 `standby` \$1 `invalid`). + `sqlServerLicenseUsage` - The license type for the SQL Server license (`full` \$1 `waived`). Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceId.N** The IDs of the SQL Server High Availability instances to describe. If omitted, the API returns SQL Server High Availability states for all SQL Server High Availability instances. Type: Array of strings Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceSet** Information about the SQL Server High Availability instances. Type: Array of [RegisteredInstance](API_RegisteredInstance.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceSqlHaStates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceSqlHaStates) # DescribeInstanceStatus Describes the status of the specified instances or all of your instances. By default, only running instances are described, unless you specifically indicate to return the status of all instances. Instance status includes the following components: + **Status checks** - Amazon EC2 performs status checks on running EC2 instances to identify hardware and software issues. For more information, see [Status checks for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-system-instance-status-check.html) and [Troubleshoot instances with failed status checks](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstances.html) in the *Amazon EC2 User Guide*. + **Scheduled events** - Amazon EC2 can schedule events (such as reboot, stop, or terminate) for your instances related to hardware issues, software updates, or system maintenance. For more information, see [Scheduled events for your instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/monitoring-instances-status-check_sched.html) in the *Amazon EC2 User Guide*. + **Instance state** - You can manage your instances from the moment you launch them through their termination. For more information, see [Instance lifecycle](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) in the *Amazon EC2 User Guide*. The Amazon EC2 API follows an eventual consistency model. This means that the result of an API command you run that creates or modifies resources might not be immediately available to all subsequent commands you run. For guidance on how to manage eventual consistency, see [Eventual consistency in the Amazon EC2 API](https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html) in the *Amazon EC2 Developer Guide*. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone` - The Availability Zone of the instance. + `availability-zone-id` - The ID of the Availability Zone of the instance. + `event.code` - The code for the scheduled event (`instance-reboot` \$1 `system-reboot` \$1 `system-maintenance` \$1 `instance-retirement` \$1 `instance-stop`). + `event.description` - A description of the event. + `event.instance-event-id` - The ID of the event whose date and time you are modifying. + `event.not-after` - The latest end time for the scheduled event (for example, `2014-09-15T17:15:20.000Z`). + `event.not-before` - The earliest start time for the scheduled event (for example, `2014-09-15T17:15:20.000Z`). + `event.not-before-deadline` - The deadline for starting the event (for example, `2014-09-15T17:15:20.000Z`). + `instance-state-code` - The code for the instance state, as a 16-bit unsigned integer. The high byte is used for internal purposes and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). + `instance-state-name` - The state of the instance (`pending` \$1 `running` \$1 `shutting-down` \$1 `terminated` \$1 `stopping` \$1 `stopped`). + `instance-status.reachability` - Filters on instance status where the name is `reachability` (`passed` \$1 `failed` \$1 `initializing` \$1 `insufficient-data`). + `instance-status.status` - The status of the instance (`ok` \$1 `impaired` \$1 `initializing` \$1 `insufficient-data` \$1 `not-applicable`). + `operator.managed` - A Boolean that indicates whether this is a managed instance. + `operator.principal` - The principal that manages the instance. Only valid for managed instances, where `managed` is `true`. + `system-status.reachability` - Filters on system status where the name is `reachability` (`passed` \$1 `failed` \$1 `initializing` \$1 `insufficient-data`). + `system-status.status` - The system status of the instance (`ok` \$1 `impaired` \$1 `initializing` \$1 `insufficient-data` \$1 `not-applicable`). + `attached-ebs-status.status` - The status of the attached EBS volume for the instance (`ok` \$1 `impaired` \$1 `initializing` \$1 `insufficient-data` \$1 `not-applicable`). Type: Array of [Filter](API_Filter.md) objects Required: No **IncludeAllInstances** When `true`, includes the health status for all instances. When `false`, includes the health status for running instances only. Default: `false` Type: Boolean Required: No **InstanceId.N** The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). You cannot specify this parameter and the instance IDs parameter in the same request. Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceStatusSet** Information about the status of the instances. Type: Array of [InstanceStatus](API_InstanceStatus.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example returns instance status descriptions for all running instances. #### Sample Request ``` https://ec2.amazonaws.com/? Action=DescribeInstanceStatus &AUTHPARAMS ``` ### Example 2 This example returns instance status descriptions for the specified instances. #### Sample Request ``` https://ec2.amazonaws.com/? Action=DescribeInstanceStatus &InstanceId.1=i-1234567890abcdef0 &InstanceId.2=i-0598c7d356eba48d7 &AUTHPARAMS ``` ### Example 3 This example returns instance status descriptions for all instances specified by supported DescribeInstanceStatus filters. #### Sample Request ``` https://ec2.amazonaws.com/? Action=DescribeInstanceStatus &Filter.1.Name=system-status.reachability &Filter.1.Value.failed &AUTHPARAMS ``` #### Sample Response ``` 3be1508e-c444-4fef-89cc-0b1223c4f02fEXAMPLE i-1234567890abcdef0 us-east-1d 16 running impaired

reachability failed YYYY-MM-DDTHH:MM:SS.000Z

impaired

reachability failed YYYY-MM-DDTHH:MM:SS.000Z

instance-retirement The instance is running on degraded hardware YYYY-MM-DDTHH:MM:SS+0000 YYYY-MM-DDTHH:MM:SS+0000 i-0598c7d356eba48d7 us-east-1d 16 running ok

reachability passed

instance-reboot The instance is scheduled for a reboot YYYY-MM-DDTHH:MM:SS+0000 YYYY-MM-DDTHH:MM:SS+0000 i-0987654321abcdef0 us-east-1d 16 running ok

reachability passed

i-0598c7d356eba48d8 us-east-1d 16 running ok

reachability passed

insufficient-data

reachability insufficient-data

``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceStatus) # DescribeInstanceTopology Describes a tree-based hierarchy that represents the physical host placement of your EC2 instances within an Availability Zone or Local Zone. You can use this information to determine the relative proximity of your EC2 instances within the AWS network to support your tightly coupled workloads. Instance topology is supported for specific instance types only. For more information, see [Prerequisites for Amazon EC2 instance topology](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology-prerequisites.html) in the *Amazon EC2 User Guide*. **Note** The Amazon EC2 API follows an eventual consistency model due to the distributed nature of the system supporting it. As a result, when you call the DescribeInstanceTopology API command immediately after launching instances, the response might return a `null` value for `capacityBlockId` because the data might not have fully propagated across all subsystems. For more information, see [Eventual consistency in the Amazon EC2 API](https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html) in the *Amazon EC2 Developer Guide*. For more information, see [Amazon EC2 topology](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-topology.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone` - The name of the Availability Zone (for example, `us-west-2a`) or Local Zone (for example, `us-west-2-lax-1b`) that the instance is in. + `instance-type` - The instance type (for example, `p4d.24xlarge`) or instance family (for example, `p4d*`). You can use the `*` wildcard to match zero or more characters, or the `?` wildcard to match zero or one character. + `zone-id` - The ID of the Availability Zone (for example, `usw2-az2`) or Local Zone (for example, `usw2-lax1-az1`) that the instance is in. Type: Array of [Filter](API_Filter.md) objects Required: No **GroupName.N** The name of the placement group that each instance is in. Constraints: Maximum 100 explicitly specified placement group names. Type: Array of strings Required: No **InstanceId.N** The instance IDs. Default: Describes all your instances. Constraints: Maximum 100 explicitly specified instance IDs. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). You can't specify this parameter and the instance IDs parameter in the same request. Default: `20` Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceSet** Information about the topology of each instance. Type: Array of [InstanceTopology](API_InstanceTopology.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceTopology) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceTopology) # DescribeInstanceTypeOfferings Lists the instance types that are offered for the specified location. If no location is specified, the default is to list the instance types that are offered in the current Region. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `instance-type` - The instance type. For a list of possible values, see [Instance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Instance.html). + `location` - The location. For a list of possible identifiers, see [Regions and Zones](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html). Type: Array of [Filter](API_Filter.md) objects Required: No **LocationType** The location type. + `availability-zone` - The Availability Zone. When you specify a location filter, it must be an Availability Zone for the current Region. + `availability-zone-id` - The AZ ID. When you specify a location filter, it must be an AZ ID for the current Region. + `outpost` - The Outpost ARN. When you specify a location filter, it must be an Outpost ARN for the current Region. + `region` - The current Region. If you specify a location filter, it must match the current Region. Type: String Valid Values: `region | availability-zone | availability-zone-id | outpost` Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceTypeOfferingSet** The instance types offered in the location. Type: Array of [InstanceTypeOffering](API_InstanceTypeOffering.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceTypeOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceTypeOfferings) # DescribeInstanceTypes Describes the specified instance types. By default, all instance types for the current Region are described. Alternatively, you can filter the results. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. + `auto-recovery-supported` - Indicates whether Amazon CloudWatch action based recovery is supported (`true` \$1 `false`). + `bare-metal` - Indicates whether it is a bare metal instance type (`true` \$1 `false`). + `burstable-performance-supported` - Indicates whether the instance type is a burstable performance T instance type (`true` \$1 `false`). + `current-generation` - Indicates whether this instance type is the latest generation instance type of an instance family (`true` \$1 `false`). + `dedicated-hosts-supported` - Indicates whether the instance type supports Dedicated Hosts. (`true` \$1 `false`) + `ebs-info.attachment-limit-type` - The type of Amazon EBS volume attachment limit (`shared` \$1 `dedicated`). + `ebs-info.maximum-ebs-attachments` - The maximum number of Amazon EBS volumes that can be attached to the instance type. + `ebs-info.ebs-optimized-info.baseline-bandwidth-in-mbps` - The baseline bandwidth performance for an EBS-optimized instance type, in Mbps. + `ebs-info.ebs-optimized-info.baseline-iops` - The baseline input/output storage operations per second for an EBS-optimized instance type. + `ebs-info.ebs-optimized-info.baseline-throughput-in-mbps` - The baseline throughput performance for an EBS-optimized instance type, in MB/s. + `ebs-info.ebs-optimized-info.maximum-bandwidth-in-mbps` - The maximum bandwidth performance for an EBS-optimized instance type, in Mbps. + `ebs-info.ebs-optimized-info.maximum-iops` - The maximum input/output storage operations per second for an EBS-optimized instance type. + `ebs-info.ebs-optimized-info.maximum-throughput-in-mbps` - The maximum throughput performance for an EBS-optimized instance type, in MB/s. + `ebs-info.ebs-optimized-support` - Indicates whether the instance type is EBS-optimized (`supported` \$1 `unsupported` \$1 `default`). + `ebs-info.encryption-support` - Indicates whether EBS encryption is supported (`supported` \$1 `unsupported`). + `ebs-info.nvme-support` - Indicates whether non-volatile memory express (NVMe) is supported for EBS volumes (`required` \$1 `supported` \$1 `unsupported`). + `free-tier-eligible` - A Boolean that indicates whether this instance type can be used under the AWS Free Tier (`true` \$1 `false`). + `hibernation-supported` - Indicates whether On-Demand hibernation is supported (`true` \$1 `false`). + `hypervisor` - The hypervisor (`nitro` \$1 `xen`). + `instance-storage-info.disk.count` - The number of local disks. + `instance-storage-info.disk.size-in-gb` - The storage size of each instance storage disk, in GB. + `instance-storage-info.disk.type` - The storage technology for the local instance storage disks (`hdd` \$1 `ssd`). + `instance-storage-info.encryption-support` - Indicates whether data is encrypted at rest (`required` \$1 `supported` \$1 `unsupported`). + `instance-storage-info.nvme-support` - Indicates whether non-volatile memory express (NVMe) is supported for instance store (`required` \$1 `supported` \$1 `unsupported`). + `instance-storage-info.total-size-in-gb` - The total amount of storage available from all local instance storage, in GB. + `instance-storage-supported` - Indicates whether the instance type has local instance storage (`true` \$1 `false`). + `instance-type` - The instance type (for example `c5.2xlarge` or c5\$1). + `memory-info.size-in-mib` - The memory size. + `network-info.bandwidth-weightings` - For instances that support bandwidth weighting to boost performance (`default`, `vpc-1`, `ebs-1`). + `network-info.efa-info.maximum-efa-interfaces` - The maximum number of Elastic Fabric Adapters (EFAs) per instance. + `network-info.efa-supported` - Indicates whether the instance type supports Elastic Fabric Adapter (EFA) (`true` \$1 `false`). + `network-info.ena-support` - Indicates whether Elastic Network Adapter (ENA) is supported or required (`required` \$1 `supported` \$1 `unsupported`). + `network-info.flexible-ena-queues-support` - Indicates whether an instance supports flexible ENA queues (`supported` \$1 `unsupported`). + `network-info.encryption-in-transit-supported` - Indicates whether the instance type automatically encrypts in-transit traffic between instances (`true` \$1 `false`). + `network-info.ipv4-addresses-per-interface` - The maximum number of private IPv4 addresses per network interface. + `network-info.ipv6-addresses-per-interface` - The maximum number of private IPv6 addresses per network interface. + `network-info.ipv6-supported` - Indicates whether the instance type supports IPv6 (`true` \$1 `false`). + `network-info.maximum-network-cards` - The maximum number of network cards per instance. + `network-info.maximum-network-interfaces` - The maximum number of network interfaces per instance. + `network-info.network-performance` - The network performance (for example, "25 Gigabit"). + `nitro-enclaves-support` - Indicates whether Nitro Enclaves is supported (`supported` \$1 `unsupported`). + `nitro-tpm-support` - Indicates whether NitroTPM is supported (`supported` \$1 `unsupported`). + `nitro-tpm-info.supported-versions` - The supported NitroTPM version (`2.0`). + `processor-info.supported-architecture` - The CPU architecture (`arm64` \$1 `i386` \$1 `x86_64`). + `processor-info.sustained-clock-speed-in-ghz` - The CPU clock speed, in GHz. + `processor-info.supported-features` - The supported CPU features (`amd-sev-snp`). + `reboot-migration-support` - Indicates whether enabling reboot migration is supported (`supported` \$1 `unsupported`). + `supported-boot-mode` - The boot mode (`legacy-bios` \$1 `uefi`). + `supported-root-device-type` - The root device type (`ebs` \$1 `instance-store`). + `supported-usage-class` - The usage class (`on-demand` \$1 `spot` \$1 `capacity-block`). + `supported-virtualization-type` - The virtualization type (`hvm` \$1 `paravirtual`). + `vcpu-info.default-cores` - The default number of cores for the instance type. + `vcpu-info.default-threads-per-core` - The default number of threads per core for the instance type. + `vcpu-info.default-vcpus` - The default number of vCPUs for the instance type. + `vcpu-info.valid-cores` - The number of cores that can be configured for the instance type. + `vcpu-info.valid-threads-per-core` - The number of threads per core that can be configured for the instance type. For example, "1" or "1,2". Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceType.N** The instance types. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 100 items. Valid Values: `a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c5n.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6g.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.metal | c6gn.medium | c6gn.large | c6gn.xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.12xlarge | c6gn.16xlarge | c6i.large | c6i.xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.32xlarge | c6i.metal | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d3.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3en.xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.12xlarge | dl1.24xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4ad.xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.16xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.48xlarge | g5g.xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.16xlarge | g5g.metal | hi1.4xlarge | hpc6a.48xlarge | hs1.8xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | im4gn.large | im4gn.xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.16xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | is4gen.medium | is4gen.large | is4gen.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.metal | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.metal | m5zn.large | m5zn.xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.12xlarge | m5zn.metal | m6a.large | m6a.xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.32xlarge | m6a.48xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge | m6i.large | m6i.xlarge | m6i.2xlarge | m6i.4xlarge | m6i.8xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.32xlarge | m6i.metal | mac1.metal | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | p4d.24xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5b.large | r5b.xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.metal | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.metal | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6g.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.metal | r6i.large | r6i.xlarge | r6i.2xlarge | r6i.4xlarge | r6i.8xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.32xlarge | r6i.metal | t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | u-6tb1.56xlarge | u-6tb1.112xlarge | u-9tb1.112xlarge | u-12tb1.112xlarge | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | vt1.3xlarge | vt1.6xlarge | vt1.24xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.12xlarge | x2iezn.metal | x2gd.medium | x2gd.large | x2gd.xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.metal | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2iedn.xlarge | x2iedn.2xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.32xlarge | c6a.large | c6a.xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.32xlarge | c6a.48xlarge | c6a.metal | m6a.metal | i4i.large | i4i.xlarge | i4i.2xlarge | i4i.4xlarge | i4i.8xlarge | i4i.16xlarge | i4i.32xlarge | i4i.metal | x2idn.metal | x2iedn.metal | c7g.medium | c7g.large | c7g.xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.12xlarge | c7g.16xlarge | mac2.metal | c6id.large | c6id.xlarge | c6id.2xlarge | c6id.4xlarge | c6id.8xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.32xlarge | c6id.metal | m6id.large | m6id.xlarge | m6id.2xlarge | m6id.4xlarge | m6id.8xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.32xlarge | m6id.metal | r6id.large | r6id.xlarge | r6id.2xlarge | r6id.4xlarge | r6id.8xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.32xlarge | r6id.metal | r6a.large | r6a.xlarge | r6a.2xlarge | r6a.4xlarge | r6a.8xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.32xlarge | r6a.48xlarge | r6a.metal | p4de.24xlarge | u-3tb1.56xlarge | u-18tb1.112xlarge | u-24tb1.112xlarge | trn1.2xlarge | trn1.32xlarge | hpc6id.32xlarge | c6in.large | c6in.xlarge | c6in.2xlarge | c6in.4xlarge | c6in.8xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.32xlarge | m6in.large | m6in.xlarge | m6in.2xlarge | m6in.4xlarge | m6in.8xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.32xlarge | m6idn.large | m6idn.xlarge | m6idn.2xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.32xlarge | r6in.large | r6in.xlarge | r6in.2xlarge | r6in.4xlarge | r6in.8xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.32xlarge | r6idn.large | r6idn.xlarge | r6idn.2xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.32xlarge | c7g.metal | m7g.medium | m7g.large | m7g.xlarge | m7g.2xlarge | m7g.4xlarge | m7g.8xlarge | m7g.12xlarge | m7g.16xlarge | m7g.metal | r7g.medium | r7g.large | r7g.xlarge | r7g.2xlarge | r7g.4xlarge | r7g.8xlarge | r7g.12xlarge | r7g.16xlarge | r7g.metal | c6in.metal | m6in.metal | m6idn.metal | r6in.metal | r6idn.metal | inf2.xlarge | inf2.8xlarge | inf2.24xlarge | inf2.48xlarge | trn1n.32xlarge | i4g.large | i4g.xlarge | i4g.2xlarge | i4g.4xlarge | i4g.8xlarge | i4g.16xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge | c7gn.medium | c7gn.large | c7gn.xlarge | c7gn.2xlarge | c7gn.4xlarge | c7gn.8xlarge | c7gn.12xlarge | c7gn.16xlarge | p5.48xlarge | m7i.large | m7i.xlarge | m7i.2xlarge | m7i.4xlarge | m7i.8xlarge | m7i.12xlarge | m7i.16xlarge | m7i.24xlarge | m7i.48xlarge | m7i-flex.large | m7i-flex.xlarge | m7i-flex.2xlarge | m7i-flex.4xlarge | m7i-flex.8xlarge | m7a.medium | m7a.large | m7a.xlarge | m7a.2xlarge | m7a.4xlarge | m7a.8xlarge | m7a.12xlarge | m7a.16xlarge | m7a.24xlarge | m7a.32xlarge | m7a.48xlarge | m7a.metal-48xl | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | c7gd.medium | c7gd.large | c7gd.xlarge | c7gd.2xlarge | c7gd.4xlarge | c7gd.8xlarge | c7gd.12xlarge | c7gd.16xlarge | m7gd.medium | m7gd.large | m7gd.xlarge | m7gd.2xlarge | m7gd.4xlarge | m7gd.8xlarge | m7gd.12xlarge | m7gd.16xlarge | r7gd.medium | r7gd.large | r7gd.xlarge | r7gd.2xlarge | r7gd.4xlarge | r7gd.8xlarge | r7gd.12xlarge | r7gd.16xlarge | r7a.medium | r7a.large | r7a.xlarge | r7a.2xlarge | r7a.4xlarge | r7a.8xlarge | r7a.12xlarge | r7a.16xlarge | r7a.24xlarge | r7a.32xlarge | r7a.48xlarge | c7i.large | c7i.xlarge | c7i.2xlarge | c7i.4xlarge | c7i.8xlarge | c7i.12xlarge | c7i.16xlarge | c7i.24xlarge | c7i.48xlarge | mac2-m2pro.metal | r7iz.large | r7iz.xlarge | r7iz.2xlarge | r7iz.4xlarge | r7iz.8xlarge | r7iz.12xlarge | r7iz.16xlarge | r7iz.32xlarge | c7a.medium | c7a.large | c7a.xlarge | c7a.2xlarge | c7a.4xlarge | c7a.8xlarge | c7a.12xlarge | c7a.16xlarge | c7a.24xlarge | c7a.32xlarge | c7a.48xlarge | c7a.metal-48xl | r7a.metal-48xl | r7i.large | r7i.xlarge | r7i.2xlarge | r7i.4xlarge | r7i.8xlarge | r7i.12xlarge | r7i.16xlarge | r7i.24xlarge | r7i.48xlarge | dl2q.24xlarge | mac2-m2.metal | i4i.12xlarge | i4i.24xlarge | c7i.metal-24xl | c7i.metal-48xl | m7i.metal-24xl | m7i.metal-48xl | r7i.metal-24xl | r7i.metal-48xl | r7iz.metal-16xl | r7iz.metal-32xl | c7gd.metal | m7gd.metal | r7gd.metal | g6.xlarge | g6.2xlarge | g6.4xlarge | g6.8xlarge | g6.12xlarge | g6.16xlarge | g6.24xlarge | g6.48xlarge | gr6.4xlarge | gr6.8xlarge | c7i-flex.large | c7i-flex.xlarge | c7i-flex.2xlarge | c7i-flex.4xlarge | c7i-flex.8xlarge | u7i-12tb.224xlarge | u7in-16tb.224xlarge | u7in-24tb.224xlarge | u7in-32tb.224xlarge | u7ib-12tb.224xlarge | c7gn.metal | r8g.medium | r8g.large | r8g.xlarge | r8g.2xlarge | r8g.4xlarge | r8g.8xlarge | r8g.12xlarge | r8g.16xlarge | r8g.24xlarge | r8g.48xlarge | r8g.metal-24xl | r8g.metal-48xl | mac2-m1ultra.metal | g6e.xlarge | g6e.2xlarge | g6e.4xlarge | g6e.8xlarge | g6e.12xlarge | g6e.16xlarge | g6e.24xlarge | g6e.48xlarge | c8g.medium | c8g.large | c8g.xlarge | c8g.2xlarge | c8g.4xlarge | c8g.8xlarge | c8g.12xlarge | c8g.16xlarge | c8g.24xlarge | c8g.48xlarge | c8g.metal-24xl | c8g.metal-48xl | m8g.medium | m8g.large | m8g.xlarge | m8g.2xlarge | m8g.4xlarge | m8g.8xlarge | m8g.12xlarge | m8g.16xlarge | m8g.24xlarge | m8g.48xlarge | m8g.metal-24xl | m8g.metal-48xl | x8g.medium | x8g.large | x8g.xlarge | x8g.2xlarge | x8g.4xlarge | x8g.8xlarge | x8g.12xlarge | x8g.16xlarge | x8g.24xlarge | x8g.48xlarge | x8g.metal-24xl | x8g.metal-48xl | i7ie.large | i7ie.xlarge | i7ie.2xlarge | i7ie.3xlarge | i7ie.6xlarge | i7ie.12xlarge | i7ie.18xlarge | i7ie.24xlarge | i7ie.48xlarge | i8g.large | i8g.xlarge | i8g.2xlarge | i8g.4xlarge | i8g.8xlarge | i8g.12xlarge | i8g.16xlarge | i8g.24xlarge | i8g.metal-24xl | u7i-6tb.112xlarge | u7i-8tb.112xlarge | u7inh-32tb.480xlarge | p5e.48xlarge | p5en.48xlarge | f2.12xlarge | f2.48xlarge | trn2.48xlarge | c7i-flex.12xlarge | c7i-flex.16xlarge | m7i-flex.12xlarge | m7i-flex.16xlarge | i7ie.metal-24xl | i7ie.metal-48xl | i8g.48xlarge | c8gd.medium | c8gd.large | c8gd.xlarge | c8gd.2xlarge | c8gd.4xlarge | c8gd.8xlarge | c8gd.12xlarge | c8gd.16xlarge | c8gd.24xlarge | c8gd.48xlarge | c8gd.metal-24xl | c8gd.metal-48xl | i7i.large | i7i.xlarge | i7i.2xlarge | i7i.4xlarge | i7i.8xlarge | i7i.12xlarge | i7i.16xlarge | i7i.24xlarge | i7i.48xlarge | i7i.metal-24xl | i7i.metal-48xl | p6-b200.48xlarge | m8gd.medium | m8gd.large | m8gd.xlarge | m8gd.2xlarge | m8gd.4xlarge | m8gd.8xlarge | m8gd.12xlarge | m8gd.16xlarge | m8gd.24xlarge | m8gd.48xlarge | m8gd.metal-24xl | m8gd.metal-48xl | r8gd.medium | r8gd.large | r8gd.xlarge | r8gd.2xlarge | r8gd.4xlarge | r8gd.8xlarge | r8gd.12xlarge | r8gd.16xlarge | r8gd.24xlarge | r8gd.48xlarge | r8gd.metal-24xl | r8gd.metal-48xl | c8gn.medium | c8gn.large | c8gn.xlarge | c8gn.2xlarge | c8gn.4xlarge | c8gn.8xlarge | c8gn.12xlarge | c8gn.16xlarge | c8gn.24xlarge | c8gn.48xlarge | c8gn.metal-24xl | c8gn.metal-48xl | f2.6xlarge | p6e-gb200.36xlarge | g6f.large | g6f.xlarge | g6f.2xlarge | g6f.4xlarge | gr6f.4xlarge | p5.4xlarge | r8i.large | r8i.xlarge | r8i.2xlarge | r8i.4xlarge | r8i.8xlarge | r8i.12xlarge | r8i.16xlarge | r8i.24xlarge | r8i.32xlarge | r8i.48xlarge | r8i.96xlarge | r8i.metal-48xl | r8i.metal-96xl | r8i-flex.large | r8i-flex.xlarge | r8i-flex.2xlarge | r8i-flex.4xlarge | r8i-flex.8xlarge | r8i-flex.12xlarge | r8i-flex.16xlarge` Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 100. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **instanceTypeSet** The instance type. Type: Array of [InstanceTypeInfo](API_InstanceTypeInfo.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInstanceTypes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInstanceTypes) # DescribeInternetGateways Describes your internet gateways. The default is to describe all your internet gateways. Alternatively, you can specify specific internet gateway IDs or filter the results to include only the internet gateways that match specific criteria. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `attachment.state` - The current state of the attachment between the gateway and the VPC (`available`). Present only if a VPC is attached. + `attachment.vpc-id` - The ID of an attached VPC. + `internet-gateway-id` - The ID of the Internet gateway. + `owner-id` - The ID of the AWS account that owns the internet gateway. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **InternetGatewayId.N** The IDs of the internet gateways. Default: Describes all your internet gateways. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **internetGatewaySet** Information about the internet gateways. Type: Array of [InternetGateway](API_InternetGateway.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all your internet gateways. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInternetGateways &AUTHPARAMS ``` #### Sample Response ``` e0fbdd4f-8e6d-437c-92eb-bc72864831d8 igw-036dde5c85EXAMPLE 11112222333304 igw-0EXAMPLE 053534965804 vpc-cEXAMPLE available ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeInternetGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeInternetGateways) # DescribeIpamByoasn Describes your Autonomous System Numbers (ASNs), their provisioning statuses, and the BYOIP CIDRs with which they are associated. For more information, see [Tutorial: Bring your ASN to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) in the *Amazon VPC IPAM guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **byoasnSet** ASN and BYOIP CIDR associations. Type: Array of [Byoasn](API_Byoasn.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamByoasn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamByoasn) # DescribeIpamExternalResourceVerificationTokens Describe verification tokens. A verification token is an AWS-generated random value that you can use to prove ownership of an external resource. For example, you can use a verification token to validate that you control a public IP address range when you bring an IP address range to AWS (BYOIP). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the request. For more information about filtering, see [Filtering CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). Available filters: + `ipam-arn` + `ipam-external-resource-verification-token-arn` + `ipam-external-resource-verification-token-id` + `ipam-id` + `ipam-region` + `state` + `status` + `token-name` + `token-value` Type: Array of [Filter](API_Filter.md) objects Required: No **IpamExternalResourceVerificationTokenId.N** Verification token IDs. Type: Array of strings Required: No **MaxResults** The maximum number of tokens to return in one page of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamExternalResourceVerificationTokenSet** Verification tokens. Type: Array of [IpamExternalResourceVerificationToken](API_IpamExternalResourceVerificationToken.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamExternalResourceVerificationTokens) # DescribeIpamPolicies Describes one or more IPAM policies. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the IPAM policy description. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPolicyId.N** The IDs of the IPAM policies to describe. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPolicySet** Information about the IPAM policies. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. Type: Array of [IpamPolicy](API_IpamPolicy.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamPolicies) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamPolicies) # DescribeIpamPools Get information about your IPAM pools. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the request. For more information about filtering, see [Filtering CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPoolId.N** The IDs of the IPAM pools you would like information on. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in the request. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPoolSet** Information about the IPAM pools. Type: Array of [IpamPool](API_IpamPool.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamPools) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamPools) # DescribeIpamPrefixListResolvers Describes one or more IPAM prefix list resolvers. Use this operation to view the configuration, status, and properties of your resolvers. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to limit the results. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPrefixListResolverId.N** The IDs of the IPAM prefix list resolvers to describe. If not specified, all resolvers in your account are described. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPrefixListResolverSet** Information about the IPAM prefix list resolvers. Type: Array of [IpamPrefixListResolver](API_IpamPrefixListResolver.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamPrefixListResolvers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamPrefixListResolvers) # DescribeIpamPrefixListResolverTargets Describes one or more IPAM prefix list resolver Targets. Use this operation to view the configuration and status of resolver targets. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to limit the results. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPrefixListResolverId** The ID of the IPAM prefix list resolver to filter targets by. Only targets associated with this resolver will be returned. Type: String Required: No **IpamPrefixListResolverTargetId.N** The IDs of the IPAM prefix list resolver Targets to describe. If not specified, all targets in your account are described. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPrefixListResolverTargetSet** Information about the IPAM prefix list resolver Targets. Type: Array of [IpamPrefixListResolverTarget](API_IpamPrefixListResolverTarget.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamPrefixListResolverTargets) # DescribeIpamResourceDiscoveries Describes IPAM resource discoveries. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The resource discovery filters. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamResourceDiscoveryId.N** The IPAM resource discovery IDs. Type: Array of strings Required: No **MaxResults** The maximum number of resource discoveries to return in one page of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamResourceDiscoverySet** The resource discoveries. Type: Array of [IpamResourceDiscovery](API_IpamResourceDiscovery.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamResourceDiscoveries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamResourceDiscoveries) # DescribeIpamResourceDiscoveryAssociations Describes resource discovery association with an Amazon VPC IPAM. An associated resource discovery is a resource discovery that has been associated with an IPAM.. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The resource discovery association filters. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamResourceDiscoveryAssociationId.N** The resource discovery association IDs. Type: Array of strings Required: No **MaxResults** The maximum number of resource discovery associations to return in one page of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** Specify the pagination token from a previous request to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamResourceDiscoveryAssociationSet** The resource discovery associations. Type: Array of [IpamResourceDiscoveryAssociation](API_IpamResourceDiscoveryAssociation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamResourceDiscoveryAssociations) # DescribeIpams Get information about your IPAM pools. For more information, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the request. For more information about filtering, see [Filtering CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). Type: Array of [Filter](API_Filter.md) objects Required: No **IpamId.N** The IDs of the IPAMs you want information on. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in the request. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamSet** Information about the IPAMs. Type: Array of [Ipam](API_Ipam.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpams) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpams) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpams) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpams) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpams) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpams) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpams) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpams) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpams) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpams) # DescribeIpamScopes Get information about your IPAM scopes. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the request. For more information about filtering, see [Filtering CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). Type: Array of [Filter](API_Filter.md) objects Required: No **IpamScopeId.N** The IDs of the scopes you want information on. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in the request. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamScopeSet** The scopes you want information on. Type: Array of [IpamScope](API_IpamScope.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpamScopes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpamScopes) # DescribeIpv6Pools Describes your IPv6 address pools. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PoolId.N** The IDs of the IPv6 address pools. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **ipv6PoolSet** Information about the IPv6 address pools. Type: Array of [Ipv6Pool](API_Ipv6Pool.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeIpv6Pools) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeIpv6Pools) # DescribeKeyPairs Describes the specified key pairs or all of your key pairs. For more information about key pairs, see [Amazon EC2 key pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `key-pair-id` - The ID of the key pair. + `fingerprint` - The fingerprint of the key pair. + `key-name` - The name of the key pair. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [Filter](API_Filter.md) objects Required: No **IncludePublicKey** If `true`, the public key material is included in the response. Default: `false` Type: Boolean Required: No **KeyName.N** The key pair names. Default: Describes all of your key pairs. Type: Array of strings Required: No **KeyPairId.N** The IDs of the key pairs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **keySet** Information about the key pairs. Type: Array of [KeyPairInfo](API_KeyPairInfo.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the key pair with name my-key-pair. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeKeyPairs &KeyName.1=my-key-pair &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE my-key-pair 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f ``` ### Example This example filters the response to include only key pairs whose names include the string `Dave`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeKeyPairs &Filter.1.Name=key-name &Filter.1.Value.1=*Dave* &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeKeyPairs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeKeyPairs) # DescribeLaunchTemplates Describes one or more launch templates. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `create-time` - The time the launch template was created. + `launch-template-name` - The name of the launch template. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **LaunchTemplateId.N** One or more launch template IDs. Type: Array of strings Required: No **LaunchTemplateName.N** One or more launch template names. Type: Array of strings Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: `[a-zA-Z0-9\.\-/_]+` Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned `NextToken` value. This value can be between 1 and 200. Type: Integer Valid Range: Minimum value of 1. Maximum value of 200. Required: No **NextToken** The token to request the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **launchTemplates** Information about the launch templates. Type: Array of [LaunchTemplate](API_LaunchTemplate.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your launch templates. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeLaunchTemplates &AUTHPARAMS ``` #### Sample Response ``` 1afa6e44-eb38-4229-8db6-d5eaexample 2017-10-31T11:38:52.000Z arn:aws:iam::123456789012:root 1 1 lt-0a20c965061f64abc MyLaunchTemplate ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLaunchTemplates) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLaunchTemplates) # DescribeLaunchTemplateVersions Describes one or more versions of a specified launch template. You can describe all versions, individual versions, or a range of versions. You can also describe all the latest versions or all the default versions of all the launch templates in your account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `create-time` - The time the launch template version was created. + `ebs-optimized` - A boolean that indicates whether the instance is optimized for Amazon EBS I/O. + `http-endpoint` - Indicates whether the HTTP metadata endpoint on your instances is enabled (`enabled` \$1 `disabled`). + `http-protocol-ipv4` - Indicates whether the IPv4 endpoint for the instance metadata service is enabled (`enabled` \$1 `disabled`). + `host-resource-group-arn` - The ARN of the host resource group in which to launch the instances. + `http-tokens` - The state of token usage for your instance metadata requests (`optional` \$1 `required`). + `iam-instance-profile` - The ARN of the IAM instance profile. + `image-id` - The ID of the AMI. + `instance-type` - The instance type. + `is-default-version` - A boolean that indicates whether the launch template version is the default version. + `kernel-id` - The kernel ID. + `license-configuration-arn` - The ARN of the license configuration. + `network-card-index` - The index of the network card. + `ram-disk-id` - The RAM disk ID. Type: Array of [Filter](API_Filter.md) objects Required: No **LaunchTemplateId** The ID of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template ID or the launch template name, but not both. To describe all the latest or default launch template versions in your account, you must omit this parameter. Type: String Required: No **LaunchTemplateName** The name of the launch template. To describe one or more versions of a specified launch template, you must specify either the launch template name or the launch template ID, but not both. To describe all the latest or default launch template versions in your account, you must omit this parameter. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: `[a-zA-Z0-9\.\-/_]+` Required: No **LaunchTemplateVersion.N** One or more versions of the launch template. Valid values depend on whether you are describing a specified launch template (by ID or name) or all launch templates in your account. To describe one or more versions of a specified launch template, valid values are `$Latest`, `$Default`, and numbers. To describe all launch templates in your account that are defined as the latest version, the valid value is `$Latest`. To describe all launch templates in your account that are defined as the default version, the valid value is `$Default`. You can specify `$Latest` and `$Default` in the same request. You cannot specify numbers. Type: Array of strings Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned `NextToken` value. This value can be between 1 and 200. Type: Integer Required: No **MaxVersion** The version number up to which to describe launch template versions. Type: String Required: No **MinVersion** The version number after which to describe launch template versions. Type: String Required: No **NextToken** The token to request the next page of results. Type: String Required: No **ResolveAlias** If `true`, and if a Systems Manager parameter is specified for `ImageId`, the AMI ID is displayed in the response for `imageId`. If `false`, and if a Systems Manager parameter is specified for `ImageId`, the parameter is displayed in the response for `imageId`. For more information, see [Use a Systems Manager parameter instead of an AMI ID](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-launch-template.html#use-an-ssm-parameter-instead-of-an-ami-id) in the *Amazon EC2 User Guide*. Default: `false` Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **launchTemplateVersionSet** Information about the launch template versions. Type: Array of [LaunchTemplateVersion](API_LaunchTemplateVersion.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes all versions of launch template `lt-0a20c965061f64abc` up to version 3. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeLaunchTemplateVersions &LaunchTemplateId=lt-0a20c965061f64abc &MaxVersion=3 &AUTHPARAMS ``` #### Sample Response ``` 65cadec1-b364-4354-8ca8-4176dexample 2017-10-31T11:38:52.000Z arn:aws:iam::123456789012:root true ami-8c1be5f6 t2.micro lt-0a20c965061f64abc MyLaunchTemplate FirstVersion 1 2017-10-31T11:52:03.000Z arn:aws:iam::123456789012:root false ami-12345678 lt-0a20c965061f64abc MyLaunchTemplate AMIOnlyv1 2 2017-10-31T11:55:15.000Z arn:aws:iam::123456789012:root false ami-aabbccdd lt-0a20c965061f64abc MyLaunchTemplate AMIOnlyv2 3 ``` ### Example 2 This example describes all the latest versions of the launch templates in your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeLaunchTemplateVersions &LaunchTemplateVersion.1=$Latest &AUTHPARAMS ``` #### Sample Response ``` 65cadec1-b364-4354-8ca8-4176dexample 2020-01-31T11:38:52.000Z arn:aws:iam::123456789012:root true ami-8c1be5f6 t2.micro lt-1111111111EXAMPLE MyLaunchTemplate1 FirstTemplate 1 2020-02-14T11:52:03.000Z arn:aws:iam::123456789012:root false ami-12345678 t2.micro lt-2222222222EXAMPLE MyLaunchTemplate2 ThirdVersion 3 2020-03-03T11:55:15.000Z arn:aws:iam::123456789012:root false ami-aabbccdd t3.small lt-3333333333EXAMPLE MyLaunchTemplate3 AMIOnlyv2 2 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLaunchTemplateVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLaunchTemplateVersions) # DescribeLocalGatewayRouteTables Describes one or more local gateway route tables. By default, all local gateway route tables are described. Alternatively, you can filter the results. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `local-gateway-id` - The ID of a local gateway. + `local-gateway-route-table-arn` - The Amazon Resource Name (ARN) of the local gateway route table. + `local-gateway-route-table-id` - The ID of a local gateway route table. + `outpost-arn` - The Amazon Resource Name (ARN) of the Outpost. + `owner-id` - The ID of the AWS account that owns the local gateway route table. + `state` - The state of the local gateway route table. Type: Array of [Filter](API_Filter.md) objects Required: No **LocalGatewayRouteTableId.N** The IDs of the local gateway route tables. Type: Array of strings Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **localGatewayRouteTableSet** Information about the local gateway route tables. Type: Array of [LocalGatewayRouteTable](API_LocalGatewayRouteTable.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLocalGatewayRouteTables) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLocalGatewayRouteTables) # DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations Describes the associations between virtual interface groups and local gateway route tables. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `local-gateway-id` - The ID of a local gateway. + `local-gateway-route-table-arn` - The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group. + `local-gateway-route-table-id` - The ID of the local gateway route table. + `local-gateway-route-table-virtual-interface-group-association-id` - The ID of the association. + `local-gateway-route-table-virtual-interface-group-id` - The ID of the virtual interface group. + `owner-id` - The ID of the AWS account that owns the local gateway virtual interface group association. + `state` - The state of the association. Type: Array of [Filter](API_Filter.md) objects Required: No **LocalGatewayRouteTableVirtualInterfaceGroupAssociationId.N** The IDs of the associations. Type: Array of strings Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **localGatewayRouteTableVirtualInterfaceGroupAssociationSet** Information about the associations. Type: Array of [LocalGatewayRouteTableVirtualInterfaceGroupAssociation](API_LocalGatewayRouteTableVirtualInterfaceGroupAssociation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVirtualInterfaceGroupAssociations) # DescribeLocalGatewayRouteTableVpcAssociations Describes the specified associations between VPCs and local gateway route tables. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `local-gateway-id` - The ID of a local gateway. + `local-gateway-route-table-arn` - The Amazon Resource Name (ARN) of the local gateway route table for the association. + `local-gateway-route-table-id` - The ID of the local gateway route table. + `local-gateway-route-table-vpc-association-id` - The ID of the association. + `owner-id` - The ID of the AWS account that owns the local gateway route table for the association. + `state` - The state of the association. + `vpc-id` - The ID of the VPC. Type: Array of [Filter](API_Filter.md) objects Required: No **LocalGatewayRouteTableVpcAssociationId.N** The IDs of the associations. Type: Array of strings Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **localGatewayRouteTableVpcAssociationSet** Information about the associations. Type: Array of [LocalGatewayRouteTableVpcAssociation](API_LocalGatewayRouteTableVpcAssociation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLocalGatewayRouteTableVpcAssociations) # DescribeLocalGateways Describes one or more local gateways. By default, all local gateways are described. Alternatively, you can filter the results. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `local-gateway-id` - The ID of a local gateway. + `outpost-arn` - The Amazon Resource Name (ARN) of the Outpost. + `owner-id` - The ID of the AWS account that owns the local gateway. + `state` - The state of the association. Type: Array of [Filter](API_Filter.md) objects Required: No **LocalGatewayId.N** The IDs of the local gateways. Type: Array of strings Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **localGatewaySet** Information about the local gateways. Type: Array of [LocalGateway](API_LocalGateway.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLocalGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLocalGateways) # DescribeLocalGatewayVirtualInterfaceGroups Describes the specified local gateway virtual interface groups. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `local-gateway-id` - The ID of a local gateway. + `local-gateway-virtual-interface-group-id` - The ID of the virtual interface group. + `local-gateway-virtual-interface-id` - The ID of the virtual interface. + `owner-id` - The ID of the AWS account that owns the local gateway virtual interface group. Type: Array of [Filter](API_Filter.md) objects Required: No **LocalGatewayVirtualInterfaceGroupId.N** The IDs of the virtual interface groups. Type: Array of strings Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **localGatewayVirtualInterfaceGroupSet** The virtual interface groups. Type: Array of [LocalGatewayVirtualInterfaceGroup](API_LocalGatewayVirtualInterfaceGroup.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaceGroups) # DescribeLocalGatewayVirtualInterfaces Describes the specified local gateway virtual interfaces. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `local-address` - The local address. + `local-bgp-asn` - The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway. + `local-gateway-id` - The ID of the local gateway. + `local-gateway-virtual-interface-id` - The ID of the virtual interface. + `owner-id` - The ID of the AWS account that owns the local gateway virtual interface. + `peer-address` - The peer address. + `peer-bgp-asn` - The peer BGP ASN. + `vlan` - The ID of the VLAN. Type: Array of [Filter](API_Filter.md) objects Required: No **LocalGatewayVirtualInterfaceId.N** The IDs of the virtual interfaces. Type: Array of strings Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **localGatewayVirtualInterfaceSet** Information about the virtual interfaces. Type: Array of [LocalGatewayVirtualInterface](API_LocalGatewayVirtualInterface.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLocalGatewayVirtualInterfaces) # DescribeLockedSnapshots Describes the lock status for a snapshot. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `lock-state` - The state of the snapshot lock (`compliance-cooloff` \$1 `governance` \$1 `compliance` \$1 `expired`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **SnapshotId.N** The IDs of the snapshots for which to view the lock status. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **snapshotSet** Information about the snapshots. Type: Array of [LockedSnapshotsInfo](API_LockedSnapshotsInfo.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeLockedSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeLockedSnapshots) # DescribeMacHosts Describes the specified EC2 Mac Dedicated Host or all of your EC2 Mac Dedicated Hosts. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** The filters. + `availability-zone` - The Availability Zone of the EC2 Mac Dedicated Host. + `instance-type` - The instance type size that the EC2 Mac Dedicated Host is configured to support. Type: Array of [Filter](API_Filter.md) objects Required: No **HostId.N** The IDs of the EC2 Mac Dedicated Hosts. Type: Array of strings Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned `nextToken` value. This value can be between 5 and 500. If `maxResults` is given a larger value than 500, you receive an error. Type: Integer Valid Range: Minimum value of 5. Maximum value of 500. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **macHostSet** Information about the EC2 Mac Dedicated Hosts. Type: Array of [MacHost](API_MacHost.md) objects **nextToken** The token to use to retrieve the next page of results. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeMacHosts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeMacHosts) # DescribeMacModificationTasks Describes a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance. For more information, see [Configure SIP for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/mac-sip-settings.html#mac-sip-configure) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Specifies one or more filters for the request: + `instance-id` - The ID of the instance for which the task was created. + `task-state` - The state of the task (`successful` \$1 `failed` \$1 `in-progress` \$1 `pending`). + `mac-system-integrity-protection-configuration.sip-status` - The overall SIP state requested in the task (`enabled` \$1 `disabled`). + `start-time` - The date and time the task was created. + `task-type` - The type of task (`sip-modification` \$1 `volume-ownership-delegation`). Type: Array of [Filter](API_Filter.md) objects Required: No **MacModificationTaskId.N** The ID of task. Type: Array of strings Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results can be seen by sending another request with the returned `nextToken` value. This value can be between 5 and 500. If `maxResults` is given a larger value than 500, you receive an error. Type: Integer Valid Range: Minimum value of 1. Maximum value of 500. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **macModificationTaskSet** Information about the tasks. Type: Array of [MacModificationTask](API_MacModificationTask.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeMacModificationTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeMacModificationTasks) # DescribeManagedPrefixLists Describes your managed prefix lists and any AWS-managed prefix lists. To view the entries for your prefix list, use [GetManagedPrefixListEntries](API_GetManagedPrefixListEntries.md). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `owner-id` - The ID of the prefix list owner. + `prefix-list-id` - The ID of the prefix list. + `prefix-list-name` - The name of the prefix list. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PrefixListId.N** One or more prefix list IDs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **prefixListSet** Information about the prefix lists. Type: Array of [ManagedPrefixList](API_ManagedPrefixList.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes managed prefix lists and filters by the prefix lists owned by account `123456789012`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeManagedPrefixList &Filter.1.Name=owner-id &Filter.1.Value.1=123456789012 &AUTHPARAMS ``` #### Sample Response ``` ace27020-4268-4c9c-a8d3-example IPv4 10 123456789012 arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123aabb pl-0123123123123aabb tgw-attachments create-complete Purpose For TGW-1a attachments 1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeManagedPrefixLists) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeManagedPrefixLists) # DescribeMovingAddresses **Note** This action is deprecated. Describes your Elastic IP addresses that are being moved from or being restored to the EC2-Classic platform. This request does not return information about any other Elastic IP addresses in your account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `moving-status` - The status of the Elastic IP address (`MovingToVpc` \$1 `RestoringToClassic`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned `NextToken` value. This value can be between 5 and 1000; if `MaxResults` is given a value outside of this range, an error is returned. Default: If no value is provided, the default is 1000. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PublicIp.N** One or more Elastic IP addresses. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **movingAddressStatusSet** The status for each Elastic IP address. Type: Array of [MovingAddressStatus](API_MovingAddressStatus.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeMovingAddresses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeMovingAddresses) # DescribeNatGateways Describes your NAT gateways. The default is to describe all your NAT gateways. Alternatively, you can specify specific NAT gateway IDs or filter the results to include only the NAT gateways that match specific criteria. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `nat-gateway-id` - The ID of the NAT gateway. + `state` - The state of the NAT gateway (`pending` \$1 `failed` \$1 `available` \$1 `deleting` \$1 `deleted`). + `subnet-id` - The ID of the subnet in which the NAT gateway resides. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC in which the NAT gateway resides. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NatGatewayId.N** The IDs of the NAT gateways. Type: Array of strings Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **natGatewaySet** Information about the NAT gateways. Type: Array of [NatGateway](API_NatGateway.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your NAT gateways. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeNatGateways &AUTHPARAMS ``` #### Sample Response ``` fcb1ea98-1c04-4f9f-a96d-61442example 2017-02-22T09:30:33.000Z eipalloc-8f409cb1 eni-1c8fa2fc 10.0.0.174 203.0.113.5 nat-05a4fd8a2a3e2574d available subnet-7b16de0c Name MyNatGateway vpc-1a2b3c4d ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNatGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNatGateways) # DescribeNetworkAcls Describes your network ACLs. The default is to describe all your network ACLs. Alternatively, you can specify specific network ACL IDs or filter the results to include only the network ACLs that match specific criteria. For more information, see [Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `association.association-id` - The ID of an association ID for the ACL. + `association.network-acl-id` - The ID of the network ACL involved in the association. + `association.subnet-id` - The ID of the subnet involved in the association. + `default` - Indicates whether the ACL is the default network ACL for the VPC. + `entry.cidr` - The IPv4 CIDR range specified in the entry. + `entry.icmp.code` - The ICMP code specified in the entry, if any. + `entry.icmp.type` - The ICMP type specified in the entry, if any. + `entry.ipv6-cidr` - The IPv6 CIDR range specified in the entry. + `entry.port-range.from` - The start of the port range specified in the entry. + `entry.port-range.to` - The end of the port range specified in the entry. + `entry.protocol` - The protocol specified in the entry (`tcp` \$1 `udp` \$1 `icmp` or a protocol number). + `entry.rule-action` - Allows or denies the matching traffic (`allow` \$1 `deny`). + `entry.egress` - A Boolean that indicates the type of rule. Specify `true` for egress rules, or `false` for ingress rules. + `entry.rule-number` - The number of an entry (in other words, rule) in the set of ACL entries. + `network-acl-id` - The ID of the network ACL. + `owner-id` - The ID of the AWS account that owns the network ACL. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC for the network ACL. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NetworkAclId.N** The IDs of the network ACLs. Type: Array of strings Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **networkAclSet** Information about the network ACLs. Type: Array of [NetworkAcl](API_NetworkAcl.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all your network ACLs. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeNetworkAcls &AUTHPARAMS ``` #### Sample Response ``` be8171a0-2b2a-4a02-8b13-9c3436f2f02d acl-0ea1f54ca7EXAMPLE vpc-06e4ab6c6cEXAMPLE 111122223333 true 100 -1 allow true 0.0.0.0/0 32767 -1 deny true 0.0.0.0/0 100 -1 allow false 0.0.0.0/0 32767 -1 deny false 0.0.0.0/0 aclassoc-0c1679dc41EXAMPLE acl-0ea1f54ca7EXAMPLE subnet-0931fc2fa5EXAMPLE acl-09a47ac966EXAMPLE vpc-06b7830650EXAMPLE 111122223333 true 100 -1 allow true 0.0.0.0/0 32767 -1 deny true 0.0.0.0/0 100 -1 allow false 0.0.0.0/0 32767 -1 deny false 0.0.0.0/0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkAcls) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkAcls) # DescribeNetworkInsightsAccessScopeAnalyses Describes the specified Network Access Scope analyses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AnalysisStartTimeBegin** Filters the results based on the start time. The analysis must have started on or after this time. Type: Timestamp Required: No **AnalysisStartTimeEnd** Filters the results based on the start time. The analysis must have started on or before this time. Type: Timestamp Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** There are no supported filters. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NetworkInsightsAccessScopeAnalysisId.N** The IDs of the Network Access Scope analyses. Type: Array of strings Required: No **NetworkInsightsAccessScopeId** The ID of the Network Access Scope. Type: String Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **networkInsightsAccessScopeAnalysisSet** The Network Access Scope analyses. Type: Array of [NetworkInsightsAccessScopeAnalysis](API_NetworkInsightsAccessScopeAnalysis.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopeAnalyses) # DescribeNetworkInsightsAccessScopes Describes the specified Network Access Scopes. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** There are no supported filters. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NetworkInsightsAccessScopeId.N** The IDs of the Network Access Scopes. Type: Array of strings Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **networkInsightsAccessScopeSet** The Network Access Scopes. Type: Array of [NetworkInsightsAccessScope](API_NetworkInsightsAccessScope.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkInsightsAccessScopes) # DescribeNetworkInsightsAnalyses Describes one or more of your network insights analyses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AnalysisEndTime** The time when the network insights analyses ended. Type: Timestamp Required: No **AnalysisStartTime** The time when the network insights analyses started. Type: Timestamp Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. The following are the possible values: + path-found - A Boolean value that indicates whether a feasible path is found. + status - The status of the analysis (running \$1 succeeded \$1 failed). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NetworkInsightsAnalysisId.N** The ID of the network insights analyses. You must specify either analysis IDs or a path ID. Type: Array of strings Required: No **NetworkInsightsPathId** The ID of the path. You must specify either a path ID or analysis IDs. Type: String Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **networkInsightsAnalysisSet** Information about the network insights analyses. Type: Array of [NetworkInsightsAnalysis](API_NetworkInsightsAnalysis.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkInsightsAnalyses) # DescribeNetworkInsightsPaths Describes one or more of your paths. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. The following are the possible values: + destination - The ID of the resource. + filter-at-source.source-address - The source IPv4 address at the source. + filter-at-source.source-port-range - The source port range at the source. + filter-at-source.destination-address - The destination IPv4 address at the source. + filter-at-source.destination-port-range - The destination port range at the source. + filter-at-destination.source-address - The source IPv4 address at the destination. + filter-at-destination.source-port-range - The source port range at the destination. + filter-at-destination.destination-address - The destination IPv4 address at the destination. + filter-at-destination.destination-port-range - The destination port range at the destination. + protocol - The protocol. + source - The ID of the resource. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NetworkInsightsPathId.N** The IDs of the paths. Type: Array of strings Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **networkInsightsPathSet** Information about the paths. Type: Array of [NetworkInsightsPath](API_NetworkInsightsPath.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkInsightsPaths) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkInsightsPaths) # DescribeNetworkInterfaceAttribute Describes a network interface attribute. You can specify only one attribute at a time. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The attribute of the network interface. This parameter is required. Type: String Valid Values: `description | groupSet | sourceDestCheck | attachment | associatePublicIpAddress` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associatePublicIpAddress** Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0). Type: Boolean **attachment** The attachment (if any) of the network interface. Type: [NetworkInterfaceAttachment](API_NetworkInterfaceAttachment.md) object **description** The description of the network interface. Type: [AttributeValue](API_AttributeValue.md) object **groupSet** The security groups associated with the network interface. Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects **networkInterfaceId** The ID of the network interface. Type: String **requestId** The ID of the request. Type: String **sourceDestCheck** Indicates whether source/destination checking is enabled. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the `sourceDestCheck` attribute of the specified network interface. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaceAttribute &NetworkInterfaceId=eni-686ea200 &Attribute=sourceDestCheck &AUTHPARAMS ``` #### Sample Response ``` 7a20c6b2-d71c-45fb-bba7-37306850544b eni-686ea200 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkInterfaceAttribute) # DescribeNetworkInterfacePermissions Describes the permissions for your network interfaces. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** One or more filters. + `network-interface-permission.network-interface-permission-id` - The ID of the permission. + `network-interface-permission.network-interface-id` - The ID of the network interface. + `network-interface-permission.aws-account-id` - The AWS account ID. + `network-interface-permission.aws-service` - The AWS service. + `network-interface-permission.permission` - The type of permission (`INSTANCE-ATTACH` \$1 `EIP-ASSOCIATE`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. If this parameter is not specified, up to 50 results are returned by default. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 255. Required: No **NetworkInterfacePermissionId.N** The network interface permission IDs. Type: Array of strings Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **networkInterfacePermissions** The network interface permissions. Type: Array of [NetworkInterfacePermission](API_NetworkInterfacePermission.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your network interface permissions. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeNetworkInterfacePermissions &AUTHPARAMS ``` #### Sample Response ``` 6d4fe5e1-4bd2-4e76-8980-04cexample 123456789012 eni-b909511a eni-perm-06fd19020ede149ea INSTANCE-ATTACH GRANTED ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkInterfacePermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkInterfacePermissions) # DescribeNetworkInterfaces Describes the specified network interfaces or all your network interfaces. If you have a large number of network interfaces, the operation fails unless you use pagination or one of the following filters: `group-id`, `mac-address`, `private-dns-name`, `private-ip-address`, `subnet-id`, or `vpc-id`. **Important** We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `association.allocation-id` - The allocation ID returned when you allocated the Elastic IP address (IPv4) for your network interface. + `association.association-id` - The association ID returned when the network interface was associated with an IPv4 address. + `addresses.association.owner-id` - The owner ID of the addresses associated with the network interface. + `addresses.association.public-ip` - The association ID returned when the network interface was associated with the Elastic IP address (IPv4). + `addresses.primary` - Whether the private IPv4 address is the primary IP address associated with the network interface. + `addresses.private-ip-address` - The private IPv4 addresses associated with the network interface. + `association.ip-owner-id` - The owner of the Elastic IP address (IPv4) associated with the network interface. + `association.public-ip` - The address of the Elastic IP address (IPv4) bound to the network interface. + `association.public-dns-name` - The public DNS name for the network interface (IPv4). + `attachment.attach-time` - The time that the network interface was attached to an instance. + `attachment.attachment-id` - The ID of the interface attachment. + `attachment.delete-on-termination` - Indicates whether the attachment is deleted when an instance is terminated. + `attachment.device-index` - The device index to which the network interface is attached. + `attachment.instance-id` - The ID of the instance to which the network interface is attached. + `attachment.instance-owner-id` - The owner ID of the instance to which the network interface is attached. + `attachment.status` - The status of the attachment (`attaching` \$1 `attached` \$1 `detaching` \$1 `detached`). + `availability-zone` - The Availability Zone of the network interface. + `availability-zone-id` - The ID of the Availability Zone of the network interface. + `description` - The description of the network interface. + `group-id` - The ID of a security group associated with the network interface. + `ipv6-addresses.ipv6-address` - An IPv6 address associated with the network interface. + `interface-type` - The type of network interface (`api_gateway_managed` \$1 `aws_codestar_connections_managed` \$1 `branch` \$1 `ec2_instance_connect_endpoint` \$1 `efa` \$1 `efa-only` \$1 `efs` \$1 `evs` \$1 `gateway_load_balancer` \$1 `gateway_load_balancer_endpoint` \$1 `global_accelerator_managed` \$1 `interface` \$1 `iot_rules_managed` \$1 `lambda` \$1 `load_balancer` \$1 `nat_gateway` \$1 `network_load_balancer` \$1 `quicksight` \$1 `transit_gateway` \$1 `trunk` \$1 `vpc_endpoint`). + `mac-address` - The MAC address of the network interface. + `network-interface-id` - The ID of the network interface. + `operator.managed` - A Boolean that indicates whether this is a managed network interface. + `operator.principal` - The principal that manages the network interface. Only valid for managed network interfaces, where `managed` is `true`. + `owner-id` - The AWS account ID of the network interface owner. + `private-dns-name` - The private DNS name of the network interface (IPv4). + `private-ip-address` - The private IPv4 address or addresses of the network interface. + `requester-id` - The alias or AWS account ID of the principal or service that created the network interface. + `requester-managed` - Indicates whether the network interface is being managed by an AWS service (for example, AWS Management Console, Auto Scaling, and so on). + `source-dest-check` - Indicates whether the network interface performs source/destination checking. A value of `true` means checking is enabled, and `false` means checking is disabled. The value must be `false` for the network interface to perform network address translation (NAT) in your VPC. + `status` - The status of the network interface. If the network interface is not attached to an instance, the status is `available`; if a network interface is attached to an instance the status is `in-use`. + `subnet-id` - The ID of the subnet for the network interface. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC for the network interface. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. You cannot specify this parameter and the network interface IDs parameter in the same request. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NetworkInterfaceId.N** The network interface IDs. Default: Describes all your network interfaces. Type: Array of strings Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **networkInterfaceSet** Information about the network interfaces. Type: Array of [NetworkInterface](API_NetworkInterface.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes all your network interfaces. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaces &AUTHPARAMS ``` #### Sample Response ``` fc45294c-006b-457b-bab9-012f5b3b0e40 eni-0f62d866 subnet-c53c87ac vpc-cc3c87a5 api-southeast-1b 053230519467 false in-use 02:81:60:cb:27:37 10.0.0.146 true sg-3f4b5653 default eni-attach-6537fc0c i-1234567890abcdef0 053230519467 0 attached 2012-07-01T21:45:27.000Z true 10.0.0.146 true 10.0.0.148 false 10.0.0.150 false eni-a66ed5cf subnet-cd8a35a4 vpc-f28a359b ap-southeast-1b Primary network interface 053230519467 false in-use 02:78:d7:00:8a:1e 10.0.1.233 true sg-a2a0b2ce quick-start-1 eni-attach-a99c57c0 i-0598c7d356eba48d7 053230519467 0 attached 2012-06-27T20:08:44.000Z true 10.0.1.233 true 10.0.1.20 false 2001:db8:1234:1a00::123 2001:db8:1234:1a00::456 ``` ### Example 2 This example uses a filter to describe only network interfaces that are in Availability Zone `us-east-2a`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeNetworkInterfaces &Filter.1.Name=availability-zone &Filter.1.Value.1=us-east-2a &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeNetworkInterfaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeNetworkInterfaces) # DescribeOutpostLags Describes the Outposts link aggregation groups (LAGs). **Note** LAGs are only available for second-generation Outposts racks at this time. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters to use for narrowing down the request. The following filters are supported: + `service-link-virtual-interface-id` - The ID of the service link virtual interface. + `service-link-virtual-interface-arn` - The ARN of the service link virtual interface. + `outpost-id` - The Outpost ID. + `outpost-arn` - The Outpost ARN. + `owner-id` - The ID of the AWS account that owns the service link virtual interface. + `vlan` - The ID of the address pool. + `local-address` - The local address. + `peer-address` - The peer address. + `peer-bgp-asn` - The peer BGP ASN. + `outpost-lag-id` - The Outpost LAG ID. + `configuration-state` - The configuration state of the service link virtual interface. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **OutpostLagId.N** The IDs of the Outpost LAGs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **outpostLagSet** The Outpost LAGs. Type: Array of [OutpostLag](API_OutpostLag.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeOutpostLags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeOutpostLags) # DescribePlacementGroups Describes the specified placement groups or all of your placement groups. **Note** To describe a specific placement group that is *shared* with your account, you must specify the ID of the placement group using the `GroupId` parameter. Specifying the name of a *shared* placement group using the `GroupNames` parameter will result in an error. For more information, see [Placement groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `group-name` - The name of the placement group. + `group-arn` - The Amazon Resource Name (ARN) of the placement group. + `spread-level` - The spread level for the placement group (`host` \$1 `rack`). + `state` - The state of the placement group (`pending` \$1 `available` \$1 `deleting` \$1 `deleted`). + `strategy` - The strategy of the placement group (`cluster` \$1 `spread` \$1 `partition`). + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **GroupId.N** The IDs of the placement groups. Type: Array of strings Required: No **GroupName.N** The names of the placement groups. Constraints: + You can specify a name only if the placement group is owned by your account. + If a placement group is *shared* with your account, specifying the name results in an error. You must use the `GroupId` parameter instead. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **placementGroupSet** Information about the placement groups. Type: Array of [PlacementGroup](API_PlacementGroup.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the placement group named `ABC-spread`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribePlacementGroups &GroupName.1=ABC-spread &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE ABC-spread rack spread available ``` ### Example 2 This example filters the response to include only placement groups that include the string `Project` in the name. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribePlacementGroups &Filter.1.Name=group-name &Filter.1.Value=*Project* &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE Project-cluster cluster available ``` ### Example 3 This example describes the partition placement group named `HDSF-Group-A` with three partitions. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribePlacementGroups &GroupName.1=HDSF-Group-A &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE HDSF-Group-A partition 3 available ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribePlacementGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribePlacementGroups) # DescribePrefixLists Describes available AWS services in a prefix list format, which includes the prefix list name and prefix list ID of the service and the IP address range for the service. We recommend that you use [DescribeManagedPrefixLists](API_DescribeManagedPrefixLists.md) instead. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `prefix-list-id`: The ID of a prefix list. + `prefix-list-name`: The name of a prefix list. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Required: No **NextToken** The token for the next page of results. Type: String Required: No **PrefixListId.N** One or more prefix list IDs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **prefixListSet** All available prefix lists. Type: Array of [PrefixList](API_PrefixList.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example lists all available AWS prefix lists. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribePrefixLists &AUTHPARAMS ``` #### Sample Response ``` com.amazonaws.us-west-2.s3 pl-12345678 54.123.456.7/19 614db4d4-ac7b-4cb6-853e-example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribePrefixLists) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribePrefixLists) # DescribePrincipalIdFormat Describes the ID format settings for the root user and all IAM roles and IAM users that have explicitly specified a longer ID (17-character ID) preference. By default, all IAM roles and IAM users default to the same ID settings as the root user, unless they explicitly override the settings. This request is useful for identifying those IAM users and IAM roles that have overridden the default ID settings. The following resource types support longer IDs: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to request the next page of results. Type: String Required: No **Resource.N** The type of resource: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `instance` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `reservation` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `snapshot` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `volume` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway` Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String **principalSet** Information about the ID format settings for the ARN. Type: Array of [PrincipalIdFormat](API_PrincipalIdFormat.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the ID format for the root user and all IAM roles and IAM users that have explicitly specified a longer ID preference. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribePrincipalIdFormat &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE arn:aws:iam::123456789012:root 2016-12-15T12:00:00.000Z reservation true 2016-12-15T12:00:00.000Z instance true 2016-12-15T12:00:00.000Z volume true 2016-12-15T12:00:00.000Z snapshot true network-interface-attachment true network-interface true elastic-ip-allocation true elastic-ip-association true vpc true subnet true route-table true route-table-association true network-acl true network-acl-association true dhcp-options true internet-gateway true vpc-cidr-block-association true vpc-ipv6-cidr-block-association true subnet-ipv6-cidr-block-association true vpc-peering-connection true security-group true flow-log true customer-gateway true vpc-endpoint true vpn-connection true vpn-gateway true arn:aws:iam::987654321000:user/user1 2016-12-15T12:00:00.000Z reservation true 2016-12-15T12:00:00.000Z instance true 2016-12-15T12:00:00.000Z volume true 2016-12-15T12:00:00.000Z snapshot true network-interface-attachment true network-interface true elastic-ip-allocation true elastic-ip-association true vpc false subnet true route-table true route-table-association true network-acl true network-acl-association true dhcp-options true internet-gateway true vpc-cidr-block-association true vpc-ipv6-cidr-block-association true subnet-ipv6-cidr-block-association true vpc-peering-connection true security-group true flow-log true customer-gateway true vpc-endpoint true vpn-connection true vpn-gateway true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribePrincipalIdFormat) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribePrincipalIdFormat) # DescribePublicIpv4Pools Describes the specified IPv4 address pools. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** One or more filters. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PoolId.N** The IDs of the address pools. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **publicIpv4PoolSet** Information about the address pools. Type: Array of [PublicIpv4Pool](API_PublicIpv4Pool.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribePublicIpv4Pools) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribePublicIpv4Pools) # DescribeRegions Describes the Regions that are enabled for your account, or all Regions. For a list of the Regions supported by Amazon EC2, see [Amazon EC2 service endpoints](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-endpoints.html). For information about enabling and disabling Regions for your account, see [Specify which AWS Regions your account can use](https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html) in the * AWS Account Management Reference Guide*. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllRegions** Indicates whether to display all Regions, including Regions that are disabled for your account. Type: Boolean Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `endpoint` - The endpoint of the Region (for example, `ec2.us-east-1.amazonaws.com`). + `opt-in-status` - The opt-in status of the Region (`opt-in-not-required` \$1 `opted-in` \$1 `not-opted-in`). + `region-name` - The name of the Region (for example, `us-east-1`). Type: Array of [Filter](API_Filter.md) objects Required: No **RegionName.N** The names of the Regions. You can specify any Regions, whether they are enabled and disabled for your account. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **regionInfo** Information about the Regions. Type: Array of [Region](API_Region.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example displays information about all Regions enabled for your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeRegions &AUTHPARAMS ``` ### Example 2 This example displays information about all Regions, even the Regions that are disabled for your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeRegions &AllRegions=true &AUTHPARAMS ``` ### Example 3 This example displays information about the specified Regions only. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeRegions &RegionName.1=us-east-1 &RegionName.2=eu-west-1 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE us-east-1 ec2.us-east-1.amazonaws.com opt-in-not-required United States of America eu-west-1 ec2.eu-west-1.amazonaws.com opt-in-not-required Ireland ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeRegions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeRegions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeRegions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeRegions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeRegions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeRegions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeRegions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeRegions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeRegions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeRegions) # DescribeReplaceRootVolumeTasks Describes a root volume replacement task. For more information, see [Replace a root volume](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/replace-root.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Filter to use: + `instance-id` - The ID of the instance for which the root volume replacement task was created. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **ReplaceRootVolumeTaskId.N** The ID of the root volume replacement task to view. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **replaceRootVolumeTaskSet** Information about the root volume replacement task. Type: Array of [ReplaceRootVolumeTask](API_ReplaceRootVolumeTask.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeReplaceRootVolumeTasks) # DescribeReservedInstances Describes one or more of the Reserved Instances that you purchased. For more information about Reserved Instances, see [Reserved Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html) in the *Amazon EC2 User Guide*. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `availability-zone` - The Availability Zone where the Reserved Instance can be used. + `availability-zone-id` - The ID of the Availability Zone where the Reserved Instance can be used. + `duration` - The duration of the Reserved Instance (one year or three years), in seconds (`31536000` \$1 `94608000`). + `end` - The time when the Reserved Instance expires (for example, 2015-08-07T11:54:42.000Z). + `fixed-price` - The purchase price of the Reserved Instance (for example, 9800.0). + `instance-type` - The instance type that is covered by the reservation. + `scope` - The scope of the Reserved Instance (`Region` or `Availability Zone`). + `product-description` - The Reserved Instance product platform description (`Linux/UNIX` \$1 `Linux with SQL Server Standard` \$1 `Linux with SQL Server Web` \$1 `Linux with SQL Server Enterprise` \$1 `SUSE Linux` \$1 `Red Hat Enterprise Linux` \$1 `Red Hat Enterprise Linux with HA` \$1 `Windows` \$1 `Windows with SQL Server Standard` \$1 `Windows with SQL Server Web` \$1 `Windows with SQL Server Enterprise`). + `reserved-instances-id` - The ID of the Reserved Instance. + `start` - The time at which the Reserved Instance purchase request was placed (for example, 2014-08-07T11:54:42.000Z). + `state` - The state of the Reserved Instance (`payment-pending` \$1 `active` \$1 `payment-failed` \$1 `retired`). + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `usage-price` - The usage price of the Reserved Instance, per hour (for example, 0.84). Type: Array of [Filter](API_Filter.md) objects Required: No **OfferingClass** Describes whether the Reserved Instance is Standard or Convertible. Type: String Valid Values: `standard | convertible` Required: No **OfferingType** The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the `Medium Utilization` Reserved Instance offering type. Type: String Valid Values: `Heavy Utilization | Medium Utilization | Light Utilization | No Upfront | Partial Upfront | All Upfront` Required: No **ReservedInstancesId.N** One or more Reserved Instance IDs. Default: Describes all your Reserved Instances, or only those otherwise specified. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **reservedInstancesSet** A list of Reserved Instances. Type: Array of [ReservedInstances](API_ReservedInstances.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes Reserved Instances owned by your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstances &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ... e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE m1.xlarge us-east-1b 2015-07-14T11:00:00:00.000Z 2016-07-13T1212:00:00:000Z 31536000 0.0 0.034 2 Linux/UNIX (Amazon VPC) active default USD Partial Upfront Hourly 0.05 standard AvailabilityZone ... ``` ### Example This example filters the response to include only one-year, `m1.small` Linux/UNIX Reserved Instances. If you want Linux/UNIX Reserved Instances specifically for use with a VPC, set the product description to `Linux/UNIX (Amazon VPC)`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstances &Filter.1.Name=duration &Filter.1.Value.1=31536000 &Filter.2.Name=instance-type &Filter.2.Value.1=m1.small &Filter.3.Name=product-description &Filter.3.Value.1=Linux%2FUNIX &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeReservedInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeReservedInstances) # DescribeReservedInstancesListings Describes your account's Reserved Instance listings in the Reserved Instance Marketplace. The Reserved Instance Marketplace matches sellers who want to resell Reserved Instance capacity that they no longer need with buyers who want to purchase additional capacity. Reserved Instances bought and sold through the Reserved Instance Marketplace work like any other Reserved Instances. As a seller, you choose to list some or all of your Reserved Instances, and you specify the upfront price to receive for them. Your Reserved Instances are then listed in the Reserved Instance Marketplace and are available for purchase. As a buyer, you specify the configuration of the Reserved Instance to purchase, and the Marketplace matches what you're searching for with what's available. The Marketplace first sells the lowest priced Reserved Instances to you, and continues to sell available Reserved Instance listings to you until your demand is met. You are charged based on the total price of all of the listings that you purchase. For more information, see [Sell in the Reserved Instance Marketplace](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in the *Amazon EC2 User Guide*. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** One or more filters. + `reserved-instances-id` - The ID of the Reserved Instances. + `reserved-instances-listing-id` - The ID of the Reserved Instances listing. + `status` - The status of the Reserved Instance listing (`pending` \$1 `active` \$1 `cancelled` \$1 `closed`). + `status-message` - The reason for the status. Type: Array of [Filter](API_Filter.md) objects Required: No **ReservedInstancesId** One or more Reserved Instance IDs. Type: String Required: No **ReservedInstancesListingId** One or more Reserved Instance listing IDs. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **reservedInstancesListingsSet** Information about the Reserved Instance listing. Type: Array of [ReservedInstancesListing](API_ReservedInstancesListing.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example shows all the listings associated with your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstancesListings &AUTHPARAMS ``` #### Sample Response ``` cec5c904-8f3a-4de5-8f5a-ff7f9EXAMPLE 253dfbf9-c335-4808-b956-d942cEXAMPLE e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE 2012-07-06T19:35:29.000Z 2012-07-06T19:35:30.000Z active ACTIVE Available 20 Sold 0 Cancelled 0 Pending 0 8 480.0 USD false 7 420.0 USD false 6 360.0 USD active 5 300.0 USD false 4 240.0 USD false 3 180.0 USD false 2 120.0 USD false 1 60.0 USD false myclienttoken1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeReservedInstancesListings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeReservedInstancesListings) # DescribeReservedInstancesModifications Describes the modifications made to your Reserved Instances. If no parameter is specified, information about all your Reserved Instances modification requests is returned. If a modification ID is specified, only information about the specific modification is returned. For more information, see [Modify Reserved Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) in the *Amazon EC2 User Guide*. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Filter.N** One or more filters. + `client-token` - The idempotency token for the modification request. + `create-date` - The time when the modification request was created. + `effective-date` - The time when the modification becomes effective. + `modification-result.reserved-instances-id` - The ID for the Reserved Instances created as part of the modification request. This ID is only available when the status of the modification is `fulfilled`. + `modification-result.target-configuration.availability-zone` - The Availability Zone for the new Reserved Instances. + `modification-result.target-configuration.availability-zone-id` - The ID of the Availability Zone for the new Reserved Instances. + `modification-result.target-configuration.instance-count ` - The number of new Reserved Instances. + `modification-result.target-configuration.instance-type` - The instance type of the new Reserved Instances. + `reserved-instances-id` - The ID of the Reserved Instances modified. + `reserved-instances-modification-id` - The ID of the modification request. + `status` - The status of the Reserved Instances modification request (`processing` \$1 `fulfilled` \$1 `failed`). + `status-message` - The reason for the status. + `update-date` - The time when the modification request was last updated. Type: Array of [Filter](API_Filter.md) objects Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No **ReservedInstancesModificationId.N** IDs for the submitted modification request. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **reservedInstancesModificationsSet** The Reserved Instance modification information. Type: Array of [ReservedInstancesModification](API_ReservedInstancesModification.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example illustrates one usage of DescribeReservedInstancesModifications. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstancesModifications &AUTHPARAMS ``` ### Example 2 This example filters the response to include only Reserved Instances modification requests with status `processing`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstancesModifications &Filter.1.Name=status &Filter.1.Value.1=processing &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeReservedInstancesModifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeReservedInstancesModifications) # DescribeReservedInstancesOfferings Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used. If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances. For more information, see [Sell in the Reserved Instance Marketplace](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in the *Amazon EC2 User Guide*. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** The Availability Zone in which the Reserved Instance can be used. Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both. Type: String Required: No **AvailabilityZoneId** The ID of the Availability Zone. Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `availability-zone` - The Availability Zone where the Reserved Instance can be used. + `availability-zone-id` - The ID of the Availability Zone where the Reserved Instance can be used. + `duration` - The duration of the Reserved Instance (for example, one year or three years), in seconds (`31536000` \$1 `94608000`). + `fixed-price` - The purchase price of the Reserved Instance (for example, 9800.0). + `instance-type` - The instance type that is covered by the reservation. + `marketplace` - Set to `true` to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both AWS and the Reserved Instance Marketplace are listed. + `product-description` - The Reserved Instance product platform description (`Linux/UNIX` \$1 `Linux with SQL Server Standard` \$1 `Linux with SQL Server Web` \$1 `Linux with SQL Server Enterprise` \$1 `SUSE Linux` \$1 `Red Hat Enterprise Linux` \$1 `Red Hat Enterprise Linux with HA` \$1 `Windows` \$1 `Windows with SQL Server Standard` \$1 `Windows with SQL Server Web` \$1 `Windows with SQL Server Enterprise`). + `reserved-instances-offering-id` - The Reserved Instances offering ID. + `scope` - The scope of the Reserved Instance (`Availability Zone` or `Region`). + `usage-price` - The usage price of the Reserved Instance, per hour (for example, 0.84). Type: Array of [Filter](API_Filter.md) objects Required: No **IncludeMarketplace** Include Reserved Instance Marketplace offerings in the response. Type: Boolean Required: No **InstanceTenancy** The tenancy of the instances covered by the reservation. A Reserved Instance with a tenancy of `dedicated` is applied to instances that run in a VPC on single-tenant hardware (i.e., Dedicated Instances). **Important:** The `host` value cannot be used with this parameter. Use the `default` or `dedicated` values only. Default: `default` Type: String Valid Values: `default | dedicated | host` Required: No **InstanceType** The instance type that the reservation will cover (for example, `m1.small`). For more information, see [Amazon EC2 instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c5n.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6g.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.metal | c6gn.medium | c6gn.large | c6gn.xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.12xlarge | c6gn.16xlarge | c6i.large | c6i.xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.32xlarge | c6i.metal | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d3.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3en.xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.12xlarge | dl1.24xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4ad.xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.16xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.48xlarge | g5g.xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.16xlarge | g5g.metal | hi1.4xlarge | hpc6a.48xlarge | hs1.8xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | im4gn.large | im4gn.xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.16xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | is4gen.medium | is4gen.large | is4gen.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.metal | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.metal | m5zn.large | m5zn.xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.12xlarge | m5zn.metal | m6a.large | m6a.xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.32xlarge | m6a.48xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge | m6i.large | m6i.xlarge | m6i.2xlarge | m6i.4xlarge | m6i.8xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.32xlarge | m6i.metal | mac1.metal | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | p4d.24xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5b.large | r5b.xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.metal | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.metal | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6g.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.metal | r6i.large | r6i.xlarge | r6i.2xlarge | r6i.4xlarge | r6i.8xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.32xlarge | r6i.metal | t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | u-6tb1.56xlarge | u-6tb1.112xlarge | u-9tb1.112xlarge | u-12tb1.112xlarge | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | vt1.3xlarge | vt1.6xlarge | vt1.24xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.12xlarge | x2iezn.metal | x2gd.medium | x2gd.large | x2gd.xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.metal | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2iedn.xlarge | x2iedn.2xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.32xlarge | c6a.large | c6a.xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.32xlarge | c6a.48xlarge | c6a.metal | m6a.metal | i4i.large | i4i.xlarge | i4i.2xlarge | i4i.4xlarge | i4i.8xlarge | i4i.16xlarge | i4i.32xlarge | i4i.metal | x2idn.metal | x2iedn.metal | c7g.medium | c7g.large | c7g.xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.12xlarge | c7g.16xlarge | mac2.metal | c6id.large | c6id.xlarge | c6id.2xlarge | c6id.4xlarge | c6id.8xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.32xlarge | c6id.metal | m6id.large | m6id.xlarge | m6id.2xlarge | m6id.4xlarge | m6id.8xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.32xlarge | m6id.metal | r6id.large | r6id.xlarge | r6id.2xlarge | r6id.4xlarge | r6id.8xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.32xlarge | r6id.metal | r6a.large | r6a.xlarge | r6a.2xlarge | r6a.4xlarge | r6a.8xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.32xlarge | r6a.48xlarge | r6a.metal | p4de.24xlarge | u-3tb1.56xlarge | u-18tb1.112xlarge | u-24tb1.112xlarge | trn1.2xlarge | trn1.32xlarge | hpc6id.32xlarge | c6in.large | c6in.xlarge | c6in.2xlarge | c6in.4xlarge | c6in.8xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.32xlarge | m6in.large | m6in.xlarge | m6in.2xlarge | m6in.4xlarge | m6in.8xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.32xlarge | m6idn.large | m6idn.xlarge | m6idn.2xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.32xlarge | r6in.large | r6in.xlarge | r6in.2xlarge | r6in.4xlarge | r6in.8xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.32xlarge | r6idn.large | r6idn.xlarge | r6idn.2xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.32xlarge | c7g.metal | m7g.medium | m7g.large | m7g.xlarge | m7g.2xlarge | m7g.4xlarge | m7g.8xlarge | m7g.12xlarge | m7g.16xlarge | m7g.metal | r7g.medium | r7g.large | r7g.xlarge | r7g.2xlarge | r7g.4xlarge | r7g.8xlarge | r7g.12xlarge | r7g.16xlarge | r7g.metal | c6in.metal | m6in.metal | m6idn.metal | r6in.metal | r6idn.metal | inf2.xlarge | inf2.8xlarge | inf2.24xlarge | inf2.48xlarge | trn1n.32xlarge | i4g.large | i4g.xlarge | i4g.2xlarge | i4g.4xlarge | i4g.8xlarge | i4g.16xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge | c7gn.medium | c7gn.large | c7gn.xlarge | c7gn.2xlarge | c7gn.4xlarge | c7gn.8xlarge | c7gn.12xlarge | c7gn.16xlarge | p5.48xlarge | m7i.large | m7i.xlarge | m7i.2xlarge | m7i.4xlarge | m7i.8xlarge | m7i.12xlarge | m7i.16xlarge | m7i.24xlarge | m7i.48xlarge | m7i-flex.large | m7i-flex.xlarge | m7i-flex.2xlarge | m7i-flex.4xlarge | m7i-flex.8xlarge | m7a.medium | m7a.large | m7a.xlarge | m7a.2xlarge | m7a.4xlarge | m7a.8xlarge | m7a.12xlarge | m7a.16xlarge | m7a.24xlarge | m7a.32xlarge | m7a.48xlarge | m7a.metal-48xl | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | c7gd.medium | c7gd.large | c7gd.xlarge | c7gd.2xlarge | c7gd.4xlarge | c7gd.8xlarge | c7gd.12xlarge | c7gd.16xlarge | m7gd.medium | m7gd.large | m7gd.xlarge | m7gd.2xlarge | m7gd.4xlarge | m7gd.8xlarge | m7gd.12xlarge | m7gd.16xlarge | r7gd.medium | r7gd.large | r7gd.xlarge | r7gd.2xlarge | r7gd.4xlarge | r7gd.8xlarge | r7gd.12xlarge | r7gd.16xlarge | r7a.medium | r7a.large | r7a.xlarge | r7a.2xlarge | r7a.4xlarge | r7a.8xlarge | r7a.12xlarge | r7a.16xlarge | r7a.24xlarge | r7a.32xlarge | r7a.48xlarge | c7i.large | c7i.xlarge | c7i.2xlarge | c7i.4xlarge | c7i.8xlarge | c7i.12xlarge | c7i.16xlarge | c7i.24xlarge | c7i.48xlarge | mac2-m2pro.metal | r7iz.large | r7iz.xlarge | r7iz.2xlarge | r7iz.4xlarge | r7iz.8xlarge | r7iz.12xlarge | r7iz.16xlarge | r7iz.32xlarge | c7a.medium | c7a.large | c7a.xlarge | c7a.2xlarge | c7a.4xlarge | c7a.8xlarge | c7a.12xlarge | c7a.16xlarge | c7a.24xlarge | c7a.32xlarge | c7a.48xlarge | c7a.metal-48xl | r7a.metal-48xl | r7i.large | r7i.xlarge | r7i.2xlarge | r7i.4xlarge | r7i.8xlarge | r7i.12xlarge | r7i.16xlarge | r7i.24xlarge | r7i.48xlarge | dl2q.24xlarge | mac2-m2.metal | i4i.12xlarge | i4i.24xlarge | c7i.metal-24xl | c7i.metal-48xl | m7i.metal-24xl | m7i.metal-48xl | r7i.metal-24xl | r7i.metal-48xl | r7iz.metal-16xl | r7iz.metal-32xl | c7gd.metal | m7gd.metal | r7gd.metal | g6.xlarge | g6.2xlarge | g6.4xlarge | g6.8xlarge | g6.12xlarge | g6.16xlarge | g6.24xlarge | g6.48xlarge | gr6.4xlarge | gr6.8xlarge | c7i-flex.large | c7i-flex.xlarge | c7i-flex.2xlarge | c7i-flex.4xlarge | c7i-flex.8xlarge | u7i-12tb.224xlarge | u7in-16tb.224xlarge | u7in-24tb.224xlarge | u7in-32tb.224xlarge | u7ib-12tb.224xlarge | c7gn.metal | r8g.medium | r8g.large | r8g.xlarge | r8g.2xlarge | r8g.4xlarge | r8g.8xlarge | r8g.12xlarge | r8g.16xlarge | r8g.24xlarge | r8g.48xlarge | r8g.metal-24xl | r8g.metal-48xl | mac2-m1ultra.metal | g6e.xlarge | g6e.2xlarge | g6e.4xlarge | g6e.8xlarge | g6e.12xlarge | g6e.16xlarge | g6e.24xlarge | g6e.48xlarge | c8g.medium | c8g.large | c8g.xlarge | c8g.2xlarge | c8g.4xlarge | c8g.8xlarge | c8g.12xlarge | c8g.16xlarge | c8g.24xlarge | c8g.48xlarge | c8g.metal-24xl | c8g.metal-48xl | m8g.medium | m8g.large | m8g.xlarge | m8g.2xlarge | m8g.4xlarge | m8g.8xlarge | m8g.12xlarge | m8g.16xlarge | m8g.24xlarge | m8g.48xlarge | m8g.metal-24xl | m8g.metal-48xl | x8g.medium | x8g.large | x8g.xlarge | x8g.2xlarge | x8g.4xlarge | x8g.8xlarge | x8g.12xlarge | x8g.16xlarge | x8g.24xlarge | x8g.48xlarge | x8g.metal-24xl | x8g.metal-48xl | i7ie.large | i7ie.xlarge | i7ie.2xlarge | i7ie.3xlarge | i7ie.6xlarge | i7ie.12xlarge | i7ie.18xlarge | i7ie.24xlarge | i7ie.48xlarge | i8g.large | i8g.xlarge | i8g.2xlarge | i8g.4xlarge | i8g.8xlarge | i8g.12xlarge | i8g.16xlarge | i8g.24xlarge | i8g.metal-24xl | u7i-6tb.112xlarge | u7i-8tb.112xlarge | u7inh-32tb.480xlarge | p5e.48xlarge | p5en.48xlarge | f2.12xlarge | f2.48xlarge | trn2.48xlarge | c7i-flex.12xlarge | c7i-flex.16xlarge | m7i-flex.12xlarge | m7i-flex.16xlarge | i7ie.metal-24xl | i7ie.metal-48xl | i8g.48xlarge | c8gd.medium | c8gd.large | c8gd.xlarge | c8gd.2xlarge | c8gd.4xlarge | c8gd.8xlarge | c8gd.12xlarge | c8gd.16xlarge | c8gd.24xlarge | c8gd.48xlarge | c8gd.metal-24xl | c8gd.metal-48xl | i7i.large | i7i.xlarge | i7i.2xlarge | i7i.4xlarge | i7i.8xlarge | i7i.12xlarge | i7i.16xlarge | i7i.24xlarge | i7i.48xlarge | i7i.metal-24xl | i7i.metal-48xl | p6-b200.48xlarge | m8gd.medium | m8gd.large | m8gd.xlarge | m8gd.2xlarge | m8gd.4xlarge | m8gd.8xlarge | m8gd.12xlarge | m8gd.16xlarge | m8gd.24xlarge | m8gd.48xlarge | m8gd.metal-24xl | m8gd.metal-48xl | r8gd.medium | r8gd.large | r8gd.xlarge | r8gd.2xlarge | r8gd.4xlarge | r8gd.8xlarge | r8gd.12xlarge | r8gd.16xlarge | r8gd.24xlarge | r8gd.48xlarge | r8gd.metal-24xl | r8gd.metal-48xl | c8gn.medium | c8gn.large | c8gn.xlarge | c8gn.2xlarge | c8gn.4xlarge | c8gn.8xlarge | c8gn.12xlarge | c8gn.16xlarge | c8gn.24xlarge | c8gn.48xlarge | c8gn.metal-24xl | c8gn.metal-48xl | f2.6xlarge | p6e-gb200.36xlarge | g6f.large | g6f.xlarge | g6f.2xlarge | g6f.4xlarge | gr6f.4xlarge | p5.4xlarge | r8i.large | r8i.xlarge | r8i.2xlarge | r8i.4xlarge | r8i.8xlarge | r8i.12xlarge | r8i.16xlarge | r8i.24xlarge | r8i.32xlarge | r8i.48xlarge | r8i.96xlarge | r8i.metal-48xl | r8i.metal-96xl | r8i-flex.large | r8i-flex.xlarge | r8i-flex.2xlarge | r8i-flex.4xlarge | r8i-flex.8xlarge | r8i-flex.12xlarge | r8i-flex.16xlarge` Required: No **MaxDuration** The maximum duration (in seconds) to filter when searching for offerings. Default: 94608000 (3 years) Type: Long Required: No **MaxInstanceCount** The maximum number of instances to filter when searching for offerings. Default: 20 Type: Integer Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned `NextToken` value. The maximum is 100. Default: 100 Type: Integer Required: No **MinDuration** The minimum duration (in seconds) to filter when searching for offerings. Default: 2592000 (1 month) Type: Long Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No **OfferingClass** The offering class of the Reserved Instance. Can be `standard` or `convertible`. Type: String Valid Values: `standard | convertible` Required: No **OfferingType** The Reserved Instance offering type. If you are using tools that predate the 2011-11-01 API version, you only have access to the `Medium Utilization` Reserved Instance offering type. Type: String Valid Values: `Heavy Utilization | Medium Utilization | Light Utilization | No Upfront | Partial Upfront | All Upfront` Required: No **ProductDescription** The Reserved Instance product platform description. Instances that include `(Amazon VPC)` in the description are for use with Amazon VPC. Type: String Valid Values: `Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)` Required: No **ReservedInstancesOfferingId.N** One or more Reserved Instances offering IDs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **reservedInstancesOfferingsSet** A list of Reserved Instances offerings. Type: Array of [ReservedInstancesOffering](API_ReservedInstancesOffering.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example Describing Reserved Instance Marketplace Offerings Only This example requests a list of Linux/UNIX, No Upfront Reserved Instances that are available through the Reserved Instance Marketplace only. When using the Query API, all strings must be URL-encoded. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &Filter.1.Name=marketplace &Filter.1.Value.1=true &IncludeMarketplace=true &OfferingType=No+Upfront &ProductDescription=Linux%2FUNIX &Version=2016-11-15 &AUTHPARAMS ``` #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &AUTHPARAMS ``` #### Sample Response ``` cec5c904-8f3a-4de5-8f5a-ff7f9EXAMPLE 253dfbf9-c335-4808-b956-d942cEXAMPLE e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE 2012-07-06T19:35:29.000Z 2012-07-06T19:35:30.000Z active ACTIVE Available 20 Sold 0 Cancelled 0 Pending 0 8 480.0 USD false 7 420.0 USD false 6 360.0 USD active 5 300.0 USD false 4 240.0 USD false 3 180.0 USD false 2 120.0 USD false 1 60.0 USD false myclienttoken1 ``` ``` 2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE a6ce8269-7b8c-42cd-a7f5-0841cEXAMPLE m3.xlarge us-east-1e 2332800 0.0 0.0 Linux/UNIX default USD No Upfront Hourly 0.19 true 0.0 3 standard Availability Zone 2bc7dafa-dafd-4257-bdf9-c0814EXAMPLE m3.2xlarge us-east-1b 15552000 1.01 0.0 Linux/UNIX default USD No Upfront Hourly 0.38 true 1.01 1 standard Availability Zone ``` ### Example Describing Offerings Only This example lists AWS offerings only. #### Sample Request ``` http://ec2.amazonaws.com/doc/2016-11-15/?Action=DescribeReservedInstancesOfferings &IncludeMarketplace=false &AUTHPARAMS ``` #### Sample Response ``` 2bc7dafa-dafd-4257-b6tf-c0814EXAMPLE a6ce8269-7b8c-42cd-a6y5-0841cEXAMPLE c1.medium us-east-1e 94608000 631.0 0.0 Linux/UNIX default USD Partial Upfront Hourly 0.28 false standard Availability Zone 2bc7dafa-rafd-6t7y-bdf9-c0814EXAMPLE c1.medium us-east-1b 94608000 631.0 0.0 Linux/UNIX default USD Partial Upfront Hourly 0.88 false convertible Availability Zone ``` ### Example Using Tokens to Manage Results You can use pagination support to query the results sequentially and in parts. Specify the maximum number of results that are returned in the response. Then, each paginated response contains a token that can be provided as input to a subsequent DescribeReservedInstancesOfferings call to fetch the next page. (Make sure that you use URL encoding for the token value.) #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &MaxResults=5 &AUTHPARAMS ``` #### Sample Response ``` d072f652-cc57-458c-89e0-e6c02EXAMPLE ... 649fd0c8-7846-46b8-8f84-a6400EXAMPLE c1.medium us-east-1a 94608000 631.0 0.0 Linux/UNIX (Amazon VPC) default USD Partial Upfront >Hourly 0.028 false standard Availability Zone ... h/C8YKPQBHEjW8xKz1827/Zzyb0VqsqkjRo3TqhFYeE= &MaxResults=5 &NextToken=h%2FC8YKPQBHEjW8xKz1827%2FZzyb0VqsqkjRo3TqhFYeE%3D &AUTHPARAMS ``` ### Example Using Filters This example filters the response to include only one-year, `m1.small` or `m1.large` Linux/UNIX Reserved Instances. If you want Linux/UNIX Reserved Instances specifically for use with a VPC, set the product description to `Linux/UNIX (Amazon VPC)`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeReservedInstancesOfferings &Filter.1.Name=duration &Filter.1.Value.1=31536000 &Filter.2.Name=instance-type &Filter.2.Value.1=m1.small &Filter.2.Value.2=m1.large &Filter.3.Name=product-description &Filter.3.Value.1=Linux%2FUNIX &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeReservedInstancesOfferings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeReservedInstancesOfferings) # DescribeRouteServerEndpoints Describes one or more route server endpoints. A route server endpoint is an AWS-managed component inside a subnet that facilitates [BGP (Border Gateway Protocol)](https://en.wikipedia.org/wiki/Border_Gateway_Protocol) connections between your route server and your BGP peers. For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to apply to the describe request. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **RouteServerEndpointId.N** The IDs of the route server endpoints to describe. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **routeServerEndpointSet** Information about the described route server endpoints. Type: Array of [RouteServerEndpoint](API_RouteServerEndpoint.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeRouteServerEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeRouteServerEndpoints) # DescribeRouteServerPeers Describes one or more route server peers. A route server peer is a session between a route server endpoint and the device deployed in AWS (such as a firewall appliance or other network security function running on an EC2 instance). The device must meet these requirements: + Have an elastic network interface in the VPC + Support BGP (Border Gateway Protocol) + Can initiate BGP sessions For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to apply to the describe request. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **RouteServerPeerId.N** The IDs of the route server peers to describe. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **routeServerPeerSet** Information about the described route server peers. Type: Array of [RouteServerPeer](API_RouteServerPeer.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeRouteServerPeers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeRouteServerPeers) # DescribeRouteServers Describes one or more route servers. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: + VPC route tables not associated with subnets + Subnet route tables + Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html). For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to apply to the describe request. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **RouteServerId.N** The IDs of the route servers to describe. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **routeServerSet** Information about the described route servers. Type: Array of [RouteServer](API_RouteServer.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeRouteServers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeRouteServers) # DescribeRouteTables Describes your route tables. The default is to describe all your route tables. Alternatively, you can specify specific route table IDs or filter the results to include only the route tables that match specific criteria. Each subnet in your VPC must be associated with a route table. If a subnet is not explicitly associated with any route table, it is implicitly associated with the main route table. This command does not return the subnet ID for implicit associations. For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `association.gateway-id` - The ID of the gateway involved in the association. + `association.route-table-association-id` - The ID of an association ID for the route table. + `association.route-table-id` - The ID of the route table involved in the association. + `association.subnet-id` - The ID of the subnet involved in the association. + `association.main` - Indicates whether the route table is the main route table for the VPC (`true` \$1 `false`). Route tables that do not have an association ID are not returned in the response. + `owner-id` - The ID of the AWS account that owns the route table. + `route-table-id` - The ID of the route table. + `route.destination-cidr-block` - The IPv4 CIDR range specified in a route in the table. + `route.destination-ipv6-cidr-block` - The IPv6 CIDR range specified in a route in the route table. + `route.destination-prefix-list-id` - The ID (prefix) of the AWS service specified in a route in the table. + `route.egress-only-internet-gateway-id` - The ID of an egress-only Internet gateway specified in a route in the route table. + `route.gateway-id` - The ID of a gateway specified in a route in the table. + `route.instance-id` - The ID of an instance specified in a route in the table. + `route.nat-gateway-id` - The ID of a NAT gateway. + `route.transit-gateway-id` - The ID of a transit gateway. + `route.origin` - Describes how the route was created. `CreateRouteTable` indicates that the route was automatically created when the route table was created; `CreateRoute` indicates that the route was manually added to the route table; `EnableVgwRoutePropagation` indicates that the route was propagated by route propagation. + `route.state` - The state of a route in the route table (`active` \$1 `blackhole`). The blackhole state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, the specified NAT instance has been terminated, and so on). + `route.vpc-peering-connection-id` - The ID of a VPC peering connection specified in a route in the table. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC for the route table. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 100. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **RouteTableId.N** The IDs of the route tables. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **routeTableSet** Information about the route tables. Type: Array of [RouteTable](API_RouteTable.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all your route tables. The first route table in the returned list is the VPC's main route table. Its association ID represents the association between the table and the VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeRouteTables &AUTHPARAMS ``` #### Sample Response ``` fe876446-c8c0-4f2d-a6df-ed506example rtb-1122334455667788a vpc-12345678912345678 111122223333 10.0.1.0/32 igw-012345678901abcdef active CreateRoute 172.31.0.0/16 local active CreateRouteTable 0.0.0.0/0 igw-012345678901abcdef active CreateRoute rtbassoc-04ca27a6914a0b4fc rtb-1122334455667788a

true

``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeRouteTables) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeRouteTables) # DescribeScheduledInstanceAvailability Finds available schedules that meet the specified criteria. You can search for an available schedule no more than 3 months in advance. You must meet the minimum required duration of 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. After you find a schedule that meets your needs, call [PurchaseScheduledInstances](API_PurchaseScheduledInstances.md) to purchase Scheduled Instances with that schedule. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone` - The Availability Zone (for example, `us-west-2a`). + `instance-type` - The instance type (for example, `c4.large`). + `platform` - The platform (`Linux/UNIX` or `Windows`). Type: Array of [Filter](API_Filter.md) objects Required: No **FirstSlotStartTimeRange** The time period for the first schedule to start. Type: [SlotDateTimeRangeRequest](API_SlotDateTimeRangeRequest.md) object Required: Yes **MaxResults** The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 300. To retrieve the remaining results, make another call with the returned `NextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 300. Required: No **MaxSlotDurationInHours** The maximum available duration, in hours. This value must be greater than `MinSlotDurationInHours` and less than 1,720. Type: Integer Required: No **MinSlotDurationInHours** The minimum available duration, in hours. The minimum required duration is 1,200 hours per year. For example, the minimum daily schedule is 4 hours, the minimum weekly schedule is 24 hours, and the minimum monthly schedule is 100 hours. Type: Integer Required: No **NextToken** The token for the next set of results. Type: String Required: No **Recurrence** The schedule recurrence. Type: [ScheduledInstanceRecurrenceRequest](API_ScheduledInstanceRecurrenceRequest.md) object Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token required to retrieve the next set of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **scheduledInstanceAvailabilitySet** Information about the available Scheduled Instances. Type: Array of [ScheduledInstanceAvailability](API_ScheduledInstanceAvailability.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeScheduledInstanceAvailability) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeScheduledInstanceAvailability) # DescribeScheduledInstances Describes the specified Scheduled Instances or all your Scheduled Instances. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone` - The Availability Zone (for example, `us-west-2a`). + `instance-type` - The instance type (for example, `c4.large`). + `platform` - The platform (`Linux/UNIX` or `Windows`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return in a single call. This value can be between 5 and 300. The default value is 100. To retrieve the remaining results, make another call with the returned `NextToken` value. Type: Integer Required: No **NextToken** The token for the next set of results. Type: String Required: No **ScheduledInstanceId.N** The Scheduled Instance IDs. Type: Array of strings Required: No **SlotStartTimeRange** The time period for the first schedule to start. Type: [SlotStartTimeRangeRequest](API_SlotStartTimeRangeRequest.md) object Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token required to retrieve the next set of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **scheduledInstanceSet** Information about the Scheduled Instances. Type: Array of [ScheduledInstance](API_ScheduledInstance.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeScheduledInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeScheduledInstances) # DescribeSecondaryInterfaces Describes one or more of your secondary interfaces. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `attachment.attachment-id` - The ID of the secondary interface attachment. + `attachment.instance-id` - The ID of the instance to which the secondary interface is attached. + `attachment.instance-owner-id` - The ID of the AWS account that owns the instance to which the secondary interface is attached. + `attachment.status` - The attachment status (`attaching` \$1 `attached` \$1 `detaching` \$1 `detached`). + `private-ipv4-addresses.private-ip-address` - The private IPv4 address associated with the secondary interface. + `owner-id` - The ID of the AWS account that owns the secondary interface. + `secondary-interface-arn` - The ARN of the secondary interface. + `secondary-interface-id` - The ID of the secondary interface. + `secondary-interface-type` - The type of secondary interface (`secondary`). + `secondary-network-id` - The ID of the secondary network. + `secondary-network-type` - The type of the secondary network (`rdma`). + `secondary-subnet-id` - The ID of the secondary subnet. + `status` - The status of the secondary interface (`available` \$1 `in-use`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **SecondaryInterfaceId.N** The IDs of the secondary interfaces. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **secondaryInterfaceSet** Information about the secondary interfaces. Type: Array of [SecondaryInterface](API_SecondaryInterface.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes all secondary interfaces in the current Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecondaryInterfaces &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE si-0123456789abcdef0 arn:aws:ec2:us-east-2:123456789012:secondary-interface/si-0123456789abcdef0 123456789012 ss-0123456789abcdef0 sn-0123456789abcdef0 rdma use2-az1 us-east-2a 02:2f:8f:b0:cf:75 true in-use secondary 10.0.1.17 attached 0 1 i-1234567890abcdef0 true si-attach-0123456789abcdef0 123456789012 2026-02-28T23:35:33.000Z Name Prod Secondary Interface ``` ### Example 2 This example uses filters to describe secondary interfaces attached to a specific instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecondaryInterfaces &Filter.1.Name=attachment.instance-id &Filter.1.Value.1=i-1234567890abcdef0 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSecondaryInterfaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSecondaryInterfaces) # DescribeSecondaryNetworks Describes one or more secondary networks. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. The following are the possible values: + `ipv4-cidr-block-association.association-id` - The association ID for an IPv4 CIDR block associated with the secondary network. + `ipv4-cidr-block-association.cidr-block` - An IPv4 CIDR block associated with the secondary network. + `ipv4-cidr-block-association.state` - The state of an IPv4 CIDR block associated with the secondary network. + `owner-id` - The ID of the AWS account that owns the secondary network. + `secondary-network-id` - The ID of the secondary network. + `secondary-network-arn` - The ARN of the secondary network. + `state` - The state of the secondary network (`create-in-progress` \$1 `create-complete` \$1 `create-failed` \$1 `delete-in-progress` \$1 `delete-complete` \$1 `delete-failed`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `type` - The type of the secondary network (`rdma`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **SecondaryNetworkId.N** The IDs of the secondary networks. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **secondaryNetworkSet** Information about the secondary networks. Type: Array of [SecondaryNetwork](API_SecondaryNetwork.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the specified secondary networks. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecondaryNetworks &SecondaryNetworkId.1=sn-0123456789abcdef0 &SecondaryNetworkId.2=sn-0987654321fedcba0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE sn-0123456789abcdef0 arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0123456789abcdef0 123456789012 rdma create-complete sn-cidr-assoc-56789901234abcdef0 10.0.0.0/16 associated Name Prod Secondary Network sn-0987654321fedcba0 arn:aws:ec2:us-east-2:123456789012:secondary-network/sn-0987654321fedcba0 123456789012 rdma create-complete sn-cidr-assoc-09876543210fedcba0 10.1.0.0/16 associated Name Dev Secondary Network ``` ### Example 2 This example uses filters to describe any secondary network you own that has a tag with the key Environment and the value Production and whose state is create-complete. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecondaryNetworks &Filter.1.Name=tag:Environment &Filter.1.Value.1=Production &Filter.2.Name=state &Filter.2.Value.1=create-complete &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSecondaryNetworks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSecondaryNetworks) # DescribeSecondarySubnets Describes one or more of your secondary subnets. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `ipv4-cidr-block-association.association-id` - The association ID for an IPv4 CIDR block associated with the secondary subnet. + `ipv4-cidr-block-association.cidr-block` - An IPv4 CIDR block associated with the secondary subnet. + `ipv4-cidr-block-association.state` - The state of an IPv4 CIDR block associated with the secondary subnet. + `owner-id` - The ID of the AWS account that owns the secondary subnet. + `secondary-network-id` - The ID of the secondary network. + `secondary-network-type` - The type of the secondary network (`rdma`). + `secondary-subnet-id` - The ID of the secondary subnet. + `secondary-subnet-arn` - The ARN of the secondary subnet. + `state` - The state of the secondary subnet (`create-in-progress` \$1 `create-complete` \$1 `create-failed` \$1 `delete-in-progress` \$1 `delete-complete` \$1 `delete-failed`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **SecondarySubnetId.N** The IDs of the secondary subnets. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **secondarySubnetSet** Information about the secondary subnets. Type: Array of [SecondarySubnet](API_SecondarySubnet.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the specified secondary subnets. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecondarySubnets &SecondarySubnetId.1=ss-0123456789abcdef0 &SecondarySubnetId.2=ss-0987654321fedcba0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ss-0123456789abcdef0 arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0123456789abcdef0 sn-0123456789abcdef0 rdma 123456789012 use2-az1 us-east-2a ss-cidr-assoc-56789901234abcdef0 10.0.0.0/24 associated create-complete Name Prod Secondary Subnet ss-0987654321fedcba0 arn:aws:ec2:us-east-2:123456789012:secondary-subnet/ss-0987654321fedcba0 sn-0123456789abcdef0 rdma 123456789012 use2-az1 us-east-2a ss-cidr-assoc-09876543210fedcba0 10.0.1.0/24 associated create-complete Name Dev Secondary Subnet ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSecondarySubnets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSecondarySubnets) # DescribeSecurityGroupReferences Describes the VPCs on the other side of a VPC peering or Transit Gateway connection that are referencing the security groups you've specified in this request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupId.N** The IDs of the security groups in your account. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **securityGroupReferenceSet** Information about the VPCs with the referencing security groups. Type: Array of [SecurityGroupReference](API_SecurityGroupReference.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the security group references for sg-11aa22bb. The response indicates that this security group is referenced by a security group in VPC vpc-1a2b3c4d. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecurityGroupReferences &GroupId.1=sg-11aa22bb &AUTHPARAMS ``` #### Sample Response ``` 19744c88-baa2-45df-905f-example vpc-1a2b3c4d pcx-b04deed9 sg-11aa22bb ``` ### Example 2 This example describes the security group references for sg-11aa22bb and sg-1111aaaa. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecurityGroupReferences &GroupId.1=sg-11aa22bb &GroupId.2=sg-1111aaaa &AUTHPARAMS ``` #### Sample Response ``` d1835dca-61c1-459d-99cb-example vpc-81326ae4 pcx-b04deed9 sg-11aa22bb vpc-1a2b3c4d pcx-aabbccdd sg-1111aaaa ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSecurityGroupReferences) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSecurityGroupReferences) # DescribeSecurityGroupRules Describes one or more of your security group rules. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `group-id` - The ID of the security group. + `security-group-rule-id` - The ID of the security group rule. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **SecurityGroupRuleId.N** The IDs of the security group rules. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **securityGroupRuleSet** Information about security group rules. Type: Array of [SecurityGroupRule](API_SecurityGroupRule.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSecurityGroupRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSecurityGroupRules) # DescribeSecurityGroups Describes the specified security groups or all of your security groups. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. If using multiple filters for rules, the results include security groups for which any combination of rules - not necessarily a single rule - match all filters. + `description` - The description of the security group. + `egress.ip-permission.cidr` - An IPv4 CIDR block for an outbound security group rule. + `egress.ip-permission.from-port` - For an outbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. + `egress.ip-permission.group-id` - The ID of a security group that has been referenced in an outbound security group rule. + `egress.ip-permission.group-name` - The name of a security group that is referenced in an outbound security group rule. + `egress.ip-permission.ipv6-cidr` - An IPv6 CIDR block for an outbound security group rule. + `egress.ip-permission.prefix-list-id` - The ID of a prefix list to which a security group rule allows outbound access. + `egress.ip-permission.protocol` - The IP protocol for an outbound security group rule (`tcp` \$1 `udp` \$1 `icmp`, a protocol number, or -1 for all protocols). + `egress.ip-permission.to-port` - For an outbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. + `egress.ip-permission.user-id` - The ID of an AWS account that has been referenced in an outbound security group rule. + `group-id` - The ID of the security group. + `group-name` - The name of the security group. + `ip-permission.cidr` - An IPv4 CIDR block for an inbound security group rule. + `ip-permission.from-port` - For an inbound rule, the start of port range for the TCP and UDP protocols, or an ICMP type number. + `ip-permission.group-id` - The ID of a security group that has been referenced in an inbound security group rule. + `ip-permission.group-name` - The name of a security group that is referenced in an inbound security group rule. + `ip-permission.ipv6-cidr` - An IPv6 CIDR block for an inbound security group rule. + `ip-permission.prefix-list-id` - The ID of a prefix list from which a security group rule allows inbound access. + `ip-permission.protocol` - The IP protocol for an inbound security group rule (`tcp` \$1 `udp` \$1 `icmp`, a protocol number, or -1 for all protocols). + `ip-permission.to-port` - For an inbound rule, the end of port range for the TCP and UDP protocols, or an ICMP code. + `ip-permission.user-id` - The ID of an AWS account that has been referenced in an inbound security group rule. + `owner-id` - The AWS account ID of the owner of the security group. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC specified when the security group was created. Type: Array of [Filter](API_Filter.md) objects Required: No **GroupId.N** The IDs of the security groups. Required for security groups in a nondefault VPC. Default: Describes all of your security groups. Type: Array of strings Required: No **GroupName.N** [Default VPC] The names of the security groups. You can specify either the security group name or the security group ID. Default: Describes all of your security groups. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. This value can be between 5 and 1000. If this parameter is not specified, then all items are returned. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **securityGroupInfo** Information about the security groups. Type: Array of [SecurityGroup](API_SecurityGroup.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the specified security group. The response indicates that this security group references another security group. The referenced group can be in a different VPC if used through a VPC peering connection. If the referenced security group or the VPC peering connection is deleted, the rule becomes stale but is not automatically removed from the security group. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecurityGroups &GroupId.1=sg-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` edb7c570-be05-4192-bd1b-example 123456789012 sg-1a2b3c4d MySecurityGroup MySecurityGroup vpc-81326ae4 tcp 22 22 0.0.0.0/0 icmp -1 -1 sgr-abcdefghi01234560 111222333444 sg-11aa22bb vpc-dd326ab8 pcx-11223344 active -1 0.0.0.0/0 ``` ### Example 2 This example describes all security groups that grant access over port 22 and that grant access from instances associated with `app_server_group` or `database_group`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecurityGroups &Filter.1.Name=ip-permission.protocol &Filter.1.Value.1=tcp &Filter.2.Name=ip-permission.from-port &Filter.2.Value.1=22 &Filter.3.Name=ip-permission.to-port &Filter.3.Value.1=22 &Filter.4.Name=ip-permission.group-name &Filter.4.Value.1=app_server_group &Filter.4.Value.2=database_group &AUTHPARAMS ``` ### Example 3 This example describes the specified security group. The security group has a rule that allows all outbound IPv6 traffic (this rule is added by default for security groups in an IPv6-enabled VPC) and a rule that allows inbound access over SSH for IPv6 traffic. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecurityGroups &GroupId.1=sg-9bf6ceff &AUTHPARAMS ``` #### Sample Response ``` 1d62eae0-acdd-481d-88c9-example 123456789012 sg-9bf6ceff SSHAccess Security group for SSH access vpc-31896b55 tcp 22 22 0.0.0.0/0 ::/0 -1 0.0.0.0/0 ::/0 ``` ### Example 4 This example describes the specified security group. For the ingress rule that permits RDP traffic from IPv4 address range `203.0.113.0/24`, there is a rule description. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSecurityGroups &GroupId.1=sg-bcc24bcd &AUTHPARAMS ``` #### Sample Response ``` 6b0c76fb-0da6-4357-bb60-1fexample 123456789012 sg-bcc24bcd default default VPC security group vpc-a33cbfda -1 123456789012 sg-bcc24bcd tcp 3389 3389 203.0.113.0/24 RDP access from B network -1 0.0.0.0/0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSecurityGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSecurityGroups) # DescribeSecurityGroupVpcAssociations Describes security group VPC associations made with [AssociateSecurityGroupVpc](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateSecurityGroupVpc.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Security group VPC association filters. + `group-id`: The security group ID. + `group-owner-id`: The group owner ID. + `state`: The state of the association. + `vpc-id`: The ID of the associated VPC. + `vpc-owner-id`: The account ID of the VPC owner. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **securityGroupVpcAssociationSet** The security group VPC associations. Type: Array of [SecurityGroupVpcAssociation](API_SecurityGroupVpcAssociation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSecurityGroupVpcAssociations) # DescribeServiceLinkVirtualInterfaces Describes the Outpost service link virtual interfaces. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters to use for narrowing down the request. The following filters are supported: + `outpost-lag-id` - The ID of the Outpost LAG. + `outpost-arn` - The Outpost ARN. + `owner-id` - The ID of the AWS account that owns the service link virtual interface. + `state` - The state of the Outpost LAG. + `vlan` - The ID of the address pool. + `service-link-virtual-interface-id` - The ID of the service link virtual interface. + `local-gateway-virtual-interface-id` - The ID of the local gateway virtual interface. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **ServiceLinkVirtualInterfaceId.N** The IDs of the service link virtual interfaces. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **serviceLinkVirtualInterfaceSet** Describes the service link virtual interfaces. Type: Array of [ServiceLinkVirtualInterface](API_ServiceLinkVirtualInterface.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeServiceLinkVirtualInterfaces) # DescribeSnapshotAttribute Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time. For more information about EBS snapshots, see [Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshots.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The snapshot attribute you would like to view. Type: String Valid Values: `productCodes | createVolumePermission` Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SnapshotId** The ID of the EBS snapshot. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **createVolumePermission** The users and groups that have the permissions for creating volumes from the snapshot. Type: Array of [CreateVolumePermission](API_CreateVolumePermission.md) objects **productCodes** The product codes. Type: Array of [ProductCode](API_ProductCode.md) objects **requestId** The ID of the request. Type: String **snapshotId** The ID of the EBS snapshot. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the create volume permissions for the specified snapshot. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSnapshotAttribute &SnapshotId=snap-1234567890abcdef0 &Attribute=createVolumePermission &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE snap-1234567890abcdef0 all ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSnapshotAttribute) # DescribeSnapshots Describes the specified EBS snapshots available to you or all of the EBS snapshots available to you. The snapshots available to you include public snapshots, private snapshots that you own, and private snapshots owned by other AWS accounts for which you have explicit create volume permissions. The create volume permissions fall into the following categories: + *public*: The owner of the snapshot granted create volume permissions for the snapshot to the `all` group. All AWS accounts have create volume permissions for these snapshots. + *explicit*: The owner of the snapshot granted create volume permissions to a specific AWS account. + *implicit*: An AWS account has implicit create volume permissions for all snapshots it owns. The list of snapshots returned can be filtered by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions. If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results. If you specify one or more snapshot owners using the `OwnerIds` option, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, `amazon` for snapshots owned by Amazon, or `self` for snapshots that you own. If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), `self` for snapshots for which you own or have explicit permissions, or `all` for public snapshots. If you are describing a long list of snapshots, we recommend that you paginate the output to make the list more manageable. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). To get the state of fast snapshot restores for a snapshot, use [DescribeFastSnapshotRestores](API_DescribeFastSnapshotRestores.md). For more information about EBS snapshots, see [Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-snapshots.html) in the *Amazon EBS User Guide*. **Important** We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `description` - A description of the snapshot. + `encrypted` - Indicates whether the snapshot is encrypted (`true` \$1 `false`) + `owner-alias` - The owner alias, from an Amazon-maintained list (`amazon`). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. + `owner-id` - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter. + `progress` - The progress of the snapshot, as a percentage (for example, 80%). + `snapshot-id` - The snapshot ID. + `start-time` - The time stamp when the snapshot was initiated. + `status` - The status of the snapshot (`pending` \$1 `completed` \$1 `error`). + `storage-tier` - The storage tier of the snapshot (`archive` \$1 `standard`). + `transfer-type` - The type of operation used to create the snapshot (`time-based` \$1 `standard`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `volume-id` - The ID of the volume the snapshot is for. + `volume-size` - The size of the volume, in GiB. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **Owner.N** Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, `self`, and `amazon`. Type: Array of strings Required: No **RestorableBy.N** The IDs of the AWS accounts that can create volumes from the snapshot. Type: Array of strings Required: No **SnapshotId.N** The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **snapshotSet** Information about the snapshots. Type: Array of [Snapshot](API_Snapshot.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes a snapshot with an ID of `snap-1234567890abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSnapshots &SnapshotId=snap-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 12345678-1234-1234-1234-3755ba4b9fa6 snap-0abcdef1234567890 vol-01234567890abcdef completed 2025-02-03T23:53:18.195Z 100% 123456789012 8 My root volume snapshot purpose production_backup true arn:aws:kms:us-east-1:123456789012:key/12345678-abcd-9876-ab12-cd56f438c90b standard standard 2025-02-03T23:56:27.864Z 1770520576 ``` ### Example This example filters the response to include only snapshots with the `pending` status, and a tag with the key `Owner` and the value `DbAdmin`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSnapshots &Filter.1.Name=status &Filter.1.Value.1=pending &Filter.2.Name=tag:Owner &Filter.2.Value.1=DbAdmin &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSnapshots) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSnapshots) # DescribeSnapshotTierStatus Describes the storage tier status of one or more Amazon EBS snapshots. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `snapshot-id` - The snapshot ID. + `volume-id` - The ID of the volume the snapshot is for. + `last-tiering-operation` - The state of the last archive or restore action. (`archival-in-progress` \$1 `archival-completed` \$1 `archival-failed` \$1 `permanent-restore-in-progress` \$1 `permanent-restore-completed` \$1 `permanent-restore-failed` \$1 `temporary-restore-in-progress` \$1 `temporary-restore-completed` \$1 `temporary-restore-failed`) Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **snapshotTierStatusSet** Information about the snapshot's storage tier. Type: Array of [SnapshotTierStatus](API_SnapshotTierStatus.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSnapshotTierStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSnapshotTierStatus) # DescribeSpotDatafeedSubscription Describes the data feed for Spot Instances. For more information, see [Spot Instance data feed](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-data-feeds.html) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **spotDatafeedSubscription** The Spot Instance data feed subscription. Type: [SpotDatafeedSubscription](API_SpotDatafeedSubscription.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the data feed for the account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotDatafeedSubscription &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE 123456789012 amzn-s3-demo-bucket spotdata_ Active ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSpotDatafeedSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSpotDatafeedSubscription) # DescribeSpotFleetInstances Describes the running instances for the specified Spot Fleet. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String Required: No **SpotFleetRequestId** The ID of the Spot Fleet request. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **activeInstanceSet** The running instances. This list is refreshed periodically and might be out of date. Type: Array of [ActiveInstance](API_ActiveInstance.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **spotFleetRequestId** The ID of the Spot Fleet request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the running instances for Spot Fleet request sfr-123f8fc2-cb31-425e-abcd-example2710. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotFleetInstances &SpotFleetRequestId=sfr-123f8fc2-cb31-425e-abcd-example2710 &AUTHPARAMS ``` #### Sample Response ``` cfb09950-45e2-472d-a6a9-example sfr-123f8fc2-cb31-425e-abcd-example2710 i-1234567890abcdef0 sir-1a1a1a1a m3.medium i-1234567890abcdef1 sir-2b2b2b2b m3.medium i-1234567890abcdef2 sir-3c3c3c3c m3.medium i-1234567890abcdef3 sir-4d4d4d4d m3.medium i-1234567890abcdef4 sir-5e5e5e5e m3.medium ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSpotFleetInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSpotFleetInstances) # DescribeSpotFleetRequestHistory Describes the events for the specified Spot Fleet request during the specified time. Spot Fleet events are delayed by up to 30 seconds before they can be described. This ensures that you can query by the last evaluated time and not miss a recorded event. Spot Fleet events are available for 48 hours. For more information, see [Monitor fleet events using Amazon EventBridge](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/fleet-monitor.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EventType** The type of events to describe. By default, all events are described. Type: String Valid Values: `instanceChange | fleetRequestChange | error | information` Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String Required: No **SpotFleetRequestId** The ID of the Spot Fleet request. Type: String Required: Yes **StartTime** The starting date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Type: Timestamp Required: Yes ## Response Elements The following elements are returned by the service. **historyRecordSet** Information about the events in the history of the Spot Fleet request. Type: Array of [HistoryRecord](API_HistoryRecord.md) objects **lastEvaluatedTime** The last date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). All records up to this time were retrieved. If `nextToken` indicates that there are more items, this value is not present. Type: Timestamp **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **spotFleetRequestId** The ID of the Spot Fleet request. Type: String **startTime** The starting date and time for the events, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the events for Spot Fleet request sfr-123f8fc2-cb31-425e-abcd-example2710 from the specified start time. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotFleetRequestHistory &SpotFleetRequestId=sfr-123f8fc2-cb31-425e-abcd-example2710 &StartTime=2015-07-01T12:00:00Z &AUTHPARAMS ``` #### Sample Response ``` 30be3aaf-afd2-408c-b62b-example 2015-07-01T13:29:40+0000 sfr-123f8fc2-cb31-425e-abcd-example2710 2015-07-01T12:00:00Z submitted fleetRequestChange 2015-07-01T13:10:10.219Z active fleetRequestChange 2015-07-01T13:10:11.624Z m3.medium, ami-1ecae776, Linux/UNIX (Amazon VPC); old price: 0.0153, new price: 0.0153 price_update fleetRequestChange 2015-07-01T13:10:13.365Z i-1234567890abcdef0 launched instanceChange 2015-07-01T13:19:53.795Z i-1234567890abcdef1 launched instanceChange 2015-07-01T13:20:39.777Z i-1234567890abcdef2 launched instanceChange 2015-07-01T13:20:57.773Z i-1234567890abcdef3 launched instanceChange 2015-07-01T13:22:05.696Z i-1234567890abcdef4 launched instanceChange 2015-07-01T13:23:58.927Z ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSpotFleetRequestHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSpotFleetRequestHistory) # DescribeSpotFleetRequests Describes your Spot Fleet requests. Spot Fleet requests are deleted 48 hours after they are canceled and their instances are terminated. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String Required: No **SpotFleetRequestId.N** The IDs of the Spot Fleet requests. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **spotFleetRequestConfigSet** Information about the configuration of your Spot Fleet. Type: Array of [SpotFleetRequestConfig](API_SpotFleetRequestConfig.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your Spot Fleet requests. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotFleetRequests &AUTHPARAMS ``` #### Sample Response ``` 4d68a6cc-8f2e-4be1-b425-example sfr-12345678-cb31-425e-8c23-example2710 cancelled 0.0153 20 arn:aws:iam::123456789011:role/spot-fleet-role subnet-1a2b3c4d false ami-1ecae776 m4.xlarge subnet-1a2b3c4d false ami-1ecae776 m3.medium sfr-abcdefgh-e71f-450d-880d-examplec127 active 0.0153 5 arn:aws:iam::123456789011:role/spot-fleet-role subnet-abc123ab false ami-1ecae776 m4.large subnet-abc123ab false ami-1ecae776 m3.medium ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSpotFleetRequests) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSpotFleetRequests) # DescribeSpotInstanceRequests Describes the specified Spot Instance requests. You can use `DescribeSpotInstanceRequests` to find a running Spot Instance by examining the response. If the status of the Spot Instance is `fulfilled`, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use [DescribeInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances) with a filter to look for instances where the instance lifecycle is `spot`. We recommend that you set `MaxResults` to a value between 5 and 1000 to limit the number of items returned. This paginates the output, which makes the list more manageable and returns the items faster. If the list of items exceeds your `MaxResults` value, then that number of items is returned along with a `NextToken` value that can be passed to a subsequent `DescribeSpotInstanceRequests` request to retrieve the remaining items. Spot Instance requests are deleted four hours after they are canceled and their instances are terminated. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone-group` - The Availability Zone group. + `create-time` - The time stamp when the Spot Instance request was created. + `fault-code` - The fault code related to the request. + `fault-message` - The fault message related to the request. + `instance-id` - The ID of the instance that fulfilled the request. + `launch-group` - The Spot Instance launch group. + `launch.block-device-mapping.delete-on-termination` - Indicates whether the EBS volume is deleted on instance termination. + `launch.block-device-mapping.device-name` - The device name for the volume in the block device mapping (for example, `/dev/sdh` or `xvdh`). + `launch.block-device-mapping.snapshot-id` - The ID of the snapshot for the EBS volume. + `launch.block-device-mapping.volume-size` - The size of the EBS volume, in GiB. + `launch.block-device-mapping.volume-type` - The type of EBS volume: `gp2` or `gp3` for General Purpose SSD, `io1` or `io2` for Provisioned IOPS SSD, `st1` for Throughput Optimized HDD, `sc1` for Cold HDD, or `standard` for Magnetic. + `launch.group-id` - The ID of the security group for the instance. + `launch.group-name` - The name of the security group for the instance. + `launch.image-id` - The ID of the AMI. + `launch.instance-type` - The type of instance (for example, `m3.medium`). + `launch.kernel-id` - The kernel ID. + `launch.key-name` - The name of the key pair the instance launched with. + `launch.monitoring-enabled` - Whether detailed monitoring is enabled for the Spot Instance. + `launch.ramdisk-id` - The RAM disk ID. + `launched-availability-zone` - The Availability Zone in which the request is launched. + `launched-availability-zone-id` - The ID of the Availability Zone in which the request is launched. + `network-interface.addresses.primary` - Indicates whether the IP address is the primary private IP address. + `network-interface.delete-on-termination` - Indicates whether the network interface is deleted when the instance is terminated. + `network-interface.description` - A description of the network interface. + `network-interface.device-index` - The index of the device for the network interface attachment on the instance. + `network-interface.group-id` - The ID of the security group associated with the network interface. + `network-interface.network-interface-id` - The ID of the network interface. + `network-interface.private-ip-address` - The primary private IP address of the network interface. + `network-interface.subnet-id` - The ID of the subnet for the instance. + `product-description` - The product description associated with the instance (`Linux/UNIX` \$1 `Windows`). + `spot-instance-request-id` - The Spot Instance request ID. + `spot-price` - The maximum hourly price for any Spot Instance launched to fulfill the request. + `state` - The state of the Spot Instance request (`open` \$1 `active` \$1 `closed` \$1 `cancelled` \$1 `failed`). Spot request status information can help you track your Amazon EC2 Spot Instance requests. For more information, see [Spot request status](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html) in the *Amazon EC2 User Guide*. + `status-code` - The short code describing the most recent evaluation of your Spot Instance request. + `status-message` - The message explaining the status of the Spot Instance request. + `tag:` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `type` - The type of Spot Instance request (`one-time` \$1 `persistent`). + `valid-from` - The start date of the request. + `valid-until` - The end date of the request. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **SpotInstanceRequestId.N** The IDs of the Spot Instance requests. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **spotInstanceRequestSet** The Spot Instance requests. Type: Array of [SpotInstanceRequest](API_SpotInstanceRequest.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example for DescribeSpotInstanceRequests This example returns information about current Spot Instance requests. In the response, if the status of the Spot Instance is `fulfilled`, the instance ID appears in the response and contains the identifier of the instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotInstanceRequests &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE sir-1a2b3c4d 0.09 one-time active fulfilled YYYY-MM-DDTHH:MM:SS.000Z Your Spot request is fulfilled. ami-1a2b3c4d my-key-pair sg-1a2b3c4d websrv m3.medium false false i-1234567890abcdef0 YYYY-MM-DDTHH:MM:SS.000Z Linux/UNIX us-west-2a ``` ### Example for DescribeSpotInstanceRequests This example describes all persistent Spot Instance requests that have resulted in the launch of at least one instance, that has been fulfilled in the us-west-2a Availability Zone, and that also has monitoring enabled. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotInstanceRequests &Filter.1.Name=type &Filter.1.Value.1=persistent &Filter.2.Name=instance-type &Filter.2.Value.1=m3.medium &Filter.3.Name=monitoring-enabled &Filter.3.Value.1=true &Filter.4.Name=launched-availability-zone &Filter.4.Value.1=us-west-2a &AUTHPARAMS ``` ### Example for DescribeInstances Alternatively, you can use [DescribeInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances) and use a filter to look for instances where the instance lifecycle contains `spot`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeInstances &Filter.1.Name=instance-lifecycle &Filter.1.Value.1=spot &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSpotInstanceRequests) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSpotInstanceRequests) # DescribeSpotPriceHistory Describes the Spot price history. For more information, see [Spot Instance pricing history](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-spot-instances-history.html) in the *Amazon EC2 User Guide*. When you specify a start and end time, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** Filters the results by the specified Availability Zone. Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both Type: String Required: No **AvailabilityZoneId** Filters the results by the specified ID of the Availability Zone. Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndTime** The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Type: Timestamp Required: No **Filter.N** The filters. + `availability-zone` - The Availability Zone for which prices should be returned. + `availability-zone-id` - The ID of the Availability Zone for which prices should be returned. + `instance-type` - The type of instance (for example, `m3.medium`). + `product-description` - The product description for the Spot price (`Linux/UNIX` \$1 `Red Hat Enterprise Linux` \$1 `SUSE Linux` \$1 `Windows` \$1 `Linux/UNIX (Amazon VPC)` \$1 `Red Hat Enterprise Linux (Amazon VPC)` \$1 `SUSE Linux (Amazon VPC)` \$1 `Windows (Amazon VPC)`). + `spot-price` - The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported). + `timestamp` - The time stamp of the Spot price history, in UTC format (for example, *ddd MMM dd HH*:*mm*:*ss* UTC *YYYY*). You can use wildcards (`*` and `?`). Greater than or less than comparison is not supported. Type: Array of [Filter](API_Filter.md) objects Required: No **InstanceType.N** Filters the results by the specified instance types. Type: Array of strings Valid Values: `a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c5n.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6g.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.metal | c6gn.medium | c6gn.large | c6gn.xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.12xlarge | c6gn.16xlarge | c6i.large | c6i.xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.32xlarge | c6i.metal | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d3.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3en.xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.12xlarge | dl1.24xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4ad.xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.16xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.48xlarge | g5g.xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.16xlarge | g5g.metal | hi1.4xlarge | hpc6a.48xlarge | hs1.8xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | im4gn.large | im4gn.xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.16xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | is4gen.medium | is4gen.large | is4gen.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.metal | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.metal | m5zn.large | m5zn.xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.12xlarge | m5zn.metal | m6a.large | m6a.xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.32xlarge | m6a.48xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge | m6i.large | m6i.xlarge | m6i.2xlarge | m6i.4xlarge | m6i.8xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.32xlarge | m6i.metal | mac1.metal | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | p4d.24xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5b.large | r5b.xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.metal | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.metal | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6g.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.metal | r6i.large | r6i.xlarge | r6i.2xlarge | r6i.4xlarge | r6i.8xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.32xlarge | r6i.metal | t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | u-6tb1.56xlarge | u-6tb1.112xlarge | u-9tb1.112xlarge | u-12tb1.112xlarge | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | vt1.3xlarge | vt1.6xlarge | vt1.24xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.12xlarge | x2iezn.metal | x2gd.medium | x2gd.large | x2gd.xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.metal | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2iedn.xlarge | x2iedn.2xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.32xlarge | c6a.large | c6a.xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.32xlarge | c6a.48xlarge | c6a.metal | m6a.metal | i4i.large | i4i.xlarge | i4i.2xlarge | i4i.4xlarge | i4i.8xlarge | i4i.16xlarge | i4i.32xlarge | i4i.metal | x2idn.metal | x2iedn.metal | c7g.medium | c7g.large | c7g.xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.12xlarge | c7g.16xlarge | mac2.metal | c6id.large | c6id.xlarge | c6id.2xlarge | c6id.4xlarge | c6id.8xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.32xlarge | c6id.metal | m6id.large | m6id.xlarge | m6id.2xlarge | m6id.4xlarge | m6id.8xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.32xlarge | m6id.metal | r6id.large | r6id.xlarge | r6id.2xlarge | r6id.4xlarge | r6id.8xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.32xlarge | r6id.metal | r6a.large | r6a.xlarge | r6a.2xlarge | r6a.4xlarge | r6a.8xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.32xlarge | r6a.48xlarge | r6a.metal | p4de.24xlarge | u-3tb1.56xlarge | u-18tb1.112xlarge | u-24tb1.112xlarge | trn1.2xlarge | trn1.32xlarge | hpc6id.32xlarge | c6in.large | c6in.xlarge | c6in.2xlarge | c6in.4xlarge | c6in.8xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.32xlarge | m6in.large | m6in.xlarge | m6in.2xlarge | m6in.4xlarge | m6in.8xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.32xlarge | m6idn.large | m6idn.xlarge | m6idn.2xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.32xlarge | r6in.large | r6in.xlarge | r6in.2xlarge | r6in.4xlarge | r6in.8xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.32xlarge | r6idn.large | r6idn.xlarge | r6idn.2xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.32xlarge | c7g.metal | m7g.medium | m7g.large | m7g.xlarge | m7g.2xlarge | m7g.4xlarge | m7g.8xlarge | m7g.12xlarge | m7g.16xlarge | m7g.metal | r7g.medium | r7g.large | r7g.xlarge | r7g.2xlarge | r7g.4xlarge | r7g.8xlarge | r7g.12xlarge | r7g.16xlarge | r7g.metal | c6in.metal | m6in.metal | m6idn.metal | r6in.metal | r6idn.metal | inf2.xlarge | inf2.8xlarge | inf2.24xlarge | inf2.48xlarge | trn1n.32xlarge | i4g.large | i4g.xlarge | i4g.2xlarge | i4g.4xlarge | i4g.8xlarge | i4g.16xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge | c7gn.medium | c7gn.large | c7gn.xlarge | c7gn.2xlarge | c7gn.4xlarge | c7gn.8xlarge | c7gn.12xlarge | c7gn.16xlarge | p5.48xlarge | m7i.large | m7i.xlarge | m7i.2xlarge | m7i.4xlarge | m7i.8xlarge | m7i.12xlarge | m7i.16xlarge | m7i.24xlarge | m7i.48xlarge | m7i-flex.large | m7i-flex.xlarge | m7i-flex.2xlarge | m7i-flex.4xlarge | m7i-flex.8xlarge | m7a.medium | m7a.large | m7a.xlarge | m7a.2xlarge | m7a.4xlarge | m7a.8xlarge | m7a.12xlarge | m7a.16xlarge | m7a.24xlarge | m7a.32xlarge | m7a.48xlarge | m7a.metal-48xl | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | c7gd.medium | c7gd.large | c7gd.xlarge | c7gd.2xlarge | c7gd.4xlarge | c7gd.8xlarge | c7gd.12xlarge | c7gd.16xlarge | m7gd.medium | m7gd.large | m7gd.xlarge | m7gd.2xlarge | m7gd.4xlarge | m7gd.8xlarge | m7gd.12xlarge | m7gd.16xlarge | r7gd.medium | r7gd.large | r7gd.xlarge | r7gd.2xlarge | r7gd.4xlarge | r7gd.8xlarge | r7gd.12xlarge | r7gd.16xlarge | r7a.medium | r7a.large | r7a.xlarge | r7a.2xlarge | r7a.4xlarge | r7a.8xlarge | r7a.12xlarge | r7a.16xlarge | r7a.24xlarge | r7a.32xlarge | r7a.48xlarge | c7i.large | c7i.xlarge | c7i.2xlarge | c7i.4xlarge | c7i.8xlarge | c7i.12xlarge | c7i.16xlarge | c7i.24xlarge | c7i.48xlarge | mac2-m2pro.metal | r7iz.large | r7iz.xlarge | r7iz.2xlarge | r7iz.4xlarge | r7iz.8xlarge | r7iz.12xlarge | r7iz.16xlarge | r7iz.32xlarge | c7a.medium | c7a.large | c7a.xlarge | c7a.2xlarge | c7a.4xlarge | c7a.8xlarge | c7a.12xlarge | c7a.16xlarge | c7a.24xlarge | c7a.32xlarge | c7a.48xlarge | c7a.metal-48xl | r7a.metal-48xl | r7i.large | r7i.xlarge | r7i.2xlarge | r7i.4xlarge | r7i.8xlarge | r7i.12xlarge | r7i.16xlarge | r7i.24xlarge | r7i.48xlarge | dl2q.24xlarge | mac2-m2.metal | i4i.12xlarge | i4i.24xlarge | c7i.metal-24xl | c7i.metal-48xl | m7i.metal-24xl | m7i.metal-48xl | r7i.metal-24xl | r7i.metal-48xl | r7iz.metal-16xl | r7iz.metal-32xl | c7gd.metal | m7gd.metal | r7gd.metal | g6.xlarge | g6.2xlarge | g6.4xlarge | g6.8xlarge | g6.12xlarge | g6.16xlarge | g6.24xlarge | g6.48xlarge | gr6.4xlarge | gr6.8xlarge | c7i-flex.large | c7i-flex.xlarge | c7i-flex.2xlarge | c7i-flex.4xlarge | c7i-flex.8xlarge | u7i-12tb.224xlarge | u7in-16tb.224xlarge | u7in-24tb.224xlarge | u7in-32tb.224xlarge | u7ib-12tb.224xlarge | c7gn.metal | r8g.medium | r8g.large | r8g.xlarge | r8g.2xlarge | r8g.4xlarge | r8g.8xlarge | r8g.12xlarge | r8g.16xlarge | r8g.24xlarge | r8g.48xlarge | r8g.metal-24xl | r8g.metal-48xl | mac2-m1ultra.metal | g6e.xlarge | g6e.2xlarge | g6e.4xlarge | g6e.8xlarge | g6e.12xlarge | g6e.16xlarge | g6e.24xlarge | g6e.48xlarge | c8g.medium | c8g.large | c8g.xlarge | c8g.2xlarge | c8g.4xlarge | c8g.8xlarge | c8g.12xlarge | c8g.16xlarge | c8g.24xlarge | c8g.48xlarge | c8g.metal-24xl | c8g.metal-48xl | m8g.medium | m8g.large | m8g.xlarge | m8g.2xlarge | m8g.4xlarge | m8g.8xlarge | m8g.12xlarge | m8g.16xlarge | m8g.24xlarge | m8g.48xlarge | m8g.metal-24xl | m8g.metal-48xl | x8g.medium | x8g.large | x8g.xlarge | x8g.2xlarge | x8g.4xlarge | x8g.8xlarge | x8g.12xlarge | x8g.16xlarge | x8g.24xlarge | x8g.48xlarge | x8g.metal-24xl | x8g.metal-48xl | i7ie.large | i7ie.xlarge | i7ie.2xlarge | i7ie.3xlarge | i7ie.6xlarge | i7ie.12xlarge | i7ie.18xlarge | i7ie.24xlarge | i7ie.48xlarge | i8g.large | i8g.xlarge | i8g.2xlarge | i8g.4xlarge | i8g.8xlarge | i8g.12xlarge | i8g.16xlarge | i8g.24xlarge | i8g.metal-24xl | u7i-6tb.112xlarge | u7i-8tb.112xlarge | u7inh-32tb.480xlarge | p5e.48xlarge | p5en.48xlarge | f2.12xlarge | f2.48xlarge | trn2.48xlarge | c7i-flex.12xlarge | c7i-flex.16xlarge | m7i-flex.12xlarge | m7i-flex.16xlarge | i7ie.metal-24xl | i7ie.metal-48xl | i8g.48xlarge | c8gd.medium | c8gd.large | c8gd.xlarge | c8gd.2xlarge | c8gd.4xlarge | c8gd.8xlarge | c8gd.12xlarge | c8gd.16xlarge | c8gd.24xlarge | c8gd.48xlarge | c8gd.metal-24xl | c8gd.metal-48xl | i7i.large | i7i.xlarge | i7i.2xlarge | i7i.4xlarge | i7i.8xlarge | i7i.12xlarge | i7i.16xlarge | i7i.24xlarge | i7i.48xlarge | i7i.metal-24xl | i7i.metal-48xl | p6-b200.48xlarge | m8gd.medium | m8gd.large | m8gd.xlarge | m8gd.2xlarge | m8gd.4xlarge | m8gd.8xlarge | m8gd.12xlarge | m8gd.16xlarge | m8gd.24xlarge | m8gd.48xlarge | m8gd.metal-24xl | m8gd.metal-48xl | r8gd.medium | r8gd.large | r8gd.xlarge | r8gd.2xlarge | r8gd.4xlarge | r8gd.8xlarge | r8gd.12xlarge | r8gd.16xlarge | r8gd.24xlarge | r8gd.48xlarge | r8gd.metal-24xl | r8gd.metal-48xl | c8gn.medium | c8gn.large | c8gn.xlarge | c8gn.2xlarge | c8gn.4xlarge | c8gn.8xlarge | c8gn.12xlarge | c8gn.16xlarge | c8gn.24xlarge | c8gn.48xlarge | c8gn.metal-24xl | c8gn.metal-48xl | f2.6xlarge | p6e-gb200.36xlarge | g6f.large | g6f.xlarge | g6f.2xlarge | g6f.4xlarge | gr6f.4xlarge | p5.4xlarge | r8i.large | r8i.xlarge | r8i.2xlarge | r8i.4xlarge | r8i.8xlarge | r8i.12xlarge | r8i.16xlarge | r8i.24xlarge | r8i.32xlarge | r8i.48xlarge | r8i.96xlarge | r8i.metal-48xl | r8i.metal-96xl | r8i-flex.large | r8i-flex.xlarge | r8i-flex.2xlarge | r8i-flex.4xlarge | r8i-flex.8xlarge | r8i-flex.12xlarge | r8i-flex.16xlarge` Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **ProductDescription.N** Filters the results by the specified basic product descriptions. Type: Array of strings Required: No **StartTime** The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Type: Timestamp Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is an empty string (`""`) or `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **spotPriceHistorySet** The historical Spot prices. Type: Array of [SpotPrice](API_SpotPrice.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example gets the Spot price history for the first day in November 2016 for the specified Availability Zone. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory &StartTime=2016-11-01T00:00:00.000Z &EndTime=2016-11-01T23:59:59.000Z &AvailabilityZone=us-west-2a &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE m3.medium Linux/UNIX 0.287 2016-11-01T20:56:05.000Z us-west-2a m3.medium Windows 0.033 2016-11-01T22:33:47.000Z us-west-2a ``` ### Example with Filters This example uses filters to get the same results as the previous example. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSpotPriceHistory &Filter.1.Name=timestamp &Filter.1.Value.1='Tue Nov 01 01* UTC 2016' &Filter.2.Name=availability-zone &Filter.2.Value.1=us-west-2a &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSpotPriceHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSpotPriceHistory) # DescribeStaleSecurityGroups Describes the stale security group rules for security groups referenced across a VPC peering connection, transit gateway connection, or with a security group VPC association. Rules are stale when they reference a deleted security group. Rules can also be stale if they reference a security group in a peer VPC for which the VPC peering connection has been deleted, across a transit gateway where the transit gateway has been deleted (or [the transit gateway security group referencing feature](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#vpc-attachment-security) has been disabled), or if a security group VPC association has been disassociated. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 255. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **staleSecurityGroupSet** Information about the stale security groups. Type: Array of [StaleSecurityGroup](API_StaleSecurityGroup.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes stale security group rules for vpc-11223344. The response shows that sg-5fa68d3a in your account has a stale ingress SSH rule that references sg-279ab042 in the peer VPC, and sg-fe6fba9a in your account has a stale egress SSH rule that references sg-ef6fba8b in the peer VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeStaleSecurityGroups &VpcId=vpc-11223344 &AUTHPARAMS ``` #### Sample Response ``` ece1f9a0-b201-4eec-b74b-example 22 22 vpc-7a20e51f sg-ef6fba8b pcx-b04deed9 active Access to pcx-b04deed9 tcp Sg-1 vpc-11223344 sg-fe6fba9a Sg-1 for peering Sg-2 vpc-11223344 sg-5fa68d3a Sg-2 for peering 22 22 vpc-7a20e51f sg-279ab042 pcx-b04deed9 active Access from pcx-b04deed9 tcp ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeStaleSecurityGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeStaleSecurityGroups) # DescribeStoreImageTasks Describes the progress of the AMI store tasks. You can describe the store tasks for specified AMIs. If you don't specify the AMIs, you get a paginated list of store tasks from the last 31 days. For each AMI task, the response indicates if the task is `InProgress`, `Completed`, or `Failed`. For tasks `InProgress`, the response shows the estimated progress as a percentage. Tasks are listed in reverse chronological order. Currently, only tasks from the past 31 days can be viewed. To use this API, you must have the required permissions. For more information, see [Permissions for storing and restoring AMIs using S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-ami-store-restore.html#ami-s3-permissions) in the *Amazon EC2 User Guide*. For more information, see [Store and restore an AMI using S3](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-store-restore.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `task-state` - Returns tasks in a certain state (`InProgress` \$1 `Completed` \$1 `Failed`) + `bucket` - Returns task information for tasks that targeted a specific bucket. For the filter value, specify the bucket name. When you specify the `ImageIds` parameter, any filters that you specify are ignored. To use the filters, you must remove the `ImageIds` parameter. Type: Array of [Filter](API_Filter.md) objects Required: No **ImageId.N** The AMI IDs for which to show progress. Up to 20 AMI IDs can be included in a request. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). You cannot specify this parameter and the `ImageIds` parameter in the same call. Type: Integer Valid Range: Minimum value of 1. Maximum value of 200. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **storeImageTaskResultSet** The information about the AMI store tasks. Type: Array of [StoreImageTaskResult](API_StoreImageTaskResult.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeStoreImageTasks) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeStoreImageTasks) # DescribeSubnets Describes your subnets. The default is to describe all your subnets. Alternatively, you can specify specific subnet IDs or filter the results to include only the subnets that match specific criteria. For more information, see [Subnets](https://docs.aws.amazon.com/vpc/latest/userguide/configure-subnets.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `availability-zone` - The Availability Zone for the subnet. You can also use `availabilityZone` as the filter name. + `availability-zone-id` - The ID of the Availability Zone for the subnet. You can also use `availabilityZoneId` as the filter name. + `available-ip-address-count` - The number of IPv4 addresses in the subnet that are available. + `cidr-block` - The IPv4 CIDR block of the subnet. The CIDR block you specify must exactly match the subnet's CIDR block for information to be returned for the subnet. You can also use `cidr` or `cidrBlock` as the filter names. + `customer-owned-ipv4-pool` - The customer-owned IPv4 address pool associated with the subnet. + `default-for-az` - Indicates whether this is the default subnet for the Availability Zone (`true` \$1 `false`). You can also use `defaultForAz` as the filter name. + `enable-dns64` - Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. + `enable-lni-at-device-index` - Indicates the device position for local network interfaces in this subnet. For example, `1` indicates local network interfaces in this subnet are the secondary network interface (eth1). + `ipv6-cidr-block-association.ipv6-cidr-block` - An IPv6 CIDR block associated with the subnet. + `ipv6-cidr-block-association.association-id` - An association ID for an IPv6 CIDR block associated with the subnet. + `ipv6-cidr-block-association.state` - The state of an IPv6 CIDR block associated with the subnet. + `ipv6-native` - Indicates whether this is an IPv6 only subnet (`true` \$1 `false`). + `map-customer-owned-ip-on-launch` - Indicates whether a network interface created in this subnet (including a network interface created by [RunInstances](API_RunInstances.md)) receives a customer-owned IPv4 address. + `map-public-ip-on-launch` - Indicates whether instances launched in this subnet receive a public IPv4 address. + `outpost-arn` - The Amazon Resource Name (ARN) of the Outpost. + `owner-id` - The ID of the AWS account that owns the subnet. + `private-dns-name-options-on-launch.hostname-type` - The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name). + `private-dns-name-options-on-launch.enable-resource-name-dns-a-record` - Indicates whether to respond to DNS queries for instance hostnames with DNS A records. + `private-dns-name-options-on-launch.enable-resource-name-dns-aaaa-record` - Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. + `state` - The state of the subnet (`pending` \$1 `available`). + `subnet-arn` - The Amazon Resource Name (ARN) of the subnet. + `subnet-id` - The ID of the subnet. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC for the subnet. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **SubnetId.N** The IDs of the subnets. Default: Describes all your subnets. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **subnetSet** Information about the subnets. Type: Array of [Subnet](API_Subnet.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the subnets. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSubnets &AUTHPARAMS ``` #### Sample Response ``` 1927e20c-0ed0-4a02-a6d7-d955fbd2d13c subnet-0bb1c79de301436ee arn:aws:ec2:us-east-2:111122223333:subnet/subnet-0bb1c79de3EXAMPLE available 111122223333 vpc-0ee975135dEXAMPLE 10.0.2.0/24 251 us-east-2c use2-az3 false false false subnet-02bf4c428bf44ebce arn:aws:ec2:us-east-2:111122223333:subnet/subnet-02bf4c428bEXAMPLE available 111122223333 vpc-07e8ffd50fEXAMPLE 10.0.0.0/24 2600:1f16:115:200::/64 subnet-cidr-assoc-002afb9f3cEXAMPLE associated 251 us-east-2b use2-az2 false false false ``` ### Example 2 This example uses filters to describe any subnet you own that is in the VPC with the ID `vpc-0056ae9ffdEXAMPLE` or `vpc-0096ae9ffdEXAMPLE`, and whose state is `available`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeSubnets &Filter.1.Name=vpc-id &Filter.1.Value.1=vpc-0056ae9ffdEXAMPLE &Filter.1.Value.2=vpc-0096ae9ffdEXAMPLE &Filter.2.Name=state &Filter.2.Value.1=available &AUTHPARAMS ``` #### Sample Response ``` 43e9cb52-0e10-40fe-b457-988c8fbfea26 subnet-0f8c6c2f37EXAMPLE arn:aws:ec2:us-west-2:123456789012:subnet/subnet-0f8c6c2f37903e9dc available 123456789012 vpc-0056ae9ffdEXAMPLE 172.168.0.0/16 65531 us-west-2b usw2-az2 false false false ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeSubnets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeSubnets) # DescribeTags Describes the specified tags for your EC2 resources. For more information about tags, see [Tag your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html) in the *Amazon Elastic Compute Cloud User Guide*. **Important** We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `key` - The tag key. + `resource-id` - The ID of the resource. + `resource-type` - The resource type. For a list of possible values, see [TagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_TagSpecification.html). + `tag`: - The key/value combination of the tag. For example, specify "tag:Owner" for the filter name and "TeamA" for the filter value to find resources with the tag "Owner=TeamA". + `value` - The tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. This value can be between 5 and 1000. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **tagSet** The tags. Type: Array of [TagDescription](API_TagDescription.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all the tags in your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTags &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE ami-1a2b3c4d image webserver ami-1a2b3c4d image stack Production i-1234567890abcdef0 instance webserver i-1234567890abcdef0 instance stack Production i-0598c7d356eba48d7 instance database_server i-0598c7d356eba48d7 instance stack Test ``` ### Example This example describes only the tags for the AMI with ID ami-1a2b3c4d. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTags &Filter.1.Name=resource-id &Filter.1.Value.1=ami-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE ami-1a2b3c4d image webserver ami-1a2b3c4d image stack Production ``` ### Example This example describes the tags for all your instances. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTags &Filter.1.Name=resource-type &Filter.1.Value.1=instance &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE i-0598c7d356eba48d7 instance webserver i-0598c7d356eba48d7 instance stack Production i-1234567890abcdef0 instance database_server i-1234567890abcdef0 instance stack Test ``` ### Example This example describes the tags for all your instances tagged with the key *webserver*. You can use wildcards with filters, so you could specify the value as `?ebserver` to find tags with the key *webserver* or *Webserver*. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTags &Filter.1.Name=key &Filter.1.Value.1=webserver &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE i-1234567890abcdef0 instance webserver ``` ### Example This example describes the tags for all your instances tagged with either stack=Test or stack=Production. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTags &Filter.1.Name=resource-type &Filter.1.Value.1=instance &Filter.2.Name=key &Filter.2.Value.1=stack &Filter.3.Name=value &Filter.3.Value.1=Test &Filter.3.Value.2=Production &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE i-1234567890abcdef0 instance stack Production i-0598c7d356eba48d7 instance stack Test ``` ### Example This example describes the tags for all your instances tagged with Purpose=[empty string]. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTags &Filter.1.Name=resource-type &Filter.1.Value.1=instance &Filter.2.Name=key &Filter.2.Value.1=Purpose &Filter.3.Name=value &Filter.3.Value.1= &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTags) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTags) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTags) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTags) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTags) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTags) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTags) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTags) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTags) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTags) # DescribeTrafficMirrorFilterRules Describe traffic mirror filters that determine the traffic that is mirrored. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Traffic mirror filters. + `traffic-mirror-filter-rule-id`: The ID of the Traffic Mirror rule. + `traffic-mirror-filter-id`: The ID of the filter that this rule is associated with. + `rule-number`: The number of the Traffic Mirror rule. + `rule-action`: The action taken on the filtered traffic. Possible actions are `accept` and `reject`. + `traffic-direction`: The traffic direction. Possible directions are `ingress` and `egress`. + `protocol`: The protocol, for example UDP, assigned to the Traffic Mirror rule. + `source-cidr-block`: The source CIDR block assigned to the Traffic Mirror rule. + `destination-cidr-block`: The destination CIDR block assigned to the Traffic Mirror rule. + `description`: The description of the Traffic Mirror rule. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TrafficMirrorFilterId** Traffic filter ID. Type: String Required: No **TrafficMirrorFilterRuleId.N** Traffic filter rule IDs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. The value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **trafficMirrorFilterRuleSet** Traffic mirror rules. Type: Array of [TrafficMirrorFilterRule](API_TrafficMirrorFilterRule.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTrafficMirrorFilterRules) # DescribeTrafficMirrorFilters Describes one or more Traffic Mirror filters. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `description`: The Traffic Mirror filter description. + `traffic-mirror-filter-id`: The ID of the Traffic Mirror filter. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TrafficMirrorFilterId.N** The ID of the Traffic Mirror filter. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. The value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **trafficMirrorFilterSet** Information about one or more Traffic Mirror filters. Type: Array of [TrafficMirrorFilter](API_TrafficMirrorFilter.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTrafficMirrorFilters) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTrafficMirrorFilters) # DescribeTrafficMirrorSessions Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `description`: The Traffic Mirror session description. + `network-interface-id`: The ID of the Traffic Mirror session network interface. + `owner-id`: The ID of the account that owns the Traffic Mirror session. + `packet-length`: The assigned number of packets to mirror. + `session-number`: The assigned session number. + `traffic-mirror-filter-id`: The ID of the Traffic Mirror filter. + `traffic-mirror-session-id`: The ID of the Traffic Mirror session. + `traffic-mirror-target-id`: The ID of the Traffic Mirror target. + `virtual-network-id`: The virtual network ID of the Traffic Mirror session. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TrafficMirrorSessionId.N** The ID of the Traffic Mirror session. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. The value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **trafficMirrorSessionSet** Describes one or more Traffic Mirror sessions. By default, all Traffic Mirror sessions are described. Alternatively, you can filter the results. Type: Array of [TrafficMirrorSession](API_TrafficMirrorSession.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTrafficMirrorSessions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTrafficMirrorSessions) # DescribeTrafficMirrorTargets Information about one or more Traffic Mirror targets. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `description`: The Traffic Mirror target description. + `network-interface-id`: The ID of the Traffic Mirror session network interface. + `network-load-balancer-arn`: The Amazon Resource Name (ARN) of the Network Load Balancer that is associated with the session. + `owner-id`: The ID of the account that owns the Traffic Mirror session. + `traffic-mirror-target-id`: The ID of the Traffic Mirror target. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TrafficMirrorTargetId.N** The ID of the Traffic Mirror targets. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. The value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **trafficMirrorTargetSet** Information about one or more Traffic Mirror targets. Type: Array of [TrafficMirrorTarget](API_TrafficMirrorTarget.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTrafficMirrorTargets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTrafficMirrorTargets) # DescribeTransitGatewayAttachments Describes one or more attachments between resources and transit gateways. By default, all attachments are described. Alternatively, you can filter the results by attachment ID, attachment state, resource ID, or resource owner. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `association.state` - The state of the association (`associating` \$1 `associated` \$1 `disassociating`). + `association.transit-gateway-route-table-id` - The ID of the route table for the transit gateway. + `resource-id` - The ID of the resource. + `resource-owner-id` - The ID of the AWS account that owns the resource. + `resource-type` - The resource type. Valid values are `vpc` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `peering` \$1 `connect`. + `state` - The state of the attachment. Valid values are `available` \$1 `deleted` \$1 `deleting` \$1 `failed` \$1 `failing` \$1 `initiatingRequest` \$1 `modifying` \$1 `pendingAcceptance` \$1 `pending` \$1 `rollingBack` \$1 `rejected` \$1 `rejecting`. + `transit-gateway-attachment-id` - The ID of the attachment. + `transit-gateway-id` - The ID of the transit gateway. + `transit-gateway-owner-id` - The ID of the AWS account that owns the transit gateway. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayAttachmentIds.N** The IDs of the attachments. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayAttachments** Information about the attachments. Type: Array of [TransitGatewayAttachment](API_TransitGatewayAttachment.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayAttachments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayAttachments) # DescribeTransitGatewayConnectPeers Describes one or more Connect peers. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `state` - The state of the Connect peer (`pending` \$1 `available` \$1 `deleting` \$1 `deleted`). + `transit-gateway-attachment-id` - The ID of the attachment. + `transit-gateway-connect-peer-id` - The ID of the Connect peer. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayConnectPeerIds.N** The IDs of the Connect peers. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayConnectPeerSet** Information about the Connect peers. Type: Array of [TransitGatewayConnectPeer](API_TransitGatewayConnectPeer.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayConnectPeers) # DescribeTransitGatewayConnects Describes one or more Connect attachments. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `options.protocol` - The tunnel protocol (`gre`). + `state` - The state of the attachment (`initiating` \$1 `initiatingRequest` \$1 `pendingAcceptance` \$1 `rollingBack` \$1 `pending` \$1 `available` \$1 `modifying` \$1 `deleting` \$1 `deleted` \$1 `failed` \$1 `rejected` \$1 `rejecting` \$1 `failing`). + `transit-gateway-attachment-id` - The ID of the Connect attachment. + `transit-gateway-id` - The ID of the transit gateway. + `transport-transit-gateway-attachment-id` - The ID of the transit gateway attachment from which the Connect attachment was created. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayAttachmentIds.N** The IDs of the attachments. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayConnectSet** Information about the Connect attachments. Type: Array of [TransitGatewayConnect](API_TransitGatewayConnect.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayConnects) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayConnects) # DescribeTransitGatewayMeteringPolicies Describes one or more transit gateway metering policies. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to apply when describing transit gateway metering policies. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayMeteringPolicyIds.N** The IDs of the transit gateway metering policies to describe. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayMeteringPolicies** Information about the transit gateway metering policies. Type: Array of [TransitGatewayMeteringPolicy](API_TransitGatewayMeteringPolicy.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayMeteringPolicies) # DescribeTransitGatewayMulticastDomains Describes one or more transit gateway multicast domains. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `state` - The state of the transit gateway multicast domain. Valid values are `pending` \$1 `available` \$1 `deleting` \$1 `deleted`. + `transit-gateway-id` - The ID of the transit gateway. + `transit-gateway-multicast-domain-id` - The ID of the transit gateway multicast domain. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayMulticastDomainIds.N** The ID of the transit gateway multicast domain. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayMulticastDomains** Information about the transit gateway multicast domains. Type: Array of [TransitGatewayMulticastDomain](API_TransitGatewayMulticastDomain.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes your multicast domains. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTransitGatewayMulticastDomains &AUTHPARAMS ``` #### Sample Response ``` e19ec53b-f3f5-4eae-97c3-a9605EXAMPLE 2019-11-19T22:05:50.000Z available tgw-06150e5ae0EXAMPLE tgw-mcast-domain-0c4905cef7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayMulticastDomains) # DescribeTransitGatewayPeeringAttachments Describes your transit gateway peering attachments. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `transit-gateway-attachment-id` - The ID of the transit gateway attachment. + `local-owner-id` - The ID of your AWS account. + `remote-owner-id` - The ID of the AWS account in the remote Region that owns the transit gateway. + `state` - The state of the peering attachment. Valid values are `available` \$1 `deleted` \$1 `deleting` \$1 `failed` \$1 `failing` \$1 `initiatingRequest` \$1 `modifying` \$1 `pendingAcceptance` \$1 `pending` \$1 `rollingBack` \$1 `rejected` \$1 `rejecting`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value. + `transit-gateway-id` - The ID of the transit gateway. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayAttachmentIds.N** One or more IDs of the transit gateway peering attachments. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayPeeringAttachments** The transit gateway peering attachments. Type: Array of [TransitGatewayPeeringAttachment](API_TransitGatewayPeeringAttachment.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes your peering attachment. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTransitGatewayPeeringAttachments &AUTHPARAMS ``` #### Sample Response ``` f2ad2616-b1bc-42ab-8533-bd50example 111111111111 us-west-2 tgw-123456789012abc12 2019-11-11T11:25:31.000Z 123456789012 us-east-1 tgw-abc123abc123abc12 pendingAcceptance tgw-attach-1122334455aabbcc1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayPeeringAttachments) # DescribeTransitGatewayPolicyTables Describes one or more transit gateway route policy tables. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters associated with the transit gateway policy table. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayPolicyTableIds.N** The IDs of the transit gateway policy tables. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token for the next page of results. Type: String **requestId** The ID of the request. Type: String **transitGatewayPolicyTables** Describes the transit gateway policy tables. Type: Array of [TransitGatewayPolicyTable](API_TransitGatewayPolicyTable.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayPolicyTables) # DescribeTransitGatewayRouteTableAnnouncements Describes one or more transit gateway route table advertisements. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters associated with the transit gateway policy table. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayRouteTableAnnouncementIds.N** The IDs of the transit gateway route tables that are being advertised. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token for the next page of results. Type: String **requestId** The ID of the request. Type: String **transitGatewayRouteTableAnnouncements** Describes the transit gateway route table announcement. Type: Array of [TransitGatewayRouteTableAnnouncement](API_TransitGatewayRouteTableAnnouncement.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayRouteTableAnnouncements) # DescribeTransitGatewayRouteTables Describes one or more transit gateway route tables. By default, all transit gateway route tables are described. Alternatively, you can filter the results. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `default-association-route-table` - Indicates whether this is the default association route table for the transit gateway (`true` \$1 `false`). + `default-propagation-route-table` - Indicates whether this is the default propagation route table for the transit gateway (`true` \$1 `false`). + `state` - The state of the route table (`available` \$1 `deleting` \$1 `deleted` \$1 `pending`). + `transit-gateway-id` - The ID of the transit gateway. + `transit-gateway-route-table-id` - The ID of the transit gateway route table. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayRouteTableIds.N** The IDs of the transit gateway route tables. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayRouteTables** Information about the transit gateway route tables. Type: Array of [TransitGatewayRouteTable](API_TransitGatewayRouteTable.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayRouteTables) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayRouteTables) # DescribeTransitGateways Describes one or more transit gateways. By default, all transit gateways are described. Alternatively, you can filter the results. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `options.propagation-default-route-table-id` - The ID of the default propagation route table. + `options.amazon-side-asn` - The private ASN for the Amazon side of a BGP session. + `options.association-default-route-table-id` - The ID of the default association route table. + `options.auto-accept-shared-attachments` - Indicates whether there is automatic acceptance of attachment requests (`enable` \$1 `disable`). + `options.default-route-table-association` - Indicates whether resource attachments are automatically associated with the default association route table (`enable` \$1 `disable`). + `options.default-route-table-propagation` - Indicates whether resource attachments automatically propagate routes to the default propagation route table (`enable` \$1 `disable`). + `options.dns-support` - Indicates whether DNS support is enabled (`enable` \$1 `disable`). + `options.vpn-ecmp-support` - Indicates whether Equal Cost Multipath Protocol support is enabled (`enable` \$1 `disable`). + `owner-id` - The ID of the AWS account that owns the transit gateway. + `state` - The state of the transit gateway (`available` \$1 `deleted` \$1 `deleting` \$1 `modifying` \$1 `pending`). + `transit-gateway-id` - The ID of the transit gateway. + `tag-key `- The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayIds.N** The IDs of the transit gateways. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewaySet** Information about the transit gateways. Type: Array of [TransitGateway](API_TransitGateway.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes your transit gateways. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTransitGateways &AUTHPARAMS ``` #### Sample Response ``` 151283df-f7dc-4317-89b4-01c9888b1d45 2019-05-08T13:21:33.000Z example tgw 64512 tgw-rtb-002573ed1eEXAMPLE disable enable enable enable tgw-rtb-002573ed1eEXAMPLE enable 111122223333 available arn:aws:ec2:us-east-1:111122223333:transit-gateway/tgw-02f776b1a7EXAMPLE tgw-02f776b1a7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGateways) # DescribeTransitGatewayVpcAttachments Describes one or more VPC attachments. By default, all VPC attachments are described. Alternatively, you can filter the results. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `state` - The state of the attachment. Valid values are `available` \$1 `deleted` \$1 `deleting` \$1 `failed` \$1 `failing` \$1 `initiatingRequest` \$1 `modifying` \$1 `pendingAcceptance` \$1 `pending` \$1 `rollingBack` \$1 `rejected` \$1 `rejecting`. + `transit-gateway-attachment-id` - The ID of the attachment. + `transit-gateway-id` - The ID of the transit gateway. + `vpc-id` - The ID of the VPC. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayAttachmentIds.N** The IDs of the attachments. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayVpcAttachments** Information about the VPC attachments. Type: Array of [TransitGatewayVpcAttachment](API_TransitGatewayVpcAttachment.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes your transit gateway VPC attachments. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeTransitGatewayVpcAttachment &AUTHPARAMS ``` #### Sample Response ``` 5eeb22d7-c1cf-4efd-9725-1e92e8f9a4e7 2019-07-17T16:04:27.000Z enable disable available subnet-0187aff814EXAMPLE tgw-attach-0d2c54bdb3EXAMPLE tgw-02f776b1a7EXAMPLE vpc-0065acced4EXAMPLE 111122223333 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTransitGatewayVpcAttachments) # DescribeTrunkInterfaceAssociations Describes one or more network interface trunk associations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId.N** The IDs of the associations. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `gre-key` - The ID of a trunk interface association. + `interface-protocol` - The interface protocol. Valid values are `VLAN` and `GRE`. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 255. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **interfaceAssociationSet** Information about the trunk associations. Type: Array of [TrunkInterfaceAssociation](API_TrunkInterfaceAssociation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeTrunkInterfaceAssociations) # DescribeVerifiedAccessEndpoints Describes the specified AWS Verified Access endpoints. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **VerifiedAccessEndpointId.N** The ID of the Verified Access endpoint. Type: Array of strings Required: No **VerifiedAccessGroupId** The ID of the Verified Access group. Type: String Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **verifiedAccessEndpointSet** Details about the Verified Access endpoints. Type: Array of [VerifiedAccessEndpoint](API_VerifiedAccessEndpoint.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVerifiedAccessEndpoints) # DescribeVerifiedAccessGroups Describes the specified Verified Access groups. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **VerifiedAccessGroupId.N** The ID of the Verified Access groups. Type: Array of strings Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **verifiedAccessGroupSet** Details about the Verified Access groups. Type: Array of [VerifiedAccessGroup](API_VerifiedAccessGroup.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVerifiedAccessGroups) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVerifiedAccessGroups) # DescribeVerifiedAccessInstanceLoggingConfigurations Describes the specified AWS Verified Access instances. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 10. Required: No **NextToken** The token for the next page of results. Type: String Required: No **VerifiedAccessInstanceId.N** The IDs of the Verified Access instances. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **loggingConfigurationSet** The logging configuration for the Verified Access instances. Type: Array of [VerifiedAccessInstanceLoggingConfiguration](API_VerifiedAccessInstanceLoggingConfiguration.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVerifiedAccessInstanceLoggingConfigurations) # DescribeVerifiedAccessInstances Describes the specified AWS Verified Access instances. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 200. Required: No **NextToken** The token for the next page of results. Type: String Required: No **VerifiedAccessInstanceId.N** The IDs of the Verified Access instances. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **verifiedAccessInstanceSet** Details about the Verified Access instances. Type: Array of [VerifiedAccessInstance](API_VerifiedAccessInstance.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVerifiedAccessInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVerifiedAccessInstances) # DescribeVerifiedAccessTrustProviders Describes the specified AWS Verified Access trust providers. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. Filter names and values are case-sensitive. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 200. Required: No **NextToken** The token for the next page of results. Type: String Required: No **VerifiedAccessTrustProviderId.N** The IDs of the Verified Access trust providers. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **verifiedAccessTrustProviderSet** Details about the Verified Access trust providers. Type: Array of [VerifiedAccessTrustProvider](API_VerifiedAccessTrustProvider.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVerifiedAccessTrustProviders) # DescribeVolumeAttribute Describes the specified attribute of the specified volume. You can specify only one attribute at a time. For more information about EBS volumes, see [Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The attribute of the volume. This parameter is required. Type: String Valid Values: `autoEnableIO | productCodes` Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VolumeId** The ID of the volume. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **autoEnableIO** The state of `autoEnableIO` attribute. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **productCodes** A list of product codes. Type: Array of [ProductCode](API_ProductCode.md) objects **requestId** The ID of the request. Type: String **volumeId** The ID of the volume. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the `autoEnableIO` attribute of the volume vol-1234567890abcdef0. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVolumeAttribute &Attribute=autoEnableIO &VolumeId=vol-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE vol-1234567890abcdef0 false ``` ### Example This example describes the `productCodes` attribute of the volume vol-1234567890abcdef0. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVolumeAttribute &Attribute=productCodes &VolumeId=vol-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE vol-1234567890abcdef0 a1b2c3d4e5f6g7h8i9j10k11 marketplace ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVolumeAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVolumeAttribute) # DescribeVolumes Describes the specified EBS volumes or all of your EBS volumes. If you are describing a long list of volumes, we recommend that you paginate the output to make the list more manageable. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). For more information about EBS volumes, see [Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes.html) in the *Amazon EBS User Guide*. **Important** We strongly recommend using only paginated requests. Unpaginated requests are susceptible to throttling and timeouts. **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `attachment.attach-time` - The time stamp when the attachment initiated. + `attachment.delete-on-termination` - Whether the volume is deleted on instance termination. + `attachment.device` - The device name specified in the block device mapping (for example, `/dev/sda1`). + `attachment.instance-id` - The ID of the instance the volume is attached to. + `attachment.status` - The attachment state (`attaching` \$1 `attached` \$1 `detaching`). + `availability-zone` - The Availability Zone in which the volume was created. + `availability-zone-id` - The ID of the Availability Zone in which the volume was created. + `create-time` - The time stamp when the volume was created. + `encrypted` - Indicates whether the volume is encrypted (`true` \$1 `false`) + `fast-restored` - Indicates whether the volume was created from a snapshot that is enabled for fast snapshot restore (`true` \$1 `false`). + `multi-attach-enabled` - Indicates whether the volume is enabled for Multi-Attach (`true` \$1 `false`) + `operator.managed` - A Boolean that indicates whether this is a managed volume. + `operator.principal` - The principal that manages the volume. Only valid for managed volumes, where `managed` is `true`. + `size` - The size of the volume, in GiB. + `snapshot-id` - The snapshot from which the volume was created. + `status` - The state of the volume (`creating` \$1 `available` \$1 `in-use` \$1 `deleting` \$1 `deleted` \$1 `error`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `volume-id` - The volume ID. + `volume-type` - The Amazon EBS volume type (`gp2` \$1 `gp3` \$1 `io1` \$1 `io2` \$1 `st1` \$1 `sc1`\$1 `standard`) Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VolumeId.N** The volume IDs. If not specified, then all volumes are included in the response. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **volumeSet** Information about the volumes. Type: Array of [Volume](API_Volume.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all volumes associated with your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVolumes &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE vol-1234567890abcdef0 80 us-east-1a in-use YYYY-MM-DDTHH:MM:SS.SSSZ vol-1234567890abcdef0 i-1234567890abcdef0 /dev/sdh attached YYYY-MM-DDTHH:MM:SS.SSSZ false standard true false ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVolumes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVolumes) # DescribeVolumesModifications Describes the most recent volume modification request for the specified EBS volumes. For more information, see [ Monitor the progress of volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `modification-state` - The current modification state (modifying \$1 optimizing \$1 completed \$1 failed). + `original-iops` - The original IOPS rate of the volume. + `original-size` - The original size of the volume, in GiB. + `original-volume-type` - The original volume type of the volume (standard \$1 io1 \$1 io2 \$1 gp2 \$1 sc1 \$1 st1). + `originalMultiAttachEnabled` - Indicates whether Multi-Attach support was enabled (true \$1 false). + `start-time` - The modification start time. + `target-iops` - The target IOPS rate of the volume. + `target-size` - The target size of the volume, in GiB. + `target-volume-type` - The target volume type of the volume (standard \$1 io1 \$1 io2 \$1 gp2 \$1 sc1 \$1 st1). + `targetMultiAttachEnabled` - Indicates whether Multi-Attach support is to be enabled (true \$1 false). + `volume-id` - The ID of the volume. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results (up to a limit of 500) to be returned in a paginated request. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VolumeId.N** The IDs of the volumes. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **volumeModificationSet** Information about the volume modifications. Type: Array of [VolumeModification](API_VolumeModification.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example displays volume status after modifications to size, type, IOPS provisioning, and Multi-Attach support. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVolumesModifications &VolumeId.1=vol-0123456789EXAMPLE &Version=2016-11-15 ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE 10000 300 optimizing 200 io1 vol-0123456789EXAMPLE 40 2017-01-19T23:58:04.922Z 100 gp2 false true ``` ### Example 2 This example displays information about all volumes in a Region with a modification state of optimizing or completed. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVolumesModifications &Filter.1.Value.2=completed &Filter.1.Value.1=optimizing &Version=2016-11-15 &Filter.1.Name=modification-state ``` #### Sample Response ``` 35fdf8d3-6ffa-46dc-8f8e-62fe70bc31a2 10000 100 optimizing 2000 io1 vol-06397e7a0eEXAMPLE 3 2017-02-10T23:40:57.612Z 10 gp2 10000 100 completed 200 io1 vol-bEXAMPLE 100 2017-02-10T22:50:52.207Z 2017-02-10T22:56:04.823Z 8 gp2 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVolumesModifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVolumesModifications) # DescribeVolumeStatus Describes the status of the specified volumes. Volume status provides the result of the checks performed on your volumes to determine events that can impair the performance of your volumes. The performance of a volume can be affected if an issue occurs on the volume's underlying host. If the volume's underlying host experiences a power outage or system issue, after the system is restored, there could be data inconsistencies on the volume. Volume events notify you if this occurs. Volume actions notify you if any action needs to be taken in response to the event. The `DescribeVolumeStatus` operation provides the following information about the specified volumes: *Status*: Reflects the current status of the volume. The possible values are `ok`, `impaired` , `warning`, or `insufficient-data`. If all checks pass, the overall status of the volume is `ok`. If the check fails, the overall status is `impaired`. If the status is `insufficient-data`, then the checks might still be taking place on your volume at the time. We recommend that you retry the request. For more information about volume status, see [Monitor the status of your volumes](https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-status.html) in the *Amazon EBS User Guide*. *Events*: Reflect the cause of a volume status and might require you to take action. For example, if your volume returns an `impaired` status, then the volume event might be `potential-data-inconsistency`. This means that your volume has been affected by an issue with the underlying host, has all I/O operations disabled, and might have inconsistent data. *Actions*: Reflect the actions you might have to take in response to an event. For example, if the status of the volume is `impaired` and the volume event shows `potential-data-inconsistency`, then the action shows `enable-volume-io`. This means that you may want to enable the I/O operations for the volume and then check the volume for data consistency. For more information, see [Work with an impaired EBS volume](https://docs.aws.amazon.com/ebs/latest/userguide/work_volumes_impaired.html). Volume status is based on the volume status checks, and does not reflect the volume state. Therefore, volume status does not indicate volumes in the `error` state (for example, when a volume is incapable of accepting I/O.) **Note** The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `action.code` - The action code for the event (for example, `enable-volume-io`). + `action.description` - A description of the action. + `action.event-id` - The event ID associated with the action. + `availability-zone` - The Availability Zone of the instance. + `event.description` - A description of the event. + `event.event-id` - The event ID. + `event.event-type` - The event type (for `io-enabled`: `passed` \$1 `failed`; for `io-performance`: `io-performance:degraded` \$1 `io-performance:severely-degraded` \$1 `io-performance:stalled`). + `event.not-after` - The latest end time for the event. + `event.not-before` - The earliest start time for the event. + `volume-status.details-name` - The cause for `volume-status.status` (`io-enabled` \$1 `io-performance`). + `volume-status.details-status` - The status of `volume-status.details-name` (for `io-enabled`: `passed` \$1 `failed`; for `io-performance`: `normal` \$1 `degraded` \$1 `severely-degraded` \$1 `stalled`). + `volume-status.status` - The status of the volume (`ok` \$1 `impaired` \$1 `warning` \$1 `insufficient-data`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VolumeId.N** The IDs of the volumes. Default: Describes all your volumes. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **volumeStatusSet** Information about the status of the volumes. Type: Array of [VolumeStatusItem](API_VolumeStatusItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the status of all the volumes associated with your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVolumeStatus &AUTHPARAMS ``` #### Sample Response ``` 5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE vol-1234567890abcdef0 us-east-1d ok

io-enabled passed

vol-1234567890abcdef1 us-east-1d impaired

io-enabled failed

evol-61a54008 potential-data-inconsistency THIS IS AN EXAMPLE 2011-12-01T14:00:00.000Z 2011-12-01T15:00:00.000Z enable-volume-io evol-61a54008 potential-data-inconsistency THIS IS AN EXAMPLE ``` ### Example This example describes all the volumes in the `us-east-1d` Availability Zone with `failed` `io-enabled` status. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVolumeStatus &Filter.1.Name=availability-zone &Filter.1.Value.1=us-east-1d &Filter.2.Name=volume-status.details-name &Filter.2.Value.1=io-enabled &Filter.3.Name=volume-status.details-status &Filter.3.Value.1=failed &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVolumeStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVolumeStatus) # DescribeVpcAttribute Describes the specified attribute of the specified VPC. You can specify only one attribute at a time. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The VPC attribute. Type: String Valid Values: `enableDnsSupport | enableDnsHostnames | enableNetworkAddressUsageMetrics` Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **enableDnsHostnames** Indicates whether the instances launched in the VPC get DNS hostnames. If this attribute is `true`, instances in the VPC get DNS hostnames; otherwise, they do not. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **enableDnsSupport** Indicates whether DNS resolution is enabled for the VPC. If this attribute is `true`, the Amazon DNS server resolves DNS hostnames for your instances to their corresponding IP addresses; otherwise, it does not. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **enableNetworkAddressUsageMetrics** Indicates whether Network Address Usage metrics are enabled for your VPC. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object **requestId** The ID of the request. Type: String **vpcId** The ID of the VPC. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the `enableDnsSupport` attribute of the specified VPC. The sample response indicates that DNS resolution is supported. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcAttribute &VpcId=vpc-1a2b3c4d &Attribute=enableDnsSupport &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vpc-1a2b3c4d true ``` ### Example 2 This request describes the `enableDnsHostnames` attribute of the specified VPC. The sample response indicates that DNS hostnames are supported. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcAttribute &VpcId=vpc-1a2b3c4d &Attribute=enableDnsHostnames &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vpc-1a2b3c4d true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcAttribute) # DescribeVpcBlockPublicAccessExclusions Describe VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. To learn more about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExclusionId.N** IDs of exclusions. Type: Array of strings Required: No **Filter.N** Filters for the request: + `resource-arn` - The Amazon Resource Name (ARN) of a exclusion. + `internet-gateway-exclusion-mode` - The mode of a VPC BPA exclusion. Possible values: `allow-bidirectional | allow-egress`. + `state` - The state of VPC BPA. Possible values: `create-in-progress | create-complete | update-in-progress | update-complete | delete-in-progress | deleted-complete | disable-in-progress | disable-complete` + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `tag-value`: The value of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific value, regardless of the tag key. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **vpcBlockPublicAccessExclusionSet** Details related to the exclusions. Type: Array of [VpcBlockPublicAccessExclusion](API_VpcBlockPublicAccessExclusion.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcBlockPublicAccessExclusions) # DescribeVpcBlockPublicAccessOptions Describe VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcBlockPublicAccessOptions** Details related to the options. Type: [VpcBlockPublicAccessOptions](API_VpcBlockPublicAccessOptions.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcBlockPublicAccessOptions) # DescribeVpcClassicLink **Note** This action is deprecated. Describes the ClassicLink status of the specified VPCs. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `is-classic-link-enabled` - Whether the VPC is enabled for ClassicLink (`true` \$1 `false`). + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **VpcId.N** The VPCs for which you want to describe the ClassicLink status. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcSet** The ClassicLink status of the VPCs. Type: Array of [VpcClassicLink](API_VpcClassicLink.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcClassicLink) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcClassicLink) # DescribeVpcClassicLinkDnsSupport **Note** This action is deprecated. Describes the ClassicLink DNS support status of one or more VPCs. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 255. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No **VpcIds.N** The IDs of the VPCs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. **requestId** The ID of the request. Type: String **vpcs** Information about the ClassicLink DNS support status of the VPCs. Type: Array of [ClassicLinkDnsSupport](API_ClassicLinkDnsSupport.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcClassicLinkDnsSupport) # DescribeVpcEncryptionControls Describes one or more VPC Encryption Control configurations. VPC Encryption Control enables you to enforce encryption for all data in transit within and between VPCs to meet compliance requirements You can filter the results to return information about specific encryption controls or VPCs. For more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters to apply to the request. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VpcEncryptionControlId.N** The IDs of the VPC Encryption Control configurations to describe. Type: Array of strings Required: No **VpcId.N** The IDs of the VPCs to describe encryption control configurations for. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **vpcEncryptionControlSet** Information about the VPC Encryption Control configurations. Type: Array of [VpcEncryptionControl](API_VpcEncryptionControl.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEncryptionControls) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEncryptionControls) # DescribeVpcEndpointAssociations Describes the VPC resources, VPC endpoint services, Amazon Lattice services, or service networks associated with the VPC endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `vpc-endpoint-id` - The ID of the VPC endpoint. + `associated-resource-accessibility` - The association state. When the state is `accessible`, it returns `AVAILABLE`. When the state is `inaccessible`, it returns `PENDING` or `FAILED`. + `association-id` - The ID of the VPC endpoint association. + `associated-resource-id` - The ID of the associated resource configuration. + `service-network-arn` - The Amazon Resource Name (ARN) of the associated service network. Only VPC endpoints of type service network will be returned. + `resource-configuration-group-arn` - The Amazon Resource Name (ARN) of the resource configuration of type GROUP. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum page size. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NextToken** The pagination token. Type: String Required: No **VpcEndpointId.N** The IDs of the VPC endpoints. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The pagination token. Type: String **requestId** The ID of the request. Type: String **vpcEndpointAssociationSet** Details of the endpoint associations. Type: Array of [VpcEndpointAssociation](API_VpcEndpointAssociation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEndpointAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEndpointAssociations) # DescribeVpcEndpointConnectionNotifications Describes the connection notifications for VPC endpoints and VPC endpoint services. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ConnectionNotificationId** The ID of the notification. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `connection-notification-arn` - The ARN of the SNS topic for the notification. + `connection-notification-id` - The ID of the notification. + `connection-notification-state` - The state of the notification (`Enabled` \$1 `Disabled`). + `connection-notification-type` - The type of notification (`Topic`). + `service-id` - The ID of the endpoint service. + `vpc-endpoint-id` - The ID of the VPC endpoint. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another request with the returned `NextToken` value. Type: Integer Required: No **NextToken** The token to request the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **connectionNotificationSet** The notifications. Type: Array of [ConnectionNotification](API_ConnectionNotification.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your connection notifications. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcEndpointConnectionNotifications &AUTHPARAMS ``` #### Sample Response ``` 48541e40-9b6f-488e-8da7-a52a7example arn:aws:sns:us-east-1:123456789012:EndpointNotification Accept Connect Delete Reject Topic Enabled vpce-nfn-123cb952bc8af7123 vpce-1234151a02f327123 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEndpointConnectionNotifications) # DescribeVpcEndpointConnections Describes the VPC endpoint connections to your VPC endpoint services, including any endpoints that are pending your acceptance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `ip-address-type` - The IP address type (`ipv4` \$1 `ipv6`). + `service-id` - The ID of the service. + `vpc-endpoint-owner` - The ID of the AWS account ID that owns the endpoint. + `vpc-endpoint-region` - The Region of the endpoint or `cross-region` to find endpoints for other Regions. + `vpc-endpoint-state` - The state of the endpoint (`pendingAcceptance` \$1 `pending` \$1 `available` \$1 `deleting` \$1 `deleted` \$1 `rejected` \$1 `failed`). + `vpc-endpoint-id` - The ID of the endpoint. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned `NextToken` value. This value can be between 5 and 1,000; if `MaxResults` is given a value larger than 1,000, only 1,000 results are returned. Type: Integer Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **vpcEndpointConnectionSet** Information about the VPC endpoint connections. Type: Array of [VpcEndpointConnection](API_VpcEndpointConnection.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of the VPC endpoint connections for all of your services. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcEndpointConnections &AUTHPARAMS ``` #### Sample Response ``` ed2d237f-426b-4927-981b-980example 123456789012 2017-10-19T12:36:10.939Z available vpce-svc-0127881c0d25a3123 vpce-09bce00dc3edcc329 112233445566 2017-10-18T12:14:41.892Z rejected vpce-svc-0435c4480f65e3abc vpce-051a4ba136c8a12d8 123123123123 2017-10-18T13:25:07.739Z pendingAcceptance vpce-svc-01f406f3e99f8a123 vpce-09593ee8e85835659 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEndpointConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEndpointConnections) # DescribeVpcEndpoints Describes your VPC endpoints. The default is to describe all your VPC endpoints. Alternatively, you can specify specific VPC endpoint IDs or filter the results to include only the VPC endpoints that match specific criteria. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `ip-address-type` - The IP address type (`ipv4` \$1 `ipv6`). + `service-name` - The name of the service. + `service-region` - The Region of the service. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC in which the endpoint resides. + `vpc-endpoint-id` - The ID of the endpoint. + `vpc-endpoint-state` - The state of the endpoint (`pendingAcceptance` \$1 `pending` \$1 `available` \$1 `deleting` \$1 `deleted` \$1 `rejected` \$1 `failed`). + `vpc-endpoint-type` - The type of VPC endpoint (`Interface` \$1 `Gateway` \$1 `GatewayLoadBalancer` \$1 `Resource` \$1 `ServiceNetwork`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1,000, we return only 1,000 items. Type: Integer Required: No **NextToken** The token for the next set of items to return. (You received this token from a prior call.) Type: String Required: No **VpcEndpointId.N** The IDs of the VPC endpoints. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String **requestId** The ID of the request. Type: String **vpcEndpointSet** Information about the VPC endpoints. Type: Array of [VpcEndpoint](API_VpcEndpoint.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your endpoints. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcEndpoints &AUTHPARAMS ``` #### Sample Response ``` 8d3e7656-3328-451d-8c86-7156example {"Version":"2008-10-17", "Statement":[{"Effect":"Allow","Principal":"*","Action":"*","Resource":"*"}]} rtb-3d560345 com.amazonaws.us-east-1.dynamodb true vpce-032a826a Gateway vpc-aabb1122 2017-09-05T20:41:28Z available Name TeamA {"Statement": [{"Action": "*", "Effect": "Allow", "Principal": "*", "Resource": "*"}]} Z7HUB22UULQXV vpce-0f89a33420c1931d7-bluzidnv.elasticloadbalancing.us-east-1.vpce.amazonaws.com Z7HUB22UULQXV vpce-0f89a33420c1931d7-bluzidnv-us-east-1b.elasticloadbalancing.us-east-1.vpce.amazonaws.com Z7HUB22UULQXV vpce-0f89a33420c1931d7-bluzidnv-us-east-1a.elasticloadbalancing.us-east-1.vpce.amazonaws.com com.amazonaws.us-east-1.elasticloadbalancing false default sg-54e8bf31 vpce-0f89a33420c1931d7 subnet-d6fcaa8d subnet-7b16de0c eni-2ec2b084 eni-1b4a65cf Interface vpc-1a2b3c4d 2017-09-05T17:55:27.583Z available Name TeamA 2020-11-11T08:06:03.522Z eni-111111222222333aad 123456789012 false com.amazonaws.vpce.us-east-1.vpce-svc-abcd33a1c4321c123 available subnet-aaaabbbb333322211 vpce-22223333bbbbaaaa1 GatewayLoadBalancer vpc-abcabcabc12312312 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEndpoints) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEndpoints) # DescribeVpcEndpointServiceConfigurations Describes the VPC endpoint service configurations in your account (your services). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `service-name` - The name of the service. + `service-id` - The ID of the service. + `service-state` - The state of the service (`Pending` \$1 `Available` \$1 `Deleting` \$1 `Deleted` \$1 `Failed`). + `supported-ip-address-types` - The IP address type (`ipv4` \$1 `ipv6`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned `NextToken` value. This value can be between 5 and 1,000; if `MaxResults` is given a value larger than 1,000, only 1,000 results are returned. Type: Integer Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No **ServiceId.N** The IDs of the endpoint services. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **serviceConfigurationSet** Information about the services. Type: Array of [ServiceConfiguration](API_ServiceConfiguration.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all of your VPC endpoint service configurations. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcEndpointServiceConfigurations &AUTHPARAMS ``` #### Sample Response ``` d5bad480-0167-4a7f-a1c6-2651example Available Interface vpce-svc-0799b7d1c483b0123.us-east-1.vpce.amazonaws.com true us-east-1d vpce-svc-0799b7d1c483b0123 com.amazonaws.vpce.us-east-1.vpce-svc-0799b7d1c483b0123 arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/mynlb/1238753950b25123 Name TeamA Available GatewayLoadBalancer false us-east-1d vpce-svc-123abcc1298abc123 com.amazonaws.vpce.us-east-1.vpce-svc-123abcc1298abc123 arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/gwy/GWLBService/abc210844e429abc Name SecurityAppliance ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEndpointServiceConfigurations) # DescribeVpcEndpointServicePermissions Describes the principals (service consumers) that are permitted to discover your VPC endpoint service. Principal ARNs with path components aren't supported. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `principal` - The ARN of the principal. + `principal-type` - The principal type (`All` \$1 `Service` \$1 `OrganizationUnit` \$1 `Account` \$1 `User` \$1 `Role`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return for the request in a single page. The remaining results of the initial request can be seen by sending another request with the returned `NextToken` value. This value can be between 5 and 1,000; if `MaxResults` is given a value larger than 1,000, only 1,000 results are returned. Type: Integer Required: No **NextToken** The token to retrieve the next page of results. Type: String Required: No **ServiceId** The ID of the service. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **allowedPrincipals** Information about the allowed principals. Type: Array of [AllowedPrincipal](API_AllowedPrincipal.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the permissions for service `vpce-svc-03d5ebb7d9579a123`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcEndpointServicePermissions &ServiceId=vpce-svc-03d5ebb7d9579a123 &AUTHPARAMS ``` #### Sample Response ``` 5359c8a3-9151-4964-abed-b4422example arn:aws:iam::123456789012:root Account ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEndpointServicePermissions) # DescribeVpcEndpointServices Describes available services to which you can create a VPC endpoint. When the service provider and the consumer have different accounts in multiple Availability Zones, and the consumer views the VPC endpoint service information, the response only includes the common Availability Zones. For example, when the service provider account uses `us-east-1a` and `us-east-1c` and the consumer uses `us-east-1a` and `us-east-1b`, the response includes the VPC endpoint services in the common Availability Zone, `us-east-1a`. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `owner` - The ID or alias of the AWS account that owns the service. + `service-name` - The name of the service. + `service-region` - The Region of the service. + `service-type` - The type of service (`Interface` \$1 `Gateway` \$1 `GatewayLoadBalancer`). + `supported-ip-address-types` - The IP address type (`ipv4` \$1 `ipv6`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. The request returns a token that you can specify in a subsequent call to get the next set of results. Constraint: If the value is greater than 1,000, we return only 1,000 items. Type: Integer Required: No **NextToken** The token for the next set of items to return. (You received this token from a prior call.) Type: String Required: No **ServiceName.N** The service names. Type: Array of strings Required: No **ServiceRegion.N** The service Regions. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use when requesting the next set of items. If there are no additional items to return, the string is empty. Type: String **requestId** The ID of the request. Type: String **serviceDetailSet** Information about the service. Type: Array of [ServiceDetail](API_ServiceDetail.md) objects **serviceNameSet** The supported services. Type: Array of strings ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes all available endpoint services. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcEndpointServices &AUTHPARAMS ``` #### Sample Response ``` 19a9ff46-7df6-49b8-9726-3df27527089d com.amazonaws.us-east-1.dynamodb com.amazonaws.us-east-1.ec2 com.amazonaws.us-east-1.ec2messages com.amazonaws.us-east-1.elasticloadbalancing com.amazonaws.us-east-1.kinesis-streams com.amazonaws.us-east-1.s3 com.amazonaws.us-east-1.ssm amazon Gateway dynamodb.us-east-1.amazonaws.com false us-east-1a us-east-1b us-east-1c us-east-1d us-east-1e us-east-1f com.amazonaws.us-east-1.dynamodb true Name TeamA amazon Interface ec2.us-east-1.vpce.amazonaws.com false ec2.us-east-1.amazonaws.com us-east-1a us-east-1b us-east-1c us-east-1d us-east-1e us-east-1f com.amazonaws.us-east-1.ec2 false Name TeamA amazon Interface ec2messages.us-east-1.vpce.amazonaws.com false ec2messages.us-east-1.amazonaws.com us-east-1a us-east-1b us-east-1c us-east-1d us-east-1e us-east-1f com.amazonaws.us-east-1.ec2messages false Name TeamA amazon Interface elasticloadbalancing.us-east-1.vpce.amazonaws.com false elasticloadbalancing.us-east-1.amazonaws.com us-east-1a us-east-1b us-east-1c us-east-1d us-east-1e us-east-1f com.amazonaws.us-east-1.elasticloadbalancing false Name TeamA amazon Interface kinesis.us-east-1.vpce.amazonaws.com false kinesis.us-east-1.amazonaws.com us-east-1a us-east-1b us-east-1c us-east-1d us-east-1e us-east-1f com.amazonaws.us-east-1.kinesis-streams false Name TeamA amazon Gateway s3.us-east-1.amazonaws.com false us-east-1a us-east-1b us-east-1c us-east-1d us-east-1e us-east-1f com.amazonaws.us-east-1.s3 true Name TeamA amazon Interface ssm.us-east-1.vpce.amazonaws.com false ssm.us-east-1.amazonaws.com us-east-1a us-east-1b us-east-1c us-east-1d us-east-1e com.amazonaws.us-east-1.ssm true Name TeamA ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcEndpointServices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcEndpointServices) # DescribeVpcPeeringConnections Describes your VPC peering connections. The default is to describe all your VPC peering connections. Alternatively, you can specify specific VPC peering connection IDs or filter the results to include only the VPC peering connections that match specific criteria. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `accepter-vpc-info.cidr-block` - The IPv4 CIDR block of the accepter VPC. + `accepter-vpc-info.owner-id` - The ID of the AWS account that owns the accepter VPC. + `accepter-vpc-info.vpc-id` - The ID of the accepter VPC. + `expiration-time` - The expiration date and time for the VPC peering connection. + `requester-vpc-info.cidr-block` - The IPv4 CIDR block of the requester's VPC. + `requester-vpc-info.owner-id` - The ID of the AWS account that owns the requester VPC. + `requester-vpc-info.vpc-id` - The ID of the requester VPC. + `status-code` - The status of the VPC peering connection (`pending-acceptance` \$1 `failed` \$1 `expired` \$1 `provisioning` \$1 `active` \$1 `deleting` \$1 `deleted` \$1 `rejected`). + `status-message` - A message that provides more information about the status of the VPC peering connection, if applicable. + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-peering-connection-id` - The ID of the VPC peering connection. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VpcPeeringConnectionId.N** The IDs of the VPC peering connections. Default: Describes all your VPC peering connections. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **vpcPeeringConnectionSet** Information about the VPC peering connections. Type: Array of [VpcPeeringConnection](API_VpcPeeringConnection.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes all of your VPC peering connections. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE pcx-111aaa22 777788889999 vpc-1a2b3c4d 172.31.0.0/16 123456789012 vpc-aa22cc33 10.0.0.0/16 false true false active Active ``` ### Example 2 This example describes all of your VPC peering connections that are in the `pending-acceptance` state. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections &Filter.1.Name=status-code &Filter.1.Value=pending-acceptance &AUTHPARAMS ``` ### Example 3 This example describes all of your VPC peering connections that have the tag `Name=Finance` or `Name=Accounts`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections &Filter.1.Name=tag:Name &Filter.1.Value.1=Finance &Filter.1.Value.2=Accounts &AUTHPARAMS ``` ### Example 4 This example describes all of the VPC peering connections for your specified VPC, `vpc-1a2b3c4d`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcPeeringConnections &Filter.1.Name=requester-vpc-info.vpc-id &Filter.1.Value=vpc-1a2b3c4d &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcPeeringConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcPeeringConnections) # DescribeVpcs Describes your VPCs. The default is to describe all your VPCs. Alternatively, you can specify specific VPC IDs or filter the results to include only the VPCs that match specific criteria. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. + `cidr` - The primary IPv4 CIDR block of the VPC. The CIDR block you specify must exactly match the VPC's CIDR block for information to be returned for the VPC. Must contain the slash followed by one or two digits (for example, `/28`). + `cidr-block-association.cidr-block` - An IPv4 CIDR block associated with the VPC. + `cidr-block-association.association-id` - The association ID for an IPv4 CIDR block associated with the VPC. + `cidr-block-association.state` - The state of an IPv4 CIDR block associated with the VPC. + `dhcp-options-id` - The ID of a set of DHCP options. + `ipv6-cidr-block-association.ipv6-cidr-block` - An IPv6 CIDR block associated with the VPC. + `ipv6-cidr-block-association.ipv6-pool` - The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated. + `ipv6-cidr-block-association.association-id` - The association ID for an IPv6 CIDR block associated with the VPC. + `ipv6-cidr-block-association.state` - The state of an IPv6 CIDR block associated with the VPC. + `is-default` - Indicates whether the VPC is the default VPC. + `owner-id` - The ID of the AWS account that owns the VPC. + `state` - The state of the VPC (`pending` \$1 `available`). + `tag` - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `vpc-id` - The ID of the VPC. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VpcId.N** The IDs of the VPCs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **vpcSet** Information about the VPCs. Type: Array of [Vpc](API_Vpc.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the specified VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcs &VpcId.1=vpc-081ec835f3EXAMPLE &vpcId.2=vpc-0ee975135dEXAMPLE &VpcId.3=vpc-06e4ab6c6cEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 8b67ac77-886c-4027-8f0e-d351f7fc9971 vpc-081ec835f3EXAMPLE 111122223333 available 10.0.1.0/24 10.0.1.0/24 vpc-cidr-assoc-043f572c17EXAMPLE associated dopt-19edf471 Name MyVPC default false vpc-0ee975135dEXAMPLE 111122223333 available 10.0.0.0/16 10.0.0.0/16 vpc-cidr-assoc-067c3a0a1fEXAMPLE associated dopt-f30d649a default false vpc-06e4ab6c6cEXAMPLE 123456789012 available 10.0.0.0/16 10.0.0.0/16 vpc-cidr-assoc-00b17b4eddEXAMPLE associated dopt-19edf471 Name Shared VPC default false ``` ### Example 2 This example uses filters to describe any VPC you own that uses the set of DHCP options with the ID `dopt-7a8b9c2d` or `dopt-2b2a3d3c` and whose state is `available`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpcs &Filter.1.Name=dhcp-options-id &Filter.1.Value.1=dopt-7a8b9c2d &Filter.1.Value.2=dopt-2b2a3d3c &Filter.2.Name=state &Filter.2.Value.1=available &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpcs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpcs) # DescribeVpnConcentrators Describes one or more of your VPN concentrators. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to limit the results. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 200. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **VpnConcentratorId.N** One or more VPN concentrator IDs. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **vpnConcentratorSet** Information about the VPN concentrators. Type: Array of [VpnConcentrator](API_VpnConcentrator.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes all VPN Concentrators. #### Sample Request ``` https://ec2.us-east-1.amazonaws.com/?Version=2016-11-15&Action=DescribeVpnConcentrators ``` #### Sample Response ``` e1d4832f-cef7-4809-b9d4-3e54e50aff7a available tgw-attach-04a445da95a6814cc tgw-0eae06e326d7c27d8 ipsec.1 vcn-0767cb7521c5c4945 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpnConcentrators) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpnConcentrators) # DescribeVpnConnections Describes one or more of your VPN connections. For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `customer-gateway-configuration` - The configuration information for the customer gateway. + `customer-gateway-id` - The ID of a customer gateway associated with the VPN connection. + `state` - The state of the VPN connection (`pending` \$1 `available` \$1 `deleting` \$1 `deleted`). + `option.static-routes-only` - Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP). + `route.destination-cidr-block` - The destination CIDR block. This corresponds to the subnet used in a customer data center. + `bgp-asn` - The BGP Autonomous System Number (ASN) associated with a BGP device. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `type` - The type of VPN connection. Currently the only supported type is `ipsec.1`. + `vpn-connection-id` - The ID of the VPN connection. + `vpn-gateway-id` - The ID of a virtual private gateway associated with the VPN connection. + `transit-gateway-id` - The ID of a transit gateway associated with the VPN connection. Type: Array of [Filter](API_Filter.md) objects Required: No **VpnConnectionId.N** One or more VPN connection IDs. Default: Describes your VPN connections. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConnectionSet** Information about one or more VPN connections. Type: Array of [VpnConnection](API_VpnConnection.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the specified VPN connection. The response includes the customer gateway device configuration information. Because it's a long set of information, we haven't displayed it here. To see an example of the configuration information, see the [Your customer gateway device](https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html). #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpnConnections &VpnConnectionId.1=vpn-1122334455aabbccd &AUTHPARAMS ``` #### Sample Response ``` 6791f4b8-5717-4272-aed2-faa18example vpn-1122334455aabbccd available ..Customer gateway configuration data in escaped XML format... ipsec.1 cgw-01234567abcde1234 Name CanadaVPN 203.0.113.3 DOWN 2020-07-29T10:35:11.000Z 0 203.0.113.5 UP 2020-09-02T09:09:33.000Z 0 tgw-00112233445566aab false true 0.0.0.0/0 0.0.0.0/0 ipv4 VPN ``` ### Example 2 This example describes any VPN connection you own that is associated with the customer gateway with ID cgw-b4dc3961, and whose state is either `pending` or `available`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpnConnections &Filter.1.Name=customer-gateway-id &Filter.1.Value.1=cgw-b4dc3961 &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpnConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpnConnections) # DescribeVpnGateways Describes one or more of your virtual private gateways. For more information, see [AWS Site-to-Site VPN](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPC_VPN.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `amazon-side-asn` - The Autonomous System Number (ASN) for the Amazon side of the gateway. + `attachment.state` - The current state of the attachment between the gateway and the VPC (`attaching` \$1 `attached` \$1 `detaching` \$1 `detached`). + `attachment.vpc-id` - The ID of an attached VPC. + `availability-zone` - The Availability Zone for the virtual private gateway (if applicable). + `state` - The state of the virtual private gateway (`pending` \$1 `available` \$1 `deleting` \$1 `deleted`). + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. + `type` - The type of virtual private gateway. Currently the only supported type is `ipsec.1`. + `vpn-gateway-id` - The ID of the virtual private gateway. Type: Array of [Filter](API_Filter.md) objects Required: No **VpnGatewayId.N** One or more virtual private gateway IDs. Default: Describes all your virtual private gateways. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnGatewaySet** Information about one or more virtual private gateways. Type: Array of [VpnGateway](API_VpnGateway.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example describes the specified virtual private gateway. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpnGateways &VpnGatewayId.1=vgw-8db04f81 &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE vgw-8db04f81 available ipsec.1 vpc-4c090c2a attached 65001 Name NYOffice ``` ### Example 2 This example uses filters to describe any virtual private gateway you own whose state is either `pending` or `available`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DescribeVpnGateways &Filter.1.Name=state &Filter.1.Value.1=pending &Filter.1.Value.2=available &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DescribeVpnGateways) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeVpnGateways) # DetachClassicLinkVpc **Note** This action is deprecated. Unlinks (detaches) a linked EC2-Classic instance from a VPC. After the instance has been unlinked, the VPC security groups are no longer associated with it. An instance is automatically unlinked from a VPC when it's stopped. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance to unlink from the VPC. Type: String Required: Yes **VpcId** The ID of the VPC to which the instance is linked. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DetachClassicLinkVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DetachClassicLinkVpc) # DetachInternetGateway Detaches an internet gateway from a VPC, disabling connectivity between the internet and the VPC. The VPC must not contain any running instances with Elastic IP addresses or public IPv4 addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InternetGatewayId** The ID of the internet gateway. Type: String Required: Yes **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example The example detaches the specified internet gateway from the specified VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DetachInternetGateway &InternetGatewayId=igw-eaad4883 &VpcId=vpc-11ad4878 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DetachInternetGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DetachInternetGateway) # DetachNetworkInterface Detaches a network interface from an instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AttachmentId** The ID of the attachment. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Force** Specifies whether to force a detachment. + Use the `Force` parameter only as a last resort to detach a network interface from a failed instance. + If you use the `Force` parameter to detach a network interface, you might not be able to attach a different network interface to the same index on the instance without first stopping and starting the instance. + If you force the detachment of a network interface, the [instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) might not get updated. This means that the attributes associated with the detached network interface might still be visible. The instance metadata will get updated when you stop and start the instance. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example detaches the specified elastic network interface (ENI). #### Sample Request ``` https://ec2.amazonaws.com/?Action=DetachNetworkInterface &AttachmentId=eni-attach-d94b09b0 &AUTHPARAMS ``` #### Sample Response ``` ce540707-0635-46bc-97da-33a8a362a0e8 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DetachNetworkInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DetachNetworkInterface) # DetachVerifiedAccessTrustProvider Detaches the specified AWS Verified Access trust provider from the specified AWS Verified Access instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: Yes **VerifiedAccessTrustProviderId** The ID of the Verified Access trust provider. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessInstance** Details about the Verified Access instance. Type: [VerifiedAccessInstance](API_VerifiedAccessInstance.md) object **verifiedAccessTrustProvider** Details about the Verified Access trust provider. Type: [VerifiedAccessTrustProvider](API_VerifiedAccessTrustProvider.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DetachVerifiedAccessTrustProvider) # DetachVolume Detaches an EBS volume from an instance. Make sure to unmount any file systems on the device within your operating system before detaching the volume. Failure to do so can result in the volume becoming stuck in the `busy` state while detaching. If this happens, detachment can be delayed indefinitely until you unmount the volume, force detachment, reboot the instance, or all three. If an EBS volume is the root device of an instance, it can't be detached while the instance is running. To detach the root volume, stop the instance first. When a volume with an AWS Marketplace product code is detached from an instance, the product code is no longer associated with the instance. You can't detach or force detach volumes that are attached to AWS-managed resources. Attempting to do this results in the `UnsupportedOperationException` exception. For more information, see [Detach an Amazon EBS volume](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-detaching-volume.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Device** The device name. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Force** Forces detachment if the previous detachment attempt did not occur cleanly (for example, logging into an instance, unmounting the volume, and detaching normally). This option can lead to data loss or a corrupted file system. Use this option only as a last resort to detach a volume from a failed instance. The instance won't have an opportunity to flush file system caches or file system metadata. If you use this option, you must perform file system check and repair procedures. Type: Boolean Required: No **InstanceId** The ID of the instance. If you are detaching a Multi-Attach enabled volume, you must specify an instance ID. Type: String Required: No **VolumeId** The ID of the volume. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associatedResource** The ARN of the AWS-managed resource to which the volume is attached. Type: String **attachTime** The time stamp when the attachment initiated. Type: Timestamp **deleteOnTermination** Indicates whether the EBS volume is deleted on instance termination. Type: Boolean **device** The device name. If the volume is attached to an AWS-managed resource, this parameter returns `null`. Type: String **ebsCardIndex** The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0. Type: Integer **instanceId** The ID of the instance. If the volume is attached to an AWS-managed resource, this parameter returns `null`. Type: String **instanceOwningService** The service principal of the AWS service that owns the underlying resource to which the volume is attached. This parameter is returned only for volumes that are attached to AWS-managed resources. Type: String **requestId** The ID of the request. Type: String **status** The attachment state of the volume. Type: String Valid Values: `attaching | attached | detaching | detached | busy` **volumeId** The ID of the volume. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example detaches volume `vol-1234567890abcdef0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DetachVolume &VolumeId=vol-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE vol-1234567890abcdef0 i-1234567890abcdef0 /dev/sdh detaching YYYY-MM-DDTHH:MM:SS.000Z ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DetachVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DetachVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DetachVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DetachVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DetachVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DetachVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DetachVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DetachVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DetachVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DetachVolume) # DetachVpnGateway Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway (any attachments to the virtual private gateway are also described). You must wait for the attachment's state to switch to `detached` before you can delete the VPC or attach a different VPC to the virtual private gateway. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcId** The ID of the VPC. Type: String Required: Yes **VpnGatewayId** The ID of the virtual private gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example detaches the specified virtual private gateway from the specified VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DetachVpnGateway &VpnGatewayId=vgw-8db04f81 &VpcId=vpc-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DetachVpnGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DetachVpnGateway) # DisableAddressTransfer Disables Elastic IP address transfer. For more information, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId** The allocation ID of an Elastic IP address. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **addressTransfer** An Elastic IP address transfer. Type: [AddressTransfer](API_AddressTransfer.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableAddressTransfer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableAddressTransfer) # DisableAllowedImagesSettings Disables Allowed AMIs for your account in the specified AWS Region. When set to `disabled`, the image criteria in your Allowed AMIs settings do not apply, and no restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account. **Note** The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see [Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html) in *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **allowedImagesSettingsState** Returns `disabled` if the request succeeds; otherwise, it returns an error. Type: String Valid Values: `disabled` **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableAllowedImagesSettings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableAllowedImagesSettings) # DisableAwsNetworkPerformanceMetricSubscription Disables Infrastructure Performance metric subscriptions. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Destination** The target Region or Availability Zone that the metric subscription is disabled for. For example, `eu-north-1`. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Metric** The metric used for the disabled subscription. Type: String Valid Values: `aggregate-latency` Required: No **Source** The source Region or Availability Zone that the metric subscription is disabled for. For example, `us-east-1`. Type: String Required: No **Statistic** The statistic used for the disabled subscription. Type: String Valid Values: `p50` Required: No ## Response Elements The following elements are returned by the service. **output** Indicates whether the unsubscribe action was successful. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableAwsNetworkPerformanceMetricSubscription) # DisableCapacityManager Disables EC2 Capacity Manager for your account. This stops data ingestion and removes access to capacity analytics and optimization recommendations. Previously collected data is retained but no new data will be processed. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **capacityManagerStatus** The current status of Capacity Manager after the disable operation. Type: String Valid Values: `enabled | disabled` **organizationsAccess** Indicates whether Organizations access is enabled. This will be `false` after disabling Capacity Manager. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disables Capacity Manager for your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisableCapacityManager &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE disabled false ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableCapacityManager) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableCapacityManager) # DisableEbsEncryptionByDefault Disables EBS encryption by default for your account in the current Region. After you disable encryption by default, you can still create encrypted volumes by enabling encryption when you create each volume. Disabling encryption by default does not change the encryption status of your existing volumes. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **ebsEncryptionByDefault** The updated status of encryption by default. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableEbsEncryptionByDefault) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableEbsEncryptionByDefault) # DisableFastLaunch Discontinue Windows fast launch for a Windows AMI, and clean up existing pre-provisioned snapshots. After you disable Windows fast launch, the AMI uses the standard launch process for each new instance. Amazon EC2 must remove all pre-provisioned snapshots before you can enable Windows fast launch again. **Note** You can only change these settings for Windows AMIs that you own or that have been shared with you. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Force** Forces the image settings to turn off Windows fast launch for your Windows AMI. This parameter overrides any errors that are encountered while cleaning up resources in your account. Type: Boolean Required: No **ImageId** Specify the ID of the image for which to disable Windows fast launch. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **imageId** The ID of the image for which Windows fast launch was disabled. Type: String **launchTemplate** The launch template that was used to launch Windows instances from pre-provisioned snapshots. Type: [FastLaunchLaunchTemplateSpecificationResponse](API_FastLaunchLaunchTemplateSpecificationResponse.md) object **maxParallelLaunches** The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch. Type: Integer **ownerId** The owner of the Windows AMI for which Windows fast launch was disabled. Type: String **requestId** The ID of the request. Type: String **resourceType** The pre-provisioning resource type that must be cleaned after turning off Windows fast launch for the Windows AMI. Supported values include: `snapshot`. Type: String Valid Values: `snapshot` **snapshotConfiguration** Parameters that were used for Windows fast launch for the Windows AMI before Windows fast launch was disabled. This informs the clean-up process. Type: [FastLaunchSnapshotConfigurationResponse](API_FastLaunchSnapshotConfigurationResponse.md) object **state** The current state of Windows fast launch for the specified Windows AMI. Type: String Valid Values: `enabling | enabling-failed | enabled | enabled-failed | disabling | disabling-failed` **stateTransitionReason** The reason that the state changed for Windows fast launch for the Windows AMI. Type: String **stateTransitionTime** The time that the state changed for Windows fast launch for the Windows AMI. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableFastLaunch) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableFastLaunch) # DisableFastSnapshotRestores Disables fast snapshot restores for the specified snapshots in the specified Availability Zones. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone.N** One or more Availability Zones. For example, `us-east-2a`. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both. Type: Array of strings Required: No **AvailabilityZoneId.N** One or more Availability Zone IDs. For example, `use2-az1`. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SourceSnapshotId.N** The IDs of one or more snapshots. For example, `snap-1234567890abcdef0`. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successful** Information about the snapshots for which fast snapshot restores were successfully disabled. Type: Array of [DisableFastSnapshotRestoreSuccessItem](API_DisableFastSnapshotRestoreSuccessItem.md) objects **unsuccessful** Information about the snapshots for which fast snapshot restores could not be disabled. Type: Array of [DisableFastSnapshotRestoreErrorItem](API_DisableFastSnapshotRestoreErrorItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableFastSnapshotRestores) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableFastSnapshotRestores) # DisableImage Sets the AMI state to `disabled` and removes all launch permissions from the AMI. A disabled AMI can't be used for instance launches. A disabled AMI can't be shared. If an AMI was public or previously shared, it is made private. If an AMI was shared with an AWS account, organization, or Organizational Unit, they lose access to the disabled AMI. A disabled AMI does not appear in [DescribeImages](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) API calls by default. Only the AMI owner can disable an AMI. You can re-enable a disabled AMI using [EnableImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_EnableImage.html). For more information, see [Disable an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disables the specified AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisableImage &ImageId=ami-0123456789EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 11aabb229-4eac-35bd-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableImage) # DisableImageBlockPublicAccess Disables *block public access for AMIs* at the account level in the specified AWS Region. This removes the *block public access* restriction from your account. With the restriction removed, you can publicly share your AMIs in the specified AWS Region. For more information, see [Block public access to your AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-public-access-to-amis.html) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **imageBlockPublicAccessState** Returns `unblocked` if the request succeeds; otherwise, it returns an error. Type: String Valid Values: `unblocked` **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disables *block public access for AMIs* at the account level in the specified Region to allow users in your account to publicly share your AMIs in the specified Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisableImageBlockPublicAccess &Region=us-east-1 &AUTHPARAMS ``` #### Sample Response ``` 11aabb229-4eac-35bd-99ed-be587EXAMPLE unblocked ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableImageBlockPublicAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableImageBlockPublicAccess) # DisableImageDeprecation Cancels the deprecation of the specified AMI. For more information, see [Deprecate an Amazon EC2 AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example cancels the planned deprecation of the specified AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisableImageDeprecation &ImageId=ami-0123456789EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 11aabb229-4eac-35bd-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableImageDeprecation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableImageDeprecation) # DisableImageDeregistrationProtection Disables deregistration protection for an AMI. When deregistration protection is disabled, the AMI can be deregistered. If you chose to include a 24-hour cooldown period when you enabled deregistration protection for the AMI, then, when you disable deregistration protection, you won’t immediately be able to deregister the AMI. For more information, see [Protect an Amazon EC2 AMI from deregistration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deregistration-protection.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableImageDeregistrationProtection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableImageDeregistrationProtection) # DisableInstanceSqlHaStandbyDetections Disable Amazon EC2 instances running in an SQL Server High Availability cluster from SQL Server High Availability instance standby detection monitoring. Once disabled, AWS no longer monitors the metadata for the instances to determine whether they are active or standby nodes in the SQL Server High Availability cluster. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId.N** The IDs of the instances to disable from SQL Server High Availability standby detection monitoring. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 30 items. Required: Yes ## Response Elements The following elements are returned by the service. **instanceSet** Information about the instances that were disabled from SQL Server High Availability standby detection monitoring. Type: Array of [RegisteredInstance](API_RegisteredInstance.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableInstanceSqlHaStandbyDetections) # DisableIpamOrganizationAdminAccount Disable the IPAM account. For more information, see [Enable integration with AWS Organizations](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DelegatedAdminAccountId** The AWS Organizations member account ID that you want to disable as IPAM account. Type: String Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **success** The result of disabling the IPAM account. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableIpamOrganizationAdminAccount) # DisableIpamPolicy Disables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPolicyId** The ID of the IPAM policy to disable. Type: String Required: Yes **OrganizationTargetId** The ID of the AWS Organizations target for which to disable the IPAM policy. This parameter is required only when IPAM is integrated with AWS Organizations. When IPAM is not integrated with AWS Organizations, omit this parameter and the policy will be disabled for the current account. A target can be an individual AWS account or an entity within an AWS Organization to which an IPAM policy can be applied. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns true if the IPAM policy was successfully disabled. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableIpamPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableIpamPolicy) # DisableRouteServerPropagation Disables route propagation from a route server to a specified route table. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: + VPC route tables not associated with subnets + Subnet route tables + Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html). For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The ID of the route server for which to disable propagation. Type: String Required: Yes **RouteTableId** The ID of the route table for which to disable route server propagation. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerPropagation** Information about the disabled route server propagation. Type: [RouteServerPropagation](API_RouteServerPropagation.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableRouteServerPropagation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableRouteServerPropagation) # DisableSerialConsoleAccess Disables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see [Manage account access to the EC2 serial console](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **serialConsoleAccessEnabled** If `true`, access to the EC2 serial console of all instances is enabled for your account. If `false`, access to the EC2 serial console of all instances is disabled for your account. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableSerialConsoleAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableSerialConsoleAccess) # DisableSnapshotBlockPublicAccess Disables the *block public access for snapshots* setting at the account level for the specified AWS Region. After you disable block public access for snapshots in a Region, users can publicly share snapshots in that Region. **Important** Enabling block public access for snapshots in *block-all-sharing* mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available. If you disable block public access , these snapshots will become publicly available again. For more information, see [ Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) in the *Amazon EBS User Guide* . ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **state** Returns `unblocked` if the request succeeds. Type: String Valid Values: `block-all-sharing | block-new-sharing | unblocked` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableSnapshotBlockPublicAccess) # DisableTransitGatewayRouteTablePropagation Disables the specified resource attachment from propagating routes to the specified propagation route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: No **TransitGatewayRouteTableAnnouncementId** The ID of the route table announcement. Type: String Required: No **TransitGatewayRouteTableId** The ID of the propagation route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **propagation** Information about route propagation. Type: [TransitGatewayPropagation](API_TransitGatewayPropagation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableTransitGatewayRouteTablePropagation) # DisableVgwRoutePropagation Disables a virtual private gateway (VGW) from propagating routes to a specified route table of a VPC. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GatewayId** The ID of the virtual private gateway. Type: String Required: Yes **RouteTableId** The ID of the route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disables the virtual private gateway `vgw-d8e09e8a` from automatically propagating routes to the route table with ID `rtb-c98a35a0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisableVgwRoutePropagationResponse &RouteTableId=rtb-c98a35a0 &GatewayId=vgw-d8e09e8a &AUTHPARAMS ``` #### Sample Response ``` 4f35a1b2-c2c3-4093-b51f-abb9d7311990 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableVgwRoutePropagation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableVgwRoutePropagation) # DisableVpcClassicLink **Note** This action is deprecated. Disables ClassicLink for a VPC. You cannot disable ClassicLink for a VPC that has EC2-Classic instances linked to it. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableVpcClassicLink) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableVpcClassicLink) # DisableVpcClassicLinkDnsSupport **Note** This action is deprecated. Disables ClassicLink DNS support for a VPC. If disabled, DNS hostnames resolve to public IP addresses when addressed between a linked EC2-Classic instance and instances in the VPC to which it's linked. You must specify a VPC ID in the request. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **VpcId** The ID of the VPC. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disables ClassicLink DNS support for `vpc-8888888`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisableVpcClassicLinkDnsSupport &VpcId=vpc-8888888 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableVpcClassicLinkDnsSupport) # DisassociateAddress Disassociates an Elastic IP address from the instance or network interface it's associated with. This is an idempotent operation. If you perform the operation more than once, Amazon EC2 doesn't return an error. An address cannot be disassociated if the all of the following conditions are met: + Network interface has a `publicDualStackDnsName` publicDnsName + Public IPv4 address is the primary public IPv4 address + Network interface only has one remaining public IPv4 address ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId** The association ID. This parameter is required. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PublicIp** Deprecated. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disassociates the specified Elastic IP address from the instance to which it is associated. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisassociateAddress &AssociationId=eipassoc-aa7486c3 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateAddress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateAddress) # DisassociateCapacityReservationBillingOwner Cancels a pending request to assign billing of the unused capacity of a Capacity Reservation to a consumer account, or revokes a request that has already been accepted. For more information, see [Billing assignment for shared Amazon EC2 Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the Capacity Reservation. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **UnusedReservationBillingOwnerId** The ID of the consumer account to which the request was sent. Type: String Length Constraints: Fixed length of 12. Pattern: `[0-9]{12}` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateCapacityReservationBillingOwner) # DisassociateClientVpnTargetNetwork Disassociates a target network from the specified Client VPN endpoint. When you disassociate the last target network from a Client VPN, the following happens: + The route that was automatically added for the VPC is deleted + All active client connections are terminated + New client connections are disallowed + The Client VPN endpoint's status changes to `pending-associate` ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId** The ID of the target network association. Type: String Required: Yes **ClientVpnEndpointId** The ID of the Client VPN endpoint from which to disassociate the target network. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **associationId** The ID of the target network association. Type: String **requestId** The ID of the request. Type: String **status** The current state of the target network association. Type: [AssociationStatus](API_AssociationStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disassociates a target network from a Client VPN endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisassociateClientVpnTargetNetwork &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &AssociationId=cvpn-assoc-0bc4bd8cecEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 61312648-93ec-4a86-a1d1-098c9EXAMPLE disassociating cvpn-assoc-0bc4bd8cecEXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateClientVpnTargetNetwork) # DisassociateEnclaveCertificateIamRole Disassociates an IAM role from an AWS Certificate Manager (ACM) certificate. Disassociating an IAM role from an ACM certificate removes the Amazon S3 object that contains the certificate, certificate chain, and encrypted private key from the Amazon S3 bucket. It also revokes the IAM role's permission to use the KMS key used to encrypt the private key. This effectively revokes the role's permission to use the certificate. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CertificateArn** The ARN of the ACM certificate from which to disassociate the IAM role. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RoleArn** The ARN of the IAM role to disassociate. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateEnclaveCertificateIamRole) # DisassociateIamInstanceProfile Disassociates an IAM instance profile from a running or stopped instance. Use [DescribeIamInstanceProfileAssociations](API_DescribeIamInstanceProfileAssociations.md) to get the association ID. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId** The ID of the IAM instance profile association. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **iamInstanceProfileAssociation** Information about the IAM instance profile association. Type: [IamInstanceProfileAssociation](API_IamInstanceProfileAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disassociates the specified IAM instance profile association. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisassociateIamInstanceProfile &AssociationId=iip-assoc-08049da59357d598c &AUTHPARAMS ``` #### Sample Response ``` 4840f938-fc84-4791-8ae5-example iip-assoc-08049da59357d598c arn:aws:iam::123456789012:instance-profile/AdminProfile AIPAI5IVIHMFFYY2DKV5Y i-1234567890abcdef0 disassociating ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateIamInstanceProfile) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateIamInstanceProfile) # DisassociateInstanceEventWindow Disassociates one or more targets from an event window. For more information, see [Define event windows for scheduled events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationTarget** One or more targets to disassociate from the specified event window. Type: [InstanceEventWindowDisassociationRequest](API_InstanceEventWindowDisassociationRequest.md) object Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceEventWindowId** The ID of the event window. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **instanceEventWindow** Information about the event window. Type: [InstanceEventWindow](API_InstanceEventWindow.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateInstanceEventWindow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateInstanceEventWindow) # DisassociateIpamByoasn Remove the association between your Autonomous System Number (ASN) and your BYOIP CIDR. You may want to use this action to disassociate an ASN from a CIDR or if you want to swap ASNs. For more information, see [Tutorial: Bring your ASN to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) in the *Amazon VPC IPAM guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Asn** A public 2-byte or 4-byte ASN. Type: String Required: Yes **Cidr** A BYOIP CIDR. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **asnAssociation** An ASN and BYOIP CIDR association. Type: [AsnAssociation](API_AsnAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateIpamByoasn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateIpamByoasn) # DisassociateIpamResourceDiscovery Disassociates a resource discovery from an Amazon VPC IPAM. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamResourceDiscoveryAssociationId** A resource discovery association ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamResourceDiscoveryAssociation** A resource discovery association. Type: [IpamResourceDiscoveryAssociation](API_IpamResourceDiscoveryAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateIpamResourceDiscovery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateIpamResourceDiscovery) # DisassociateNatGatewayAddress Disassociates secondary Elastic IP addresses (EIPs) from a public NAT gateway. You cannot disassociate your primary EIP. For more information, see [Edit secondary IP address associations](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html#nat-gateway-edit-secondary) in the *Amazon VPC User Guide*. While disassociating is in progress, you cannot associate/disassociate additional EIPs while the connections are being drained. You are, however, allowed to delete the NAT gateway. An EIP is released only at the end of MaxDrainDurationSeconds. It stays associated and supports the existing connections but does not support any new connections (new connections are distributed across the remaining associated EIPs). As the existing connections drain out, the EIPs (and the corresponding private IP addresses mapped to them) are released. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId.N** The association IDs of EIPs that have been associated with the NAT gateway. Type: Array of strings Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxDrainDurationSeconds** The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds. Type: Integer Valid Range: Minimum value of 1. Maximum value of 4000. Required: No **NatGatewayId** The ID of the NAT gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **natGatewayAddressSet** Information about the NAT gateway IP addresses. Type: Array of [NatGatewayAddress](API_NatGatewayAddress.md) objects **natGatewayId** The ID of the NAT gateway. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateNatGatewayAddress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateNatGatewayAddress) # DisassociateRouteServer Disassociates a route server from a VPC. A route server association is the connection established between a route server and a VPC. For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The ID of the route server to disassociate. Type: String Required: Yes **VpcId** The ID of the VPC to disassociate from the route server. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerAssociation** Information about the disassociated route server. Type: [RouteServerAssociation](API_RouteServerAssociation.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateRouteServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateRouteServer) # DisassociateRouteTable Disassociates a subnet or gateway from a route table. After you perform this action, the subnet no longer uses the routes in the route table. Instead, it uses the routes in the VPC's main route table. For more information about route tables, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId** The association ID representing the current association between the route table and subnet or gateway. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disassociates the specified route table from the subnet it's associated to. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisassociateRouteTable &AssociationId=rtbassoc-0531ae3257956bdfb &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateRouteTable) # DisassociateSecurityGroupVpc Disassociates a security group from a VPC. You cannot disassociate the security group if any Elastic network interfaces in the associated VPC are still associated with the security group. Note that the disassociation is asynchronous and you can check the status of the request with [DescribeSecurityGroupVpcAssociations](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSecurityGroupVpcAssociations.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupId** A security group ID. Type: String Required: Yes **VpcId** A VPC ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **state** The state of the disassociation. Type: String Valid Values: `associating | associated | association-failed | disassociating | disassociated | disassociation-failed` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateSecurityGroupVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateSecurityGroupVpc) # DisassociateSubnetCidrBlock Disassociates a CIDR block from a subnet. Currently, you can disassociate an IPv6 CIDR block only. You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId** The association ID for the CIDR block. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipv6CidrBlockAssociation** Information about the IPv6 CIDR block association. Type: [SubnetIpv6CidrBlockAssociation](API_SubnetIpv6CidrBlockAssociation.md) object **requestId** The ID of the request. Type: String **subnetId** The ID of the subnet. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disassociates the IPv6 CIDR block from the subnet. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisassociateSubnetCidrBlock &AssociationId=subnet-cidr-assoc-3aa54053 &AUTHPARAMS ``` #### Sample Response ``` subnet-5f46ec3b 2001:db8:1234:1a00::/64 disassociating subnet-cidr-assoc-3aa54053 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateSubnetCidrBlock) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateSubnetCidrBlock) # DisassociateTransitGatewayMulticastDomain Disassociates the specified subnets from the transit gateway multicast domain. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SubnetIds.N** The IDs of the subnets; Type: Array of strings Required: Yes **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associations** Information about the association. Type: [TransitGatewayMulticastDomainAssociations](API_TransitGatewayMulticastDomainAssociations.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example disassociates the subnet `subnet-000de86e3bEXAMPLE` from the multicast domain `tgw-mcast-domain-0c4905cef7EXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisassociateTransitGatewayMulticastDomain &TransitGatewayAttachmentId=tgw-attach-070e571cd1EXAMPLE &SubnetId=subnet-000de86e3bEXAMPLE &TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef7EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 0008db4a-b98a-46f7-b047-e262aEXAMPLE vpc-7EXAMPLE vpc disassociating subnet-000de86e3bEXAMPLE tgw-attach-070e571cd1EXAMPLE tgw-mcast-domain-0c4905cef7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateTransitGatewayMulticastDomain) # DisassociateTransitGatewayPolicyTable Removes the association between an an attachment and a policy table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the transit gateway attachment to disassociate from the policy table. Type: String Required: Yes **TransitGatewayPolicyTableId** The ID of the disassociated policy table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **association** Returns details about the transit gateway policy table disassociation. Type: [TransitGatewayPolicyTableAssociation](API_TransitGatewayPolicyTableAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateTransitGatewayPolicyTable) # DisassociateTransitGatewayRouteTable Disassociates a resource attachment from a transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **association** Information about the association. Type: [TransitGatewayAssociation](API_TransitGatewayAssociation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateTransitGatewayRouteTable) # DisassociateTrunkInterface Removes an association between a branch network interface with a trunk network interface. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId** The ID of the association Type: String Required: Yes **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateTrunkInterface) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateTrunkInterface) # DisassociateVpcCidrBlock Disassociates a CIDR block from a VPC. To disassociate the CIDR block, you must specify its association ID. You can get the association ID by using [DescribeVpcs](API_DescribeVpcs.md). You must detach or delete all gateways and resources that are associated with the CIDR block before you can disassociate it. You cannot disassociate the CIDR block with which you originally created the VPC (the primary CIDR block). ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociationId** The association ID for the CIDR block. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **cidrBlockAssociation** Information about the IPv4 CIDR block association. Type: [VpcCidrBlockAssociation](API_VpcCidrBlockAssociation.md) object **ipv6CidrBlockAssociation** Information about the IPv6 CIDR block association. Type: [VpcIpv6CidrBlockAssociation](API_VpcIpv6CidrBlockAssociation.md) object **requestId** The ID of the request. Type: String **vpcId** The ID of the VPC. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disassociates the IPv6 CIDR block from the VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=DisassociateVpcCidrBlock &AssociationId=vpc-cidr-assoc-e2a5408b &AUTHPARAMS ``` #### Sample Response ``` 2001:db8:1234:1a00::/56 disassociating vpc-cidr-assoc-e2a5408b vpc-a034d6c4 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/DisassociateVpcCidrBlock) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisassociateVpcCidrBlock) # EnableAddressTransfer Enables Elastic IP address transfer. For more information, see [Transfer Elastic IP addresses](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-eips.html#transfer-EIPs-intro) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId** The allocation ID of an Elastic IP address. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransferAccountId** The ID of the account that you want to transfer the Elastic IP address to. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **addressTransfer** An Elastic IP address transfer. Type: [AddressTransfer](API_AddressTransfer.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableAddressTransfer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableAddressTransfer) # EnableAllowedImagesSettings Enables Allowed AMIs for your account in the specified AWS Region. Two values are accepted: + `enabled`: The image criteria in your Allowed AMIs settings are applied. As a result, only AMIs matching these criteria are discoverable and can be used by your account to launch instances. + `audit-mode`: The image criteria in your Allowed AMIs settings are not applied. No restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account. The purpose of `audit-mode` is to indicate which AMIs will be affected when Allowed AMIs is `enabled`. In `audit-mode`, each AMI displays either `"ImageAllowed": true` or `"ImageAllowed": false` to indicate whether the AMI will be discoverable and available to users in the account when Allowed AMIs is enabled. **Note** The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see [Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html) in *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllowedImagesSettingsState** Specify `enabled` to apply the image criteria specified by the Allowed AMIs settings. Specify `audit-mode` so that you can check which AMIs will be allowed or not allowed by the image criteria. Type: String Valid Values: `enabled | audit-mode` Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **allowedImagesSettingsState** Returns `enabled` or `audit-mode` if the request succeeds; otherwise, it returns an error. Type: String Valid Values: `enabled | audit-mode` **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableAllowedImagesSettings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableAllowedImagesSettings) # EnableAwsNetworkPerformanceMetricSubscription Enables Infrastructure Performance subscriptions. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Destination** The target Region (like `us-east-2`) or Availability Zone ID (like `use2-az2`) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Metric** The metric used for the enabled subscription. Type: String Valid Values: `aggregate-latency` Required: No **Source** The source Region (like `us-east-1`) or Availability Zone ID (like `use1-az1`) that the metric subscription is enabled for. If you use Availability Zone IDs, the Source and Destination Availability Zones must be in the same Region. Type: String Required: No **Statistic** The statistic used for the enabled subscription. Type: String Valid Values: `p50` Required: No ## Response Elements The following elements are returned by the service. **output** Indicates whether the subscribe action was successful. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableAwsNetworkPerformanceMetricSubscription) # EnableCapacityManager Enables EC2 Capacity Manager for your account. This starts data ingestion for your EC2 capacity usage across On-Demand, Spot, and Capacity Reservations. Initial data processing may take several hours to complete. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **OrganizationsAccess** Specifies whether to enable cross-account access for AWS Organizations. When enabled, Capacity Manager can aggregate data from all accounts in your organization. Default is false. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **capacityManagerStatus** The current status of Capacity Manager after the enable operation. Type: String Valid Values: `enabled | disabled` **organizationsAccess** Indicates whether Organizations access is enabled for cross-account data aggregation. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example enables Capacity Manager with Organizations access for cross-account data aggregation. #### Sample Request ``` https://ec2.amazonaws.com/?Action=EnableCapacityManager &OrganizationsAccess=true &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE enabled true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableCapacityManager) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableCapacityManager) # EnableEbsEncryptionByDefault Enables EBS encryption by default for your account in the current Region. After you enable encryption by default, the EBS volumes that you create are always encrypted, either using the default KMS key or the KMS key that you specified when you created each volume. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. You can specify the default KMS key for encryption by default using [ModifyEbsDefaultKmsKeyId](API_ModifyEbsDefaultKmsKeyId.md) or [ResetEbsDefaultKmsKeyId](API_ResetEbsDefaultKmsKeyId.md). Enabling encryption by default has no effect on the encryption status of your existing volumes. After you enable encryption by default, you can no longer launch instances using instance types that do not support encryption. For more information, see [Supported instance types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption-requirements.html#ebs-encryption_supported_instances). ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **ebsEncryptionByDefault** The updated status of encryption by default. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableEbsEncryptionByDefault) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableEbsEncryptionByDefault) # EnableFastLaunch When you enable Windows fast launch for a Windows AMI, images are pre-provisioned, using snapshots to launch instances up to 65% faster. To create the optimized Windows image, Amazon EC2 launches an instance and runs through Sysprep steps, rebooting as required. Then it creates a set of reserved snapshots that are used for subsequent launches. The reserved snapshots are automatically replenished as they are used, depending on your settings for launch frequency. **Note** You can only change these settings for Windows AMIs that you own or that have been shared with you. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** Specify the ID of the image for which to enable Windows fast launch. Type: String Required: Yes **LaunchTemplate** The launch template to use when launching Windows instances from pre-provisioned snapshots. Launch template parameters can include either the name or ID of the launch template, but not both. Type: [FastLaunchLaunchTemplateSpecificationRequest](API_FastLaunchLaunchTemplateSpecificationRequest.md) object Required: No **MaxParallelLaunches** The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch. Value must be `6` or greater. Type: Integer Required: No **ResourceType** The type of resource to use for pre-provisioning the AMI for Windows fast launch. Supported values include: `snapshot`, which is the default value. Type: String Required: No **SnapshotConfiguration** Configuration settings for creating and managing the snapshots that are used for pre-provisioning the AMI for Windows fast launch. The associated `ResourceType` must be `snapshot`. Type: [FastLaunchSnapshotConfigurationRequest](API_FastLaunchSnapshotConfigurationRequest.md) object Required: No ## Response Elements The following elements are returned by the service. **imageId** The image ID that identifies the AMI for which Windows fast launch was enabled. Type: String **launchTemplate** The launch template that is used when launching Windows instances from pre-provisioned snapshots. Type: [FastLaunchLaunchTemplateSpecificationResponse](API_FastLaunchLaunchTemplateSpecificationResponse.md) object **maxParallelLaunches** The maximum number of instances that Amazon EC2 can launch at the same time to create pre-provisioned snapshots for Windows fast launch. Type: Integer **ownerId** The owner ID for the AMI for which Windows fast launch was enabled. Type: String **requestId** The ID of the request. Type: String **resourceType** The type of resource that was defined for pre-provisioning the AMI for Windows fast launch. Type: String Valid Values: `snapshot` **snapshotConfiguration** Settings to create and manage the pre-provisioned snapshots that Amazon EC2 uses for faster launches from the Windows AMI. This property is returned when the associated `resourceType` is `snapshot`. Type: [FastLaunchSnapshotConfigurationResponse](API_FastLaunchSnapshotConfigurationResponse.md) object **state** The current state of Windows fast launch for the specified AMI. Type: String Valid Values: `enabling | enabling-failed | enabled | enabled-failed | disabling | disabling-failed` **stateTransitionReason** The reason that the state changed for Windows fast launch for the AMI. Type: String **stateTransitionTime** The time that the state changed for Windows fast launch for the AMI. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableFastLaunch) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableFastLaunch) # EnableFastSnapshotRestores Enables fast snapshot restores for the specified snapshots in the specified Availability Zones. You get the full benefit of fast snapshot restores after they enter the `enabled` state. To get the current state of fast snapshot restores, use [DescribeFastSnapshotRestores](API_DescribeFastSnapshotRestores.md). To disable fast snapshot restores, use [DisableFastSnapshotRestores](API_DisableFastSnapshotRestores.md). For more information, see [Amazon EBS fast snapshot restore](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-fast-snapshot-restore.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone.N** One or more Availability Zones. For example, `us-east-2a`. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both. Type: Array of strings Required: No **AvailabilityZoneId.N** One or more Availability Zone IDs. For example, `use2-az1`. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SourceSnapshotId.N** The IDs of one or more snapshots. For example, `snap-1234567890abcdef0`. You can specify a snapshot that was shared with you from another AWS account. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successful** Information about the snapshots for which fast snapshot restores were successfully enabled. Type: Array of [EnableFastSnapshotRestoreSuccessItem](API_EnableFastSnapshotRestoreSuccessItem.md) objects **unsuccessful** Information about the snapshots for which fast snapshot restores could not be enabled. Type: Array of [EnableFastSnapshotRestoreErrorItem](API_EnableFastSnapshotRestoreErrorItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableFastSnapshotRestores) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableFastSnapshotRestores) # EnableImage Re-enables a disabled AMI. The re-enabled AMI is marked as `available` and can be used for instance launches, appears in describe operations, and can be shared. AWS accounts, organizations, and Organizational Units that lost access to the AMI when it was disabled do not regain access automatically. Once the AMI is available, it can be shared with them again. Only the AMI owner can re-enable a disabled AMI. For more information, see [Disable an Amazon EC2 AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/disable-an-ami.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example enables the specified AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=EnableImage &ImageId=ami-0123456789EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 11aabb229-4eac-35bd-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableImage) # EnableImageBlockPublicAccess Enables *block public access for AMIs* at the account level in the specified AWS Region. This prevents the public sharing of your AMIs. However, if you already have public AMIs, they will remain publicly available. The API can take up to 10 minutes to configure this setting. During this time, if you run [GetImageBlockPublicAccessState](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetImageBlockPublicAccessState.html), the response will be `unblocked`. When the API has completed the configuration, the response will be `block-new-sharing`. For more information, see [Block public access to your AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-public-access-to-amis.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageBlockPublicAccessState** Specify `block-new-sharing` to enable block public access for AMIs at the account level in the specified Region. This will block any attempt to publicly share your AMIs in the specified Region. Type: String Valid Values: `block-new-sharing` Required: Yes ## Response Elements The following elements are returned by the service. **imageBlockPublicAccessState** Returns `block-new-sharing` if the request succeeds; otherwise, it returns an error. Type: String Valid Values: `block-new-sharing` **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example enables *block public access for AMIs* at the account level in the specified Region to prevent users in your account from publicly sharing your AMIs in the specified Region. If you already have public AMIs, they will remain publicly available. #### Sample Request ``` https://ec2.amazonaws.com/?Action=EnableImageBlockPublicAccess &Region=us-east-1 &ImageBlockPublicAccessState=block-new-sharing &AUTHPARAMS ``` #### Sample Response ``` 11aabb229-4eac-35bd-99ed-be587EXAMPLE block-new-sharing ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableImageBlockPublicAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableImageBlockPublicAccess) # EnableImageDeprecation Enables deprecation of the specified AMI at the specified date and time. For more information, see [Deprecate an AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deprecate.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DeprecateAt** The date and time to deprecate the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute. You can’t specify a date in the past. The upper limit for `DeprecateAt` is 10 years from now, except for public AMIs, where the upper limit is 2 years from the creation date. Type: Timestamp Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example deprecates the specified AMI at the specified date and time. If you specify a value for seconds, Amazon EC2 rounds the seconds to the nearest minute. #### Sample Request ``` https://ec2.amazonaws.com/?Action=EnableImageDeprecation &ImageId=ami-0123456789EXAMPLE &DeprecateAt="2022-06-15T13:17:00.000Z" &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableImageDeprecation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableImageDeprecation) # EnableImageDeregistrationProtection Enables deregistration protection for an AMI. When deregistration protection is enabled, the AMI can't be deregistered. To allow the AMI to be deregistered, you must first disable deregistration protection. For more information, see [Protect an Amazon EC2 AMI from deregistration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-deregistration-protection.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes **WithCooldown** If `true`, enforces deregistration protection for 24 hours after deregistration protection is disabled. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableImageDeregistrationProtection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableImageDeregistrationProtection) # EnableInstanceSqlHaStandbyDetections Enable Amazon EC2 instances running in an SQL Server High Availability cluster for SQL Server High Availability instance standby detection monitoring. Once enabled, AWS monitors the metadata for the instances to determine whether they are active or standby nodes in the SQL Server High Availability cluster. If the instances are determined to be standby failover nodes, AWS automatically applies SQL Server licensing fee waiver for those instances. To register an instance, it must be running a Windows SQL Server license-included AMI and have the AWS Systems Manager agent installed and running. Only Windows Server 2019 and later and SQL Server (Standard and Enterprise editions) 2017 and later are supported. For more information, see [ Prerequisites for using SQL Server High Availability instance standby detection](https://docs.aws.amazon.com/sql-server-ec2/latest/userguide/prerequisites-and-requirements.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId.N** The IDs of the instances to enable for SQL Server High Availability standby detection monitoring. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 30 items. Required: Yes **SqlServerCredentials** The ARN of the AWS Secrets Manager secret containing the SQL Server access credentials. The specified secret must contain valid SQL Server credentials for the specified instances. If not specified, deafult local user credentials will be used by the AWS Systems Manager agent. To enable instances with different credentials, you must make separate requests. Type: String Pattern: `^(?=.{20,2048}$)arn:aws[a-z-]*:secretsmanager:[a-z0-9-]+:\d{12}:secret:[a-zA-Z0-9/_+=.@-]+` Required: No ## Response Elements The following elements are returned by the service. **instanceSet** Information about the instances that were enabled for SQL Server High Availability standby detection monitoring. Type: Array of [RegisteredInstance](API_RegisteredInstance.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableInstanceSqlHaStandbyDetections) # EnableIpamOrganizationAdminAccount Enable an AWS Organizations member account as the IPAM admin account. You cannot select the AWS Organizations management account as the IPAM admin account. For more information, see [Enable integration with AWS Organizations](https://docs.aws.amazon.com/vpc/latest/ipam/enable-integ-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DelegatedAdminAccountId** The AWS Organizations member account ID that you want to enable as the IPAM account. Type: String Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **success** The result of enabling the IPAM account. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableIpamOrganizationAdminAccount) # EnableIpamPolicy Enables an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. For more information, see [Define public IPv4 allocation strategy with IPAM policies](https://docs.aws.amazon.com/vpc/latest/ipam/define-public-ipv4-allocation-strategy-with-ipam-policies.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPolicyId** The ID of the IPAM policy to enable. Type: String Required: Yes **OrganizationTargetId** The ID of the AWS Organizations target for which to enable the IPAM policy. This parameter is required only when IPAM is integrated with AWS Organizations. When IPAM is not integrated with AWS Organizations, omit this parameter and the policy will apply to the current account. A target can be an individual AWS account or an entity within an AWS Organization to which an IPAM policy can be applied. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPolicyId** The ID of the IPAM policy that was enabled. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableIpamPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableIpamPolicy) # EnableReachabilityAnalyzerOrganizationSharing Establishes a trust relationship between Reachability Analyzer and AWS Organizations. This operation must be performed by the management account for the organization. After you establish a trust relationship, a user in the management account or a delegated administrator account can run a cross-account analysis using resources from the member accounts. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **returnValue** Returns `true` if the request succeeds; otherwise, returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableReachabilityAnalyzerOrganizationSharing) # EnableRouteServerPropagation Defines which route tables the route server can update with routes. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The ID of the route server for which to enable propagation. Type: String Required: Yes **RouteTableId** The ID of the route table to which route server will propagate routes. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerPropagation** Information about the enabled route server propagation. Type: [RouteServerPropagation](API_RouteServerPropagation.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableRouteServerPropagation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableRouteServerPropagation) # EnableSerialConsoleAccess Enables access to the EC2 serial console of all instances for your account. By default, access to the EC2 serial console is disabled for your account. For more information, see [Manage account access to the EC2 serial console](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **serialConsoleAccessEnabled** If `true`, access to the EC2 serial console of all instances is enabled for your account. If `false`, access to the EC2 serial console of all instances is disabled for your account. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableSerialConsoleAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableSerialConsoleAccess) # EnableSnapshotBlockPublicAccess Enables or modifies the *block public access for snapshots* setting at the account level for the specified AWS Region. After you enable block public access for snapshots in a Region, users can no longer request public sharing for snapshots in that Region. Snapshots that are already publicly shared are either treated as private or they remain publicly shared, depending on the **State** that you specify. **Important** Enabling block public access for snapshots in *block all sharing* mode does not change the permissions for snapshots that are already publicly shared. Instead, it prevents these snapshots from be publicly visible and publicly accessible. Therefore, the attributes for these snapshots still indicate that they are publicly shared, even though they are not publicly available. If you later disable block public access or change the mode to *block new sharing*, these snapshots will become publicly available again. For more information, see [ Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **State** The mode in which to enable block public access for snapshots for the Region. Specify one of the following values: + `block-all-sharing` - Prevents all public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. Additionally, snapshots that are already publicly shared are treated as private and they are no longer publicly available. + `block-new-sharing` - Prevents only new public sharing of snapshots in the Region. Users in the account will no longer be able to request new public sharing. However, snapshots that are already publicly shared, remain publicly available. `unblocked` is not a valid value for **EnableSnapshotBlockPublicAccess**. Type: String Valid Values: `block-all-sharing | block-new-sharing | unblocked` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **state** The state of block public access for snapshots for the account and Region. Returns either `block-all-sharing` or `block-new-sharing` if the request succeeds. Type: String Valid Values: `block-all-sharing | block-new-sharing | unblocked` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableSnapshotBlockPublicAccess) # EnableTransitGatewayRouteTablePropagation Enables the specified attachment to propagate routes to the specified propagation route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: No **TransitGatewayRouteTableAnnouncementId** The ID of the transit gateway route table announcement. Type: String Required: No **TransitGatewayRouteTableId** The ID of the propagation route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **propagation** Information about route propagation. Type: [TransitGatewayPropagation](API_TransitGatewayPropagation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableTransitGatewayRouteTablePropagation) # EnableVgwRoutePropagation Enables a virtual private gateway (VGW) to propagate routes to the specified route table of a VPC. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GatewayId** The ID of the virtual private gateway that is attached to a VPC. The virtual private gateway must be attached to the same VPC that the routing tables are associated with. Type: String Required: Yes **RouteTableId** The ID of the route table. The routing table must be associated with the same VPC that the virtual private gateway is attached to. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example enables the specified virtual private gateway to propagate routes automatically to the route table with the ID `rtb-c98a35a0`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=EnableVgwRoutePropagation &RouteTableID=rtb-c98a35a0 &GatewayId=vgw-d8e09e8a &AUTHPARAMS ``` #### Sample Response ``` 4f35a1b2-c2c3-4093-b51f-abb9d7311990 true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableVgwRoutePropagation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableVgwRoutePropagation) # EnableVolumeIO Enables I/O operations for a volume that had I/O operations disabled because the data on the volume was potentially inconsistent. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VolumeId** The ID of the volume. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example enables the I/O operations of the volume vol-8888888. #### Sample Request ``` https://ec2.amazonaws.com/?Action=EnableVolumeIO &VolumeId= vol-8888888 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableVolumeIO) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableVolumeIO) # EnableVpcClassicLink **Note** This action is deprecated. Enables a VPC for ClassicLink. You can then link EC2-Classic instances to your ClassicLink-enabled VPC to allow communication over private IP addresses. You cannot enable your VPC for ClassicLink if any of your VPC route tables have existing routes for address ranges within the `10.0.0.0/8` IP address range, excluding local routes for VPCs in the `10.0.0.0/16` and `10.1.0.0/16` IP address ranges. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableVpcClassicLink) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableVpcClassicLink) # EnableVpcClassicLinkDnsSupport **Note** This action is deprecated. Enables a VPC to support DNS hostname resolution for ClassicLink. If enabled, the DNS hostname of a linked EC2-Classic instance resolves to its private IP address when addressed from an instance in the VPC to which it's linked. Similarly, the DNS hostname of an instance in a VPC resolves to its private IP address when addressed from a linked EC2-Classic instance. You must specify a VPC ID in the request. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **VpcId** The ID of the VPC. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableVpcClassicLinkDnsSupport) # ExportClientVpnClientCertificateRevocationList Downloads the client certificate revocation list for the specified Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **certificateRevocationList** Information about the client certificate revocation list. Type: String **requestId** The ID of the request. Type: String **status** The current state of the client certificate revocation list. Type: [ClientCertificateRevocationListStatus](API_ClientCertificateRevocationListStatus.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportClientVpnClientCertificateRevocationList) # ExportClientVpnClientConfiguration Downloads the contents of the Client VPN endpoint configuration file for the specified Client VPN endpoint. The Client VPN endpoint configuration file includes the Client VPN endpoint and certificate information clients need to establish a connection with the Client VPN endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientVpnEndpointId** The ID of the Client VPN endpoint. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **clientConfiguration** The contents of the Client VPN endpoint configuration file. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example downloads a Client VPN endpoint configuration file. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ExportClientVpnClientConfiguration &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 44e88bf8-d460-4c43-80b8-a27e4EXAMPLE client dev tun proto udp remote cvpn-endpoint-00c5d11fc4EXAMPLE.clientvpn.us-east-1.amazonaws.com 443 remote-random-hostname resolv-retry infinite nobind persist-key persist-tun remote-cert-tls server cipher AES-256-CBC verb 3 -----BEGIN CERTIFICATE----- EXAMPLECAgmgAwIBAgIJAOjnW3hL6o+7MA0GCSqGSIb3DQEBCwUAMBAxDEXAMPLE -----END CERTIFICATE----- ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ExportClientVpnClientConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportClientVpnClientConfiguration) # ExportImage Exports an Amazon Machine Image (AMI) to a VM file. For more information, see [Exporting a VM directly from an Amazon Machine Image (AMI)](https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport_image.html) in the *VM Import/Export User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Token to enable idempotency for export image requests. Type: String Required: No **Description** A description of the image being exported. The maximum length is 255 characters. Type: String Required: No **DiskImageFormat** The disk image format. Type: String Valid Values: `VMDK | RAW | VHD` Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the image. Type: String Required: Yes **RoleName** The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'. Type: String Required: No **S3ExportLocation** The Amazon S3 bucket for the destination image. The destination bucket must exist. Type: [ExportTaskS3LocationRequest](API_ExportTaskS3LocationRequest.md) object Required: Yes **TagSpecification.N** The tags to apply to the export image task during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **description** A description of the image being exported. Type: String **diskImageFormat** The disk image format for the exported image. Type: String Valid Values: `VMDK | RAW | VHD` **exportImageTaskId** The ID of the export image task. Type: String **imageId** The ID of the image. Type: String **progress** The percent complete of the export image task. Type: String **requestId** The ID of the request. Type: String **roleName** The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. Type: String **s3ExportLocation** Information about the destination Amazon S3 bucket. Type: [ExportTaskS3Location](API_ExportTaskS3Location.md) object **status** The status of the export image task. The possible values are `active`, `completed`, `deleting`, and `deleted`. Type: String **statusMessage** The status message for the export image task. Type: String **tagSet** Any tags assigned to the export image task. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ExportImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ExportImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ExportImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ExportImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ExportImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ExportImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ExportImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportImage) # ExportTransitGatewayRoutes Exports routes from the specified transit gateway route table to the specified S3 bucket. By default, all routes are exported. Alternatively, you can filter by CIDR range. The routes are saved to the specified bucket in a JSON file. For more information, see [Export route tables to Amazon S3](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-route-tables.html#tgw-export-route-tables) in the * AWS Transit Gateways Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `attachment.transit-gateway-attachment-id` - The id of the transit gateway attachment. + `attachment.resource-id` - The resource id of the transit gateway attachment. + `route-search.exact-match` - The exact match of the specified filter. + `route-search.longest-prefix-match` - The longest prefix that matches the route. + `route-search.subnet-of-match` - The routes with a subnet that match the specified CIDR filter. + `route-search.supernet-of-match` - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29. + `state` - The state of the route (`active` \$1 `blackhole`). + `transit-gateway-route-destination-cidr-block` - The CIDR range. + `type` - The type of route (`propagated` \$1 `static`). Type: Array of [Filter](API_Filter.md) objects Required: No **S3Bucket** The name of the S3 bucket. Type: String Required: Yes **TransitGatewayRouteTableId** The ID of the route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **s3Location** The URL of the exported file in Amazon S3. For example, s3://*bucket\$1name*/VPCTransitGateway/TransitGatewayRouteTables/*file\$1name*. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ExportTransitGatewayRoutes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportTransitGatewayRoutes) # ExportVerifiedAccessInstanceClientConfiguration Exports the client configuration for a Verified Access instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **deviceTrustProviderSet** The device trust providers. Type: Array of strings Valid Values: `jamf | crowdstrike | jumpcloud` **openVpnConfigurationSet** The Open VPN configuration. Type: Array of [VerifiedAccessInstanceOpenVpnClientConfiguration](API_VerifiedAccessInstanceOpenVpnClientConfiguration.md) objects **region** The Region. Type: String **requestId** The ID of the request. Type: String **userTrustProvider** The user identity trust provider. Type: [VerifiedAccessInstanceUserTrustProviderClientConfiguration](API_VerifiedAccessInstanceUserTrustProviderClientConfiguration.md) object **verifiedAccessInstanceId** The ID of the Verified Access instance. Type: String **version** The version. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportVerifiedAccessInstanceClientConfiguration) # GetActiveVpnTunnelStatus Returns the currently negotiated security parameters for an active VPN tunnel, including IKE version, DH groups, encryption algorithms, and integrity algorithms. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request. Type: Boolean Required: No **VpnConnectionId** The ID of the VPN connection for which to retrieve the active tunnel status. Type: String Required: Yes **VpnTunnelOutsideIpAddress** The external IP address of the VPN tunnel for which to retrieve the active status. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **activeVpnTunnelStatus** Information about the current security configuration of the VPN tunnel. Type: [ActiveVpnTunnelStatus](API_ActiveVpnTunnelStatus.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetActiveVpnTunnelStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetActiveVpnTunnelStatus) # GetAllowedImagesSettings Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria at the account level in the specified Region. **Note** The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account. For more information, see [Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html) in *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **imageCriterionSet** The list of criteria for images that are discoverable and usable in the account in the specified AWS Region. Type: Array of [ImageCriterion](API_ImageCriterion.md) objects **managedBy** The entity that manages the Allowed AMIs settings. Possible values include: + `account` - The Allowed AMIs settings is managed by the account. + `declarative-policy` - The Allowed AMIs settings is managed by a declarative policy and can't be modified by the account. Type: String Valid Values: `account | declarative-policy` **requestId** The ID of the request. Type: String **state** The current state of the Allowed AMIs setting at the account level in the specified AWS Region. Possible values: + `disabled`: All AMIs are allowed. + `audit-mode`: All AMIs are allowed, but the `ImageAllowed` field is set to `true` if the AMI would be allowed with the current list of criteria if allowed AMIs was enabled. + `enabled`: Only AMIs matching the image criteria are discoverable and available for use. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetAllowedImagesSettings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetAllowedImagesSettings) # GetAssociatedEnclaveCertificateIamRoles Returns the IAM roles that are associated with the specified ACM (ACM) certificate. It also returns the name of the Amazon S3 bucket and the Amazon S3 object key where the certificate, certificate chain, and encrypted private key bundle are stored, and the ARN of the KMS key that's used to encrypt the private key. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CertificateArn** The ARN of the ACM certificate for which to view the associated IAM roles, encryption keys, and Amazon S3 object information. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **associatedRoleSet** Information about the associated IAM roles. Type: Array of [AssociatedRole](API_AssociatedRole.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetAssociatedEnclaveCertificateIamRoles) # GetAssociatedIpv6PoolCidrs Gets information about the IPv6 CIDR block associations for a specified IPv6 address pool. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PoolId** The ID of the IPv6 address pool. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipv6CidrAssociationSet** Information about the IPv6 CIDR block associations. Type: Array of [Ipv6CidrAssociation](API_Ipv6CidrAssociation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetAssociatedIpv6PoolCidrs) # GetAwsNetworkPerformanceData Gets network performance data. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DataQuery.N** A list of network performance data queries. Type: Array of [DataQuery](API_DataQuery.md) objects Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndTime** The ending time for the performance data request. The end time must be formatted as `yyyy-mm-ddThh:mm:ss`. For example, `2022-06-12T12:00:00.000Z`. Type: Timestamp Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Required: No **NextToken** The token for the next page of results. Type: String Required: No **StartTime** The starting time for the performance data request. The starting time must be formatted as `yyyy-mm-ddThh:mm:ss`. For example, `2022-06-10T12:00:00.000Z`. Type: Timestamp Required: No ## Response Elements The following elements are returned by the service. **dataResponseSet** The list of data responses. Type: Array of [DataResponse](API_DataResponse.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetAwsNetworkPerformanceData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetAwsNetworkPerformanceData) # GetCapacityManagerAttributes Retrieves the current configuration and status of EC2 Capacity Manager for your account, including enablement status, Organizations access settings, and data ingestion status. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **capacityManagerStatus** The current status of Capacity Manager. Type: String Valid Values: `enabled | disabled` **dataExportCount** The number of active data export configurations for this account. This count includes all data exports regardless of their current delivery status. Type: Integer **earliestDatapointTimestamp** The timestamp of the earliest data point available in Capacity Manager, in milliseconds since epoch. This indicates how far back historical data is available for queries. Type: Timestamp **ingestionStatus** The current data ingestion status. Initial ingestion may take several hours after enabling Capacity Manager. Type: String Valid Values: `initial-ingestion-in-progress | ingestion-complete | ingestion-failed` **ingestionStatusMessage** A descriptive message providing additional details about the current ingestion status. This may include error information if ingestion has failed or progress details during initial setup. Type: String **latestDatapointTimestamp** The timestamp of the most recent data point ingested by Capacity Manager, in milliseconds since epoch. This indicates how current your capacity data is. Type: Timestamp **organizationsAccess** Indicates whether Organizations access is enabled for cross-account data aggregation. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example retrieves the current Capacity Manager attributes for your account. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetCapacityManagerAttributes &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE enabled true 2 ingestion-complete Data ingestion is up to date. 2025-12-23T20:00:00+00:00 2026-03-23T15:00:00+00:00 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetCapacityManagerAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetCapacityManagerAttributes) # GetCapacityManagerMetricData Retrieves capacity usage metrics for your EC2 resources. Returns time-series data for metrics like unused capacity, utilization rates, and costs across On-Demand, Spot, and Capacity Reservations. Data can be grouped and filtered by various dimensions such as region, account, and instance family. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndTime** The end time for the metric data query, in ISO 8601 format. If the end time is beyond the latest ingested data, it will be automatically adjusted to the latest available data point. Type: Timestamp Required: Yes **FilterBy.N** Conditions to filter the metric data. Each filter specifies a dimension, comparison operator ('equals', 'in'), and values to match against. Type: Array of [CapacityManagerCondition](API_CapacityManagerCondition.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No **GroupBy.N** The dimensions by which to group the metric data. This determines how the data is aggregated and returned. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 20 items. Length Constraints: Minimum length of 0. Maximum length of 300. Valid Values: `resource-region | availability-zone-id | account-id | account-name | instance-family | instance-type | instance-platform | reservation-arn | reservation-id | reservation-type | reservation-create-timestamp | reservation-start-timestamp | reservation-end-timestamp | reservation-end-date-type | tenancy | reservation-state | reservation-instance-match-criteria | reservation-unused-financial-owner` Required: No **MaxResults** The maximum number of data points to return. Valid range is 1 to 100,000. Use with NextToken for pagination of large result sets. Type: Integer Required: No **MetricName.N** The names of the metrics to retrieve. Maximum of 10 metrics per request. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 40 items. Valid Values: `reservation-total-capacity-hrs-vcpu | reservation-total-capacity-hrs-inst | reservation-max-size-vcpu | reservation-max-size-inst | reservation-min-size-vcpu | reservation-min-size-inst | reservation-unused-total-capacity-hrs-vcpu | reservation-unused-total-capacity-hrs-inst | reservation-unused-total-estimated-cost | reservation-max-unused-size-vcpu | reservation-max-unused-size-inst | reservation-min-unused-size-vcpu | reservation-min-unused-size-inst | reservation-max-utilization | reservation-min-utilization | reservation-avg-utilization-vcpu | reservation-avg-utilization-inst | reservation-total-count | reservation-total-estimated-cost | reservation-avg-future-size-vcpu | reservation-avg-future-size-inst | reservation-min-future-size-vcpu | reservation-min-future-size-inst | reservation-max-future-size-vcpu | reservation-max-future-size-inst | reservation-avg-committed-size-vcpu | reservation-avg-committed-size-inst | reservation-max-committed-size-vcpu | reservation-max-committed-size-inst | reservation-min-committed-size-vcpu | reservation-min-committed-size-inst | reserved-total-usage-hrs-vcpu | reserved-total-usage-hrs-inst | reserved-total-estimated-cost | unreserved-total-usage-hrs-vcpu | unreserved-total-usage-hrs-inst | unreserved-total-estimated-cost | spot-total-usage-hrs-vcpu | spot-total-usage-hrs-inst | spot-total-estimated-cost | spot-avg-run-time-before-interruption-inst | spot-max-run-time-before-interruption-inst | spot-min-run-time-before-interruption-inst` Required: Yes **NextToken** The token for the next page of results. Use this value in a subsequent call to retrieve additional data points. Type: String Required: No **Period** The granularity, in seconds, of the returned data points. Type: Integer Valid Range: Minimum value of 3600. Required: Yes **StartTime** The start time for the metric data query, in ISO 8601 format. The time range (end time - start time) must be a multiple of the specified period. Type: Timestamp Required: Yes ## Response Elements The following elements are returned by the service. **metricDataResultSet** The metric data points returned by the query. Each result contains dimension values, timestamp, and metric values with their associated statistics. Type: Array of [MetricDataResult](API_MetricDataResult.md) objects **nextToken** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example retrieves hourly unused capacity metrics grouped by instance family for a specific time range. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetCapacityManagerMetricData &MetricName.1=reservation-unused-total-capacity-hrs-vcpu &StartTime=2024-01-15T00:00:00Z &EndTime=2024-01-16T00:00:00Z &Period=3600 &GroupBy.1=instanceFamily &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE m5 2024-01-15T00:00:00.000Z reservation-unused-total-capacity-hrs-vcpu 150.0 c5 2024-01-15T00:00:00.000Z reservation-unused-total-capacity-hrs-vcpu 75.5 ``` ### Example 2 This example retrieves On-Demand usage metrics grouped by the `environment` tag dimension and filtered to only production resources. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetCapacityManagerMetricData &MetricName.1=unreserved-total-usage-hrs-vcpu &StartTime=2024-01-15T00:00:00Z &EndTime=2024-01-16T00:00:00Z &Period=3600 &GroupBy.1=tag:environment &FilterBy.1.DimensionCondition.Dimension=tag:environment &FilterBy.1.DimensionCondition.Comparison=equals &FilterBy.1.DimensionCondition.Value.1=prod &AUTHPARAMS ``` #### Sample Response ``` a1b2c3d4-e5f6-7890-abcd-1234EXAMPLE environment prod 2024-01-15T00:00:00.000Z unreserved-total-usage-hrs-vcpu 320.0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetCapacityManagerMetricData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetCapacityManagerMetricData) # GetCapacityManagerMetricDimensions Retrieves the available dimension values for capacity metrics within a specified time range. This is useful for discovering what accounts, regions, instance families, and other dimensions have data available for filtering and grouping. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndTime** The end time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned. Type: Timestamp Required: Yes **FilterBy.N** Conditions to filter which dimension values are returned. Each filter specifies a dimension, comparison operator, and values to match against. Type: Array of [CapacityManagerCondition](API_CapacityManagerCondition.md) objects Array Members: Minimum number of 0 items. Maximum number of 20 items. Required: No **GroupBy.N** The dimensions to group by when retrieving available dimension values. This determines which dimension combinations are returned. Required parameter. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 20 items. Length Constraints: Minimum length of 0. Maximum length of 300. Valid Values: `resource-region | availability-zone-id | account-id | account-name | instance-family | instance-type | instance-platform | reservation-arn | reservation-id | reservation-type | reservation-create-timestamp | reservation-start-timestamp | reservation-end-timestamp | reservation-end-date-type | tenancy | reservation-state | reservation-instance-match-criteria | reservation-unused-financial-owner` Required: Yes **MaxResults** The maximum number of dimension combinations to return. Valid range is 1 to 1000. Use with NextToken for pagination. Type: Integer Required: No **MetricName.N** The metric names to use as an additional filter when retrieving dimensions. Only dimensions that have data for these metrics will be returned. Required parameter with maximum size of 1 for v1. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 40 items. Valid Values: `reservation-total-capacity-hrs-vcpu | reservation-total-capacity-hrs-inst | reservation-max-size-vcpu | reservation-max-size-inst | reservation-min-size-vcpu | reservation-min-size-inst | reservation-unused-total-capacity-hrs-vcpu | reservation-unused-total-capacity-hrs-inst | reservation-unused-total-estimated-cost | reservation-max-unused-size-vcpu | reservation-max-unused-size-inst | reservation-min-unused-size-vcpu | reservation-min-unused-size-inst | reservation-max-utilization | reservation-min-utilization | reservation-avg-utilization-vcpu | reservation-avg-utilization-inst | reservation-total-count | reservation-total-estimated-cost | reservation-avg-future-size-vcpu | reservation-avg-future-size-inst | reservation-min-future-size-vcpu | reservation-min-future-size-inst | reservation-max-future-size-vcpu | reservation-max-future-size-inst | reservation-avg-committed-size-vcpu | reservation-avg-committed-size-inst | reservation-max-committed-size-vcpu | reservation-max-committed-size-inst | reservation-min-committed-size-vcpu | reservation-min-committed-size-inst | reserved-total-usage-hrs-vcpu | reserved-total-usage-hrs-inst | reserved-total-estimated-cost | unreserved-total-usage-hrs-vcpu | unreserved-total-usage-hrs-inst | unreserved-total-estimated-cost | spot-total-usage-hrs-vcpu | spot-total-usage-hrs-inst | spot-total-estimated-cost | spot-avg-run-time-before-interruption-inst | spot-max-run-time-before-interruption-inst | spot-min-run-time-before-interruption-inst` Required: Yes **NextToken** The token for the next page of results. Use this value in a subsequent call to retrieve additional dimension values. Type: String Required: No **StartTime** The start time for the dimension query, in ISO 8601 format. Only dimensions with data in this time range will be returned. Type: Timestamp Required: Yes ## Response Elements The following elements are returned by the service. **metricDimensionResultSet** The available dimension combinations that have data within the specified time range and filters. Type: Array of [CapacityManagerDimension](API_CapacityManagerDimension.md) objects **nextToken** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example retrieves the available instance families that have unused capacity data in a given time range. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetCapacityManagerMetricDimensions &GroupBy.1=instanceFamily &MetricName.1=reservation-unused-total-capacity-hrs-vcpu &StartTime=2024-01-15T00:00:00Z &EndTime=2024-01-16T00:00:00Z &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE m5 c5 r5 ``` ### Example 2 This example retrieves the unique values of the `environment` tag dimension that have On-Demand usage data in a given time range. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetCapacityManagerMetricDimensions &GroupBy.1=tag:environment &MetricName.1=unreserved-total-usage-hrs-vcpu &StartTime=2024-01-15T00:00:00Z &EndTime=2024-01-16T00:00:00Z &AUTHPARAMS ``` #### Sample Response ``` a1b2c3d4-e5f6-7890-abcd-5678EXAMPLE environment prod environment staging environment ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetCapacityManagerMetricDimensions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetCapacityManagerMetricDimensions) # GetCapacityManagerMonitoredTagKeys Retrieves the tag keys that are currently being monitored by EC2 Capacity Manager. Monitored tag keys are included as dimensions in capacity metric data, enabling you to group and filter metrics by tag values. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned `NextToken` value. If not specified, up to 1000 results are returned. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Use the value returned from a previous call to retrieve additional results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityManagerTagKeySet** The list of tag keys being monitored by Capacity Manager, including their current status and metadata. Type: Array of [CapacityManagerMonitoredTagKey](API_CapacityManagerMonitoredTagKey.md) objects **nextToken** The token to use to retrieve the next page of results. This value is null when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example retrieves the tag keys currently being monitored by Capacity Manager. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetCapacityManagerMonitoredTagKeys &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE Environment activated false 2025-12-23T20:00:00+00:00 aws:autoscaling:groupName activated true 2025-12-23T20:00:00+00:00 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetCapacityManagerMonitoredTagKeys) # GetCapacityReservationUsage Gets usage information about a Capacity Reservation. If the Capacity Reservation is shared, it shows usage information for the Capacity Reservation owner and each AWS account that is currently using the shared capacity. If the Capacity Reservation is not shared, it shows only the Capacity Reservation owner's usage. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the Capacity Reservation. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **availableInstanceCount** The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation. Type: Integer **capacityReservationId** The ID of the Capacity Reservation. Type: String **instanceType** The type of instance for which the Capacity Reservation reserves capacity. Type: String **instanceUsageSet** Information about the Capacity Reservation usage. Type: Array of [InstanceUsage](API_InstanceUsage.md) objects **interruptible** Indicates whether the Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity. Type: Boolean **interruptibleCapacityAllocation** Information about the capacity allocated to the interruptible Capacity Reservation, including instance counts and allocation status. Type: [InterruptibleCapacityAllocation](API_InterruptibleCapacityAllocation.md) object **interruptionInfo** Details about the interruption configuration and source reservation for interruptible Capacity Reservations. Type: [InterruptionInfo](API_InterruptionInfo.md) object **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **state** The current state of the Capacity Reservation. A Capacity Reservation can be in one of the following states: + `active` - The capacity is available for use. + `expired` - The Capacity Reservation expired automatically at the date and time specified in your reservation request. The reserved capacity is no longer available for your use. + `cancelled` - The Capacity Reservation was canceled. The reserved capacity is no longer available for your use. + `pending` - The Capacity Reservation request was successful but the capacity provisioning is still pending. + `failed` - The Capacity Reservation request has failed. A request can fail due to request parameters that are not valid, capacity constraints, or instance limit constraints. You can view a failed request for 60 minutes. + `scheduled` - (*Future-dated Capacity Reservations*) The future-dated Capacity Reservation request was approved and the Capacity Reservation is scheduled for delivery on the requested start date. + `payment-pending` - (*Capacity Blocks*) The upfront payment has not been processed yet. + `payment-failed` - (*Capacity Blocks*) The upfront payment was not processed in the 12-hour time frame. Your Capacity Block was released. + `assessing` - (*Future-dated Capacity Reservations*) Amazon EC2 is assessing your request for a future-dated Capacity Reservation. + `delayed` - (*Future-dated Capacity Reservations*) Amazon EC2 encountered a delay in provisioning the requested future-dated Capacity Reservation. Amazon EC2 is unable to deliver the requested capacity by the requested start date and time. + `unsupported` - (*Future-dated Capacity Reservations*) Amazon EC2 can't support the future-dated Capacity Reservation request due to capacity constraints. You can view unsupported requests for 30 days. The Capacity Reservation will not be delivered. Type: String Valid Values: `active | expired | cancelled | pending | failed | scheduled | payment-pending | payment-failed | assessing | delayed | unsupported | unavailable` **totalInstanceCount** The number of instances for which the Capacity Reservation reserves capacity. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetCapacityReservationUsage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetCapacityReservationUsage) # GetCoipPoolUsage Describes the allocations from the specified customer-owned address pool. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `coip-address-usage.allocation-id` - The allocation ID of the address. + `coip-address-usage.aws-account-id` - The ID of the AWS account that is using the customer-owned IP address. + `coip-address-usage.aws-service` - The AWS service that is using the customer-owned IP address. + `coip-address-usage.co-ip` - The customer-owned IP address. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PoolId** The ID of the address pool. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **coipAddressUsageSet** Information about the address usage. Type: Array of [CoipAddressUsage](API_CoipAddressUsage.md) objects **coipPoolId** The ID of the customer-owned address pool. Type: String **localGatewayRouteTableId** The ID of the local gateway route table. Type: String **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetCoipPoolUsage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetCoipPoolUsage) # GetConsoleOutput Gets the console output for the specified instance. For Linux instances, the instance console output displays the exact console output that would normally be displayed on a physical monitor attached to a computer. For Windows instances, the instance console output includes the last three system event log errors. For more information, see [Instance console output](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html#instance-console-console-output) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **Latest** When enabled, retrieves the latest console output for the instance. Default: disabled (`false`) Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **instanceId** The ID of the instance. Type: String **output** The console output, base64-encoded. If you are using a command line tool, the tool decodes the output for you. Type: String **requestId** The ID of the request. Type: String **timestamp** The time at which the output was last updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example retrieves the console output for the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetConsoleOutput &InstanceId=i-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 2022-10-14T01:12:41.000Z TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj YyB2ZXJzaW9uIDQuMC4xIDIwMDUwNzI3IChSZWQgSGF0IDQuMC4xLTUpKSAjMSBTTVAgVGh1IE9j dCAyNiAwODo0MToyNiBTQVNUIDIwMDYKQklPUy1wcm92aWRlZCBwaHlzaWNhbCBSQU0gbWFwOgpY ZW46IDAwMDAwMDAwMDAwMDAwMDAgLSAwMDAwMDAwMDZhNDAwMDAwICh1c2FibGUpCjk4ME1CIEhJ R0hNRU0gYXZhaWxhYmxlLgo3MjdNQiBMT1dNRU0gYXZhaWxhYmxlLgpOWCAoRXhlY3V0ZSBEaXNh YmxlKSBwcm90ZWN0aW9uOiBhY3RpdmUKSVJRIGxvY2t1cCBkZXRlY3Rpb24gZGlzYWJsZWQKQnVp bHQgMSB6b25lbGlzdHMKS2VybmVsIGNvbW1hbmQgbGluZTogcm9vdD0vZGV2L3NkYTEgcm8gNApF bmFibGluZyBmYXN0IEZQVSBzYXZlIGFuZCByZXN0b3JlLi4uIGRvbmUuCg== ``` ### Example 2 This example retrieves the latest console output for the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetConsoleOutput &InstanceId=i-1234567890abcdef0 &Latest=true &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetConsoleOutput) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetConsoleOutput) # GetConsoleScreenshot Retrieve a JPG-format screenshot of a running instance to help with troubleshooting. The returned content is Base64-encoded. For more information, see [Instance console output](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/troubleshoot-unreachable-instance.html#instance-console-console-output) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **WakeUp** When set to `true`, acts as keystroke input and wakes up an instance that's in standby or "sleep" mode. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **imageData** The data that comprises the image. Type: String **instanceId** The ID of the instance. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example returns the image data of a successful request. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetConsoleScreenshot &InstanceId=i-0598c7d356eba48d7 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE 997987/8kgj49ikjhewkwwe0008084EXAMPLE i-765950 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetConsoleScreenshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetConsoleScreenshot) # GetDeclarativePoliciesReportSummary Retrieves a summary of the account status report. To view the full report, download it from the Amazon S3 bucket where it was saved. Reports are accessible only when they have the `complete` status. Reports with other statuses (`running`, `cancelled`, or `error`) are not available in the S3 bucket. For more information about downloading objects from an S3 bucket, see [Downloading objects](https://docs.aws.amazon.com/AmazonS3/latest/userguide/download-objects.html) in the *Amazon Simple Storage Service User Guide*. For more information, see [Generating the account status report for declarative policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_declarative_status-report.html) in the * AWS Organizations User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReportId** The ID of the report. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **attributeSummarySet** The attributes described in the report. Type: Array of [AttributeSummary](API_AttributeSummary.md) objects **endTime** The time when the report generation ended. Type: Timestamp **numberOfAccounts** The total number of accounts associated with the specified `targetId`. Type: Integer **numberOfFailedAccounts** The number of accounts where attributes could not be retrieved in any Region. Type: Integer **reportId** The ID of the report. Type: String **requestId** The ID of the request. Type: String **s3Bucket** The name of the Amazon S3 bucket where the report is located. Type: String **s3Prefix** The prefix for your S3 object. Type: String **startTime** The time when the report generation started. Type: Timestamp **targetId** The root ID, organizational unit ID, or account ID. Format: + For root: `r-ab12` + For OU: `ou-ab12-cdef1234` + For account: `123456789012` Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetDeclarativePoliciesReportSummary) # GetDefaultCreditSpecification Describes the default credit option for CPU usage of a burstable performance instance family. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceFamily** The instance family. Type: String Valid Values: `t2 | t3 | t3a | t4g` Required: Yes ## Response Elements The following elements are returned by the service. **instanceFamilyCreditSpecification** The default credit option for CPU usage of the instance family. Type: [InstanceFamilyCreditSpecification](API_InstanceFamilyCreditSpecification.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example gets the default credit option for CPU usage of instances in the T2 instance family in the specified Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetDefaultCreditSpecification &Region=us-east-1 &InstanceFamily=t2 &AUTHPARAMS ``` #### Sample Response ``` 11111111-2222-3333-4444-5555EXAMPLE unlimited t2 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetDefaultCreditSpecification) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetDefaultCreditSpecification) # GetEbsDefaultKmsKeyId Describes the default AWS KMS key for EBS encryption by default for your account in this Region. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **kmsKeyId** The Amazon Resource Name (ARN) of the default KMS key for encryption by default. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetEbsDefaultKmsKeyId) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetEbsDefaultKmsKeyId) # GetEbsEncryptionByDefault Describes whether EBS encryption by default is enabled for your account in the current Region. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **ebsEncryptionByDefault** Indicates whether encryption by default is enabled. Type: Boolean **requestId** The ID of the request. Type: String **sseType** Reserved for future use. Type: String Valid Values: `sse-ebs | sse-kms | none` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetEbsEncryptionByDefault) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetEbsEncryptionByDefault) # GetEnabledIpamPolicy Gets the enabled IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **ipamPolicyEnabled** Indicates whether the IPAM policy is enabled. Type: Boolean **ipamPolicyId** The ID of the enabled IPAM policy. Type: String **managedBy** The entity that manages the IPAM policy. Type: String Valid Values: `account | delegated-administrator-for-ipam` **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetEnabledIpamPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetEnabledIpamPolicy) # GetFlowLogsIntegrationTemplate Generates a CloudFormation template that streamlines and automates the integration of VPC flow logs with Amazon Athena. This make it easier for you to query and gain insights from VPC flow logs data. Based on the information that you provide, we configure resources in the template to do the following: + Create a table in Athena that maps fields to a custom log format + Create a Lambda function that updates the table with new partitions on a daily, weekly, or monthly basis + Create a table partitioned between two timestamps in the past + Create a set of named queries in Athena that you can use to get started quickly **Note** `GetFlowLogsIntegrationTemplate` does not support integration between AWS Transit Gateway Flow Logs and Amazon Athena. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ConfigDeliveryS3DestinationArn** To store the CloudFormation template in Amazon S3, specify the location in Amazon S3. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FlowLogId** The ID of the flow log. Type: String Required: Yes **IntegrateService** Information about the service integration. Type: [IntegrateServices](API_IntegrateServices.md) object Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **result** The generated CloudFormation template. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetFlowLogsIntegrationTemplate) # GetGroupsForCapacityReservation Lists the resource groups to which a Capacity Reservation has been added. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the Capacity Reservation. If you specify a Capacity Reservation that is shared with you, the operation returns only Capacity Reservation groups that you own. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token to use to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **capacityReservationGroupSet** Information about the resource groups to which the Capacity Reservation has been added. Type: Array of [CapacityReservationGroup](API_CapacityReservationGroup.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetGroupsForCapacityReservation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetGroupsForCapacityReservation) # GetHostReservationPurchasePreview Preview a reservation purchase with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This is a preview of the [PurchaseHostReservation](API_PurchaseHostReservation.md) action and does not result in the offering being purchased. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **HostIdSet.N** The IDs of the Dedicated Hosts with which the reservation is associated. Type: Array of strings Required: Yes **OfferingId** The offering ID of the reservation. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **currencyCode** The currency in which the `totalUpfrontPrice` and `totalHourlyPrice` amounts are specified. At this time, the only supported currency is `USD`. Type: String Valid Values: `USD` **purchase** The purchase information of the Dedicated Host reservation and the Dedicated Hosts associated with it. Type: Array of [Purchase](API_Purchase.md) objects **requestId** The ID of the request. Type: String **totalHourlyPrice** The potential total hourly price of the reservation per hour. Type: String **totalUpfrontPrice** The potential total upfront price. This is billed immediately. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example is a preview of the reservation to be purchased. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetHostReservationPurchasePreview &OfferingId=hro-0eb3541dght849c2d &HostIdSet=h-0fgr9ddb0ecd0a1cd &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-84c3-4967-gtyk-a9983EXAMPLE 31536000 7453.000 PartialUpfront m4 0.850 h-0fgr9ddb0ecd0a1cd 0.850 7453.000 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetHostReservationPurchasePreview) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetHostReservationPurchasePreview) # GetImageAncestry Retrieves the ancestry chain of the specified AMI, tracing its lineage back to the root AMI. For more information, see [AMI ancestry](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-ancestry.html) in *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI whose ancestry you want to trace. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **imageAncestryEntrySet** A list of entries in the AMI ancestry chain, from the specified AMI to the root AMI. Type: Array of [ImageAncestryEntry](API_ImageAncestryEntry.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetImageAncestry) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetImageAncestry) # GetImageBlockPublicAccessState Gets the current state of *block public access for AMIs* at the account level in the specified AWS Region. For more information, see [Block public access to your AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-public-access-to-amis.html) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **imageBlockPublicAccessState** The current state of block public access for AMIs at the account level in the specified AWS Region. Possible values: + `block-new-sharing` - Any attempt to publicly share your AMIs in the specified Region is blocked. + `unblocked` - Your AMIs in the specified Region can be publicly shared. Type: String **managedBy** The entity that manages the state for block public access for AMIs. Possible values include: + `account` - The state is managed by the account. + `declarative-policy` - The state is managed by a declarative policy and can't be modified by the account. Type: String Valid Values: `account | declarative-policy` **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example gets the state of *block public access for AMIs* at the account level in the specified Region to see whether the public sharing of your AMIs is blocked in your account. The value for the response is either `block-new-sharing` or `unblocked`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetImageBlockPublicAccessState &Region=us-east-1 &AUTHPARAMS ``` #### Sample Response ``` 11aabb229-4eac-35bd-99ed-be587EXAMPLE block-new-sharing ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetImageBlockPublicAccessState) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetImageBlockPublicAccessState) # GetInstanceMetadataDefaults Gets the default instance metadata service (IMDS) settings that are set at the account level in the specified AWS  Region. For more information, see [Order of precedence for instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **accountLevel** The account-level default IMDS settings. Type: [InstanceMetadataDefaultsResponse](API_InstanceMetadataDefaultsResponse.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetInstanceMetadataDefaults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetInstanceMetadataDefaults) # GetInstanceTpmEkPub Gets the public endorsement key associated with the Nitro Trusted Platform Module (NitroTPM) for the specified instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Specify this parameter to verify whether the request will succeed, without actually making the request. If the request will succeed, the response is `DryRunOperation`. Otherwise, the response is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance for which to get the public endorsement key. Type: String Required: Yes **KeyFormat** The required public endorsement key format. Specify `der` for a DER-encoded public key that is compatible with OpenSSL. Specify `tpmt` for a TPM 2.0 format that is compatible with tpm2-tools. The returned key is base64 encoded. Type: String Valid Values: `der | tpmt` Required: Yes **KeyType** The required public endorsement key type. Type: String Valid Values: `rsa-2048 | ecc-sec-p384` Required: Yes ## Response Elements The following elements are returned by the service. **instanceId** The ID of the instance. Type: String **keyFormat** The public endorsement key format. Type: String Valid Values: `der | tpmt` **keyType** The public endorsement key type. Type: String Valid Values: `rsa-2048 | ecc-sec-p384` **keyValue** The public endorsement key material. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetInstanceTpmEkPub) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetInstanceTpmEkPub) # GetInstanceTypesFromInstanceRequirements Returns a list of instance types with the specified instance attributes. You can use the response to preview the instance types without launching instances. Note that the response does not consider capacity. When you specify multiple parameters, you get instance types that satisfy all of the specified parameters. If you specify multiple values for a parameter, you get instance types that satisfy any of the specified values. For more information, see [Preview instance types with specified attributes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-get-instance-types-from-instance-requirements), [Specify attributes for instance type selection for EC2 Fleet or Spot Fleet](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html), and [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*, and [Creating mixed instance groups using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-asg-instance-type-requirements.html) in the *Amazon EC2 Auto Scaling User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ArchitectureType.N** The processor architecture type. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 3 items. Valid Values: `i386 | x86_64 | arm64 | x86_64_mac | arm64_mac` Required: Yes **Context** Reserved. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceRequirements** The attributes required for the instance types. Type: [InstanceRequirementsRequest](API_InstanceRequirementsRequest.md) object Required: Yes **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VirtualizationType.N** The virtualization type. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: `hvm | paravirtual` Required: Yes ## Response Elements The following elements are returned by the service. **instanceTypeSet** The instance types with the specified instance attributes. Type: Array of [InstanceTypeInfoFromInstanceRequirements](API_InstanceTypeInfoFromInstanceRequirements.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetInstanceTypesFromInstanceRequirements) # GetInstanceUefiData A binary representation of the UEFI variable store. Only non-volatile variables are stored. This is a base64 encoded and zlib compressed binary value that must be properly encoded. When you use [register-image](https://docs.aws.amazon.com/cli/latest/reference/ec2/register-image.html) to create an AMI, you can create an exact copy of your variable store by passing the UEFI data in the `UefiData` parameter. You can modify the UEFI data by using the [python-uefivars tool](https://github.com/awslabs/python-uefivars) on GitHub. You can use the tool to convert the UEFI data into a human-readable format (JSON), which you can inspect and modify, and then convert back into the binary format to use with register-image. For more information, see [UEFI Secure Boot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance from which to retrieve the UEFI data. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **instanceId** The ID of the instance from which to retrieve the UEFI data. Type: String **requestId** The ID of the request. Type: String **uefiData** Base64 representation of the non-volatile UEFI variable store. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetInstanceUefiData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetInstanceUefiData) # GetIpamAddressHistory Retrieve historical information about a CIDR within an IPAM scope. For more information, see [View the history of IP addresses](https://docs.aws.amazon.com/vpc/latest/ipam/view-history-cidr-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The CIDR you want the history of. The CIDR can be an IPv4 or IPv6 IP address range. If you enter a /16 IPv4 CIDR, you will get records that match it exactly. You will not get records for any subnets within the /16 CIDR. Type: String Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndTime** The end of the time period for which you are looking for history. If you omit this option, it will default to the current time. Type: Timestamp Required: No **IpamScopeId** The ID of the IPAM scope that the CIDR is in. Type: String Required: Yes **MaxResults** The maximum number of historical results you would like returned per page. Defaults to 100. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **StartTime** The start of the time period for which you are looking for history. If you omit this option, it will default to the value of EndTime. Type: Timestamp Required: No **VpcId** The ID of the VPC you want your history records filtered by. Type: String Required: No ## Response Elements The following elements are returned by the service. **historyRecordSet** A historical record for a CIDR within an IPAM scope. If the CIDR is associated with an EC2 instance, you will see an object in the response for the instance and one for the network interface. Type: Array of [IpamAddressHistoryRecord](API_IpamAddressHistoryRecord.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamAddressHistory) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamAddressHistory) # GetIpamDiscoveredAccounts Gets IPAM discovered accounts. A discovered account is an AWS account that is monitored under a resource discovery. If you have integrated IPAM with AWS Organizations, all accounts in the organization are discovered accounts. Only the IPAM account can get all discovered accounts in the organization. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DiscoveryRegion** The AWS Region that the account information is returned from. Type: String Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Discovered account filters. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamResourceDiscoveryId** A resource discovery ID. Type: String Required: Yes **MaxResults** The maximum number of discovered accounts to return in one page of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** Specify the pagination token from a previous request to retrieve the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamDiscoveredAccountSet** Discovered accounts. Type: Array of [IpamDiscoveredAccount](API_IpamDiscoveredAccount.md) objects **nextToken** Specify the pagination token from a previous request to retrieve the next page of results. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamDiscoveredAccounts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamDiscoveredAccounts) # GetIpamDiscoveredPublicAddresses Gets the public IP addresses that have been discovered by IPAM. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddressRegion** The AWS Region for the IP address. Type: String Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Filters. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamResourceDiscoveryId** An IPAM resource discovery ID. Type: String Required: Yes **MaxResults** The maximum number of IPAM discovered public addresses to return in one page of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamDiscoveredPublicAddressSet** IPAM discovered public addresses. Type: Array of [IpamDiscoveredPublicAddress](API_IpamDiscoveredPublicAddress.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **oldestSampleTime** The oldest successful resource discovery time. Type: Timestamp **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamDiscoveredPublicAddresses) # GetIpamDiscoveredResourceCidrs Returns the resource CIDRs that are monitored as part of a resource discovery. A discovered resource is a resource CIDR monitored under a resource discovery. The following resources can be discovered: VPCs, Public IPv4 pools, VPC subnets, and Elastic IP addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Filters. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamResourceDiscoveryId** A resource discovery ID. Type: String Required: Yes **MaxResults** The maximum number of discovered resource CIDRs to return in one page of results. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** Specify the pagination token from a previous request to retrieve the next page of results. Type: String Required: No **ResourceRegion** A resource Region. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamDiscoveredResourceCidrSet** Discovered resource CIDRs. Type: Array of [IpamDiscoveredResourceCidr](API_IpamDiscoveredResourceCidr.md) objects **nextToken** Specify the pagination token from a previous request to retrieve the next page of results. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamDiscoveredResourceCidrs) # GetIpamPolicyAllocationRules Gets the allocation rules for an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. Allocation rules are optional configurations within an IPAM policy that map AWS resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the allocation rules. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPolicyId** The ID of the IPAM policy for which to get allocation rules. Type: String Required: Yes **Locale** The locale for which to get the allocation rules. Type: String Required: No **MaxResults** The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **ResourceType** The resource type for which to get the allocation rules. The AWS service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include: + Elastic IP addresses Type: String Valid Values: `alb | eip | rds | rnat` Required: No ## Response Elements The following elements are returned by the service. **ipamPolicyDocumentSet** The IPAM policy documents containing the allocation rules. Allocation rules are optional configurations within an IPAM policy that map AWS resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses. Type: Array of [IpamPolicyDocument](API_IpamPolicyDocument.md) objects **nextToken** The token to use to retrieve the next page of results. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamPolicyAllocationRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamPolicyAllocationRules) # GetIpamPolicyOrganizationTargets Gets the AWS Organizations targets for an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. A target can be an individual AWS account or an entity within an AWS Organization to which an IPAM policy can be applied. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the AWS Organizations targets. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPolicyId** The ID of the IPAM policy for which to get AWS Organizations targets. Type: String Required: Yes **MaxResults** The maximum number of results to return in a single call. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. Type: String **organizationTargetSet** The IDs of the AWS Organizations targets. A target can be an individual AWS account or an entity within an AWS Organization to which an IPAM policy can be applied. Type: Array of [IpamPolicyOrganizationTarget](API_IpamPolicyOrganizationTarget.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamPolicyOrganizationTargets) # GetIpamPoolAllocations Get a list of all the CIDR allocations in an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the AWS Region where this IPAM pool is available for allocations. **Note** If you use this action after [AllocateIpamPoolCidr](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AllocateIpamPoolCidr.html) or [ReleaseIpamPoolAllocation](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ReleaseIpamPoolAllocation.html), note that all EC2 API actions follow an [eventual consistency](https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html) model. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the request. For more information about filtering, see [Filtering CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPoolAllocationId** The ID of the allocation. Type: String Required: No **IpamPoolId** The ID of the IPAM pool you want to see the allocations for. Type: String Required: Yes **MaxResults** The maximum number of results you would like returned per page. Type: Integer Valid Range: Minimum value of 1000. Maximum value of 100000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPoolAllocationSet** The IPAM pool allocations you want information on. Type: Array of [IpamPoolAllocation](API_IpamPoolAllocation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamPoolAllocations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamPoolAllocations) # GetIpamPoolCidrs Get the CIDRs provisioned to an IPAM pool. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the request. For more information about filtering, see [Filtering CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPoolId** The ID of the IPAM pool you want the CIDR for. Type: String Required: Yes **MaxResults** The maximum number of results to return in the request. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPoolCidrSet** Information about the CIDRs provisioned to an IPAM pool. Type: Array of [IpamPoolCidr](API_IpamPoolCidr.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamPoolCidrs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamPoolCidrs) # GetIpamPrefixListResolverRules Retrieves the CIDR selection rules for an IPAM prefix list resolver. Use this operation to view the business logic that determines which CIDRs are selected for synchronization with prefix lists. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to limit the results. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPrefixListResolverId** The ID of the IPAM prefix list resolver whose rules you want to retrieve. Type: String Required: Yes **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **ruleSet** The CIDR selection rules for the IPAM prefix list resolver. Type: Array of [IpamPrefixListResolverRule](API_IpamPrefixListResolverRule.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamPrefixListResolverRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamPrefixListResolverRules) # GetIpamPrefixListResolverVersionEntries Retrieves the CIDR entries for a specific version of an IPAM prefix list resolver. This shows the actual CIDRs that were selected and synchronized at a particular point in time. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPrefixListResolverId** The ID of the IPAM prefix list resolver whose version entries you want to retrieve. Type: String Required: Yes **IpamPrefixListResolverVersion** The version number of the resolver for which to retrieve CIDR entries. If not specified, the latest version is used. Type: Long Required: Yes **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **entrySet** The CIDR entries for the specified resolver version. Type: Array of [IpamPrefixListResolverVersionEntry](API_IpamPrefixListResolverVersionEntry.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamPrefixListResolverVersionEntries) # GetIpamPrefixListResolverVersions Retrieves version information for an IPAM prefix list resolver. Each version is a snapshot of what CIDRs matched your rules at that moment in time. The version number increments every time the CIDR list changes due to infrastructure changes. **Version example:** **Initial State (Version 1)** Production environment: + vpc-prod-web (10.1.0.0/16) - tagged env=prod + vpc-prod-db (10.2.0.0/16) - tagged env=prod Resolver rule: Include all VPCs tagged env=prod **Version 1 CIDRs:** 10.1.0.0/16, 10.2.0.0/16 **Infrastructure Change (Version 2)** New VPC added: + vpc-prod-api (10.3.0.0/16) - tagged env=prod IPAM automatically detects the change and creates a new version. **Version 2 CIDRs:** 10.1.0.0/16, 10.2.0.0/16, 10.3.0.0/16 ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to limit the results. Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPrefixListResolverId** The ID of the IPAM prefix list resolver whose versions you want to retrieve. Type: String Required: Yes **IpamPrefixListResolverVersion.N** Specific version numbers to retrieve. If not specified, all versions are returned. Type: Array of longs Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **ipamPrefixListResolverVersionSet** Information about the IPAM prefix list resolver versions. Type: Array of [IpamPrefixListResolverVersion](API_IpamPrefixListResolverVersion.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamPrefixListResolverVersions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamPrefixListResolverVersions) # GetIpamResourceCidrs Returns resource CIDRs managed by IPAM in a given scope. If an IPAM is associated with more than one resource discovery, the resource CIDRs across all of the resource discoveries is returned. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters for the request. For more information about filtering, see [Filtering CLI output](https://docs.aws.amazon.com/cli/latest/userguide/cli-usage-filter.html). Type: Array of [Filter](API_Filter.md) objects Required: No **IpamPoolId** The ID of the IPAM pool that the resource is in. Type: String Required: No **IpamScopeId** The ID of the scope that the resource is in. Type: String Required: Yes **MaxResults** The maximum number of results to return in the request. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **ResourceId** The ID of the resource. Type: String Required: No **ResourceOwner** The ID of the AWS account that owns the resource. Type: String Required: No **ResourceTag** The resource tag. Type: [RequestIpamResourceTag](API_RequestIpamResourceTag.md) object Required: No **ResourceType** The resource type. Type: String Valid Values: `vpc | subnet | eip | public-ipv4-pool | ipv6-pool | eni | anycast-ip-list` Required: No ## Response Elements The following elements are returned by the service. **ipamResourceCidrSet** The resource CIDRs. Type: Array of [IpamResourceCidr](API_IpamResourceCidr.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetIpamResourceCidrs) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetIpamResourceCidrs) # GetLaunchTemplateData Retrieves the configuration data of the specified instance. You can use this data to create a launch template. This action calls on other describe actions to get instance information. Depending on your instance configuration, you may need to allow the following actions in your IAM policy: `DescribeSpotInstanceRequests`, `DescribeInstanceCreditSpecifications`, `DescribeVolumes`, and `DescribeInstanceAttribute`. Or, you can allow `describe*` depending on your instance requirements. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **launchTemplateData** The instance data. Type: [ResponseLaunchTemplateData](API_ResponseLaunchTemplateData.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example gets the data for instance `i-123456abcabc123ab`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetLaunchTemplateData &InstanceId=i-123456abcabc123ab &AUTHPARAMS ``` #### Sample Response ``` 57372b95-c320-409e-b268-1e4example /dev/xvda true false arn:aws:iam::123456789012:instance-profile/AdminRole ami-1a2b3c4d t2.micro kp-us-east Primary network interface sg-7c227abc eni-d26c8f36 10.0.0.197 true 10.0.0.197 subnet-7b16dabc my network interface sg-54e8b123 eni-714bc4a5 10.0.0.190 true 10.0.0.190 subnet-7b16de0c us-east-1a default ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetLaunchTemplateData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetLaunchTemplateData) # GetManagedPrefixListAssociations Gets information about the resources that are associated with the specified managed prefix list. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 255. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PrefixListId** The ID of the prefix list. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **prefixListAssociationSet** Information about the associations. Type: Array of [PrefixListAssociation](API_PrefixListAssociation.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example gets the associations for the specified managed prefix list. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetManagedPrefixListAssociations &PrefixListId=pl-0123123123123aabb &AUTHPARAMS ``` #### Sample Response ``` 3ae1bcdf-4042-47f8-9b8a-example sg-01234567811abcaba 123456789012 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetManagedPrefixListAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetManagedPrefixListAssociations) # GetManagedPrefixListEntries Gets information about the entries for a specified managed prefix list. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No **NextToken** The token for the next page of results. Type: String Required: No **PrefixListId** The ID of the prefix list. Type: String Required: Yes **TargetVersion** The version of the prefix list for which to return the entries. The default is the current version. Type: Long Required: No ## Response Elements The following elements are returned by the service. **entrySet** Information about the prefix list entries. Type: Array of [PrefixListEntry](API_PrefixListEntry.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example gets the entries for the specified managed prefix list. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetManagedPrefixListEntries &PrefixListId=pl-0123123123123aabb &AUTHPARAMS ``` #### Sample Response ``` 39a3c79f-846f-4382-a592-example 10.0.0.0/16 vpc-a 10.2.0.0/16 NY office ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetManagedPrefixListEntries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetManagedPrefixListEntries) # GetNetworkInsightsAccessScopeAnalysisFindings Gets the findings for the specified Network Access Scope analysis. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NetworkInsightsAccessScopeAnalysisId** The ID of the Network Access Scope analysis. Type: String Required: Yes **NextToken** The token for the next page of results. Type: String Required: No ## Response Elements The following elements are returned by the service. **analysisFindingSet** The findings associated with Network Access Scope Analysis. Type: Array of [AccessScopeAnalysisFinding](API_AccessScopeAnalysisFinding.md) objects **analysisStatus** The status of Network Access Scope Analysis. Type: String Valid Values: `running | succeeded | failed` **networkInsightsAccessScopeAnalysisId** The ID of the Network Access Scope analysis. Type: String **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetNetworkInsightsAccessScopeAnalysisFindings) # GetNetworkInsightsAccessScopeContent Gets the content for the specified Network Access Scope. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkInsightsAccessScopeId** The ID of the Network Access Scope. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **networkInsightsAccessScopeContent** The Network Access Scope content. Type: [NetworkInsightsAccessScopeContent](API_NetworkInsightsAccessScopeContent.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetNetworkInsightsAccessScopeContent) # GetPasswordData Retrieves the encrypted administrator password for a running Windows instance. The Windows password is generated at boot by the `EC2Config` service or `EC2Launch` scripts (Windows Server 2016 and later). This usually only happens the first time an instance is launched. For more information, see [EC2Config](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UsingConfig_WinAMI.html) and [EC2Launch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2launch.html) in the *Amazon EC2 User Guide*. For the `EC2Config` service, the password is not generated for rebundled AMIs unless `Ec2SetPassword` is enabled before bundling. The password is encrypted using the key pair that you specified when you launched the instance. You must provide the corresponding key pair file. When you launch an instance, password generation and encryption may take a few minutes. If you try to retrieve the password before it's available, the output returns an empty string. We recommend that you wait up to 15 minutes after launching an instance before trying to retrieve the generated password. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the Windows instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **instanceId** The ID of the Windows instance. Type: String **passwordData** The password of the instance. Returns an empty string if the password is not available. Type: String **requestId** The ID of the request. Type: String **timestamp** The time the data was last updated. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example returns the encrypted version of the administrator password for the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetPasswordData &InstanceId=i-1234567890abcdef0 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 2009-10-24 15:00:00 TGludXggdmVyc2lvbiAyLjYuMTYteGVuVSAoYnVpbGRlckBwYXRjaGJhdC5hbWF6b25zYSkgKGdj ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetPasswordData) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetPasswordData) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetPasswordData) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetPasswordData) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetPasswordData) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetPasswordData) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetPasswordData) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetPasswordData) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetPasswordData) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetPasswordData) # GetReservedInstancesExchangeQuote Returns a quote and exchange information for exchanging one or more specified Convertible Reserved Instances for a new Convertible Reserved Instance. If the exchange cannot be performed, the reason is returned in the response. Use [AcceptReservedInstancesExchangeQuote](API_AcceptReservedInstancesExchangeQuote.md) to perform the exchange. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ReservedInstanceId.N** The IDs of the Convertible Reserved Instances to exchange. Type: Array of strings Required: Yes **TargetConfiguration.N** The configuration of the target Convertible Reserved Instance to exchange for your current Convertible Reserved Instances. Type: Array of [TargetConfigurationRequest](API_TargetConfigurationRequest.md) objects Required: No ## Response Elements The following elements are returned by the service. **currencyCode** The currency of the transaction. Type: String **isValidExchange** If `true`, the exchange is valid. If `false`, the exchange cannot be completed. Type: Boolean **outputReservedInstancesWillExpireAt** The new end date of the reservation term. Type: Timestamp **paymentDue** The total true upfront charge for the exchange. Type: String **requestId** The ID of the request. Type: String **reservedInstanceValueRollup** The cost associated with the Reserved Instance. Type: [ReservationValue](API_ReservationValue.md) object **reservedInstanceValueSet** The configuration of your Convertible Reserved Instances. Type: Array of [ReservedInstanceReservationValue](API_ReservedInstanceReservationValue.md) objects **targetConfigurationValueRollup** The cost associated with the Reserved Instance. Type: [ReservationValue](API_ReservationValue.md) object **targetConfigurationValueSet** The values of the target Convertible Reserved Instances. Type: Array of [TargetReservationValue](API_TargetReservationValue.md) objects **validationFailureReason** Describes the reason why the exchange cannot be completed. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example describes the output of requesting whether a potential exchange is valid. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetReservedInstancesExchangeQuote &ReservedInstanceId.1=649fd0c8-7768-46b8-8f84-a6400EXAMPLE &TargetConfiguration.1.OfferingId=24167194-6541-4041-9e31-bc7c5984aa53 &AUTHPARAMS ``` #### Sample Response ``` d072f652-cc57-458c-89e0-e6c02EXAMPLE 2019-05-17T12:32:53Z 649fd0c8-7768-46b8-8f84-a6400EXAMPLE 98.048402 0.018000 631.0 false -448.416438 0 0 0 873.504438 0.018000 448.416438 USD The target configuration value is less than the input ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetReservedInstancesExchangeQuote) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetReservedInstancesExchangeQuote) # GetRouteServerAssociations Gets information about the associations for the specified route server. A route server association is the connection established between a route server and a VPC. For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The ID of the route server for which to get association information. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerAssociationSet** Information about the associations for the specified route server. Type: Array of [RouteServerAssociation](API_RouteServerAssociation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetRouteServerAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetRouteServerAssociations) # GetRouteServerPropagations Gets information about the route propagations for the specified route server. When enabled, route server propagation installs the routes in the FIB on the route table you've specified. Route server supports IPv4 and IPv6 route propagation. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: + VPC route tables not associated with subnets + Subnet route tables + Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RouteServerId** The ID of the route server for which to get propagation information. Type: String Required: Yes **RouteTableId** The ID of the route table for which to get propagation information. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServerPropagationSet** Information about the route propagations for the specified route server. Type: Array of [RouteServerPropagation](API_RouteServerPropagation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetRouteServerPropagations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetRouteServerPropagations) # GetRouteServerRoutingDatabase Gets the routing database for the specified route server. The [Routing Information Base (RIB)](https://en.wikipedia.org/wiki/Routing_table) serves as a database that stores all the routing information and network topology data collected by a router or routing system, such as routes learned from BGP peers. The RIB is constantly updated as new routing information is received or existing routes change. This ensures that the route server always has the most current view of the network topology and can make optimal routing decisions. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: + VPC route tables not associated with subnets + Subnet route tables + Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** Filters to apply to the routing database query. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of routing database entries to return in a single response. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **RouteServerId** The ID of the route server for which to get the routing database. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **areRoutesPersisted** Indicates whether routes are being persisted in the routing database. Type: Boolean **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **routeSet** The collection of routes in the route server's routing database. Type: Array of [RouteServerRoute](API_RouteServerRoute.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetRouteServerRoutingDatabase) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetRouteServerRoutingDatabase) # GetSecurityGroupsForVpc Gets security groups that can be associated by the AWS account making the request with network interfaces in the specified VPC. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters. If using multiple filters, the results include security groups which match all filters. + `group-id`: The security group ID. + `description`: The security group's description. + `group-name`: The security group name. + `owner-id`: The security group owner ID. + `primary-vpc-id`: The VPC ID in which the security group was created. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VpcId** The VPC ID where the security group can be used. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **securityGroupForVpcSet** The security group that can be used by interfaces in the VPC. Type: Array of [SecurityGroupForVpc](API_SecurityGroupForVpc.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetSecurityGroupsForVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetSecurityGroupsForVpc) # GetSerialConsoleAccessStatus Retrieves the access status of your account to the EC2 serial console of all instances. By default, access to the EC2 serial console is disabled for your account. For more information, see [Manage account access to the EC2 serial console](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configure-access-to-serial-console.html#serial-console-account-access) in the *Amazon EC2 User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **managedBy** The entity that manages access to the serial console. Possible values include: + `account` - Access is managed by the account. + `declarative-policy` - Access is managed by a declarative policy and can't be modified by the account. Type: String Valid Values: `account | declarative-policy` **requestId** The ID of the request. Type: String **serialConsoleAccessEnabled** If `true`, access to the EC2 serial console of all instances is enabled for your account. If `false`, access to the EC2 serial console of all instances is disabled for your account. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetSerialConsoleAccessStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetSerialConsoleAccessStatus) # GetSnapshotBlockPublicAccessState Gets the current state of *block public access for snapshots* setting for the account and Region. For more information, see [ Block public access for snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/block-public-access-snapshots.html) in the *Amazon EBS User Guide*. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **managedBy** The entity that manages the state for block public access for snapshots. Possible values include: + `account` - The state is managed by the account. + `declarative-policy` - The state is managed by a declarative policy and can't be modified by the account. Type: String Valid Values: `account | declarative-policy` **requestId** The ID of the request. Type: String **state** The current state of block public access for snapshots. Possible values include: + `block-all-sharing` - All public sharing of snapshots is blocked. Users in the account can't request new public sharing. Additionally, snapshots that were already publicly shared are treated as private and are not publicly available. + `block-new-sharing` - Only new public sharing of snapshots is blocked. Users in the account can't request new public sharing. However, snapshots that were already publicly shared, remain publicly available. + `unblocked` - Public sharing is not blocked. Users can publicly share snapshots. Type: String Valid Values: `block-all-sharing | block-new-sharing | unblocked` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetSnapshotBlockPublicAccessState) # GetSpotPlacementScores Calculates the Spot placement score for a Region or Availability Zone based on the specified target capacity and compute requirements. You can specify your compute requirements either by using `InstanceRequirementsWithMetadata` and letting Amazon EC2 choose the optimal instance types to fulfill your Spot request, or you can specify the instance types by using `InstanceTypes`. For more information, see [Spot placement score](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-placement-score.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceRequirementsWithMetadata** The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes. If you specify `InstanceRequirementsWithMetadata`, you can't specify `InstanceTypes`. Type: [InstanceRequirementsWithMetadataRequest](API_InstanceRequirementsWithMetadataRequest.md) object Required: No **InstanceType.N** The instance types. We recommend that you specify at least three instance types. If you specify one or two instance types, or specify variations of a single instance type (for example, an `m3.xlarge` with and without instance storage), the returned placement score will always be low. If you specify `InstanceTypes`, you can't specify `InstanceRequirementsWithMetadata`. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 1000 items. Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 10. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **RegionName.N** The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, `us-east-1`. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: No **SingleAvailabilityZone** Specify `true` so that the response returns a list of scored Availability Zones. Otherwise, the response returns a list of scored Regions. A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single Availability Zone. Type: Boolean Required: No **TargetCapacity** The target capacity. Type: Integer Valid Range: Minimum value of 1. Maximum value of 2000000000. Required: Yes **TargetCapacityUnitType** The unit for the target capacity. Type: String Valid Values: `vcpu | memory-mib | units` Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **spotPlacementScoreSet** The Spot placement score for the top 10 Regions or Availability Zones, scored on a scale from 1 to 10. Each score  reflects how likely it is that each Region or Availability Zone will succeed at fulfilling the specified target capacity  *at the time of the Spot placement score request*. A score of `10` means that your Spot capacity request is highly likely to succeed in that Region or Availability Zone. If you request a Spot placement score for Regions, a high score assumes that your fleet request will be configured to use all Availability Zones and the `capacity-optimized` allocation strategy. If you request a Spot placement score for Availability Zones, a high score assumes that your fleet request will be configured to use a single Availability Zone and the `capacity-optimized` allocation strategy. Different  Regions or Availability Zones might return the same score. The Spot placement score serves as a recommendation only. No score guarantees that your Spot request will be fully or partially fulfilled. Type: Array of [SpotPlacementScore](API_SpotPlacementScore.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetSpotPlacementScores) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetSpotPlacementScores) # GetSubnetCidrReservations Gets information about the subnet CIDR reservations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. + `reservationType` - The type of reservation (`prefix` \$1 `explicit`). + `subnet-id` - The ID of the subnet. + `tag`: - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key `Owner` and the value `TeamA`, specify `tag:Owner` for the filter name and `TeamA` for the filter value. + `tag-key` - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **SubnetId** The ID of the subnet. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **subnetIpv4CidrReservationSet** Information about the IPv4 subnet CIDR reservations. Type: Array of [SubnetCidrReservation](API_SubnetCidrReservation.md) objects **subnetIpv6CidrReservationSet** Information about the IPv6 subnet CIDR reservations. Type: Array of [SubnetCidrReservation](API_SubnetCidrReservation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetSubnetCidrReservations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetSubnetCidrReservations) # GetTransitGatewayAttachmentPropagations Lists the route tables to which the specified resource attachment propagates routes. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `transit-gateway-route-table-id` - The ID of the transit gateway route table. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayAttachmentPropagations** Information about the propagation route tables. Type: Array of [TransitGatewayAttachmentPropagation](API_TransitGatewayAttachmentPropagation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayAttachmentPropagations) # GetTransitGatewayMeteringPolicyEntries Retrieves the entries for a transit gateway metering policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters to apply when retrieving metering policy entries. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayMeteringPolicyId** The ID of the transit gateway metering policy to retrieve entries for. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayMeteringPolicyEntries** Information about the transit gateway metering policy entries. Type: Array of [TransitGatewayMeteringPolicyEntry](API_TransitGatewayMeteringPolicyEntry.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayMeteringPolicyEntries) # GetTransitGatewayMulticastDomainAssociations Gets information about the associations for the transit gateway multicast domain. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `resource-id` - The ID of the resource. + `resource-type` - The type of resource. The valid value is: `vpc`. + `state` - The state of the subnet association. Valid values are `associated` \$1 `associating` \$1 `disassociated` \$1 `disassociating`. + `subnet-id` - The ID of the subnet. + `transit-gateway-attachment-id` - The id of the transit gateway attachment. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **multicastDomainAssociations** Information about the multicast domain associations. Type: Array of [TransitGatewayMulticastDomainAssociation](API_TransitGatewayMulticastDomainAssociation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example gets the multicast domain `tgw-attach-028c1dd0f8EXAMPLE` associations. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetTransitGatewayMulticastDomainAssociations &TransitGatewayMulticastDomainId=tgw-attach-028c1dd0f8EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` ca392437-3f6c-4193-92cd-24404EXAMPLE vpc-01128d2c24EXAMPLE vpc associated subnet-000de86e3bEXAMPLE tgw-attach-028c1dd0f8EXAMPLE vpc-7EXAMPLE vpc associated subnet-4EXAMPLE tgw-attach-070e571cd1EXAMPLE vpc-7f67ec07 vpc associated subnet-5EXAMPLE tgw-attach-070e571cd1EXAMPLE vpc-7EXAMPLE vpc associated subnet-aEXAMPLE tgw-attach-070e571cd1d3ee8e6 vpc-7f67ec07 vpc associated subnet-fEXAMPLE tgw-attach-070e571cd1EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayMulticastDomainAssociations) # GetTransitGatewayPolicyTableAssociations Gets a list of the transit gateway policy table associations. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters associated with the transit gateway policy table. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayPolicyTableId** The ID of the transit gateway policy table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associations** Returns details about the transit gateway policy table association. Type: Array of [TransitGatewayPolicyTableAssociation](API_TransitGatewayPolicyTableAssociation.md) objects **nextToken** The token for the next page of results. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayPolicyTableAssociations) # GetTransitGatewayPolicyTableEntries Returns a list of transit gateway policy table entries. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** The filters associated with the transit gateway policy table. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayPolicyTableId** The ID of the transit gateway policy table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPolicyTableEntries** The entries for the transit gateway policy table. Type: Array of [TransitGatewayPolicyTableEntry](API_TransitGatewayPolicyTableEntry.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayPolicyTableEntries) # GetTransitGatewayPrefixListReferences Gets information about the prefix list references in a specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `attachment.resource-id` - The ID of the resource for the attachment. + `attachment.resource-type` - The type of resource for the attachment. Valid values are `vpc` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `peering`. + `attachment.transit-gateway-attachment-id` - The ID of the attachment. + `is-blackhole` - Whether traffic matching the route is blocked (`true` \$1 `false`). + `prefix-list-id` - The ID of the prefix list. + `prefix-list-owner-id` - The ID of the owner of the prefix list. + `state` - The state of the prefix list reference (`pending` \$1 `available` \$1 `modifying` \$1 `deleting`). Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayPrefixListReferenceSet** Information about the prefix list references. Type: Array of [TransitGatewayPrefixListReference](API_TransitGatewayPrefixListReference.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example gets the prefix list references for the specified transit gateway route table. #### Sample Request ``` https://ec2.amazonaws.com/?Action=GetTransitGatewayPrefixListReferences &TransitGatewayRouteTableId=tgw-rtb-0f98a0a5d09abcabc &AUTHPARAMS ``` #### Sample Response ``` b194523f-807a-4a41-920a-example false pl-001122334455aabbc 123456789012 available vpn-12312312312312312 vpn tgw-attach-01234567abcabcabc tgw-rtb-0f98a0a5d09abcabc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayPrefixListReferences) # GetTransitGatewayRouteTableAssociations Gets information about the associations for the specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `resource-id` - The ID of the resource. + `resource-type` - The resource type. Valid values are `vpc` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `peering` \$1 `connect`. + `transit-gateway-attachment-id` - The ID of the attachment. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **associations** Information about the associations. Type: Array of [TransitGatewayRouteTableAssociation](API_TransitGatewayRouteTableAssociation.md) objects **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayRouteTableAssociations) # GetTransitGatewayRouteTablePropagations Gets information about the route table propagations for the specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Filter.N** One or more filters. The possible values are: + `resource-id` - The ID of the resource. + `resource-type` - The resource type. Valid values are `vpc` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `peering` \$1 `connect`. + `transit-gateway-attachment-id` - The ID of the attachment. Type: Array of [Filter](API_Filter.md) objects Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **transitGatewayRouteTablePropagations** Information about the route table propagations. Type: Array of [TransitGatewayRouteTablePropagation](API_TransitGatewayRouteTablePropagation.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetTransitGatewayRouteTablePropagations) # GetVerifiedAccessEndpointPolicy Get the Verified Access policy associated with the endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessEndpointId** The ID of the Verified Access endpoint. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **policyDocument** The Verified Access policy document. Type: String **policyEnabled** The status of the Verified Access policy. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetVerifiedAccessEndpointPolicy) # GetVerifiedAccessEndpointTargets Gets the targets for the specified network CIDR endpoint for Verified Access. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value. Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token for the next page of results. Type: String Required: No **VerifiedAccessEndpointId** The ID of the network CIDR endpoint. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **verifiedAccessEndpointTargetSet** The Verified Access targets. Type: Array of [VerifiedAccessEndpointTarget](API_VerifiedAccessEndpointTarget.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetVerifiedAccessEndpointTargets) # GetVerifiedAccessGroupPolicy Shows the contents of the Verified Access policy associated with the group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessGroupId** The ID of the Verified Access group. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **policyDocument** The Verified Access policy document. Type: String **policyEnabled** The status of the Verified Access policy. Type: Boolean **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetVerifiedAccessGroupPolicy) # GetVpcResourcesBlockingEncryptionEnforcement Gets information about resources in a VPC that are blocking encryption enforcement. For more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VpcId** The ID of the VPC to check for resources blocking encryption enforcement. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **nonCompliantResourceSet** Information about resources that are blocking encryption enforcement. Type: Array of [VpcEncryptionNonCompliantResource](API_VpcEncryptionNonCompliantResource.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetVpcResourcesBlockingEncryptionEnforcement) # GetVpnConnectionDeviceSampleConfiguration Download an AWS-provided sample configuration file to be used with the customer gateway device specified for your Site-to-Site VPN connection. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InternetKeyExchangeVersion** The IKE version to be used in the sample configuration file for your customer gateway device. You can specify one of the following versions: `ikev1` or `ikev2`. Type: String Required: No **SampleType** The type of sample configuration to generate. Valid values are "compatibility" (includes IKEv1) or "recommended" (throws UnsupportedOperationException for IKEv1). Type: String Required: No **VpnConnectionDeviceTypeId** Device identifier provided by the `GetVpnConnectionDeviceTypes` API. Type: String Required: Yes **VpnConnectionId** The `VpnConnectionId` specifies the Site-to-Site VPN connection used for the sample configuration. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConnectionDeviceSampleConfiguration** Sample configuration file for the specified customer gateway device. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetVpnConnectionDeviceSampleConfiguration) # GetVpnConnectionDeviceTypes Obtain a list of customer gateway devices for which sample configuration files can be provided. The request has no additional parameters. You can also see the list of device types with sample configuration files available under [Your customer gateway device](https://docs.aws.amazon.com/vpn/latest/s2svpn/your-cgw.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of results returned by `GetVpnConnectionDeviceTypes` in paginated output. When this parameter is used, `GetVpnConnectionDeviceTypes` only returns `MaxResults` results in a single page along with a `NextToken` response element. The remaining results of the initial request can be seen by sending another `GetVpnConnectionDeviceTypes` request with the returned `NextToken` value. This value can be between 200 and 1000. If this parameter is not used, then `GetVpnConnectionDeviceTypes` returns all results. Type: Integer Valid Range: Minimum value of 200. Maximum value of 1000. Required: No **NextToken** The `NextToken` value returned from a previous paginated `GetVpnConnectionDeviceTypes` request where `MaxResults` was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the `NextToken` value. This value is null when there are no more results to return. Type: String Required: No ## Response Elements The following elements are returned by the service. **nextToken** The `NextToken` value to include in a future `GetVpnConnectionDeviceTypes` request. When the results of a `GetVpnConnectionDeviceTypes` request exceed `MaxResults`, this value can be used to retrieve the next page of results. This value is null when there are no more results to return. Type: String **requestId** The ID of the request. Type: String **vpnConnectionDeviceTypeSet** List of customer gateway devices that have a sample configuration file available for use. Type: Array of [VpnConnectionDeviceType](API_VpnConnectionDeviceType.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetVpnConnectionDeviceTypes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetVpnConnectionDeviceTypes) # GetVpnTunnelReplacementStatus Get details of available tunnel endpoint maintenance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpnConnectionId** The ID of the Site-to-Site VPN connection. Type: String Required: Yes **VpnTunnelOutsideIpAddress** The external IP address of the VPN tunnel. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **customerGatewayId** The ID of the customer gateway. Type: String **maintenanceDetails** Get details of pending tunnel endpoint maintenance. Type: [MaintenanceDetails](API_MaintenanceDetails.md) object **requestId** The ID of the request. Type: String **transitGatewayId** The ID of the transit gateway associated with the VPN connection. Type: String **vpnConnectionId** The ID of the Site-to-Site VPN connection. Type: String **vpnGatewayId** The ID of the virtual private gateway. Type: String **vpnTunnelOutsideIpAddress** The external IP address of the VPN tunnel. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/GetVpnTunnelReplacementStatus) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GetVpnTunnelReplacementStatus) # ImportClientVpnClientCertificateRevocationList Uploads a client certificate revocation list to the specified Client VPN endpoint. Uploading a client certificate revocation list overwrites the existing client certificate revocation list. Uploading a client certificate revocation list resets existing client connections. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CertificateRevocationList** The client certificate revocation list file. For more information, see [Generate a Client Certificate Revocation List](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/cvpn-working-certificates.html#cvpn-working-certificates-generate) in the * AWS Client VPN Administrator Guide*. Type: String Required: Yes **ClientVpnEndpointId** The ID of the Client VPN endpoint to which the client certificate revocation list applies. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportClientVpnClientCertificateRevocationList) # ImportImage **Note** To import your virtual machines (VMs) with a console-based experience, you can use the *Import virtual machine images to AWS * template in the [Migration Hub Orchestrator console](https://console.aws.amazon.com/migrationhub/orchestrator). For more information, see the [https://docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html](https://docs.aws.amazon.com/migrationhub-orchestrator/latest/userguide/import-vm-images.html). Import single or multi-volume disk images or EBS snapshots into an Amazon Machine Image (AMI). **Important** AWS VM Import/Export strongly recommends specifying a value for either the `--license-type` or `--usage-operation` parameter when you create a new VM Import task. This ensures your operating system is licensed appropriately and your billing is optimized. For more information, see [Importing a VM as an image using VM Import/Export](https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html) in the *VM Import/Export User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Architecture** The architecture of the virtual machine. Valid values: `i386` \$1 `x86_64` Type: String Required: No **BootMode** The boot mode of the virtual machine. The `uefi-preferred` boot mode isn't supported for importing images. For more information, see [Boot modes](https://docs.aws.amazon.com/vm-import/latest/userguide/prerequisites.html#vmimport-boot-modes) in the *VM Import/Export User Guide*. Type: String Valid Values: `legacy-bios | uefi | uefi-preferred` Required: No **ClientData** The client-specific data. Type: [ClientData](API_ClientData.md) object Required: No **ClientToken** The token to enable idempotency for VM import requests. Type: String Required: No **Description** A description string for the import image task. Type: String Required: No **DiskContainer.N** Information about the disk containers. Type: Array of [ImageDiskContainer](API_ImageDiskContainer.md) objects Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Encrypted** Specifies whether the destination AMI of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using `KmsKeyId`. For more information, see [Amazon EBS Encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the *Amazon Elastic Compute Cloud User Guide*. Type: Boolean Required: No **Hypervisor** The target hypervisor platform. Valid values: `xen` Type: String Required: No **KmsKeyId** An identifier for the symmetric KMS key to use when creating the encrypted AMI. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a `KmsKeyId` is specified, the `Encrypted` flag must also be set. The KMS key identifier may be provided in any of the following formats: + Key ID + Key alias + ARN using key ID. The ID ARN contains the `arn:aws:kms` namespace, followed by the Region of the key, the AWS account ID of the key owner, the `key` namespace, and then the key ID. For example, arn:aws:kms:*us-east-1*:*012345678910*:key/*abcd1234-a123-456a-a12b-a123b4cd56ef*. + ARN using key alias. The alias ARN contains the `arn:aws:kms` namespace, followed by the Region of the key, the AWS account ID of the key owner, the `alias` namespace, and then the key alias. For example, arn:aws:kms:*us-east-1*:*012345678910*:alias/*ExampleAlias*. AWS parses `KmsKeyId` asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified KMS key must exist in the Region that the AMI is being copied to. Amazon EBS does not support asymmetric KMS keys. Type: String Required: No **LicenseSpecifications.N** The ARNs of the license configurations. Type: Array of [ImportImageLicenseConfigurationRequest](API_ImportImageLicenseConfigurationRequest.md) objects Required: No **LicenseType** The license type to be used for the Amazon Machine Image (AMI) after importing. Specify `AWS` to replace the source-system license with an AWS license or `BYOL` to retain the source-system license. Leaving this parameter undefined is the same as choosing `AWS` when importing a Windows Server operating system, and the same as choosing `BYOL` when importing a Windows client operating system (such as Windows 10) or a Linux operating system. To use `BYOL`, you must have existing licenses with rights to use these licenses in a third party cloud, such as AWS. For more information, see [Prerequisites](https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html#prerequisites-image) in the VM Import/Export User Guide. Type: String Required: No **Platform** The operating system of the virtual machine. If you import a VM that is compatible with Unified Extensible Firmware Interface (UEFI) using an EBS snapshot, you must specify a value for the platform. Valid values: `Windows` \$1 `Linux` Type: String Required: No **RoleName** The name of the role to use when not using the default role, 'vmimport'. Type: String Required: No **TagSpecification.N** The tags to apply to the import image task during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **UsageOperation** The usage operation value. For more information, see [Licensing options](https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#prerequisites) in the *VM Import/Export User Guide*. Type: String Required: No ## Response Elements The following elements are returned by the service. **architecture** The architecture of the virtual machine. Type: String **description** A description of the import task. Type: String **encrypted** Indicates whether the AMI is encrypted. Type: Boolean **hypervisor** The target hypervisor of the import task. Type: String **imageId** The ID of the Amazon Machine Image (AMI) created by the import task. Type: String **importTaskId** The task ID of the import image task. Type: String **kmsKeyId** The identifier for the symmetric KMS key that was used to create the encrypted AMI. Type: String **licenseSpecifications** The ARNs of the license configurations. Type: Array of [ImportImageLicenseConfigurationResponse](API_ImportImageLicenseConfigurationResponse.md) objects **licenseType** The license type of the virtual machine. Type: String **platform** The operating system of the virtual machine. Type: String **progress** The progress of the task. Type: String **requestId** The ID of the request. Type: String **snapshotDetailSet** Information about the snapshots. Type: Array of [SnapshotDetail](API_SnapshotDetail.md) objects **status** A brief status of the task. Type: String **statusMessage** A detailed status message of the import task. Type: String **tagSet** Any tags assigned to the import image task. Type: Array of [Tag](API_Tag.md) objects **usageOperation** The usage operation value. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ImportImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ImportImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ImportImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ImportImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ImportImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ImportImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ImportImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportImage) # ImportInstance **Note** We recommend that you use the [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportImage.html) API instead. For more information, see [Importing a VM as an image using VM Import/Export](https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-image-import.html) in the *VM Import/Export User Guide*. Creates an import instance task using metadata from the specified disk image. This API action supports only single-volume VMs. To import multi-volume VMs, use [ImportImage](API_ImportImage.md) instead. For information about the import manifest referenced by this API action, see [VM Import Manifest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). This API action is not supported by the AWS Command Line Interface (AWS CLI). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** A description for the instance being imported. Type: String Required: No **DiskImage.N** The disk image. Type: Array of [DiskImage](API_DiskImage.md) objects Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LaunchSpecification** The launch specification. Type: [ImportInstanceLaunchSpecification](API_ImportInstanceLaunchSpecification.md) object Required: No **Platform** The instance operating system. Type: String Valid Values: `Windows` Required: Yes ## Response Elements The following elements are returned by the service. **conversionTask** Information about the conversion task. Type: [ConversionTask](API_ConversionTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates an import instance task that migrates a Windows Server 2008 SP2 (32-bit) VM into the `us-east-1` Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ImportInstance &LaunchSpecification.Architecture=x86_64 &LaunchSpecification.InstanceType=m1.xlarge &DiskImage.1.Image.Format=VMDK &DiskImage.1.Image.Bytes=1179593728 &DiskImage.1.Image.ImportManifestUrl=https://s3.amazonaws.com/amzn-s3-demo-bucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D &DiskImage.1.Volume.Size=12 &Platform=Windows &AUTHPARAMS ``` #### Sample Response ``` import-i-ffvko9js 2010-12-22T12:01Z 0 us-east-1a VMDK 1179593728 https://s3.amazonaws.com/amzn-s3-demo-bucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D 12 vol-1234567890abcdef0 active i-1234567890abcdef0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ImportInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ImportInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ImportInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ImportInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ImportInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ImportInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ImportInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportInstance) # ImportKeyPair Imports the public key from an RSA or ED25519 key pair that you created using a third-party tool. You give AWS only the public key. The private key is never transferred between you and AWS. For more information about the requirements for importing a key pair, see [Create a key pair and import the public key to Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html#how-to-generate-your-own-key-and-import-it-to-aws) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **KeyName** A unique name for the key pair. Type: String Required: Yes **PublicKeyMaterial** The public key. Type: Base64-encoded binary data object Required: Yes **TagSpecification.N** The tags to apply to the imported key pair. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **keyFingerprint** + For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC 4716. + For ED25519 key pairs, the key fingerprint is the base64-encoded SHA-256 digest, which is the default for OpenSSH, starting with [OpenSSH 6.8](http://www.openssh.com/txt/release-6.8). Type: String **keyName** The key pair name that you provided. Type: String **keyPairId** The ID of the resulting key pair. Type: String **requestId** The ID of the request. Type: String **tagSet** The tags applied to the imported key pair. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example imports the public key named `my-key-pair`, and applies a tag with a key of `purpose` and a value of `production`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ImportKeyPair &KeyName=my-key-pair &PublicKeyMaterial=MIICiTCCAfICCQD6m7oRw0uXOjANBgkqhkiG9w0BAQUFADCBiDELMAkGA1UEBhMC VVMxCzAJBgNVBAgTAldBMRAwDgYDVQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6 b24xFDASBgNVBAsTC0lBTSBDb25zb2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAd BgkqhkiG9w0BCQEWEG5vb25lQGFtYXpvbi5jb20wHhcNMTEwNDI1MjA0NTIxWhcN MTIwNDI0MjA0NTIxWjCBiDELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAldBMRAwDgYD VQQHEwdTZWF0dGxlMQ8wDQYDVQQKEwZBbWF6b24xFDASBgNVBAsTC0lBTSBDb25z b2xlMRIwEAYDVQQDEwlUZXN0Q2lsYWMxHzAdBgkqhkiG9w0BCQEWEG5vb25lQGFt YXpvbi5jb20wgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMaK0dn+a4GmWIWJ 21uUSfwfEvySWtC2XADZ4nB+BLYgVIk60CpiwsZ3G93vUEIO3IyNoH/f0wYK8m9T rDHudUZg3qX4waLG5M43q7Wgc/MbQITxOUSQv7c7ugFFDzQGBzZswY6786m86gpE Ibb3OhjZnzcvQAaRHhdlQWIMm2nrAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAtCu4 nUhVVxYUntneD9+h8Mg9q6q+auNKyExzyLwaxlAoo7TJHidbtS4J5iNmZgXL0Fkb FFBjvSfpJIlJ00zbhNYS5f6GuoEDmFJl0ZxBHjJnyp378OD8uTs7fLvjx79LjSTb NYiytVbZPQUQ5Yaxu2jXnimvw3rrszlaEXAMPLE &TagSpecification.1.ResourceType=key-pair &TagSpecification.1.Tag.1.Key=purpose &TagSpecification.1.Tag.1.Value=production &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE my-key-pair key-abced1234eEXAMPLE 1f:51:ae:28:bf:89:e9:d8:1f:25:5d:37:2d:7d:b8:ca:9f:f5:f1:6f purpose production ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ImportKeyPair) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportKeyPair) # ImportSnapshot Imports a disk into an EBS snapshot. For more information, see [Importing a disk as a snapshot using VM Import/Export](https://docs.aws.amazon.com/vm-import/latest/userguide/vmimport-import-snapshot.html) in the *VM Import/Export User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientData** The client-specific data. Type: [ClientData](API_ClientData.md) object Required: No **ClientToken** Token to enable idempotency for VM import requests. Type: String Required: No **Description** The description string for the import snapshot task. Type: String Required: No **DiskContainer** Information about the disk container. Type: [SnapshotDiskContainer](API_SnapshotDiskContainer.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Encrypted** Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using `KmsKeyId`. For more information, see [Amazon EBS Encryption](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html) in the *Amazon Elastic Compute Cloud User Guide*. Type: Boolean Required: No **KmsKeyId** An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a `KmsKeyId` is specified, the `Encrypted` flag must also be set. The KMS key identifier may be provided in any of the following formats: + Key ID + Key alias + ARN using key ID. The ID ARN contains the `arn:aws:kms` namespace, followed by the Region of the key, the AWS account ID of the key owner, the `key` namespace, and then the key ID. For example, arn:aws:kms:*us-east-1*:*012345678910*:key/*abcd1234-a123-456a-a12b-a123b4cd56ef*. + ARN using key alias. The alias ARN contains the `arn:aws:kms` namespace, followed by the Region of the key, the AWS account ID of the key owner, the `alias` namespace, and then the key alias. For example, arn:aws:kms:*us-east-1*:*012345678910*:alias/*ExampleAlias*. AWS parses `KmsKeyId` asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure. The specified KMS key must exist in the Region that the snapshot is being copied to. Amazon EBS does not support asymmetric KMS keys. Type: String Required: No **RoleName** The name of the role to use when not using the default role, 'vmimport'. Type: String Required: No **TagSpecification.N** The tags to apply to the import snapshot task during creation. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **description** A description of the import snapshot task. Type: String **importTaskId** The ID of the import snapshot task. Type: String **requestId** The ID of the request. Type: String **snapshotTaskDetail** Information about the import snapshot task. Type: [SnapshotTaskDetail](API_SnapshotTaskDetail.md) object **tagSet** Any tags assigned to the import snapshot task. Type: Array of [Tag](API_Tag.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ImportSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportSnapshot) # ImportVolume **Note** This API action supports only single-volume VMs. To import multi-volume VMs, use [ImportImage](API_ImportImage.md) instead. To import a disk to a snapshot, use [ImportSnapshot](API_ImportSnapshot.md) instead. Creates an import volume task using metadata from the specified disk image. For information about the import manifest referenced by this API action, see [VM Import Manifest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/manifest.html). This API action is not supported by the AWS Command Line Interface (AWS CLI). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AvailabilityZone** The Availability Zone for the resulting EBS volume. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both. Type: String Required: No **AvailabilityZoneId** The ID of the Availability Zone for the resulting EBS volume. Either `AvailabilityZone` or `AvailabilityZoneId` must be specified, but not both. Type: String Required: No **Description** A description of the volume. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Image** The disk image. Type: [DiskImageDetail](API_DiskImageDetail.md) object Required: Yes **Volume** The volume size. Type: [VolumeDetail](API_VolumeDetail.md) object Required: Yes ## Response Elements The following elements are returned by the service. **conversionTask** Information about the conversion task. Type: [ConversionTask](API_ConversionTask.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example creates an import volume task that migrates a Windows Server 2008 SP2 (32-bit) volume into the `us-east-1` Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ImportVolume &AvailabilityZone=us-east-1c &Image.Format=VMDK &Image.Bytes=128696320 &Image.ImportManifestUrl=https://s3.amazonaws.com/amzn-s3-demo-bucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D &Volume.Size=8 &AUTHPARAMS> ``` #### Sample Response ``` import-i-fh95npoc 2010-12-22T12:01Z 0 us-east-1c VDMK 128696320 https://s3.amazonaws.com/amzn-s3-demo-bucket/a3a5e1b6-590d-43cc-97c1-15c7325d3f41/Win_2008_Server_Data_Center_SP2_32-bit.vmdkmanifest.xml?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Expires=1294855591&Signature=5snej01TlTtL0uR7KExtEXAMPLE%3D ccb1b0536a4a70e86016b85229b5c6b10b14a4eb 8 vol-1234567890abcdef0 active ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ImportVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ImportVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ImportVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ImportVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ImportVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ImportVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ImportVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportVolume) # ListImagesInRecycleBin Lists one or more AMIs that are currently in the Recycle Bin. For more information, see [Recycle Bin](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId.N** The IDs of the AMIs to list. Omit this parameter to list all of the AMIs that are in the Recycle Bin. You can specify up to 20 IDs in a single request. Type: Array of strings Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 1. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No ## Response Elements The following elements are returned by the service. **imageSet** Information about the AMIs. Type: Array of [ImageRecycleBinInfo](API_ImageRecycleBinInfo.md) objects **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ListImagesInRecycleBin) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ListImagesInRecycleBin) # ListSnapshotsInRecycleBin Lists one or more snapshots that are currently in the Recycle Bin. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Type: Integer Valid Range: Minimum value of 5. Maximum value of 1000. Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **SnapshotId.N** The IDs of the snapshots to list. Omit this parameter to list all of the snapshots that are in the Recycle Bin. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **snapshotSet** Information about the snapshots. Type: Array of [SnapshotRecycleBinInfo](API_SnapshotRecycleBinInfo.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ListSnapshotsInRecycleBin) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ListSnapshotsInRecycleBin) # ListVolumesInRecycleBin Lists one or more volumes that are currently in the Recycle Bin. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MaxResults** The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see [Pagination](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination). Valid range: 5 - 500 Type: Integer Required: No **NextToken** The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request. Type: String Required: No **VolumeId.N** The IDs of the volumes to list. Omit this parameter to list all of the volumes that are in the Recycle Bin. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **nextToken** The token to include in another request to get the next page of items. This value is `null` when there are no more items to return. Type: String **requestId** The ID of the request. Type: String **volumeSet** Information about the volumes. Type: Array of [VolumeRecycleBinInfo](API_VolumeRecycleBinInfo.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ListVolumesInRecycleBin) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ListVolumesInRecycleBin) # LockSnapshot Locks an Amazon EBS snapshot in either *governance* or *compliance* mode to protect it against accidental or malicious deletions for a specific duration. A locked snapshot can't be deleted. You can also use this action to modify the lock settings for a snapshot that is already locked. The allowed modifications depend on the lock mode and lock state: + If the snapshot is locked in governance mode, you can modify the lock mode and the lock duration or lock expiration date. + If the snapshot is locked in compliance mode and it is in the cooling-off period, you can modify the lock mode and the lock duration or lock expiration date. + If the snapshot is locked in compliance mode and the cooling-off period has lapsed, you can only increase the lock duration or extend the lock expiration date. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CoolOffPeriod** The cooling-off period during which you can unlock the snapshot or modify the lock settings after locking the snapshot in compliance mode, in hours. After the cooling-off period expires, you can't unlock or delete the snapshot, decrease the lock duration, or change the lock mode. You can increase the lock duration after the cooling-off period expires. The cooling-off period is optional when locking a snapshot in compliance mode. If you are locking the snapshot in governance mode, omit this parameter. To lock the snapshot in compliance mode immediately without a cooling-off period, omit this parameter. If you are extending the lock duration for a snapshot that is locked in compliance mode after the cooling-off period has expired, omit this parameter. If you specify a cooling-period in a such a request, the request fails. Allowed values: Min 1, max 72. Type: Integer Valid Range: Minimum value of 1. Maximum value of 72. Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExpirationDate** The date and time at which the snapshot lock is to automatically expire, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). You must specify either this parameter or **LockDuration**, but not both. Type: Timestamp Required: No **LockDuration** The period of time for which to lock the snapshot, in days. The snapshot lock will automatically expire after this period lapses. You must specify either this parameter or **ExpirationDate**, but not both. Allowed values: Min: 1, max 36500 Type: Integer Valid Range: Minimum value of 1. Maximum value of 36500. Required: No **LockMode** The mode in which to lock the snapshot. Specify one of the following: + `governance` - Locks the snapshot in governance mode. Snapshots locked in governance mode can't be deleted until one of the following conditions are met: + The lock duration expires. + The snapshot is unlocked by a user with the appropriate permissions. Users with the appropriate IAM permissions can unlock the snapshot, increase or decrease the lock duration, and change the lock mode to `compliance` at any time. If you lock a snapshot in `governance` mode, omit ** CoolOffPeriod**. + `compliance` - Locks the snapshot in compliance mode. Snapshots locked in compliance mode can't be unlocked by any user. They can be deleted only after the lock duration expires. Users can't decrease the lock duration or change the lock mode to `governance`. However, users with appropriate IAM permissions can increase the lock duration at any time. If you lock a snapshot in `compliance` mode, you can optionally specify **CoolOffPeriod**. Type: String Valid Values: `compliance | governance` Required: Yes **SnapshotId** The ID of the snapshot to lock. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **coolOffPeriod** The compliance mode cooling-off period, in hours. Type: Integer **coolOffPeriodExpiresOn** The date and time at which the compliance mode cooling-off period expires, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). Type: Timestamp **lockCreatedOn** The date and time at which the snapshot was locked, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). Type: Timestamp **lockDuration** The period of time for which the snapshot is locked, in days. Type: Integer **lockDurationStartTime** The date and time at which the lock duration started, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). Type: Timestamp **lockExpiresOn** The date and time at which the lock will expire, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). Type: Timestamp **lockState** The state of the snapshot lock. Valid states include: + `compliance-cooloff` - The snapshot has been locked in compliance mode but it is still within the cooling-off period. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions. + `governance` - The snapshot is locked in governance mode. The snapshot can't be deleted, but it can be unlocked and the lock settings can be modified by users with appropriate permissions. + `compliance` - The snapshot is locked in compliance mode and the cooling-off period has expired. The snapshot can't be unlocked or deleted. The lock duration can only be increased by users with appropriate permissions. + `expired` - The snapshot was locked in compliance or governance mode but the lock duration has expired. The snapshot is not locked and can be deleted. Type: String Valid Values: `compliance | governance | compliance-cooloff | expired` **requestId** The ID of the request. Type: String **snapshotId** The ID of the snapshot Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/LockSnapshot) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/LockSnapshot) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LockSnapshot) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/LockSnapshot) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LockSnapshot) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/LockSnapshot) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/LockSnapshot) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/LockSnapshot) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/LockSnapshot) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LockSnapshot) # ModifyAddressAttribute Modifies an attribute of the specified Elastic IP address. For requirements, see [Using reverse DNS for email applications](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId** [EC2-VPC] The allocation ID. Type: String Required: Yes **DomainName** The domain name to modify for the IP address. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **address** Information about the Elastic IP address. Type: [AddressAttribute](API_AddressAttribute.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyAddressAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyAddressAttribute) # ModifyAvailabilityZoneGroup Changes the opt-in status of the specified zone group for your account. Use [ DescribeAvailabilityZones](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeAvailabilityZones.html) to view the value for `GroupName`. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupName** The name of the Availability Zone group, Local Zone group, or Wavelength Zone group. Type: String Required: Yes **OptInStatus** Indicates whether to opt in to the zone group. The only valid value is `opted-in`. You must contact AWS Support to opt out of a Local Zone or Wavelength Zone group. Type: String Valid Values: `opted-in | not-opted-in` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyAvailabilityZoneGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyAvailabilityZoneGroup) # ModifyCapacityReservation Modifies a Capacity Reservation's capacity, instance eligibility, and the conditions under which it is to be released. You can't modify a Capacity Reservation's instance type, EBS optimization, platform, instance store settings, Availability Zone, or tenancy. If you need to modify any of these attributes, we recommend that you cancel the Capacity Reservation, and then create a new one with the required attributes. For more information, see [ Modify an active Capacity Reservation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/capacity-reservations-modify.html). The allowed modifications depend on the state of the Capacity Reservation: + `assessing` or `scheduled` state - You can modify the tags only. + `pending` state - You can't modify the Capacity Reservation in any way. + `active` state but still within the commitment duration - You can't decrease the instance count or set an end date that is within the commitment duration. All other modifications are allowed. + `active` state with no commitment duration or elapsed commitment duration - All modifications are allowed. + `expired`, `cancelled`, `unsupported`, or `failed` state - You can't modify the Capacity Reservation in any way. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Accept** Reserved. Capacity Reservations you have created are accepted by default. Type: Boolean Required: No **AdditionalInfo** Reserved for future use. Type: String Required: No **CapacityReservationId** The ID of the Capacity Reservation. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndDate** The date and time at which the Capacity Reservation expires. When a Capacity Reservation expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Reservation's state changes to `expired` when it reaches its end date and time. The Capacity Reservation is cancelled within an hour from the specified time. For example, if you specify 5/31/2019, 13:30:55, the Capacity Reservation is guaranteed to end between 13:30:55 and 14:30:55 on 5/31/2019. You must provide an `EndDate` value if `EndDateType` is `limited`. Omit `EndDate` if `EndDateType` is `unlimited`. Type: Timestamp Required: No **EndDateType** Indicates the way in which the Capacity Reservation ends. A Capacity Reservation can have one of the following end types: + `unlimited` - The Capacity Reservation remains active until you explicitly cancel it. Do not provide an `EndDate` value if `EndDateType` is `unlimited`. + `limited` - The Capacity Reservation expires automatically at a specified date and time. You must provide an `EndDate` value if `EndDateType` is `limited`. Type: String Valid Values: `unlimited | limited` Required: No **InstanceCount** The number of instances for which to reserve capacity. The number of instances can't be increased or decreased by more than `1000` in a single request. Type: Integer Required: No **InstanceMatchCriteria** The matching criteria (instance eligibility) that you want to use in the modified Capacity Reservation. If you change the instance eligibility of an existing Capacity Reservation from `targeted` to `open`, any running instances that match the attributes of the Capacity Reservation, have the `CapacityReservationPreference` set to `open`, and are not yet running in the Capacity Reservation, will automatically use the modified Capacity Reservation. To modify the instance eligibility, the Capacity Reservation must be completely idle (zero usage). Type: String Valid Values: `open | targeted` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyCapacityReservation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyCapacityReservation) # ModifyCapacityReservationFleet Modifies a Capacity Reservation Fleet. When you modify the total target capacity of a Capacity Reservation Fleet, the Fleet automatically creates new Capacity Reservations, or modifies or cancels existing Capacity Reservations in the Fleet to meet the new total target capacity. When you modify the end date for the Fleet, the end dates for all of the individual Capacity Reservations in the Fleet are updated accordingly. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationFleetId** The ID of the Capacity Reservation Fleet to modify. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EndDate** The date and time at which the Capacity Reservation Fleet expires. When the Capacity Reservation Fleet expires, its state changes to `expired` and all of the Capacity Reservations in the Fleet expire. The Capacity Reservation Fleet expires within an hour after the specified time. For example, if you specify `5/31/2019`, `13:30:55`, the Capacity Reservation Fleet is guaranteed to expire between `13:30:55` and `14:30:55` on `5/31/2019`. You can't specify **EndDate** and ** RemoveEndDate** in the same request. Type: Timestamp Required: No **RemoveEndDate** Indicates whether to remove the end date from the Capacity Reservation Fleet. If you remove the end date, the Capacity Reservation Fleet does not expire and it remains active until you explicitly cancel it using the **CancelCapacityReservationFleet** action. You can't specify **RemoveEndDate** and ** EndDate** in the same request. Type: Boolean Required: No **TotalTargetCapacity** The total number of capacity units to be reserved by the Capacity Reservation Fleet. This value, together with the instance type weights that you assign to each instance type used by the Fleet determine the number of instances for which the Fleet reserves capacity. Both values are based on units that make sense for your workload. For more information, see [Total target capacity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#target-capacity) in the *Amazon EC2 User Guide*. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyCapacityReservationFleet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyCapacityReservationFleet) # ModifyClientVpnEndpoint Modifies the specified Client VPN endpoint. Modifying the DNS server resets existing client connections. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientConnectOptions** The options for managing connection authorization for new client connections. Type: [ClientConnectOptions](API_ClientConnectOptions.md) object Required: No **ClientLoginBannerOptions** Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established. Type: [ClientLoginBannerOptions](API_ClientLoginBannerOptions.md) object Required: No **ClientRouteEnforcementOptions** Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel. Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations. Type: [ClientRouteEnforcementOptions](API_ClientRouteEnforcementOptions.md) object Required: No **ClientVpnEndpointId** The ID of the Client VPN endpoint to modify. Type: String Required: Yes **ConnectionLogOptions** Information about the client connection logging options. If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: + Client connection requests + Client connection results (successful and unsuccessful) + Reasons for unsuccessful client connection requests + Client connection termination time Type: [ConnectionLogOptions](API_ConnectionLogOptions.md) object Required: No **Description** A brief description of the Client VPN endpoint. Type: String Required: No **DisconnectOnSessionTimeout** Indicates whether the client VPN session is disconnected after the maximum timeout specified in `sessionTimeoutHours` is reached. If `true`, users are prompted to reconnect client VPN. If `false`, client VPN attempts to reconnect automatically. The default value is `true`. Type: Boolean Required: No **DnsServers** Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers. Type: [DnsServersOptionsModifyStructure](API_DnsServersOptionsModifyStructure.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SecurityGroupId.N** The IDs of one or more security groups to apply to the target network. Type: Array of strings Required: No **SelfServicePortal** Specify whether to enable the self-service portal for the Client VPN endpoint. Type: String Valid Values: `enabled | disabled` Required: No **ServerCertificateArn** The ARN of the server certificate to be used. The server certificate must be provisioned in AWS Certificate Manager (ACM). Type: String Required: No **SessionTimeoutHours** The maximum VPN session duration time in hours. Valid values: `8 | 10 | 12 | 24` Default value: `24` Type: Integer Required: No **SplitTunnel** Indicates whether the VPN is split-tunnel. For information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the * AWS Client VPN Administrator Guide*. Type: Boolean Required: No **VpcId** The ID of the VPC to associate with the Client VPN endpoint. Type: String Required: No **VpnPort** The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: `443` \$1 `1194` Default Value: `443` Type: Integer Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example modifies a Client VPN endpoint's description. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyClientVpnEndpoint &ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE &Description=my-client-vpn-endpoint &AUTHPARAMS ``` #### Sample Response ``` fe4813d3-1e79-4f67-bbd7-3186eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyClientVpnEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyClientVpnEndpoint) # ModifyDefaultCreditSpecification Modifies the default credit option for CPU usage of burstable performance instances. The default credit option is set at the account level per AWS Region, and is specified per instance family. All new burstable performance instances in the account launch using the default credit option. `ModifyDefaultCreditSpecification` is an asynchronous operation, which works at an AWS Region level and modifies the credit option for each Availability Zone. All zones in a Region are updated within five minutes. But if instances are launched during this operation, they might not get the new credit option until the zone is updated. To verify whether the update has occurred, you can call `GetDefaultCreditSpecification` and check `DefaultCreditSpecification` for updates. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CpuCredits** The credit option for CPU usage of the instance family. Valid Values: `standard` \$1 `unlimited` Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceFamily** The instance family. Type: String Valid Values: `t2 | t3 | t3a | t4g` Required: Yes ## Response Elements The following elements are returned by the service. **instanceFamilyCreditSpecification** The default credit option for CPU usage of the instance family. Type: [InstanceFamilyCreditSpecification](API_InstanceFamilyCreditSpecification.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example modifies the default credit option for CPU usage to `unlimited` for all instances in the T2 instance family in the specified Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyDefaultCreditSpecification &Region=us-east-1 &InstanceFamily=t2 &CpuCredits=unlimited &AUTHPARAMS ``` #### Sample Response ``` 11111111-2222-3333-4444-5555EXAMPLE unlimited t2 ``` ### Example 2 This example modifies the default credit option for CPU usage to `standard` for all instances in the T3 instance family in the specified Region. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyDefaultCreditSpecification &Region=us-east-1 &InstanceFamily=t3 &CpuCredits=standard &AUTHPARAMS ``` #### Sample Response ``` 11111111-2222-3333-4444-5555EXAMPLE standard t3 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyDefaultCreditSpecification) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyDefaultCreditSpecification) # ModifyEbsDefaultKmsKeyId Changes the default AWS KMS key for EBS encryption by default for your account in this Region. AWS creates a unique AWS managed KMS key in each Region for use with encryption by default. If you change the default KMS key to a symmetric customer managed KMS key, it is used instead of the AWS managed KMS key. Amazon EBS does not support asymmetric KMS keys. To reset the default KMS key to the AWS managed KMS key for EBS, use [ResetEbsDefaultKmsKeyId](API_ResetEbsDefaultKmsKeyId.md). If you delete or disable the customer managed KMS key that you specified for use with encryption by default, your instances will fail to launch. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **KmsKeyId** The identifier of the AWS KMS key to use for Amazon EBS encryption. If this parameter is not specified, your AWS KMS key for Amazon EBS is used. If `KmsKeyId` is specified, the encrypted state must be `true`. You can specify the KMS key using any of the following: + Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab. + Key alias. For example, alias/ExampleAlias. + Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab. + Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias. AWS authenticates the KMS key asynchronously. Therefore, if you specify an ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails. Amazon EBS does not support asymmetric KMS keys. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **kmsKeyId** The Amazon Resource Name (ARN) of the default KMS key for encryption by default. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyEbsDefaultKmsKeyId) # ModifyFleet Modifies the specified EC2 Fleet. You can only modify an EC2 Fleet request of type `maintain`. While the EC2 Fleet is being modified, it is in the `modifying` state. To scale up your EC2 Fleet, increase its target capacity. The EC2 Fleet launches the additional Spot Instances according to the allocation strategy for the EC2 Fleet request. If the allocation strategy is `lowest-price`, the EC2 Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is `diversified`, the EC2 Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is `capacity-optimized`, EC2 Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To scale down your EC2 Fleet, decrease its target capacity. First, the EC2 Fleet cancels any open requests that exceed the new target capacity. You can request that the EC2 Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is `lowest-price`, the EC2 Fleet terminates the instances with the highest price per unit. If the allocation strategy is `capacity-optimized`, the EC2 Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is `diversified`, the EC2 Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the EC2 Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually. If you are finished with your EC2 Fleet for now, but will use it again later, you can set the target capacity to 0. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Context** Reserved. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExcessCapacityTerminationPolicy** Indicates whether running instances should be terminated if the total target capacity of the EC2 Fleet is decreased below the current size of the EC2 Fleet. Supported only for fleets of type `maintain`. Type: String Valid Values: `no-termination | termination` Required: No **FleetId** The ID of the EC2 Fleet. Type: String Required: Yes **LaunchTemplateConfig.N** The launch template and overrides. Type: Array of [FleetLaunchTemplateConfigRequest](API_FleetLaunchTemplateConfigRequest.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No **TargetCapacitySpecification** The size of the EC2 Fleet. Type: [TargetCapacitySpecificationRequest](API_TargetCapacitySpecificationRequest.md) object Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** If the request succeeds, the response returns `true`. If the request fails, no response is returned, and instead an error message is returned. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyFleet) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyFleet) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyFleet) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyFleet) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyFleet) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyFleet) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyFleet) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyFleet) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyFleet) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyFleet) # ModifyFpgaImageAttribute Modifies the specified attribute of the specified Amazon FPGA Image (AFI). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The name of the attribute. Type: String Valid Values: `description | name | loadPermission | productCodes` Required: No **Description** A description for the AFI. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **FpgaImageId** The ID of the AFI. Type: String Required: Yes **LoadPermission** The load permission for the AFI. Type: [LoadPermissionModifications](API_LoadPermissionModifications.md) object Required: No **Name** A name for the AFI. Type: String Required: No **OperationType** The operation type. Type: String Valid Values: `add | remove` Required: No **ProductCode.N** The product codes. After you add a product code to an AFI, it can't be removed. This parameter is valid only when modifying the `productCodes` attribute. Type: Array of strings Required: No **UserGroup.N** The user groups. This parameter is valid only when modifying the `loadPermission` attribute. Type: Array of strings Required: No **UserId.N** The AWS account IDs. This parameter is valid only when modifying the `loadPermission` attribute. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **fpgaImageAttribute** Information about the attribute. Type: [FpgaImageAttribute](API_FpgaImageAttribute.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example adds load permissions for account ID `123456789012`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyFpgaImageAttribute &FpgaImageId=afi-0d123e21abcc85abc &Attribute=loadPermission &LoadPermission.Add.1.UserId=123456789012 &AUTHPARAMS ``` #### Sample Response ``` 75837959-edf9-4183-ad01-6cb1example afi-0d123e21abcc85abc 123456789012 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyFpgaImageAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyFpgaImageAttribute) # ModifyHosts Modify the auto-placement setting of a Dedicated Host. When auto-placement is enabled, any instances that you launch with a tenancy of `host` but without a specific host ID are placed onto any available Dedicated Host in your account that has auto-placement enabled. When auto-placement is disabled, you need to provide a host ID to have the instance launch onto a specific host. If no host ID is provided, the instance is launched onto a suitable host with auto-placement enabled. You can also use this API action to modify a Dedicated Host to support either multiple instance types in an instance family, or to support a specific instance type only. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AutoPlacement** Specify whether to enable or disable auto-placement. Type: String Valid Values: `on | off` Required: No **HostId.N** The IDs of the Dedicated Hosts to modify. Type: Array of strings Required: Yes **HostMaintenance** Indicates whether to enable or disable host maintenance for the Dedicated Host. For more information, see [Host maintenance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-maintenance.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `on | off` Required: No **HostRecovery** Indicates whether to enable or disable host recovery for the Dedicated Host. For more information, see [Host recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-recovery.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `on | off` Required: No **InstanceFamily** Specifies the instance family to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support multiple instance types within its current instance family. If you want to modify a Dedicated Host to support a specific instance type only, omit this parameter and specify **InstanceType** instead. You cannot specify **InstanceFamily** and **InstanceType** in the same request. Type: String Required: No **InstanceType** Specifies the instance type to be supported by the Dedicated Host. Specify this parameter to modify a Dedicated Host to support only a specific instance type. If you want to modify a Dedicated Host to support multiple instance types in its current instance family, omit this parameter and specify **InstanceFamily** instead. You cannot specify **InstanceType** and **InstanceFamily** in the same request. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successful** The IDs of the Dedicated Hosts that were successfully modified. Type: Array of strings **unsuccessful** The IDs of the Dedicated Hosts that could not be modified. Check whether the setting you requested can be used. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example enables the auto-placement setting on a Dedicated Host. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyHosts &AutoPlacement=on &HostId=h-00548908djdsgfs &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ### Example 2 This example enables host recovery on a Dedicated Host. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyHosts &HostRecovery=on &HostId=h-00548908djdsgfs &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ### Example 3 This example modifies a Dedicated Host that supports only `m5.large` instances to support multiple instance types in the `m5` instance family. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyHosts &InstanceFamily=m5 &HostId=h-00548908djdsgfs &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyHosts) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyHosts) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyHosts) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyHosts) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyHosts) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyHosts) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyHosts) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyHosts) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyHosts) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyHosts) # ModifyIdentityIdFormat Modifies the ID format of a resource for a specified IAM user, IAM role, or the root user for an account; or all IAM users, IAM roles, and the root user for an account. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. For more information, see [Resource IDs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) in the *Amazon Elastic Compute Cloud User Guide*. This setting applies to the principal specified in the request; it does not apply to the principal that makes the request. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant `Describe` command for the resource type. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **PrincipalArn** The ARN of the principal, which can be an IAM user, IAM role, or the root user. Specify `all` to modify the ID format for all IAM users, IAM roles, and the root user of the account. Type: String Required: Yes **Resource** The type of resource: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. Alternatively, use the `all-current` option to include all resource types that are currently within their opt-in period for longer IDs. Type: String Required: Yes **UseLongIds** Indicates whether the resource should use longer IDs (17-character IDs) Type: Boolean Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example sets the UseLongIds parameter to true for instances launched by the IAM role 'EC2Role'. Instances launched by the IAM role receive longer IDs. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyIdentityFormat &Resource=instance &UseLongIds=true &PrincipalArn=arn:aws:iam::123456789012:role/EC2Role &AUTHPARAMS ``` #### Sample Response ``` 92c1af09-cb4c-410e-8a96-EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIdentityIdFormat) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIdentityIdFormat) # ModifyIdFormat Modifies the ID format for the specified resource on a per-Region basis. You can specify that resources should receive longer IDs (17-character IDs) when they are created. This request can only be used to modify longer ID settings for resource types that are within the opt-in period. Resources currently in their opt-in period include: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. This setting applies to the IAM user who makes the request; it does not apply to the entire AWS account. By default, an IAM user defaults to the same settings as the root user. If you're using this action as the root user, then these settings apply to the entire account, unless an IAM user explicitly overrides these settings for themselves. For more information, see [Resource IDs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/resource-ids.html) in the *Amazon Elastic Compute Cloud User Guide*. Resources created with longer IDs are visible to all IAM roles and users, regardless of these settings and provided that they have permission to use the relevant `Describe` command for the resource type. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Resource** The type of resource: `bundle` \$1 `conversion-task` \$1 `customer-gateway` \$1 `dhcp-options` \$1 `elastic-ip-allocation` \$1 `elastic-ip-association` \$1 `export-task` \$1 `flow-log` \$1 `image` \$1 `import-task` \$1 `internet-gateway` \$1 `network-acl` \$1 `network-acl-association` \$1 `network-interface` \$1 `network-interface-attachment` \$1 `prefix-list` \$1 `route-table` \$1 `route-table-association` \$1 `security-group` \$1 `subnet` \$1 `subnet-cidr-block-association` \$1 `vpc` \$1 `vpc-cidr-block-association` \$1 `vpc-endpoint` \$1 `vpc-peering-connection` \$1 `vpn-connection` \$1 `vpn-gateway`. Alternatively, use the `all-current` option to include all resource types that are currently within their opt-in period for longer IDs. Type: String Required: Yes **UseLongIds** Indicate whether the resource should use longer IDs (17-character IDs). Type: Boolean Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example sets the UseLongIds parameter to true for instances, so that instances you launch receive longer IDs. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyIdFormat &Resource=instance &UseLongIds=true &AUTHPARAMS ``` #### Sample Response ``` 92c1af09-cb4c-410e-8a96-EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIdFormat) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIdFormat) # ModifyImageAttribute Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. To specify the attribute, you can use the `Attribute` parameter, or one of the following parameters: `Description`, `ImdsSupport`, or `LaunchPermission`. Images with an AWS Marketplace product code cannot be made public. To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The name of the attribute to modify. Valid values: `description` \$1 `imdsSupport` \$1 `launchPermission` Type: String Required: No **Description** A new description for the AMI. Type: [AttributeValue](API_AttributeValue.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ImageId** The ID of the AMI. Type: String Required: Yes **ImdsSupport** Set to `v2.0` to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have `HttpTokens` automatically set to `required` so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, `HttpPutResponseHopLimit` is set to `2`. For more information, see [Configure the AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) in the *Amazon EC2 User Guide*. Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to `v2.0`, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot. Type: [AttributeValue](API_AttributeValue.md) object Required: No **LaunchPermission** A new launch permission for the AMI. Type: [LaunchPermissionModifications](API_LaunchPermissionModifications.md) object Required: No **OperationType** The operation type. This parameter can be used only when the `Attribute` parameter is `launchPermission`. Type: String Valid Values: `add | remove` Required: No **OrganizationalUnitArn.N** The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the `Attribute` parameter is `launchPermission`. Type: Array of strings Required: No **OrganizationArn.N** The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the `Attribute` parameter is `launchPermission`. Type: Array of strings Required: No **ProductCode.N** Not supported. Type: Array of strings Required: No **UserGroup.N** The user groups. This parameter can be used only when the `Attribute` parameter is `launchPermission`. Type: Array of strings Required: No **UserId.N** The AWS account IDs. This parameter can be used only when the `Attribute` parameter is `launchPermission`. Type: Array of strings Required: No **Value** The value of the attribute being modified. This parameter can be used only when the `Attribute` parameter is `description` or `imdsSupport`. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example makes the AMI public (for example, so any AWS account can use it). #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyImageAttribute &ImageId=ami-61a54008 &LaunchPermission.Add.1.Group=all &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ### Example 2 This example makes the AMI private (for example, so that only you as the owner can use it). #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyImageAttribute &ImageId=ami-61a54008 &LaunchPermission.Remove.1.Group=all &AUTHPARAMS ``` ### Example 3 This example grants launch permission to the AWS account with ID `111122223333`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyImageAttribute &ImageId=ami-61a54008 &LaunchPermission.Add.1.UserId=111122223333 &AUTHPARAMS ``` ### Example 4 This example adds the `774F4FF8` product code to the `ami-61a54008` AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyImageAttribute &ImageId=ami-61a54008 &ProductCode.1=774F4FF8 &AUTHPARAMS ``` ### Example 5 This example changes the description of the AMI to `New Description`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyImageAttribute &ImageId=ami-61a54008 &Description.Value=New Description &AUTHPARAMS ``` ### Example 6 This example sets the AMI to IMDSv2 only. Instances created from this AMI will require that IMDSv2 is used when requesting instance metadata. Note that after you set the value to `v2.0`, you can't undo it. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyImageAttribute &ImageId=ami-61a54008 &ImdsSupport.Value=v2.0 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyImageAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyImageAttribute) # ModifyInstanceAttribute Modifies the specified attribute of the specified instance. You can specify only one attribute at a time. **Note: **Using this action to change the security groups associated with an elastic network interface (ENI) attached to an instance can result in an error if the instance has more than one ENI. To change the security groups associated with an ENI attached to an instance that has multiple ENIs, we recommend that you use the [ModifyNetworkInterfaceAttribute](API_ModifyNetworkInterfaceAttribute.md) action. To modify some attributes, the instance must be stopped. For more information, see [Modify a stopped instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_ChangingAttributesWhileInstanceStopped.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The name of the attribute to modify. When changing the instance type: If the original instance type is configured for configurable bandwidth, and the desired instance type doesn't support configurable bandwidth, first set the existing bandwidth configuration to `default` using the [ModifyInstanceNetworkPerformanceOptions](API_ModifyInstanceNetworkPerformanceOptions.md) operation. Type: String Valid Values: `disableApiTermination | instanceType | kernel | ramdisk | instanceInitiatedShutdownBehavior | blockDeviceMapping | userData | sourceDestCheck | groupSet | ebsOptimized | sriovNetSupport | enaSupport | nvmeSupport | disableApiStop | enclaveOptions` Required: No **BlockDeviceMapping.N** Modifies the `DeleteOnTermination` attribute for volumes that are currently attached. The volume must be owned by the caller. If no value is specified for `DeleteOnTermination`, the default is `true` and the volume is deleted when the instance is terminated. You can't modify the `DeleteOnTermination` attribute for volumes that are attached to AWS-managed resources. To add instance store volumes to an Amazon EBS-backed instance, you must add them when you launch the instance. For more information, see [Update the block device mapping when launching an instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html#Using_OverridingAMIBDM) in the *Amazon EC2 User Guide*. Type: Array of [InstanceBlockDeviceMappingSpecification](API_InstanceBlockDeviceMappingSpecification.md) objects Required: No **DisableApiStop** Indicates whether an instance is enabled for stop protection. For more information, see [Enable stop protection for your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html). Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **DisableApiTermination** Enable or disable termination protection for the instance. If the value is `true`, you can't terminate the instance using the Amazon EC2 console, command line interface, or API. You can't enable termination protection for Spot Instances. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EbsOptimized** Specifies whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS Optimized instance. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **EnaSupport** Set to `true` to enable enhanced networking with ENA for the instance. This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **GroupId.N** Replaces the security groups of the instance with the specified security groups. You must specify the ID of at least one security group, even if it's just the default security group for the VPC. Type: Array of strings Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **InstanceInitiatedShutdownBehavior** Specifies whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown). Type: [AttributeValue](API_AttributeValue.md) object Required: No **InstanceType** Changes the instance type to the specified value. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*. If the instance type is not valid, the error returned is `InvalidInstanceAttributeValue`. Type: [AttributeValue](API_AttributeValue.md) object Required: No **Kernel** Changes the instance's kernel to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). Type: [AttributeValue](API_AttributeValue.md) object Required: No **Ramdisk** Changes the instance's RAM disk to the specified value. We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedKernels.html). Type: [AttributeValue](API_AttributeValue.md) object Required: No **SourceDestCheck** Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is `true`, source/destination checks are enabled; otherwise, they are disabled. The default value is `true`. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **SriovNetSupport** Set to `simple` to enable enhanced networking with the Intel 82599 Virtual Function interface for the instance. There is no way to disable enhanced networking with the Intel 82599 Virtual Function interface at this time. This option is supported only for HVM instances. Specifying this option with a PV instance can make it unreachable. Type: [AttributeValue](API_AttributeValue.md) object Required: No **UserData** Changes the instance's user data to the specified value. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see [Work with instance user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instancedata-add-user-data.html). Type: [BlobAttributeValue](API_BlobAttributeValue.md) object Required: No **Value** A new value for the attribute. Use only with the `kernel`, `ramdisk`, `userData`, `disableApiTermination`, or `instanceInitiatedShutdownBehavior` attribute. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example changes the `instanceType` attribute of the specified instance. The instance must be in the `stopped` state. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &InstanceType.Value=m1.small &AUTHPARAMS ``` ### Example 2 This example changes the `enaSupport` attribute of the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &EnaSupport.Value=true &AUTHPARAMS ``` ### Example 3 This example changes the `ebsOptimized` attribute of the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &EbsOptimized.Value=true &AUTHPARAMS ``` ### Example 4 This example changes the `instanceInitiatedShutdownBehavior` attribute of the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &InstanceInitiatedShutdownBehavior.Value=terminate &AUTHPARAMS ``` ### Example 5 This example changes the `disableApiTermination` attribute of the specified instance. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceAttribute &InstanceId=i-1234567890abcdef0 &DisableApiTermination.Value=true &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceAttribute) # ModifyInstanceCapacityReservationAttributes Modifies the Capacity Reservation settings for a stopped instance. Use this action to configure an instance to target a specific Capacity Reservation, run in any `open` Capacity Reservation with matching attributes, run in On-Demand Instance capacity, or only run in a Capacity Reservation. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationSpecification** Information about the Capacity Reservation targeting option. Type: [CapacityReservationSpecification](API_CapacityReservationSpecification.md) object Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance to be modified. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceCapacityReservationAttributes) # ModifyInstanceConnectEndpoint Modifies the specified EC2 Instance Connect Endpoint. For more information, see [Modify an EC2 Instance Connect Endpoint](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/modify-ec2-instance-connect-endpoint.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceConnectEndpointId** The ID of the EC2 Instance Connect Endpoint to modify. Type: String Required: Yes **IpAddressType** The new IP address type for the EC2 Instance Connect Endpoint. `PreserveClientIp` is only supported on IPv4 EC2 Instance Connect Endpoints. To use `PreserveClientIp`, the value for `IpAddressType` must be `ipv4`. Type: String Valid Values: `ipv4 | dualstack | ipv6` Required: No **PreserveClientIp** Indicates whether the client IP address is preserved as the source when you connect to a resource. The following are the possible values. + `true` - Use the IP address of the client. Your instance must have an IPv4 address. + `false` - Use the IP address of the network interface. Type: Boolean Required: No **SecurityGroupId.N** Changes the security groups for the EC2 Instance Connect Endpoint. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 16 items. Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example: Modify an EC2 Instance Connect Endpoint This example modifies all the parameters of an EC2 Instance Connect Endpoint in a single request. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceConnectEndpoint &InstanceConnectEndpointId=eice-0123456789example &SecurityGroupId.1=sg-0123456789example &IpAddressType=dualstack &PreserveClientIp=false &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceConnectEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceConnectEndpoint) # ModifyInstanceCpuOptions By default, all vCPUs for the instance type are active when you launch an instance. When you configure the number of active vCPUs for the instance, it can help you save on licensing costs and optimize performance. The base cost of the instance remains unchanged. The number of active vCPUs equals the number of threads per CPU core multiplied by the number of cores. The instance must be in a `Stopped` state before you make changes. **Note** Some instance type options do not support this capability. For more information, see [Supported CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/cpu-options-supported-instances-values.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CoreCount** The number of CPU cores to activate for the specified instance. Type: Integer Required: No **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance to update. Type: String Required: Yes **NestedVirtualization** Indicates whether to enable or disable nested virtualization for the instance. When nested virtualization is enabled, Virtual Secure Mode (VSM) is automatically disabled for the instance. Type: String Valid Values: `enabled | disabled` Required: No **ThreadsPerCore** The number of threads to run for each CPU core. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **coreCount** The number of CPU cores that are running for the specified instance after the update. Type: Integer **instanceId** The ID of the instance that was updated. Type: String **nestedVirtualization** Indicates whether nested virtualization has been enabled or disabled. Type: String Valid Values: `enabled | disabled` **requestId** The ID of the request. Type: String **threadsPerCore** The number of threads that are running per CPU core for the specified instance after the update. Type: Integer ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This request example modifies the number of active vCPUs for the specified instance in the specified Region to `4` CPU cores running `2` threads each. This example assumes that the instance was stopped prior to running the request. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceCpuOptions &Region=us-east-1 &InstanceId=i-1234567890abcdef0 &CoreCount=4 &ThreadsPerCore=2 &AUTHPARAMS ``` #### Sample Response ``` 11111111-2222-3333-4444-5555EXAMPLE i-1234567890abcdef0 4 2 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceCpuOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceCpuOptions) # ModifyInstanceCreditSpecification Modifies the credit option for CPU usage on a running or stopped burstable performance instance. The credit options are `standard` and `unlimited`. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceCreditSpecification.N** Information about the credit option for CPU usage. Type: Array of [InstanceCreditSpecificationRequest](API_InstanceCreditSpecificationRequest.md) objects Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successfulInstanceCreditSpecificationSet** Information about the instances whose credit option for CPU usage was successfully modified. Type: Array of [SuccessfulInstanceCreditSpecificationItem](API_SuccessfulInstanceCreditSpecificationItem.md) objects **unsuccessfulInstanceCreditSpecificationSet** Information about the instances whose credit option for CPU usage was not modified. Type: Array of [UnsuccessfulInstanceCreditSpecificationItem](API_UnsuccessfulInstanceCreditSpecificationItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This request modifies the credit option for CPU usage of the specified instance in the specified Region to `unlimited`. Valid credit options are `standard` and `unlimited`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceCreditSpecification &Region=us-east-1 &InstanceCreditSpecification.1.InstanceId=i-1234567890abcdef0 &InstanceCreditSpecification.1.CpuCredits=unlimited &AUTHPARAMS ``` #### Sample Response ``` 11111111-2222-3333-4444-5555EXAMPLE i-1234567890abcdef0 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceCreditSpecification) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceCreditSpecification) # ModifyInstanceEventStartTime Modifies the start time for a scheduled Amazon EC2 instance event. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceEventId** The ID of the event whose date and time you are modifying. Type: String Required: Yes **InstanceId** The ID of the instance with the scheduled event. Type: String Required: Yes **NotBefore** The new date and time when the event will take place. Type: Timestamp Required: Yes ## Response Elements The following elements are returned by the service. **event** Information about the event. Type: [InstanceStatusEvent](API_InstanceStatusEvent.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example The following example shows how to modify the event start time for the specified instance. The event ID is specified by the `InstanceEventId` parameter and the new date and time is specified by the `NotBefore` parameter. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceEventStartTime &InstanceId=i-1234567890abcdef0 &InstanceEventId=instance-event-0abcdef1234567890 &NotBefore=2019-03-25T10:00:00.000 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceEventStartTime) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceEventStartTime) # ModifyInstanceEventWindow Modifies the specified event window. You can define either a set of time ranges or a cron expression when modifying the event window, but not both. To modify the targets associated with the event window, use the [AssociateInstanceEventWindow](API_AssociateInstanceEventWindow.md) and [DisassociateInstanceEventWindow](API_DisassociateInstanceEventWindow.md) API. If AWS has already scheduled an event, modifying an event window won't change the time of the scheduled event. For more information, see [Define event windows for scheduled events](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/event-windows.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CronExpression** The cron expression of the event window, for example, `* 0-4,20-23 * * 1,5`. Constraints: + Only hour and day of the week values are supported. + For day of the week values, you can specify either integers `0` through `6`, or alternative single values `SUN` through `SAT`. + The minute, month, and year must be specified by `*`. + The hour value must be one or a multiple range, for example, `0-4` or `0-4,20-23`. + Each hour range must be >= 2 hours, for example, `0-2` or `20-23`. + The event window must be >= 4 hours. The combined total time ranges in the event window must be >= 4 hours. For more information about cron expressions, see [cron](https://en.wikipedia.org/wiki/Cron) on the *Wikipedia website*. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceEventWindowId** The ID of the event window. Type: String Required: Yes **Name** The name of the event window. Type: String Required: No **TimeRange.N** The time ranges of the event window. Type: Array of [InstanceEventWindowTimeRangeRequest](API_InstanceEventWindowTimeRangeRequest.md) objects Required: No ## Response Elements The following elements are returned by the service. **instanceEventWindow** Information about the event window. Type: [InstanceEventWindow](API_InstanceEventWindow.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceEventWindow) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceEventWindow) # ModifyInstanceMaintenanceOptions Modifies the recovery behavior of your instance to disable simplified automatic recovery or set the recovery behavior to default. The default configuration will not enable simplified automatic recovery for an unsupported instance type. For more information, see [Simplified automatic recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery). Modifies the reboot migration behavior during a user-initiated reboot of an instance that has a pending `system-reboot` event. For more information, see [Enable or disable reboot migration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/schedevents_actions_reboot.html#reboot-migration). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AutoRecovery** Disables the automatic recovery behavior of your instance or sets it to default. Type: String Valid Values: `disabled | default` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **RebootMigration** Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled `system-reboot` event: + `default` - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the `system-reboot` event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled. + `disabled` - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The `system-reboot` event remains scheduled. This setting only applies to supported instances that have a scheduled reboot event. For more information, see [Enable or disable reboot migration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/schedevents_actions_reboot.html#reboot-migration) in the *Amazon EC2 User Guide*. Type: String Valid Values: `disabled | default` Required: No ## Response Elements The following elements are returned by the service. **autoRecovery** Provides information on the current automatic recovery behavior of your instance. Type: String Valid Values: `disabled | default` **instanceId** The ID of the instance. Type: String **rebootMigration** Specifies whether to attempt reboot migration during a user-initiated reboot of an instance that has a scheduled `system-reboot` event: + `default` - Amazon EC2 attempts to migrate the instance to new hardware (reboot migration). If successful, the `system-reboot` event is cleared. If unsuccessful, an in-place reboot occurs and the event remains scheduled. + `disabled` - Amazon EC2 keeps the instance on the same hardware (in-place reboot). The `system-reboot` event remains scheduled. This setting only applies to supported instances that have a scheduled reboot event. For more information, see [Enable or disable reboot migration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/schedevents_actions_reboot.html#reboot-migration) in the *Amazon EC2 User Guide*. Type: String Valid Values: `disabled | default` **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceMaintenanceOptions) # ModifyInstanceMetadataDefaults Modifies the default instance metadata service (IMDS) settings at the account level in the specified AWS  Region. **Note** To remove a parameter's account-level default setting, specify `no-preference`. If an account-level setting is cleared with `no-preference`, then the instance launch considers the other instance metadata settings. For more information, see [Order of precedence for instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **HttpEndpoint** Enables or disables the IMDS endpoint on an instance. When disabled, the instance metadata can't be accessed. Type: String Valid Values: `disabled | enabled | no-preference` Required: No **HttpPutResponseHopLimit** The maximum number of hops that the metadata token can travel. To indicate no preference, specify `-1`. Possible values: Integers from `1` to `64`, and `-1` to indicate no preference Type: Integer Required: No **HttpTokens** Indicates whether IMDSv2 is required. + `optional` – IMDSv2 is optional, which means that you can use either IMDSv2 or IMDSv1. + `required` – IMDSv2 is required, which means that IMDSv1 is disabled, and you must use IMDSv2. Type: String Valid Values: `optional | required | no-preference` Required: No **HttpTokensEnforced** Specifies whether to enforce the requirement of IMDSv2 on an instance at the time of launch. When enforcement is enabled, the instance can't launch unless IMDSv2 (`HttpTokens`) is set to `required`. For more information, see [Enforce IMDSv2 at the account level](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#enforce-imdsv2-at-the-account-level) in the *Amazon EC2 User Guide*. Type: String Valid Values: `disabled | enabled | no-preference` Required: No **InstanceMetadataTags** Enables or disables access to an instance's tags from the instance metadata. For more information, see [View tags for your EC2 instances using instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-tags-in-IMDS.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `disabled | enabled | no-preference` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** If the request succeeds, the response returns `true`. If the request fails, no response is returned, and instead an error message is returned. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceMetadataDefaults) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceMetadataDefaults) # ModifyInstanceMetadataOptions Modify the instance metadata parameters on a running or stopped instance. When you modify the parameters on a stopped instance, they are applied when the instance is started. When you modify the parameters on a running instance, the API responds with a state of “pending”. After the parameter modifications are successfully applied to the instance, the state of the modifications changes from “pending” to “applied” in subsequent describe-instances API calls. For more information, see [Instance metadata and user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **HttpEndpoint** Enables or disables the HTTP metadata endpoint on your instances. If this parameter is not specified, the existing state is maintained. If you specify a value of `disabled`, you cannot access your instance metadata. Type: String Valid Values: `disabled | enabled` Required: No **HttpProtocolIpv6** Enables or disables the IPv6 endpoint for the instance metadata service. Applies only if you enabled the HTTP metadata endpoint. Type: String Valid Values: `disabled | enabled` Required: No **HttpPutResponseHopLimit** The desired HTTP PUT response hop limit for instance metadata requests. The larger the number, the further instance metadata requests can travel. If no parameter is specified, the existing state is maintained. Possible values: Integers from 1 to 64 Type: Integer Required: No **HttpTokens** Indicates whether IMDSv2 is required. + `optional` - IMDSv2 is optional. You can choose whether to send a session token in your instance metadata retrieval requests. If you retrieve IAM role credentials without a session token, you receive the IMDSv1 role credentials. If you retrieve IAM role credentials using a valid session token, you receive the IMDSv2 role credentials. + `required` - IMDSv2 is required. You must send a session token in your instance metadata retrieval requests. With this option, retrieving the IAM role credentials always returns IMDSv2 credentials; IMDSv1 credentials are not available. Default: + If the value of `ImdsSupport` for the Amazon Machine Image (AMI) for your instance is `v2.0` and the account level default is set to `no-preference`, the default is `required`. + If the value of `ImdsSupport` for the Amazon Machine Image (AMI) for your instance is `v2.0`, but the account level default is set to `V1 or V2`, the default is `optional`. The default value can also be affected by other combinations of parameters. For more information, see [Order of precedence for instance metadata options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html#instance-metadata-options-order-of-precedence) in the *Amazon EC2 User Guide*. Type: String Valid Values: `optional | required` Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **InstanceMetadataTags** Set to `enabled` to allow access to instance tags from the instance metadata. Set to `disabled` to turn off access to instance tags from the instance metadata. For more information, see [View tags for your EC2 instances using instance metadata](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/work-with-tags-in-IMDS.html). Type: String Valid Values: `disabled | enabled` Required: No ## Response Elements The following elements are returned by the service. **instanceId** The ID of the instance. Type: String **instanceMetadataOptions** The metadata options for the instance. Type: [InstanceMetadataOptionsResponse](API_InstanceMetadataOptionsResponse.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1: Turn on token requirement The following example disables access to the instance metadata unless a session token is used in the instance metadata request header. To turn on token requirement, specify `required` for `HttpTokens`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceMetadataOptions &InstanceId=i-1234567890abcdef0 &HttpTokens=required &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 pending required 1 enabled ``` ### Example 2: Turn off access to instance metadata The following example disables access to the instance metadata by changing the HTTP endpoint state to disabled. To turn off access to instance metadata, specify `disabled` for `HttpEndpoint`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstanceMetadataOptions &InstanceId=i-1234567890abcdef0 &HttpEndpoint=disabled &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 pending required 1 disabled ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceMetadataOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceMetadataOptions) # ModifyInstanceNetworkPerformanceOptions Change the configuration of the network performance options for an existing instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **BandwidthWeighting** Specify the bandwidth weighting option to boost the associated type of baseline bandwidth, as follows: default This option uses the standard bandwidth configuration for your instance type. vpc-1 This option boosts your networking baseline bandwidth and reduces your EBS baseline bandwidth. ebs-1 This option boosts your EBS baseline bandwidth and reduces your networking baseline bandwidth. Type: String Valid Values: `default | vpc-1 | ebs-1` Required: Yes **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId** The ID of the instance to update. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **bandwidthWeighting** Contains the updated configuration for bandwidth weighting on the specified instance. Type: String Valid Values: `default | vpc-1 | ebs-1` **instanceId** The instance ID that was updated. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstanceNetworkPerformanceOptions) # ModifyInstancePlacement Modifies the placement attributes for a specified instance. You can do the following: + Modify the affinity between an instance and a [Dedicated Host](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-hosts-overview.html). When affinity is set to `host` and the instance is not associated with a specific Dedicated Host, the next time the instance is started, it is automatically associated with the host on which it lands. If the instance is restarted or rebooted, this relationship persists. + Change the Dedicated Host with which an instance is associated. + Change the instance tenancy of an instance. + Move an instance to or from a [placement group](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/placement-groups.html). At least one attribute for affinity, host ID, tenancy, or placement group name must be specified in the request. Affinity and tenancy can be modified in the same request. To modify the host ID, tenancy, placement group, or partition for an instance, the instance must be in the `stopped` state. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Affinity** The affinity setting for the instance. For more information, see [Host affinity](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-dedicated-hosts-work.html#dedicated-hosts-affinity) in the *Amazon EC2 User Guide*. Type: String Valid Values: `default | host` Required: No **GroupId** The Group Id of a placement group. You must specify the Placement Group **Group Id** to launch an instance in a shared placement group. Type: String Required: No **GroupName** The name of the placement group in which to place the instance. For spread placement groups, the instance must have a tenancy of `default`. For cluster and partition placement groups, the instance must have a tenancy of `default` or `dedicated`. To remove an instance from a placement group, specify an empty string (""). Type: String Required: No **HostId** The ID of the Dedicated Host with which to associate the instance. Type: String Required: No **HostResourceGroupArn** The ARN of the host resource group in which to place the instance. The instance must have a tenancy of `host` to specify this parameter. Type: String Required: No **InstanceId** The ID of the instance that you are modifying. Type: String Required: Yes **PartitionNumber** The number of the partition in which to place the instance. Valid only if the placement group strategy is set to `partition`. Type: Integer Required: No **Tenancy** The tenancy for the instance. For T3 instances, you must launch the instance on a Dedicated Host to use a tenancy of `host`. You can't change the tenancy from `host` to `dedicated` or `default`. Attempting to make one of these unsupported tenancy changes results in an `InvalidRequest` error code. Type: String Valid Values: `default | dedicated | host` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example modifies the affinity of instance `i-0b33i09` so that it always has affinity with host `h-00548908djdsgfs`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstancePlacement &Affinity=host &HostId=h-00548908djdsgfs &InstanceId=i-0b33i09 &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE true ``` ### Example 2 This example places instance `i-01234567812345678` in the placement group `MyPlacementGroup`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyInstancePlacement &InstanceId=i-01234567812345678 &GroupName=MyPlacementGroup &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyInstancePlacement) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyInstancePlacement) # ModifyIpam Modify the configurations of an IPAM. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddOperatingRegion.N** Choose the operating Regions for the IPAM. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions. For more information about operating Regions, see [Create an IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/create-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: Array of [AddIpamOperatingRegion](API_AddIpamOperatingRegion.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No **Description** The description of the IPAM you want to modify. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EnablePrivateGua** Enable this option to use your own GUA ranges as private IPv6 addresses. This option is disabled by default. Type: Boolean Required: No **IpamId** The ID of the IPAM you want to modify. Type: String Required: Yes **MeteredAccount** A metered account is an AWS account that is charged for active IP addresses managed in IPAM. For more information, see [Enable cost distribution](https://docs.aws.amazon.com/vpc/latest/ipam/ipam-enable-cost-distro.html) in the *Amazon VPC IPAM User Guide*. Possible values: + `ipam-owner` (default): The AWS account which owns the IPAM is charged for all active IP addresses managed in IPAM. + `resource-owner`: The AWS account that owns the IP address is charged for the active IP address. Type: String Valid Values: `ipam-owner | resource-owner` Required: No **RemoveOperatingRegion.N** The operating Regions to remove. Type: Array of [RemoveIpamOperatingRegion](API_RemoveIpamOperatingRegion.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No **Tier** IPAM is offered in a Free Tier and an Advanced Tier. For more information about the features available in each tier and the costs associated with the tiers, see [Amazon VPC pricing > IPAM tab](http://aws.amazon.com/vpc/pricing/). Type: String Valid Values: `free | advanced` Required: No ## Response Elements The following elements are returned by the service. **ipam** The results of the modification. Type: [Ipam](API_Ipam.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpam) # ModifyIpamPolicyAllocationRules Modifies the allocation rules in an IPAM policy. An IPAM policy is a set of rules that define how public IPv4 addresses from IPAM pools are allocated to AWS resources. Each rule maps an AWS service to IPAM pools that the service will use to get IP addresses. A single policy can have multiple rules and be applied to multiple AWS Regions. If the IPAM pool run out of addresses then the services fallback to Amazon-provided IP addresses. A policy can be applied to an individual AWS account or an entity within AWS Organizations. Allocation rules are optional configurations within an IPAM policy that map AWS resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationRule.N** The new allocation rules to apply to the IPAM policy. Allocation rules are optional configurations within an IPAM policy that map AWS resource types to specific IPAM pools. If no rules are defined, the resource types default to using Amazon-provided IP addresses. Type: Array of [IpamPolicyAllocationRuleRequest](API_IpamPolicyAllocationRuleRequest.md) objects Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPolicyId** The ID of the IPAM policy whose allocation rules you want to modify. Type: String Required: Yes **Locale** The locale for which to modify the allocation rules. Type: String Required: Yes **ResourceType** The resource type for which to modify the allocation rules. The AWS service or resource type that can use IP addresses through IPAM policies. Supported services and resource types include: + Elastic IP addresses Type: String Valid Values: `alb | eip | rds | rnat` Required: Yes ## Response Elements The following elements are returned by the service. **ipamPolicyDocument** The modified IPAM policy containing the updated allocation rules. Type: [IpamPolicyDocument](API_IpamPolicyDocument.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpamPolicyAllocationRules) # ModifyIpamPool Modify the configurations of an IPAM pool. For more information, see [Modify a pool](https://docs.aws.amazon.com/vpc/latest/ipam/mod-pool-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddAllocationResourceTag.N** Add tag allocation rules to a pool. For more information about allocation rules, see [Create a top-level pool](https://docs.aws.amazon.com/vpc/latest/ipam/create-top-ipam.html) in the *Amazon VPC IPAM User Guide*. Type: Array of [RequestIpamResourceTag](API_RequestIpamResourceTag.md) objects Required: No **AllocationDefaultNetmaskLength** The default netmask length for allocations added to this pool. If, for example, the CIDR assigned to this pool is 10.0.0.0/8 and you enter 16 here, new allocations will default to 10.0.0.0/16. Type: Integer Valid Range: Minimum value of 0. Maximum value of 128. Required: No **AllocationMaxNetmaskLength** The maximum netmask length possible for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128.The maximum netmask length must be greater than the minimum netmask length. Type: Integer Valid Range: Minimum value of 0. Maximum value of 128. Required: No **AllocationMinNetmaskLength** The minimum netmask length required for CIDR allocations in this IPAM pool to be compliant. Possible netmask lengths for IPv4 addresses are 0 - 32. Possible netmask lengths for IPv6 addresses are 0 - 128. The minimum netmask length must be less than the maximum netmask length. Type: Integer Valid Range: Minimum value of 0. Maximum value of 128. Required: No **AutoImport** If true, IPAM will continuously look for resources within the CIDR range of this pool and automatically import them as allocations into your IPAM. The CIDRs that will be allocated for these resources must not already be allocated to other resources in order for the import to succeed. IPAM will import a CIDR regardless of its compliance with the pool's allocation rules, so a resource might be imported and subsequently marked as noncompliant. If IPAM discovers multiple CIDRs that overlap, IPAM will import the largest CIDR only. If IPAM discovers multiple CIDRs with matching CIDRs, IPAM will randomly import one of them only. A locale must be set on the pool for this feature to work. Type: Boolean Required: No **ClearAllocationDefaultNetmaskLength** Clear the default netmask length allocation rule for this pool. Type: Boolean Required: No **Description** The description of the IPAM pool you want to modify. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPoolId** The ID of the IPAM pool you want to modify. Type: String Required: Yes **RemoveAllocationResourceTag.N** Remove tag allocation rules from a pool. Type: Array of [RequestIpamResourceTag](API_RequestIpamResourceTag.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamPool** The results of the modification. Type: [IpamPool](API_IpamPool.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpamPool) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpamPool) # ModifyIpamPrefixListResolver Modifies an IPAM prefix list resolver. You can update the description and CIDR selection rules. Changes to rules will trigger re-evaluation and potential updates to associated prefix lists. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** A new description for the IPAM prefix list resolver. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPrefixListResolverId** The ID of the IPAM prefix list resolver to modify. Type: String Required: Yes **Rule.N** The updated CIDR selection rules for the resolver. These rules replace the existing rules entirely. Type: Array of [IpamPrefixListResolverRuleRequest](API_IpamPrefixListResolverRuleRequest.md) objects Required: No ## Response Elements The following elements are returned by the service. **ipamPrefixListResolver** Information about the modified IPAM prefix list resolver. Type: [IpamPrefixListResolver](API_IpamPrefixListResolver.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpamPrefixListResolver) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpamPrefixListResolver) # ModifyIpamPrefixListResolverTarget Modifies an IPAM prefix list resolver target. You can update version tracking settings and the desired version of the target prefix list. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DesiredVersion** The desired version of the prefix list to target. This allows you to pin the target to a specific version. Type: Long Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPrefixListResolverTargetId** The ID of the IPAM prefix list resolver target to modify. Type: String Required: Yes **TrackLatestVersion** Indicates whether the resolver target should automatically track the latest version of the prefix list. When enabled, the target will always synchronize with the most current version. Choose this for automatic updates when you want your prefix lists to stay current with infrastructure changes without manual intervention. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **ipamPrefixListResolverTarget** Information about the modified IPAM prefix list resolver target. Type: [IpamPrefixListResolverTarget](API_IpamPrefixListResolverTarget.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpamPrefixListResolverTarget) # ModifyIpamResourceCidr Modify a resource CIDR. You can use this action to transfer resource CIDRs between scopes and ignore resource CIDRs that you do not want to manage. If set to false, the resource will not be tracked for overlap, it cannot be auto-imported into a pool, and it will be removed from any pool it has an allocation in. For more information, see [Move resource CIDRs between scopes](https://docs.aws.amazon.com/vpc/latest/ipam/move-resource-ipam.html) and [Change the monitoring state of resource CIDRs](https://docs.aws.amazon.com/vpc/latest/ipam/change-monitoring-state-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CurrentIpamScopeId** The ID of the current scope that the resource CIDR is in. Type: String Required: Yes **DestinationIpamScopeId** The ID of the scope you want to transfer the resource CIDR to. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Monitored** Determines if the resource is monitored by IPAM. If a resource is monitored, the resource is discovered by IPAM and you can view details about the resource’s CIDR. Type: Boolean Required: Yes **ResourceCidr** The CIDR of the resource you want to modify. Type: String Required: Yes **ResourceId** The ID of the resource you want to modify. Type: String Required: Yes **ResourceRegion** The AWS Region of the resource you want to modify. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **ipamResourceCidr** The CIDR of the resource. Type: [IpamResourceCidr](API_IpamResourceCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpamResourceCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpamResourceCidr) # ModifyIpamResourceDiscovery Modifies a resource discovery. A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddOperatingRegion.N** Add operating Regions to the resource discovery. Operating Regions are AWS Regions where the IPAM is allowed to manage IP address CIDRs. IPAM only discovers and monitors resources in the AWS Regions you select as operating Regions. Type: Array of [AddIpamOperatingRegion](API_AddIpamOperatingRegion.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No **AddOrganizationalUnitExclusion.N** Add an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see [Quotas for your IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*. The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the AWS CLI request process in [Add or remove OU exclusions ](https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html#exclude-ous-create-delete) in the *Amazon VPC User Guide*. Type: Array of [AddIpamOrganizationalUnitExclusion](API_AddIpamOrganizationalUnitExclusion.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: No **Description** A resource discovery description. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamResourceDiscoveryId** A resource discovery ID. Type: String Required: Yes **RemoveOperatingRegion.N** Remove operating Regions. Type: Array of [RemoveIpamOperatingRegion](API_RemoveIpamOperatingRegion.md) objects Array Members: Minimum number of 0 items. Maximum number of 50 items. Required: No **RemoveOrganizationalUnitExclusion.N** Remove an Organizational Unit (OU) exclusion to your IPAM. If your IPAM is integrated with AWS Organizations and you add an organizational unit (OU) exclusion, IPAM will not manage the IP addresses in accounts in that OU exclusion. There is a limit on the number of exclusions you can create. For more information, see [Quotas for your IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*. The resulting set of exclusions must not result in "overlap", meaning two or more OU exclusions must not exclude the same OU. For more information and examples, see the AWS CLI request process in [Add or remove OU exclusions ](https://docs.aws.amazon.com/vpc/latest/ipam/exclude-ous.html#exclude-ous-create-delete) in the *Amazon VPC User Guide*. Type: Array of [RemoveIpamOrganizationalUnitExclusion](API_RemoveIpamOrganizationalUnitExclusion.md) objects Array Members: Minimum number of 0 items. Maximum number of 10 items. Required: No ## Response Elements The following elements are returned by the service. **ipamResourceDiscovery** A resource discovery. Type: [IpamResourceDiscovery](API_IpamResourceDiscovery.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpamResourceDiscovery) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpamResourceDiscovery) # ModifyIpamScope Modify an IPAM scope. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** The description of the scope you want to modify. Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExternalAuthorityConfiguration** The configuration that links an Amazon VPC IPAM scope to an external authority system. It specifies the type of external system and the external resource identifier that identifies your account or instance in that system. In IPAM, an external authority is a third-party IP address management system that provides CIDR blocks when you provision address space for top-level IPAM pools. This allows you to use your existing IP management system to control which address ranges are allocated to AWS while using Amazon VPC IPAM to manage subnets within those ranges. Type: [ExternalAuthorityConfiguration](API_ExternalAuthorityConfiguration.md) object Required: No **IpamScopeId** The ID of the scope you want to modify. Type: String Required: Yes **RemoveExternalAuthorityConfiguration** Remove the external authority configuration. `true` to remove. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **ipamScope** The results of the modification. Type: [IpamScope](API_IpamScope.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyIpamScope) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyIpamScope) # ModifyLaunchTemplate Modifies a launch template. You can specify which version of the launch template to set as the default version. When launching an instance, the default version applies when a launch template version is not specified. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If a client token isn't specified, a randomly generated token is used in the request to ensure idempotency. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Constraint: Maximum 128 ASCII characters. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LaunchTemplateId** The ID of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Required: No **LaunchTemplateName** The name of the launch template. You must specify either the launch template ID or the launch template name, but not both. Type: String Length Constraints: Minimum length of 3. Maximum length of 128. Pattern: `[a-zA-Z0-9\.\-/_]+` Required: No **SetDefaultVersion** The version number of the launch template to set as the default version. Type: String Required: No ## Response Elements The following elements are returned by the service. **launchTemplate** Information about the launch template. Type: [LaunchTemplate](API_LaunchTemplate.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example sets version 2 of launch template `lt-0a20c965061f64abc` as the default version. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyLaunchTemplate &LaunchTemplateId=lt-0a20c965061f64abc &SetDefaultVersion=2 &AUTHPARAMS ``` #### Sample Response ``` 5b348ca5-bb13-4106-baf9-14d02example 1970-01-01T00:00:00.000Z arn:aws:iam::123456789012:root 2 4 lt-0a20c965061f64abc MyLaunchTemplate ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyLaunchTemplate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyLaunchTemplate) # ModifyLocalGatewayRoute Modifies the specified local gateway route. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DestinationCidrBlock** The CIDR block used for destination matches. The value that you provide must match the CIDR of an existing route in the table. Type: String Required: No **DestinationPrefixListId** The ID of the prefix list. Use a prefix list in place of `DestinationCidrBlock`. You cannot use `DestinationPrefixListId` and `DestinationCidrBlock` in the same request. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalGatewayRouteTableId** The ID of the local gateway route table. Type: String Required: Yes **LocalGatewayVirtualInterfaceGroupId** The ID of the virtual interface group. Type: String Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **route** Information about the local gateway route table. Type: [LocalGatewayRoute](API_LocalGatewayRoute.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyLocalGatewayRoute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyLocalGatewayRoute) # ModifyManagedPrefixList Modifies the specified managed prefix list. Adding or removing entries in a prefix list creates a new version of the prefix list. Changing the name of the prefix list does not affect the version. If you specify a current version number that does not match the true current version number, the request fails. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddEntry.N** One or more entries to add to the prefix list. Type: Array of [AddPrefixListEntry](API_AddPrefixListEntry.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. Required: No **CurrentVersion** The current version of the prefix list. Type: Long Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPrefixListResolverSyncEnabled** Indicates whether synchronization with an IPAM prefix list resolver should be enabled for this managed prefix list. When enabled, the prefix list CIDRs are automatically updated based on the associated resolver's CIDR selection rules. Type: Boolean Required: No **MaxEntries** The maximum number of entries for the prefix list. You cannot modify the entries of a prefix list and modify the size of a prefix list at the same time. If any of the resources that reference the prefix list cannot support the new maximum size, the modify operation fails. Check the state message for the IDs of the first ten resources that do not support the new maximum size. Type: Integer Required: No **PrefixListId** The ID of the prefix list. Type: String Required: Yes **PrefixListName** A name for the prefix list. Type: String Required: No **RemoveEntry.N** One or more entries to remove from the prefix list. Type: Array of [RemovePrefixListEntry](API_RemovePrefixListEntry.md) objects Array Members: Minimum number of 0 items. Maximum number of 100 items. Required: No ## Response Elements The following elements are returned by the service. **prefixList** Information about the prefix list. Type: [ManagedPrefixList](API_ManagedPrefixList.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example modifies the specified managed prefix list by adding another entry. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyManagedPrefixList &PrefixListId=pl-0123123123123aabb &CurrentVersion=1 &AddEntry.1.Cidr=10.1.0.0/16 &AddEntry.1.Description=Miami office &AUTHPARAMS ``` #### Sample Response ``` 602f3752-c348-4b14-81e2-example IPv4 10 123456789012 arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123aabb pl-0123123123123aabb tgw-attachments modify-in-progress 1 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyManagedPrefixList) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyManagedPrefixList) # ModifyNetworkInterfaceAttribute Modifies the specified network interface attribute. You can specify only one attribute at a time. You can use this action to attach and detach security groups from an existing EC2 instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssociatedSubnetId.N** A list of subnet IDs to associate with the network interface. Type: Array of strings Required: No **AssociatePublicIpAddress** Indicates whether to assign a public IPv4 address to a network interface. This option can be enabled for any network interface but will only apply to the primary network interface (eth0). Type: Boolean Required: No **Attachment** Information about the interface attachment. If modifying the `delete on termination` attribute, you must specify the ID of the interface attachment. Type: [NetworkInterfaceAttachmentChanges](API_NetworkInterfaceAttachmentChanges.md) object Required: No **ConnectionTrackingSpecification** A connection tracking specification. Type: [ConnectionTrackingSpecificationRequest](API_ConnectionTrackingSpecificationRequest.md) object Required: No **Description** A description for the network interface. Type: [AttributeValue](API_AttributeValue.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EnablePrimaryIpv6** If you’re modifying a network interface in a dual-stack or IPv6-only subnet, you have the option to assign a primary IPv6 IP address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if the instance that this ENI will be attached to relies on its IPv6 address not changing. AWS will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address. Type: Boolean Required: No **EnaSrdSpecification** Updates the ENA Express configuration for the network interface that’s attached to the instance. Type: [EnaSrdSpecification](API_EnaSrdSpecification.md) object Required: No **NetworkInterfaceId** The ID of the network interface. Type: String Required: Yes **SecurityGroupId.N** Changes the security groups for the network interface. The new set of groups you specify replaces the current set. You must specify at least one group, even if it's just the default security group in the VPC. You must specify the ID of the security group, not the name. Type: Array of strings Required: No **SourceDestCheck** Enable or disable source/destination checks, which ensure that the instance is either the source or the destination of any traffic that it receives. If the value is `true`, source/destination checks are enabled; otherwise, they are disabled. The default value is `true`. You must disable source/destination checks if the instance runs services such as network address translation, routing, or firewalls. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example sets source/destination checking to `false` for the specified network interface. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyNetworkInterfaceAttribute &NetworkInterfaceId=eni-ffda3197 &SourceDestCheck.Value=false &AUTHPARAMS ``` #### Sample Response ``` 657a4623-5620-4232-b03b-427e852d71cf true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyNetworkInterfaceAttribute) # ModifyPrivateDnsNameOptions Modifies the options for instance hostnames for the specified instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EnableResourceNameDnsAAAARecord** Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. Type: Boolean Required: No **EnableResourceNameDnsARecord** Indicates whether to respond to DNS queries for instance hostnames with DNS A records. Type: Boolean Required: No **InstanceId** The ID of the instance. Type: String Required: Yes **PrivateDnsHostnameType** The type of hostname for EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 only subnets, an instance DNS name must be based on the instance ID. For dual-stack subnets, you can specify whether DNS names use the instance IPv4 address or the instance ID. Type: String Valid Values: `ip-name | resource-name` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyPrivateDnsNameOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyPrivateDnsNameOptions) # ModifyPublicIpDnsNameOptions Modify public hostname options for a network interface. For more information, see [EC2 instance hostnames, DNS names, and domains](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **HostnameType** The public hostname type. For more information, see [EC2 instance hostnames, DNS names, and domains](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-naming.html) in the *Amazon EC2 User Guide*. + `public-dual-stack-dns-name`: A dual-stack public hostname for a network interface. Requests from within the VPC resolve to both the private IPv4 address and the IPv6 Global Unicast Address of the network interface. Requests from the internet resolve to both the public IPv4 and the IPv6 GUA address of the network interface. + `public-ipv4-dns-name`: An IPv4-enabled public hostname for a network interface. Requests from within the VPC resolve to the private primary IPv4 address of the network interface. Requests from the internet resolve to the public IPv4 address of the network interface. + `public-ipv6-dns-name`: An IPv6-enabled public hostname for a network interface. Requests from within the VPC or from the internet resolve to the IPv6 GUA of the network interface. Type: String Valid Values: `public-dual-stack-dns-name | public-ipv4-dns-name | public-ipv6-dns-name` Required: Yes **NetworkInterfaceId** A network interface ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successful** Whether or not the request was successful. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyPublicIpDnsNameOptions) # ModifyReservedInstances Modifies the configuration of your Reserved Instances, such as the Availability Zone, instance count, or instance type. The Reserved Instances to be modified must be identical, except for Availability Zone, network platform, and instance type. For more information, see [Modify Reserved Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-modifying.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token you provide to ensure idempotency of your modification request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **ReservedInstancesConfigurationSetItemType.N** The configuration settings for the Reserved Instances to modify. Type: Array of [ReservedInstancesConfiguration](API_ReservedInstancesConfiguration.md) objects Required: Yes **ReservedInstancesId.N** The IDs of the Reserved Instances to modify. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **reservedInstancesModificationId** The ID for the modification. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example illustrates one usage of ModifyReservedInstances. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyReservedInstances &ClientToken=myClientToken &ReservedInstancesConfigurationSetItemType.1.AvailabilityZone=us-east-1a &ReservedInstancesConfigurationSetItemType.1.InstanceCount=1 &ReservedInstancesConfigurationSetItemType.1.Platform=EC2-VPC &ReservedInstancesConfigurationSetItemType.1.InstanceType=m1.small &ReservedInstancesId.1=d16f7a91-4d0f-4f19-9d7f-a74d26b1ccfa &AUTHPARAMS ``` #### Sample Response ``` bef729b6-0731-4489-8881-2258746ae163 rimod-3aae219d-3d63-47a9-a7e9-e764example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyReservedInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyReservedInstances) # ModifyRouteServer Modifies the configuration of an existing route server. Amazon VPC Route Server simplifies routing for traffic between workloads that are deployed within a VPC and its internet gateways. With this feature, VPC Route Server dynamically updates VPC and internet gateway route tables with your preferred IPv4 or IPv6 routes to achieve routing fault tolerance for those workloads. This enables you to automatically reroute traffic within a VPC, which increases the manageability of VPC routing and interoperability with third-party workloads. Route server supports the follow route table types: + VPC route tables not associated with subnets + Subnet route tables + Internet gateway route tables Route server does not support route tables associated with virtual private gateways. To propagate routes into a transit gateway route table, use [Transit Gateway Connect](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-connect.html). For more information see [Dynamic routing in your VPC with VPC Route Server](https://docs.aws.amazon.com/vpc/latest/userguide/dynamic-routing-route-server.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PersistRoutes** Specifies whether to persist routes after all BGP sessions are terminated. + enable: Routes will be persisted in FIB and RIB after all BGP sessions are terminated. + disable: Routes will not be persisted in FIB and RIB after all BGP sessions are terminated. + reset: If a route server has persisted routes due to all BGP sessions having ended, reset will withdraw all routes and reset route server to an empty FIB and RIB. Type: String Valid Values: `enable | disable | reset` Required: No **PersistRoutesDuration** The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if PersistRoutes is `enabled`. If you set the duration to 1 minute, then when your network appliance re-establishes BGP with route server, it has 1 minute to relearn it's adjacent network and advertise those routes to route server before route server resumes normal functionality. In most cases, 1 minute is probably sufficient. If, however, you have concerns that your BGP network may not be capable of fully re-establishing and re-learning everything in 1 minute, you can increase the duration up to 5 minutes. Type: Long Required: No **RouteServerId** The ID of the route server to modify. Type: String Required: Yes **SnsNotificationsEnabled** Specifies whether to enable SNS notifications for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **routeServer** Information about the modified route server. Type: [RouteServer](API_RouteServer.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyRouteServer) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyRouteServer) # ModifySecurityGroupRules Modifies the rules of a security group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupId** The ID of the security group. Type: String Required: Yes **SecurityGroupRule.N** Information about the security group properties to update. Type: Array of [SecurityGroupRuleUpdate](API_SecurityGroupRuleUpdate.md) objects Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifySecurityGroupRules) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifySecurityGroupRules) # ModifySnapshotAttribute Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation. Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts. For more information about modifying snapshot permissions, see [Share a snapshot](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Attribute** The snapshot attribute to modify. Only volume creation permissions can be modified. Type: String Valid Values: `productCodes | createVolumePermission` Required: No **CreateVolumePermission** A JSON representation of the snapshot attribute modification. Type: [CreateVolumePermissionModifications](API_CreateVolumePermissionModifications.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **OperationType** The type of operation to perform to the attribute. Type: String Valid Values: `add | remove` Required: No **SnapshotId** The ID of the snapshot. Type: String Required: Yes **UserGroup.N** The group to modify for the snapshot. Type: Array of strings Required: No **UserId.N** The account ID to modify for the snapshot. Type: Array of strings Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example makes the `snap-1234567890abcdef0` snapshot public, and gives the account with ID `111122223333` permission to create volumes from the snapshot. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifySnapshotAttribute &SnapshotId=snap-1234567890abcdef0 &CreateVolumePermission.Add.1.UserId=111122223333 &CreateVolumePermission.Add.1.Group=all &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ### Example This example makes the `snap-1234567890abcdef0` snapshot public, and removes the account with ID `111122223333` from the list of users with permission to create volumes from the snapshot. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifySnapshotAttribute &SnapshotId=snap-1234567890abcdef0 &CreateVolumePermission.Remove.1.UserId=111122223333 &CreateVolumePermission.Add.1.Group=all &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifySnapshotAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifySnapshotAttribute) # ModifySnapshotTier Archives an Amazon EBS snapshot. When you archive a snapshot, it is converted to a full snapshot that includes all of the blocks of data that were written to the volume at the time the snapshot was created, and moved from the standard tier to the archive tier. For more information, see [Archive Amazon EBS snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/snapshot-archive.html) in the *Amazon EBS User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SnapshotId** The ID of the snapshot. Type: String Required: Yes **StorageTier** The name of the storage tier. You must specify `archive`. Type: String Valid Values: `archive` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **snapshotId** The ID of the snapshot. Type: String **tieringStartTime** The date and time when the archive process was started. Type: Timestamp ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifySnapshotTier) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifySnapshotTier) # ModifySpotFleetRequest Modifies the specified Spot Fleet request. You can only modify a Spot Fleet request of type `maintain`. While the Spot Fleet request is being modified, it is in the `modifying` state. To scale up your Spot Fleet, increase its target capacity. The Spot Fleet launches the additional Spot Instances according to the allocation strategy for the Spot Fleet request. If the allocation strategy is `lowestPrice`, the Spot Fleet launches instances using the Spot Instance pool with the lowest price. If the allocation strategy is `diversified`, the Spot Fleet distributes the instances across the Spot Instance pools. If the allocation strategy is `capacityOptimized`, Spot Fleet launches instances from Spot Instance pools with optimal capacity for the number of instances that are launching. To scale down your Spot Fleet, decrease its target capacity. First, the Spot Fleet cancels any open requests that exceed the new target capacity. You can request that the Spot Fleet terminate Spot Instances until the size of the fleet no longer exceeds the new target capacity. If the allocation strategy is `lowestPrice`, the Spot Fleet terminates the instances with the highest price per unit. If the allocation strategy is `capacityOptimized`, the Spot Fleet terminates the instances in the Spot Instance pools that have the least available Spot Instance capacity. If the allocation strategy is `diversified`, the Spot Fleet terminates instances across the Spot Instance pools. Alternatively, you can request that the Spot Fleet keep the fleet at its current size, but not replace any Spot Instances that are interrupted or that you terminate manually. If you are finished with your Spot Fleet for now, but will use it again later, you can set the target capacity to 0. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Context** Reserved. Type: String Required: No **ExcessCapacityTerminationPolicy** Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is decreased below the current size of the Spot Fleet. Supported only for fleets of type `maintain`. Type: String Valid Values: `noTermination | default` Required: No **LaunchTemplateConfig.N** The launch template and overrides. You can only use this parameter if you specified a launch template (`LaunchTemplateConfigs`) in your Spot Fleet request. If you specified `LaunchSpecifications` in your Spot Fleet request, then omit this parameter. Type: Array of [LaunchTemplateConfig](API_LaunchTemplateConfig.md) objects Required: No **OnDemandTargetCapacity** The number of On-Demand Instances in the fleet. Type: Integer Required: No **SpotFleetRequestId** The ID of the Spot Fleet request. Type: String Required: Yes **TargetCapacity** The size of the fleet. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** If the request succeeds, the response returns `true`. If the request fails, no response is returned, and instead an error message is returned. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifySpotFleetRequest) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifySpotFleetRequest) # ModifySubnetAttribute Modifies a subnet attribute. You can only modify one attribute at a time. Use this action to modify subnets on AWS Outposts. + To modify a subnet on an Outpost rack, set both `MapCustomerOwnedIpOnLaunch` and `CustomerOwnedIpv4Pool`. These two parameters act as a single attribute. + To modify a subnet on an Outpost server, set either `EnableLniAtDeviceIndex` or `DisableLniAtDeviceIndex`. For more information about AWS Outposts, see the following: + [Outpost servers](https://docs.aws.amazon.com/outposts/latest/userguide/how-servers-work.html) + [Outpost racks](https://docs.aws.amazon.com/outposts/latest/userguide/how-racks-work.html) ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AssignIpv6AddressOnCreation** Specify `true` to indicate that network interfaces created in the specified subnet should be assigned an IPv6 address. This includes a network interface that's created when launching an instance into the subnet (the instance therefore receives an IPv6 address). If you enable the IPv6 addressing feature for your subnet, your network interface or instance only receives an IPv6 address if it's created using version `2016-11-15` or later of the Amazon EC2 API. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **CustomerOwnedIpv4Pool** The customer-owned IPv4 address pool associated with the subnet. You must set this value when you specify `true` for `MapCustomerOwnedIpOnLaunch`. Type: String Required: No **DisableLniAtDeviceIndex** Specify `true` to indicate that local network interfaces at the current position should be disabled. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **EnableDns64** Indicates whether DNS queries made to the Amazon-provided DNS Resolver in this subnet should return synthetic IPv6 addresses for IPv4-only destinations. You must first configure a NAT gateway in a public subnet (separate from the subnet containing the IPv6-only workloads). For example, the subnet containing the NAT gateway should have a `0.0.0.0/0` route pointing to the internet gateway. For more information, see [Configure DNS64 and NAT64](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-nat64-dns64.html#nat-gateway-nat64-dns64-walkthrough) in the *Amazon VPC User Guide*. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **EnableLniAtDeviceIndex** Indicates the device position for local network interfaces in this subnet. For example, `1` indicates local network interfaces in this subnet are the secondary network interface (eth1). A local network interface cannot be the primary network interface (eth0). Type: Integer Required: No **EnableResourceNameDnsAAAARecordOnLaunch** Indicates whether to respond to DNS queries for instance hostnames with DNS AAAA records. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **EnableResourceNameDnsARecordOnLaunch** Indicates whether to respond to DNS queries for instance hostnames with DNS A records. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **MapCustomerOwnedIpOnLaunch** Specify `true` to indicate that network interfaces attached to instances created in the specified subnet should be assigned a customer-owned IPv4 address. When this value is `true`, you must specify the customer-owned IP pool using `CustomerOwnedIpv4Pool`. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **MapPublicIpOnLaunch** Specify `true` to indicate that network interfaces attached to instances created in the specified subnet should be assigned a public IPv4 address. AWS charges for all public IPv4 addresses, including public IPv4 addresses associated with running instances and Elastic IP addresses. For more information, see the *Public IPv4 Address* tab on the [Amazon VPC pricing page](http://aws.amazon.com/vpc/pricing/). Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **PrivateDnsHostnameTypeOnLaunch** The type of hostname to assign to instances in the subnet at launch. For IPv4-only and dual-stack (IPv4 and IPv6) subnets, an instance DNS name can be based on the instance IPv4 address (ip-name) or the instance ID (resource-name). For IPv6 only subnets, an instance DNS name must be based on the instance ID (resource-name). Type: String Valid Values: `ip-name | resource-name` Required: No **SubnetId** The ID of the subnet. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example modifies the attribute for `subnet-1a2b3c4d` to specify that all instances launched into this subnet are assigned a public IPv4 address. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifySubnetAttribute &SubnetId=subnet-1a2b3c4d &MapPublicIpOnLaunch.Value=true &AUTHPARAMS ``` #### Sample Response ``` c500a0bc-ad14-46c2-b9c5-e24aexample true ``` ### Example 2 This example modifies the attribute for `subnet-1a2b3c4d` to specify that all network interfaces created in this subnet (and therefore all instances launched into this subnet with a new network interface) are assigned an IPv6 address. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifySubnetAttribute &SubnetId=subnet-1a2b3c4d &AssignIpv6AddressOnCreation.Value=true &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifySubnetAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifySubnetAttribute) # ModifyTrafficMirrorFilterNetworkServices Allows or restricts mirroring network services. By default, Amazon DNS network services are not eligible for Traffic Mirror. Use `AddNetworkServices` to add network services to a Traffic Mirror filter. When a network service is added to the Traffic Mirror filter, all traffic related to that network service will be mirrored. When you no longer want to mirror network services, use `RemoveNetworkServices` to remove the network services from the Traffic Mirror filter. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddNetworkService.N** The network service, for example Amazon DNS, that you want to mirror. Type: Array of strings Valid Values: `amazon-dns` Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RemoveNetworkService.N** The network service, for example Amazon DNS, that you no longer want to mirror. Type: Array of strings Valid Values: `amazon-dns` Required: No **TrafficMirrorFilterId** The ID of the Traffic Mirror filter. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **trafficMirrorFilter** The Traffic Mirror filter that the network service is associated with. Type: [TrafficMirrorFilter](API_TrafficMirrorFilter.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTrafficMirrorFilterNetworkServices) # ModifyTrafficMirrorFilterRule Modifies the specified Traffic Mirror rule. `DestinationCidrBlock` and `SourceCidrBlock` must both be an IPv4 range or an IPv6 range. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** The description to assign to the Traffic Mirror rule. Type: String Required: No **DestinationCidrBlock** The destination CIDR block to assign to the Traffic Mirror rule. Type: String Required: No **DestinationPortRange** The destination ports that are associated with the Traffic Mirror rule. Type: [TrafficMirrorPortRangeRequest](API_TrafficMirrorPortRangeRequest.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Protocol** The protocol, for example TCP, to assign to the Traffic Mirror rule. Type: Integer Required: No **RemoveField.N** The properties that you want to remove from the Traffic Mirror filter rule. When you remove a property from a Traffic Mirror filter rule, the property is set to the default. Type: Array of strings Valid Values: `destination-port-range | source-port-range | protocol | description` Required: No **RuleAction** The action to assign to the rule. Type: String Valid Values: `accept | reject` Required: No **RuleNumber** The number of the Traffic Mirror rule. This number must be unique for each Traffic Mirror rule in a given direction. The rules are processed in ascending order by rule number. Type: Integer Required: No **SourceCidrBlock** The source CIDR block to assign to the Traffic Mirror rule. Type: String Required: No **SourcePortRange** The port range to assign to the Traffic Mirror rule. Type: [TrafficMirrorPortRangeRequest](API_TrafficMirrorPortRangeRequest.md) object Required: No **TrafficDirection** The type of traffic to assign to the rule. Type: String Valid Values: `ingress | egress` Required: No **TrafficMirrorFilterRuleId** The ID of the Traffic Mirror rule. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **trafficMirrorFilterRule** Tags are not returned for ModifyTrafficMirrorFilterRule. A Traffic Mirror rule. Type: [TrafficMirrorFilterRule](API_TrafficMirrorFilterRule.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTrafficMirrorFilterRule) # ModifyTrafficMirrorSession Modifies a Traffic Mirror session. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** The description to assign to the Traffic Mirror session. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PacketLength** The number of bytes in each packet to mirror. These are bytes after the VXLAN header. To mirror a subset, set this to the length (in bytes) to mirror. For example, if you set this value to 100, then the first 100 bytes that meet the filter criteria are copied to the target. Do not specify this parameter when you want to mirror the entire packet. For sessions with Network Load Balancer (NLB) traffic mirror targets, the default `PacketLength` will be set to 8500. Valid values are 1-8500. Setting a `PacketLength` greater than 8500 will result in an error response. Type: Integer Required: No **RemoveField.N** The properties that you want to remove from the Traffic Mirror session. When you remove a property from a Traffic Mirror session, the property is set to the default. Type: Array of strings Valid Values: `packet-length | description | virtual-network-id` Required: No **SessionNumber** The session number determines the order in which sessions are evaluated when an interface is used by multiple sessions. The first session with a matching filter is the one that mirrors the packets. Valid values are 1-32766. Type: Integer Required: No **TrafficMirrorFilterId** The ID of the Traffic Mirror filter. Type: String Required: No **TrafficMirrorSessionId** The ID of the Traffic Mirror session. Type: String Required: Yes **TrafficMirrorTargetId** The Traffic Mirror target. The target must be in the same VPC as the source, or have a VPC peering connection with the source. Type: String Required: No **VirtualNetworkId** The virtual network ID of the Traffic Mirror session. Type: Integer Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **trafficMirrorSession** Information about the Traffic Mirror session. Type: [TrafficMirrorSession](API_TrafficMirrorSession.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyTrafficMirrorSession) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTrafficMirrorSession) # ModifyTransitGateway Modifies the specified transit gateway. When you modify a transit gateway, the modified options are applied to new transit gateway attachments only. Your existing transit gateway attachments are not modified. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Description** The description for the transit gateway. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** The options to modify. Type: [ModifyTransitGatewayOptions](API_ModifyTransitGatewayOptions.md) object Required: No **TransitGatewayId** The ID of the transit gateway. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGateway** Information about the transit gateway. Type: [TransitGateway](API_TransitGateway.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyTransitGateway) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTransitGateway) # ModifyTransitGatewayMeteringPolicy Modifies a transit gateway metering policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddMiddleboxAttachmentId.N** The IDs of middlebox attachments to add to the metering policy. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RemoveMiddleboxAttachmentId.N** The IDs of middlebox attachments to remove from the metering policy. Type: Array of strings Required: No **TransitGatewayMeteringPolicyId** The ID of the transit gateway metering policy to modify. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayMeteringPolicy** Information about the modified transit gateway metering policy. Type: [TransitGatewayMeteringPolicy](API_TransitGatewayMeteringPolicy.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTransitGatewayMeteringPolicy) # ModifyTransitGatewayPrefixListReference Modifies a reference (route) to a prefix list in a specified transit gateway route table. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Blackhole** Indicates whether to drop traffic that matches this route. Type: Boolean Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PrefixListId** The ID of the prefix list. Type: String Required: Yes **TransitGatewayAttachmentId** The ID of the attachment to which traffic is routed. Type: String Required: No **TransitGatewayRouteTableId** The ID of the transit gateway route table. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPrefixListReference** Information about the prefix list reference. Type: [TransitGatewayPrefixListReference](API_TransitGatewayPrefixListReference.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example modifies the prefix list reference in the specified route table by changing the attachment to which traffic is routed. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyTransitGatewayPrefixListReference &TransitGatewayRouteTableId=tgw-rtb-0f98a0a5d09abcabc &PrefixListId=pl-001122334455aabbc &TransitGatewayAttachmentId=tgw-attach-11223344aabbcc112 &AUTHPARAMS ``` #### Sample Response ``` bbd3e523-3e5b-4d3b-b010-example false pl-001122334455aabbc 123456789012 modifying tgw-012233aabbcc11223 peering tgw-attach-11223344aabbcc112 tgw-rtb-0f98a0a5d09abcabc ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTransitGatewayPrefixListReference) # ModifyTransitGatewayVpcAttachment Modifies the specified VPC attachment. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddSubnetIds.N** The IDs of one or more subnets to add. You can specify at most one subnet per Availability Zone. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Options** The new VPC attachment options. Type: [ModifyTransitGatewayVpcAttachmentRequestOptions](API_ModifyTransitGatewayVpcAttachmentRequestOptions.md) object Required: No **RemoveSubnetIds.N** The IDs of one or more subnets to remove. Type: Array of strings Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayVpcAttachment** Information about the modified attachment. Type: [TransitGatewayVpcAttachment](API_TransitGatewayVpcAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTransitGatewayVpcAttachment) # ModifyVerifiedAccessEndpoint Modifies the configuration of the specified AWS Verified Access endpoint. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CidrOptions** The CIDR options. Type: [ModifyVerifiedAccessEndpointCidrOptions](API_ModifyVerifiedAccessEndpointCidrOptions.md) object Required: No **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access endpoint. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LoadBalancerOptions** The load balancer details if creating the Verified Access endpoint as `load-balancer`type. Type: [ModifyVerifiedAccessEndpointLoadBalancerOptions](API_ModifyVerifiedAccessEndpointLoadBalancerOptions.md) object Required: No **NetworkInterfaceOptions** The network interface options. Type: [ModifyVerifiedAccessEndpointEniOptions](API_ModifyVerifiedAccessEndpointEniOptions.md) object Required: No **RdsOptions** The RDS options. Type: [ModifyVerifiedAccessEndpointRdsOptions](API_ModifyVerifiedAccessEndpointRdsOptions.md) object Required: No **VerifiedAccessEndpointId** The ID of the Verified Access endpoint. Type: String Required: Yes **VerifiedAccessGroupId** The ID of the Verified Access group. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessEndpoint** Details about the Verified Access endpoint. Type: [VerifiedAccessEndpoint](API_VerifiedAccessEndpoint.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessEndpoint) # ModifyVerifiedAccessEndpointPolicy Modifies the specified AWS Verified Access endpoint policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PolicyDocument** The Verified Access policy document. Type: String Required: No **PolicyEnabled** The status of the Verified Access policy. Type: Boolean Required: No **SseSpecification** The options for server side encryption. Type: [VerifiedAccessSseSpecificationRequest](API_VerifiedAccessSseSpecificationRequest.md) object Required: No **VerifiedAccessEndpointId** The ID of the Verified Access endpoint. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **policyDocument** The Verified Access policy document. Type: String **policyEnabled** The status of the Verified Access policy. Type: Boolean **requestId** The ID of the request. Type: String **sseSpecification** The options in use for server side encryption. Type: [VerifiedAccessSseSpecificationResponse](API_VerifiedAccessSseSpecificationResponse.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointPolicy) # ModifyVerifiedAccessGroup Modifies the specified AWS Verified Access group configuration. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access group. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessGroupId** The ID of the Verified Access group. Type: String Required: Yes **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessGroup** Details about the Verified Access group. Type: [VerifiedAccessGroup](API_VerifiedAccessGroup.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVerifiedAccessGroup) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessGroup) # ModifyVerifiedAccessGroupPolicy Modifies the specified AWS Verified Access group policy. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PolicyDocument** The Verified Access policy document. Type: String Required: No **PolicyEnabled** The status of the Verified Access policy. Type: Boolean Required: No **SseSpecification** The options for server side encryption. Type: [VerifiedAccessSseSpecificationRequest](API_VerifiedAccessSseSpecificationRequest.md) object Required: No **VerifiedAccessGroupId** The ID of the Verified Access group. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **policyDocument** The Verified Access policy document. Type: String **policyEnabled** The status of the Verified Access policy. Type: Boolean **requestId** The ID of the request. Type: String **sseSpecification** The options in use for server side encryption. Type: [VerifiedAccessSseSpecificationResponse](API_VerifiedAccessSseSpecificationResponse.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessGroupPolicy) # ModifyVerifiedAccessInstance Modifies the configuration of the specified AWS Verified Access instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CidrEndpointsCustomSubDomain** The custom subdomain. Type: String Required: No **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access instance. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessInstance** Details about the Verified Access instance. Type: [VerifiedAccessInstance](API_VerifiedAccessInstance.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVerifiedAccessInstance) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessInstance) # ModifyVerifiedAccessInstanceLoggingConfiguration Modifies the logging configuration for the specified AWS Verified Access instance. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AccessLogs** The configuration options for Verified Access instances. Type: [VerifiedAccessLogOptions](API_VerifiedAccessLogOptions.md) object Required: Yes **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VerifiedAccessInstanceId** The ID of the Verified Access instance. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **loggingConfiguration** The logging configuration for the Verified Access instance. Type: [VerifiedAccessInstanceLoggingConfiguration](API_VerifiedAccessInstanceLoggingConfiguration.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessInstanceLoggingConfiguration) # ModifyVerifiedAccessTrustProvider Modifies the configuration of the specified AWS Verified Access trust provider. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** A unique, case-sensitive token that you provide to ensure idempotency of your modification request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **Description** A description for the Verified Access trust provider. Type: String Required: No **DeviceOptions** The options for a device-based trust provider. This parameter is required when the provider type is `device`. Type: [ModifyVerifiedAccessTrustProviderDeviceOptions](API_ModifyVerifiedAccessTrustProviderDeviceOptions.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NativeApplicationOidcOptions** The OpenID Connect (OIDC) options. Type: [ModifyVerifiedAccessNativeApplicationOidcOptions](API_ModifyVerifiedAccessNativeApplicationOidcOptions.md) object Required: No **OidcOptions** The options for an OpenID Connect-compatible user-identity trust provider. Type: [ModifyVerifiedAccessTrustProviderOidcOptions](API_ModifyVerifiedAccessTrustProviderOidcOptions.md) object Required: No **SseSpecification** The options for server side encryption. Type: [VerifiedAccessSseSpecificationRequest](API_VerifiedAccessSseSpecificationRequest.md) object Required: No **VerifiedAccessTrustProviderId** The ID of the Verified Access trust provider. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **verifiedAccessTrustProvider** Details about the Verified Access trust provider. Type: [VerifiedAccessTrustProvider](API_VerifiedAccessTrustProvider.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessTrustProvider) # ModifyVolume You can modify several parameters of an existing EBS volume, including volume size, volume type, and IOPS capacity. If your EBS volume is attached to a current-generation EC2 instance type, you might be able to apply these changes without stopping the instance or detaching the volume from it. For more information about modifying EBS volumes, see [Amazon EBS Elastic Volumes](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modify-volume.html) in the *Amazon EBS User Guide*. When you complete a resize operation on your volume, you need to extend the volume's file-system size to take advantage of the new storage capacity. For more information, see [Extend the file system](https://docs.aws.amazon.com/ebs/latest/userguide/recognize-expanded-volume-linux.html). For more information, see [Monitor the progress of volume modifications](https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-modifications.html) in the *Amazon EBS User Guide*. With previous-generation instance types, resizing an EBS volume might require detaching and reattaching the volume or stopping and restarting the instance. After you initiate a volume modification, you must wait for that modification to reach the `completed` state before you can initiate another modification for the same volume. You can modify a volume up to four times within a rolling 24-hour period, as long as the volume is in the `in-use` or `available` state, and all previous modifications for that volume are `completed`. If you exceed this limit, you get an error message that indicates when you can perform your next modification. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **Iops** The target IOPS rate of the volume. This parameter is valid only for `gp3`, `io1`, and `io2` volumes. The following are the supported values for each volume type: + `gp3`: 3,000 - 80,000 IOPS + `io1`: 100 - 64,000 IOPS + `io2`: 100 - 256,000 IOPS [ Instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) can support up to 256,000 IOPS. Other instances can support up to 32,000 IOPS. Default: The existing value is retained if you keep the same volume type. If you change the volume type to `io1`, `io2`, or `gp3`, the default is 3,000. Type: Integer Required: No **MultiAttachEnabled** Specifies whether to enable Amazon EBS Multi-Attach. If you enable Multi-Attach, you can attach the volume to up to 16 [ Nitro-based instances](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html) in the same Availability Zone. This parameter is supported with `io1` and `io2` volumes only. For more information, see [ Amazon EBS Multi-Attach](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volumes-multi.html) in the *Amazon EBS User Guide*. Type: Boolean Required: No **Size** The target size of the volume, in GiB. The target volume size must be greater than or equal to the existing size of the volume. The following are the supported volumes sizes for each volume type: + `gp2`: 1 - 16,384 GiB + `gp3`: 1 - 65,536 GiB + `io1`: 4 - 16,384 GiB + `io2`: 4 - 65,536 GiB + `st1` and `sc1`: 125 - 16,384 GiB + `standard`: 1 - 1024 GiB Default: The existing size is retained. Type: Integer Required: No **Throughput** The target throughput of the volume, in MiB/s. This parameter is valid only for `gp3` volumes. The maximum value is 2,000. Default: The existing value is retained if the source and target volume type is `gp3`. Otherwise, the default value is 125. Valid Range: Minimum value of 125. Maximum value of 2,000. Type: Integer Required: No **VolumeId** The ID of the volume. Type: String Required: Yes **VolumeType** The target EBS volume type of the volume. For more information, see [Amazon EBS volume types](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-volume-types.html) in the *Amazon EBS User Guide*. Default: The existing type is retained. Type: String Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **volumeModification** Information about the volume modification. Type: [VolumeModification](API_VolumeModification.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Modify size, type, and IOPS provisioning of a volume This example illustrates one usage of ModifyVolume. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVolume &VolumeId=vol-1234567890EXAMPLE &VolumeType=io1 &Iops=10000 &Size=200 &Version=2016-11-15 ``` #### Sample Response ``` 5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE 10000 300 modifying 200 io1 false vol-1234567890EXAMPLE 0 2017-01-19T23:58:04.922Z 100 gp2 false ``` ### Modify Multi-Attach support This example illustrates one usage of ModifyVolume. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVolume &VolumeId=vol-1234567890EXAMPLE &MultiAttachEnabled=true &Version=2016-11-15 ``` #### Sample Response ``` 5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE false true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVolume) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVolume) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVolume) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVolume) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVolume) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVolume) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVolume) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVolume) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVolume) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVolume) # ModifyVolumeAttribute Modifies a volume attribute. By default, all I/O operations for the volume are suspended when the data on the volume is determined to be potentially inconsistent, to prevent undetectable, latent data corruption. The I/O access to the volume can be resumed by first enabling I/O access and then checking the data consistency on your volume. You can change the default behavior to resume I/O operations. We recommend that you change this only for boot volumes or for volumes that are stateless or disposable. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AutoEnableIO** Indicates whether the volume should be auto-enabled for I/O operations. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VolumeId** The ID of the volume. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example modifies the attribute of the volume vol-1234567890abcdef0. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVolumeAttribute &VolumeId=vol-1234567890abcdef0 &AutoEnableIO.Value=true &AUTHPARAMS ``` #### Sample Response ``` 5jkdf074-37ed-4004-8671-a78ee82bf1cbEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVolumeAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVolumeAttribute) # ModifyVpcAttribute Modifies the specified attribute of the specified VPC. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **EnableDnsHostnames** Indicates whether the instances launched in the VPC get DNS hostnames. If enabled, instances in the VPC get DNS hostnames; otherwise, they do not. You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. You can only enable DNS hostnames if you've enabled DNS support. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **EnableDnsSupport** Indicates whether the DNS resolution is supported for the VPC. If enabled, queries to the Amazon provided DNS server at the 169.254.169.253 IP address, or the reserved IP address at the base of the VPC network range "plus two" succeed. If disabled, the Amazon provided DNS service in the VPC that resolves public DNS hostnames to IP addresses is not enabled. You cannot modify the DNS resolution and DNS hostnames attributes in the same request. Use separate requests for each attribute. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **EnableNetworkAddressUsageMetrics** Indicates whether Network Address Usage metrics are enabled for your VPC. Type: [AttributeBooleanValue](API_AttributeBooleanValue.md) object Required: No **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example disables support for DNS hostnames in the specified VPC. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcAttribute &VpcId=vpc-1a2b3c4d &EnableDnsHostnames.Value=false &AUTHPARAMS ``` #### Sample Response ``` d742de94-5f3e-4c3d-b6d4-440cexample true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcAttribute) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcAttribute) # ModifyVpcBlockPublicAccessExclusion Modify VPC Block Public Access (BPA) exclusions. A VPC BPA exclusion is a mode that can be applied to a single VPC or subnet that exempts it from the account’s BPA mode and will allow bidirectional or egress-only access. You can create BPA exclusions for VPCs and subnets even when BPA is not enabled on the account to ensure that there is no traffic disruption to the exclusions when VPC BPA is turned on. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ExclusionId** The ID of an exclusion. Type: String Required: Yes **InternetGatewayExclusionMode** The exclusion mode for internet gateway traffic. + `allow-bidirectional`: Allow all internet traffic to and from the excluded VPCs and subnets. + `allow-egress`: Allow outbound internet traffic from the excluded VPCs and subnets. Block inbound internet traffic to the excluded VPCs and subnets. Only applies when VPC Block Public Access is set to Bidirectional. Type: String Valid Values: `allow-bidirectional | allow-egress` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcBlockPublicAccessExclusion** Details related to the exclusion. Type: [VpcBlockPublicAccessExclusion](API_VpcBlockPublicAccessExclusion.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcBlockPublicAccessExclusion) # ModifyVpcBlockPublicAccessOptions Modify VPC Block Public Access (BPA) options. VPC Block Public Access (BPA) enables you to block resources in VPCs and subnets that you own in a Region from reaching or being reached from the internet through internet gateways and egress-only internet gateways. To learn more about VPC BPA, see [Block public access to VPCs and subnets](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InternetGatewayBlockMode** The mode of VPC BPA. + `off`: VPC BPA is not enabled and traffic is allowed to and from internet gateways and egress-only internet gateways in this Region. + `block-bidirectional`: Block all traffic to and from internet gateways and egress-only internet gateways in this Region (except for excluded VPCs and subnets). + `block-ingress`: Block all internet traffic to the VPCs in this Region (except for VPCs or subnets which are excluded). Only traffic to and from NAT gateways and egress-only internet gateways is allowed because these gateways only allow outbound connections to be established. Type: String Valid Values: `off | block-bidirectional | block-ingress` Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcBlockPublicAccessOptions** Details related to the VPC Block Public Access (BPA) options. Type: [VpcBlockPublicAccessOptions](API_VpcBlockPublicAccessOptions.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcBlockPublicAccessOptions) # ModifyVpcEncryptionControl Modifies the encryption control configuration for a VPC. You can update the encryption mode and exclusion settings for various gateway types and peering connections. For more information, see [Enforce VPC encryption in transit](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-encryption-controls.html) in the *Amazon VPC User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EgressOnlyInternetGatewayExclusion** Specifies whether to exclude egress-only internet gateway traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No **ElasticFileSystemExclusion** Specifies whether to exclude Elastic File System traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No **InternetGatewayExclusion** Specifies whether to exclude internet gateway traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No **LambdaExclusion** Specifies whether to exclude Lambda function traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No **Mode** The encryption mode for the VPC Encryption Control configuration. Type: String Valid Values: `monitor | enforce` Required: No **NatGatewayExclusion** Specifies whether to exclude NAT gateway traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No **VirtualPrivateGatewayExclusion** Specifies whether to exclude virtual private gateway traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No **VpcEncryptionControlId** The ID of the VPC Encryption Control resource to modify. Type: String Required: Yes **VpcLatticeExclusion** Specifies whether to exclude VPC Lattice traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No **VpcPeeringExclusion** Specifies whether to exclude VPC peering connection traffic from encryption enforcement. Type: String Valid Values: `enable | disable` Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpcEncryptionControl** Information about the VPC Encryption Control configuration. Type: [VpcEncryptionControl](API_VpcEncryptionControl.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcEncryptionControl) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcEncryptionControl) # ModifyVpcEndpoint Modifies attributes of a specified VPC endpoint. The attributes that you can modify depend on the type of VPC endpoint (interface, gateway, or Gateway Load Balancer). For more information, see the [AWS PrivateLink Guide](https://docs.aws.amazon.com/vpc/latest/privatelink/). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddRouteTableId.N** (Gateway endpoint) The IDs of the route tables to associate with the endpoint. Type: Array of strings Required: No **AddSecurityGroupId.N** (Interface endpoint) The IDs of the security groups to associate with the endpoint network interfaces. Type: Array of strings Required: No **AddSubnetId.N** (Interface and Gateway Load Balancer endpoints) The IDs of the subnets in which to serve the endpoint. For a Gateway Load Balancer endpoint, you can specify only one subnet. Type: Array of strings Required: No **DnsOptions** The DNS options for the endpoint. Type: [DnsOptionsSpecification](API_DnsOptionsSpecification.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpAddressType** The IP address type for the endpoint. Type: String Valid Values: `ipv4 | dualstack | ipv6` Required: No **PolicyDocument** (Interface and gateway endpoints) A policy to attach to the endpoint that controls access to the service. The policy must be in valid JSON format. Type: String Required: No **PrivateDnsEnabled** (Interface endpoint) Indicates whether a private hosted zone is associated with the VPC. Type: Boolean Required: No **RemoveRouteTableId.N** (Gateway endpoint) The IDs of the route tables to disassociate from the endpoint. Type: Array of strings Required: No **RemoveSecurityGroupId.N** (Interface endpoint) The IDs of the security groups to disassociate from the endpoint network interfaces. Type: Array of strings Required: No **RemoveSubnetId.N** (Interface endpoint) The IDs of the subnets from which to remove the endpoint. Type: Array of strings Required: No **ResetPolicy** (Gateway endpoint) Specify `true` to reset the policy document to the default policy. The default policy allows full access to the service. Type: Boolean Required: No **SubnetConfiguration.N** The subnet configurations for the endpoint. Type: Array of [SubnetConfiguration](API_SubnetConfiguration.md) objects Required: No **VpcEndpointId** The ID of the endpoint. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example modifies gateway endpoint `vpce-1a2b3c4d` by associating route table `rtb-aaa222bb` with the endpoint, and resetting the policy document. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcEndpoint &VpcEndpointId=vpce-1a2b3c4d &ResetPolicy=true &AddRouteTableId.1=rtb-aaa222bb &AUTHPARAMS ``` #### Sample Response ``` true 125acea6-ba5c-4c6e-8e17-example ``` ### Example 2 This example modifies interface endpoint `vpce-0fe5b17a0707d6fa5` by adding subnet `subnet-d6fcaa8d` to the endpoint. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcEndpoint &VpcEndpointId=vpce-0fe5b17a0707d6fa5 &AddSubnetId.1=subnet-d6fcaa8db &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcEndpoint) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcEndpoint) # ModifyVpcEndpointConnectionNotification Modifies a connection notification for VPC endpoint or VPC endpoint service. You can change the SNS topic for the notification, or the events for which to be notified. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ConnectionEvents.N** The events for the endpoint. Valid values are `Accept`, `Connect`, `Delete`, and `Reject`. Type: Array of strings Required: No **ConnectionNotificationArn** The ARN for the SNS topic for the notification. Type: String Required: No **ConnectionNotificationId** The ID of the notification. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example The following example modifies notification `vpce-nfn-abccb952bc8af7123` by modifying the endpoint events and the SNS topic ARN. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcEndpointConnectionNotification &ConnectionNotificationId=vpce-nfn-abccb952bc8af7123 &ConnectionNotificationArn=arn:aws:sns:us-east-1:123456789012:mytopic &ConnectionEvents.1=Accept &ConnectionEvents.2=Reject &AUTHPARAMS ``` #### Sample Response ``` 08d80840-f750-42db-a6f8-2cd32example true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcEndpointConnectionNotification) # ModifyVpcEndpointServiceConfiguration Modifies the attributes of the specified VPC endpoint service configuration. If you set or modify the private DNS name, you must prove that you own the private DNS domain name. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AcceptanceRequired** Indicates whether requests to create an endpoint to the service must be accepted. Type: Boolean Required: No **AddGatewayLoadBalancerArn.N** The Amazon Resource Names (ARNs) of Gateway Load Balancers to add to the service configuration. Type: Array of strings Required: No **AddNetworkLoadBalancerArn.N** The Amazon Resource Names (ARNs) of Network Load Balancers to add to the service configuration. Type: Array of strings Required: No **AddSupportedIpAddressType.N** The IP address types to add to the service configuration. Type: Array of strings Required: No **AddSupportedRegion.N** The supported Regions to add to the service configuration. Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PrivateDnsName** (Interface endpoint configuration) The private DNS name to assign to the endpoint service. Type: String Required: No **RemoveGatewayLoadBalancerArn.N** The Amazon Resource Names (ARNs) of Gateway Load Balancers to remove from the service configuration. Type: Array of strings Required: No **RemoveNetworkLoadBalancerArn.N** The Amazon Resource Names (ARNs) of Network Load Balancers to remove from the service configuration. Type: Array of strings Required: No **RemovePrivateDnsName** (Interface endpoint configuration) Removes the private DNS name of the endpoint service. Type: Boolean Required: No **RemoveSupportedIpAddressType.N** The IP address types to remove from the service configuration. Type: Array of strings Required: No **RemoveSupportedRegion.N** The supported Regions to remove from the service configuration. Type: Array of strings Required: No **ServiceId** The ID of the service. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example modifies service configuration `vpce-svc-03d5ebb7d9579a2b3` to specify that acceptance is required for interface VPC endpoint connection requests to the service, and to assign a private DNS name to the endpoint service. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcEndpointServiceConfiguration &ServiceId=vpce-svc-03d5ebb7d9579a2b3 &AcceptanceRequired=true &PrivateDnsName=myexampleservice.com &AUTHPARAMS ``` #### Sample Response ``` 08d80840-f750-42db-a6f8-2cd32example true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcEndpointServiceConfiguration) # ModifyVpcEndpointServicePayerResponsibility Modifies the payer responsibility for your VPC endpoint service. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PayerResponsibility** The entity that is responsible for the endpoint costs. The default is the endpoint owner. If you set the payer responsibility to the service owner, you cannot set it back to the endpoint owner. Type: String Valid Values: `ServiceOwner` Required: Yes **ServiceId** The ID of the service. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcEndpointServicePayerResponsibility) # ModifyVpcEndpointServicePermissions Modifies the permissions for your VPC endpoint service. You can add or remove permissions for service consumers (AWS accounts, users, and IAM roles) to connect to your endpoint service. Principal ARNs with path components aren't supported. If you grant permissions to all principals, the service is public. Any users who know the name of a public service can send a request to attach an endpoint. If the service does not require manual approval, attachments are automatically approved. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AddAllowedPrincipals.N** The Amazon Resource Names (ARN) of the principals. Permissions are granted to the principals in this list. To grant permissions to all principals, specify an asterisk (\$1). Type: Array of strings Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RemoveAllowedPrincipals.N** The Amazon Resource Names (ARN) of the principals. Permissions are revoked for principals in this list. Type: Array of strings Required: No **ServiceId** The ID of the service. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **addedPrincipalSet** Information about the added principals. Type: Array of [AddedPrincipal](API_AddedPrincipal.md) objects **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example permits all principals in AWS account `123456789012` to connect to your endpoint service `vpce-svc-03d5ebb7d9579a2b3`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcEndpointServicePermissions &ServiceId=vpce-svc-03d5ebb7d9579a2b3 &AddAllowedPrincipals.1=arn:aws:iam::123456789012:root &AUTHPARAMS ``` #### Sample Response ``` 08d80840-f750-42db-a6f8-2cd32example true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcEndpointServicePermissions) # ModifyVpcPeeringConnectionOptions Modifies the VPC peering connection options on one side of a VPC peering connection. If the peered VPCs are in the same AWS account, you can enable DNS resolution for queries from the local VPC. This ensures that queries from the local VPC resolve to private IP addresses in the peer VPC. This option is not available if the peered VPCs are in different AWS accounts or different Regions. For peered VPCs in different AWS accounts, each AWS account owner must initiate a separate request to modify the peering connection options. For inter-region peering connections, you must use the Region for the requester VPC to modify the requester VPC peering options and the Region for the accepter VPC to modify the accepter VPC peering options. To verify which VPCs are the accepter and the requester for a VPC peering connection, use the [DescribeVpcPeeringConnections](API_DescribeVpcPeeringConnections.md) command. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AccepterPeeringConnectionOptions** The VPC peering connection options for the accepter VPC. Type: [PeeringConnectionOptionsRequest](API_PeeringConnectionOptionsRequest.md) object Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **RequesterPeeringConnectionOptions** The VPC peering connection options for the requester VPC. Type: [PeeringConnectionOptionsRequest](API_PeeringConnectionOptionsRequest.md) object Required: No **VpcPeeringConnectionId** The ID of the VPC peering connection. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **accepterPeeringConnectionOptions** Information about the VPC peering connection options for the accepter VPC. Type: [PeeringConnectionOptions](API_PeeringConnectionOptions.md) object **requesterPeeringConnectionOptions** Information about the VPC peering connection options for the requester VPC. Type: [PeeringConnectionOptions](API_PeeringConnectionOptions.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example In this example, you want the public DNS hostnames of your instances in your VPC to resolve to private IP addresses when queried from instances in the peer VPC. You were the accepter of the VPC peering connection, therefore you modify the accepter VPC peering connection options. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcPeeringConnectionOptions &VpcPeeringConnectionId=pcx-1a2b3c4d &AccepterPeeringConnectionOptions.AllowDnsResolutionFromRemoteVpc=true &AUTHPARAMS ``` #### Sample Response ``` f5131846-7920-4359-b565-example true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcPeeringConnectionOptions) # ModifyVpcTenancy Modifies the instance tenancy attribute of the specified VPC. You can change the instance tenancy attribute of a VPC to `default` only. You cannot change the instance tenancy attribute to `dedicated`. After you modify the tenancy of the VPC, any new instances that you launch into the VPC have a tenancy of `default`, unless you specify otherwise during launch. The tenancy of any existing instances in the VPC is not affected. For more information, see [Dedicated Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/dedicated-instance.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceTenancy** The instance tenancy attribute for the VPC. Type: String Valid Values: `default` Required: Yes **VpcId** The ID of the VPC. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example modifies the tenancy of `vpc-1a2b3c4d` to `default`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ModifyVpcTenancy &VpcId=vpc-1a2b3c4d &InstanceTenancy=default &AUTHPARAMS ``` #### Sample Response ``` true 125acea6-ba5c-4c6e-8e17-example ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpcTenancy) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpcTenancy) # ModifyVpnConnection Modifies the customer gateway or the target gateway of an AWS Site-to-Site VPN connection. To modify the target gateway, the following migration options are available: + An existing virtual private gateway to a new virtual private gateway + An existing virtual private gateway to a transit gateway + An existing transit gateway to a new transit gateway + An existing transit gateway to a virtual private gateway Before you perform the migration to the new gateway, you must configure the new gateway. Use [CreateVpnGateway](API_CreateVpnGateway.md) to create a virtual private gateway, or [CreateTransitGateway](API_CreateTransitGateway.md) to create a transit gateway. This step is required when you migrate from a virtual private gateway with static routes to a transit gateway. You must delete the static routes before you migrate to the new gateway. Keep a copy of the static route before you delete it. You will need to add back these routes to the transit gateway after the VPN connection migration is complete. After you migrate to the new gateway, you might need to modify your VPC route table. Use [CreateRoute](API_CreateRoute.md) and [DeleteRoute](API_DeleteRoute.md) to make the changes described in [Update VPC route tables](https://docs.aws.amazon.com/vpn/latest/s2svpn/modify-vpn-target.html#step-update-routing) in the * AWS Site-to-Site VPN User Guide*. When the new gateway is a transit gateway, modify the transit gateway route table to allow traffic between the VPC and the AWS Site-to-Site VPN connection. Use [CreateTransitGatewayRoute](API_CreateTransitGatewayRoute.md) to add the routes. If you deleted VPN static routes, you must add the static routes to the transit gateway route table. After you perform this operation, the VPN endpoint's IP addresses on the AWS side and the tunnel options remain intact. Your AWS Site-to-Site VPN connection will be temporarily unavailable for a brief period while we provision the new endpoints. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CustomerGatewayId** The ID of the customer gateway at your end of the VPN connection. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayId** The ID of the transit gateway. Type: String Required: No **VpnConnectionId** The ID of the VPN connection. Type: String Required: Yes **VpnGatewayId** The ID of the virtual private gateway at the AWS side of the VPN connection. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConnection** Information about the VPN connection. Type: [VpnConnection](API_VpnConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpnConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpnConnection) # ModifyVpnConnectionOptions Modifies the connection options for your Site-to-Site VPN connection. When you modify the VPN connection options, the VPN endpoint IP addresses on the AWS side do not change, and the tunnel options do not change. Your VPN connection will be temporarily unavailable for a brief period while the VPN connection is updated. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **LocalIpv4NetworkCidr** The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection. Default: `0.0.0.0/0` Type: String Required: No **LocalIpv6NetworkCidr** The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection. Default: `::/0` Type: String Required: No **RemoteIpv4NetworkCidr** The IPv4 CIDR on the AWS side of the VPN connection. Default: `0.0.0.0/0` Type: String Required: No **RemoteIpv6NetworkCidr** The IPv6 CIDR on the AWS side of the VPN connection. Default: `::/0` Type: String Required: No **VpnConnectionId** The ID of the Site-to-Site VPN connection. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConnection** Information about the VPN connection. Type: [VpnConnection](API_VpnConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpnConnectionOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpnConnectionOptions) # ModifyVpnTunnelCertificate Modifies the VPN tunnel endpoint certificate. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpnConnectionId** The ID of the AWS Site-to-Site VPN connection. Type: String Required: Yes **VpnTunnelOutsideIpAddress** The external IP address of the VPN tunnel. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConnection** Information about the VPN connection. Type: [VpnConnection](API_VpnConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpnTunnelCertificate) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpnTunnelCertificate) # ModifyVpnTunnelOptions Modifies the options for a VPN tunnel in an AWS Site-to-Site VPN connection. You can modify multiple options for a tunnel in a single request, but you can only modify one tunnel at a time. For more information, see [Site-to-Site VPN tunnel options for your Site-to-Site VPN connection](https://docs.aws.amazon.com/vpn/latest/s2svpn/VPNTunnels.html) in the * AWS Site-to-Site VPN User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PreSharedKeyStorage** Specifies the storage mode for the pre-shared key (PSK). Valid values are `Standard` (stored in Site-to-Site VPN service) or `SecretsManager` (stored in AWS Secrets Manager). Type: String Required: No **SkipTunnelReplacement** Choose whether or not to trigger immediate tunnel replacement. This is only applicable when turning on or off `EnableTunnelLifecycleControl`. Valid values: `True` \$1 `False` Type: Boolean Required: No **TunnelOptions** The tunnel options to modify. Type: [ModifyVpnTunnelOptionsSpecification](API_ModifyVpnTunnelOptionsSpecification.md) object Required: Yes **VpnConnectionId** The ID of the AWS Site-to-Site VPN connection. Type: String Required: Yes **VpnTunnelOutsideIpAddress** The external IP address of the VPN tunnel. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **vpnConnection** Information about the VPN connection. Type: [VpnConnection](API_VpnConnection.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ModifyVpnTunnelOptions) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpnTunnelOptions) # MonitorInstances Enables detailed monitoring for a running instance. Otherwise, basic monitoring is enabled. For more information, see [Monitor your instances using CloudWatch](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html) in the *Amazon EC2 User Guide*. To disable detailed monitoring, see [UnmonitorInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_UnmonitorInstances.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId.N** The IDs of the instances. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **instancesSet** The monitoring information. Type: Array of [InstanceMonitoring](API_InstanceMonitoring.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example enables detailed monitoring for the specified two instances. #### Sample Request ``` https://ec2.amazonaws.com/?Action=MonitorInstances &InstanceId.1=i-1234567890abcdef0 &InstanceId.2=i-0598c7d356eba48d7 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE i-1234567890abcdef0 pending i-0598c7d356eba48d7 pending ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/MonitorInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/MonitorInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MonitorInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/MonitorInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MonitorInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/MonitorInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/MonitorInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/MonitorInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/MonitorInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MonitorInstances) # MoveAddressToVpc **Note** This action is deprecated. Moves an Elastic IP address from the EC2-Classic platform to the EC2-VPC platform. The Elastic IP address must be allocated to your account for more than 24 hours, and it must not be associated with an instance. After the Elastic IP address is moved, it is no longer available for use in the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in the EC2-VPC platform to the EC2-Classic platform. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PublicIp** The Elastic IP address. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **allocationId** The allocation ID for the Elastic IP address. Type: String **requestId** The ID of the request. Type: String **status** The status of the move of the IP address. Type: String Valid Values: `MoveInProgress | InVpc | InClassic` ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/MoveAddressToVpc) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MoveAddressToVpc) # MoveByoipCidrToIpam Move a BYOIPv4 CIDR to IPAM from a public IPv4 pool. If you already have a BYOIPv4 CIDR with AWS, you can move the CIDR to IPAM from a public IPv4 pool. You cannot move an IPv6 CIDR to IPAM. If you are bringing a new IP address to AWS for the first time, complete the steps in [Tutorial: BYOIP address CIDRs to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoip-ipam.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The BYOIP CIDR. Type: String Required: Yes **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPoolId** The IPAM pool ID. Type: String Required: Yes **IpamPoolOwner** The AWS account ID of the owner of the IPAM pool. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **byoipCidr** The BYOIP CIDR. Type: [ByoipCidr](API_ByoipCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/MoveByoipCidrToIpam) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MoveByoipCidrToIpam) # MoveCapacityReservationInstances Move available capacity from a source Capacity Reservation to a destination Capacity Reservation. The source Capacity Reservation and the destination Capacity Reservation must be `active`, owned by your AWS account, and share the following: + Instance type + Platform + Availability Zone + Tenancy + Placement group + Capacity Reservation end time - `At specific time` or `Manually`. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensure Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **DestinationCapacityReservationId** The ID of the Capacity Reservation that you want to move capacity into. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceCount** The number of instances that you want to move from the source Capacity Reservation. Type: Integer Required: Yes **SourceCapacityReservationId** The ID of the Capacity Reservation from which you want to move capacity. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **destinationCapacityReservation** Information about the destination Capacity Reservation. Type: [CapacityReservation](API_CapacityReservation.md) object **instanceCount** The number of instances that were moved from the source Capacity Reservation to the destination Capacity Reservation. Type: Integer **requestId** The ID of the request. Type: String **sourceCapacityReservation** Information about the source Capacity Reservation. Type: [CapacityReservation](API_CapacityReservation.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/MoveCapacityReservationInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MoveCapacityReservationInstances) # ProvisionByoipCidr Provisions an IPv4 or IPv6 address range for use with your AWS resources through bring your own IP addresses (BYOIP) and creates a corresponding address pool. After the address range is provisioned, it is ready to be advertised. AWS verifies that you own the address range and are authorized to advertise it. You must ensure that the address range is registered to you and that you created an RPKI ROA to authorize Amazon ASNs 16509 and 14618 to advertise the address range. For more information, see [Bring your own IP addresses (BYOIP)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html) in the *Amazon EC2 User Guide*. Provisioning an address range is an asynchronous operation, so the call returns immediately, but the address range is not ready to use until its status changes from `pending-provision` to `provisioned`. For more information, see [Onboard your address range](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/byoip-onboard.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region. Type: String Required: Yes **CidrAuthorizationContext** A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP. Type: [CidrAuthorizationContext](API_CidrAuthorizationContext.md) object Required: No **Description** A description for the address range and the address pool. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **MultiRegion** Reserved. Type: Boolean Required: No **NetworkBorderGroup** If you have [Local Zones](https://docs.aws.amazon.com/local-zones/latest/ug/how-local-zones-work.html) enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the AWS resource it is associated with must reside in the same network border group. You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups: + us-east-1-dfw-2 + us-west-2-lax-1 + us-west-2-phx-2 You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time. Type: String Required: No **PoolTagSpecification.N** The tags to apply to the address pool. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **PubliclyAdvertisable** (IPv6 only) Indicate whether the address range will be publicly advertised to the internet. Default: true Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **byoipCidr** Information about the address range. Type: [ByoipCidr](API_ByoipCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ProvisionByoipCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ProvisionByoipCidr) # ProvisionIpamByoasn Provisions your Autonomous System Number (ASN) for use in your AWS account. This action requires authorization context for Amazon to bring the ASN to an AWS account. For more information, see [Tutorial: Bring your ASN to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) in the *Amazon VPC IPAM guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Asn** A public 2-byte or 4-byte ASN. Type: String Required: Yes **AsnAuthorizationContext** An ASN authorization context. Type: [AsnAuthorizationContext](API_AsnAuthorizationContext.md) object Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamId** An IPAM ID. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **byoasn** An ASN and BYOIP CIDR association. Type: [Byoasn](API_Byoasn.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ProvisionIpamByoasn) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ProvisionIpamByoasn) # ProvisionIpamPoolCidr Provision a CIDR to an IPAM pool. You can use this action to provision new CIDRs to a top-level pool or to transfer a CIDR from a top-level pool to a pool within it. For more information, see [Provision CIDRs to pools](https://docs.aws.amazon.com/vpc/latest/ipam/prov-cidr-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Cidr** The CIDR you want to assign to the IPAM pool. Either "NetmaskLength" or "Cidr" is required. This value will be null if you specify "NetmaskLength" and will be filled in during the provisioning process. Type: String Required: No **CidrAuthorizationContext** A signed document that proves that you are authorized to bring a specified IP address range to Amazon using BYOIP. This option only applies to IPv4 and IPv6 pools in the public scope. Type: [IpamCidrAuthorizationContext](API_IpamCidrAuthorizationContext.md) object Required: No **ClientToken** A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html). Type: String Required: No **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamExternalResourceVerificationTokenId** Verification token ID. This option only applies to IPv4 and IPv6 pools in the public scope. Type: String Required: No **IpamPoolId** The ID of the IPAM pool to which you want to assign a CIDR. Type: String Required: Yes **NetmaskLength** The netmask length of the CIDR you'd like to provision to a pool. Can be used for provisioning Amazon-provided IPv6 CIDRs to top-level pools and for provisioning CIDRs to pools with source pools. Cannot be used to provision BYOIP CIDRs to top-level pools. Either "NetmaskLength" or "Cidr" is required. Type: Integer Required: No **VerificationMethod** The method for verifying control of a public IP address range. Defaults to `remarks-x509` if not specified. This option only applies to IPv4 and IPv6 pools in the public scope. Type: String Valid Values: `remarks-x509 | dns-token` Required: No ## Response Elements The following elements are returned by the service. **ipamPoolCidr** Information about the provisioned CIDR. Type: [IpamPoolCidr](API_IpamPoolCidr.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ProvisionIpamPoolCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ProvisionIpamPoolCidr) # ProvisionPublicIpv4PoolCidr Provision a CIDR to a public IPv4 pool. For more information about IPAM, see [What is IPAM?](https://docs.aws.amazon.com/vpc/latest/ipam/what-is-it-ipam.html) in the *Amazon VPC IPAM User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **IpamPoolId** The ID of the IPAM pool you would like to use to allocate this CIDR. Type: String Required: Yes **NetmaskLength** The netmask length of the CIDR you would like to allocate to the public IPv4 pool. The least specific netmask length you can define is 24. Type: Integer Required: Yes **NetworkBorderGroup** The Availability Zone (AZ) or Local Zone (LZ) network border group that the resource that the IP address is assigned to is in. Defaults to an AZ network border group. For more information on available Local Zones, see [Local Zone availability](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#byoip-zone-avail) in the *Amazon EC2 User Guide*. Type: String Required: No **PoolId** The ID of the public IPv4 pool you would like to use for this CIDR. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **poolAddressRange** Information about the address range of the public IPv4 pool. Type: [PublicIpv4PoolRange](API_PublicIpv4PoolRange.md) object **poolId** The ID of the pool that you want to provision the CIDR to. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ProvisionPublicIpv4PoolCidr) # PurchaseCapacityBlock Purchase the Capacity Block for use with your account. With Capacity Blocks you ensure GPU capacity is available for machine learning (ML) workloads. You must specify the ID of the Capacity Block offering you are purchasing. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityBlockOfferingId** The ID of the Capacity Block offering. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstancePlatform** The type of operating system for which to reserve capacity. Type: String Valid Values: `Linux/UNIX | Red Hat Enterprise Linux | SUSE Linux | Windows | Windows with SQL Server | Windows with SQL Server Enterprise | Windows with SQL Server Standard | Windows with SQL Server Web | Linux with SQL Server Standard | Linux with SQL Server Web | Linux with SQL Server Enterprise | RHEL with SQL Server Standard | RHEL with SQL Server Enterprise | RHEL with SQL Server Web | RHEL with HA | RHEL with HA and SQL Server Standard | RHEL with HA and SQL Server Enterprise | Ubuntu Pro` Required: Yes **TagSpecification.N** The tags to apply to the Capacity Block during launch. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **capacityBlockSet** The Capacity Block. Type: Array of [CapacityBlock](API_CapacityBlock.md) objects **capacityReservation** The Capacity Reservation. Type: [CapacityReservation](API_CapacityReservation.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/PurchaseCapacityBlock) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PurchaseCapacityBlock) # PurchaseCapacityBlockExtension Purchase the Capacity Block extension for use with your account. You must specify the ID of the Capacity Block extension offering you are purchasing. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityBlockExtensionOfferingId** The ID of the Capacity Block extension offering to purchase. Type: String Required: Yes **CapacityReservationId** The ID of the Capacity reservation to be extended. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **capacityBlockExtensionSet** The purchased Capacity Block extensions. Type: Array of [CapacityBlockExtension](API_CapacityBlockExtension.md) objects **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/PurchaseCapacityBlockExtension) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PurchaseCapacityBlockExtension) # PurchaseHostReservation Purchase a reservation with configurations that match those of your Dedicated Host. You must have active Dedicated Hosts in your account before you purchase a reservation. This action results in the specified reservation being purchased and charged to your account. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **CurrencyCode** The currency in which the `totalUpfrontPrice`, `LimitPrice`, and `totalHourlyPrice` amounts are specified. At this time, the only supported currency is `USD`. Type: String Valid Values: `USD` Required: No **HostIdSet.N** The IDs of the Dedicated Hosts with which the reservation will be associated. Type: Array of strings Required: Yes **LimitPrice** The specified limit is checked against the total upfront cost of the reservation (calculated as the offering's upfront cost multiplied by the host count). If the total upfront cost is greater than the specified price limit, the request fails. This is used to ensure that the purchase does not exceed the expected upfront cost of the purchase. At this time, the only supported currency is `USD`. For example, to indicate a limit price of USD 100, specify 100.00. Type: String Required: No **OfferingId** The ID of the offering. Type: String Required: Yes **TagSpecification.N** The tags to apply to the Dedicated Host Reservation during purchase. Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No ## Response Elements The following elements are returned by the service. **clientToken** Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String **currencyCode** The currency in which the `totalUpfrontPrice` and `totalHourlyPrice` amounts are specified. At this time, the only supported currency is `USD`. Type: String Valid Values: `USD` **purchase** Describes the details of the purchase. Type: Array of [Purchase](API_Purchase.md) objects **requestId** The ID of the request. Type: String **totalHourlyPrice** The total hourly price of the reservation calculated per hour. Type: String **totalUpfrontPrice** The total amount charged to your account when you purchase the reservation. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example uses the same configuration information from [GetHostReservationPurchasePreview](API_GetHostReservationPurchasePreview.md) to make the purchase and associate the offering with the specified Dedicated Host. #### Sample Request ``` https://ec2.amazonaws.com/?Action=PurchaseHostReservation &OfferingId=hro-0eb3541dght849c2d &HostIdSet=h-0fgr9ddb0ecd0a1cd &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-84c3-b40d-gtyk-a9983EXAMPLE 31536000 7453.000 PartialUpfront m4 0.850 h-0fgr9ddb0ecd0a1cd 0.850 7453.000 ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/PurchaseHostReservation) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PurchaseHostReservation) # PurchaseReservedInstancesOffering Purchases a Reserved Instance for use with your account. With Reserved Instances, you pay a lower hourly rate compared to On-Demand instance pricing. Use [DescribeReservedInstancesOfferings](API_DescribeReservedInstancesOfferings.md) to get a list of Reserved Instance offerings that match your specifications. After you've purchased a Reserved Instance, you can check for your new Reserved Instance with [DescribeReservedInstances](API_DescribeReservedInstances.md). To queue a purchase for a future date and time, specify a purchase time. If you do not specify a purchase time, the default is the current time. For more information, see [Reserved Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-on-demand-reserved-instances.html) and [Sell in the Reserved Instance Marketplace](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ri-market-general.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceCount** The number of Reserved Instances to purchase. Type: Integer Required: Yes **LimitPrice** Specified for Reserved Instance Marketplace offerings to limit the total order and ensure that the Reserved Instances are not purchased at unexpected prices. Type: [ReservedInstanceLimitPrice](API_ReservedInstanceLimitPrice.md) object Required: No **PurchaseTime** The time at which to purchase the Reserved Instance, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Type: Timestamp Required: No **ReservedInstancesOfferingId** The ID of the Reserved Instance offering to purchase. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **reservedInstancesId** The IDs of the purchased Reserved Instances. If your purchase crosses into a discounted pricing tier, the final Reserved Instances IDs might change. For more information, see [Crossing pricing tiers](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/concepts-reserved-instances-application.html#crossing-pricing-tiers) in the *Amazon EC2 User Guide*. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example uses a limit price to limit the total purchase order of Standard Reserved Instances from the Reserved Instance Marketplace. #### Sample Request ``` https://ec2.amazonaws.com/?Action=PurchaseReservedInstancesOffering &ReservedInstancesOfferingId=4b2293b4-5813-4cc8-9ce3-1957fEXAMPLE &LimitPrice.Amount=200 &InstanceCount=2 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE ``` ### Example 2 This example illustrates a purchase of a Reserved Instances offering. #### Sample Request ``` https://ec2.amazonaws.com/?Action=PurchaseReservedInstancesOffering &ReservedInstancesOfferingId=4b2293b4-5813-4cc8-9ce3-1957fEXAMPLE &InstanceCount=2 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE e5a2ff3b-7d14-494f-90af-0b5d0EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/PurchaseReservedInstancesOffering) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PurchaseReservedInstancesOffering) # PurchaseScheduledInstances **Note** You can no longer purchase Scheduled Instances. Purchases the Scheduled Instances with the specified schedule. Scheduled Instances enable you to purchase Amazon EC2 compute capacity by the hour for a one-year term. Before you can purchase a Scheduled Instance, you must call [DescribeScheduledInstanceAvailability](API_DescribeScheduledInstanceAvailability.md) to check for available schedules and obtain a purchase token. After you purchase a Scheduled Instance, you must call [RunScheduledInstances](API_RunScheduledInstances.md) during each scheduled time period. After you purchase a Scheduled Instance, you can't cancel, modify, or resell your purchase. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **ClientToken** Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html). Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **PurchaseRequest.N** The purchase requests. Type: Array of [PurchaseRequest](API_PurchaseRequest.md) objects Array Members: Minimum number of 1 item. Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **scheduledInstanceSet** Information about the Scheduled Instances. Type: Array of [ScheduledInstance](API_ScheduledInstance.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/PurchaseScheduledInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PurchaseScheduledInstances) # RebootInstances Requests a reboot of the specified instances. This operation is asynchronous; it only queues a request to reboot the specified instances. The operation succeeds if the instances are valid and belong to you. Requests to reboot terminated instances are ignored. If an instance does not cleanly shut down within a few minutes, Amazon EC2 performs a hard reboot. For more information about troubleshooting, see [Troubleshoot an unreachable instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-console.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceId.N** The instance IDs. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example reboots two instances. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RebootInstances &InstanceId.1=i-1234567890abcdef0 &InstanceId.2=i-0598c7d356eba48d7 &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RebootInstances) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RebootInstances) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RebootInstances) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RebootInstances) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RebootInstances) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RebootInstances) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RebootInstances) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RebootInstances) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RebootInstances) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RebootInstances) # RegisterImage Registers an AMI. When you're creating an instance-store backed AMI, registering the AMI is the final step in the creation process. For more information about creating AMIs, see [Create an AMI from a snapshot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot) and [Create an instance-store backed AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-instance-store.html) in the *Amazon EC2 User Guide*. **Note** For Amazon EBS-backed instances, [CreateImage](API_CreateImage.md) creates and registers the AMI in a single request, so you don't have to register the AMI yourself. We recommend that you always use [CreateImage](API_CreateImage.md) unless you have a specific reason to use RegisterImage. If needed, you can deregister an AMI at any time. Any modifications you make to an AMI backed by an instance store volume invalidates its registration. If you make changes to an image, deregister the previous image and register the new image. **Register a snapshot of a root device volume** You can use `RegisterImage` to create an Amazon EBS-backed Linux AMI from a snapshot of a root device volume. You specify the snapshot using a block device mapping. You can't set the encryption state of the volume using the block device mapping. If the snapshot is encrypted, or encryption by default is enabled, the root volume of an instance launched from the AMI is encrypted. For more information, see [Create an AMI from a snapshot](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#creating-launching-ami-from-snapshot) and [Use encryption with EBS-backed AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AMIEncryption.html) in the *Amazon EC2 User Guide*. ** AWS Marketplace product codes** If any snapshots have AWS Marketplace product codes, they are copied to the new AMI. In most cases, AMIs for Windows, RedHat, SUSE, and SQL Server require correct licensing information to be present on the AMI. For more information, see [Understand AMI billing information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html) in the *Amazon EC2 User Guide*. When creating an AMI from a snapshot, the `RegisterImage` operation derives the correct billing information from the snapshot's metadata, but this requires the appropriate metadata to be present. To verify if the correct billing information was applied, check the `PlatformDetails` field on the new AMI. If the field is empty or doesn't match the expected operating system code (for example, Windows, RedHat, SUSE, or SQL), the AMI creation was unsuccessful, and you should discard the AMI and instead create the AMI from an instance. For more information, see [Create an AMI from an instance ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/creating-an-ami-ebs.html#how-to-create-ebs-ami) in the *Amazon EC2 User Guide*. If you purchase a Reserved Instance to apply to an On-Demand Instance that was launched from an AMI with a billing product code, make sure that the Reserved Instance has the matching billing product code. If you purchase a Reserved Instance without the matching billing product code, the Reserved Instance is not applied to the On-Demand Instance. For information about how to obtain the platform details and billing information of an AMI, see [Understand AMI billing information](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-billing-info.html) in the *Amazon EC2 User Guide*. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **Architecture** The architecture of the AMI. Default: For Amazon EBS-backed AMIs, `i386`. For instance store-backed AMIs, the architecture specified in the manifest file. Type: String Valid Values: `i386 | x86_64 | arm64 | x86_64_mac | arm64_mac` Required: No **BillingProduct.N** The billing product codes. Your account must be authorized to specify billing product codes. If your account is not authorized to specify billing product codes, you can publish AMIs that include billable software and list them on the AWS Marketplace. You must first register as a seller on the AWS Marketplace. For more information, see [Getting started as an AWS Marketplace seller](https://docs.aws.amazon.com/marketplace/latest/userguide/user-guide-for-sellers.html) and [AMI-based products in AWS Marketplace](https://docs.aws.amazon.com/marketplace/latest/userguide/ami-products.html) in the * AWS Marketplace Seller Guide*. Type: Array of strings Required: No **BlockDeviceMapping.N** The block device mapping entries. If you specify an Amazon EBS volume using the ID of an Amazon EBS snapshot, you can't specify the encryption state of the volume. If you create an AMI on an Outpost, then all backing snapshots must be on the same Outpost or in the Region of that Outpost. AMIs on an Outpost that include local snapshots can be used to launch instances on the same Outpost only. For more information, [Create AMIs from local snapshots](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#ami) in the *Amazon EBS User Guide*. Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects Required: No **BootMode** The boot mode of the AMI. A value of `uefi-preferred` indicates that the AMI supports both UEFI and Legacy BIOS. The operating system contained in the AMI must be configured to support the specified boot mode. For more information, see [Instance launch behavior with Amazon EC2 boot modes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `legacy-bios | uefi | uefi-preferred` Required: No **Description** A description for your AMI. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **EnaSupport** Set to `true` to enable enhanced networking with ENA for the AMI and any instances that you launch from the AMI. This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable. Type: Boolean Required: No **ImageLocation** The full path to your AMI manifest in Amazon S3 storage. The specified bucket must have the `aws-exec-read` canned access control list (ACL) to ensure that it can be accessed by Amazon EC2. For more information, see [Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl) in the *Amazon S3 Service Developer Guide*. Type: String Required: No **ImdsSupport** Set to `v2.0` to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will have `HttpTokens` automatically set to `required` so that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition, `HttpPutResponseHopLimit` is set to `2`. For more information, see [Configure the AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-IMDS-new-instances.html#configure-IMDS-new-instances-ami-configuration) in the *Amazon EC2 User Guide*. If you set the value to `v2.0`, make sure that your AMI software can support IMDSv2. Type: String Valid Values: `v2.0` Required: No **KernelId** The ID of the kernel. Type: String Required: No **Name** A name for your AMI. Constraints: 3-128 alphanumeric characters, parentheses (()), square brackets ([]), spaces ( ), periods (.), slashes (/), dashes (-), single quotes ('), at-signs (@), or underscores(\$1) Type: String Required: Yes **RamdiskId** The ID of the RAM disk. Type: String Required: No **RootDeviceName** The device name of the root device volume (for example, `/dev/sda1`). Type: String Required: No **SriovNetSupport** Set to `simple` to enable enhanced networking with the Intel 82599 Virtual Function interface for the AMI and any instances that you launch from the AMI. There is no way to disable `sriovNetSupport` at this time. This option is supported only for HVM AMIs. Specifying this option with a PV AMI can make instances launched from the AMI unreachable. Type: String Required: No **TagSpecification.N** The tags to apply to the AMI. To tag the AMI, the value for `ResourceType` must be `image`. If you specify another value for `ResourceType`, the request fails. To tag an AMI after it has been registered, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html). Type: Array of [TagSpecification](API_TagSpecification.md) objects Required: No **TpmSupport** Set to `v2.0` to enable Trusted Platform Module (TPM) support. For more information, see [NitroTPM](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) in the *Amazon EC2 User Guide*. Type: String Valid Values: `v2.0` Required: No **UefiData** Base64 representation of the non-volatile UEFI variable store. To retrieve the UEFI data, use the [GetInstanceUefiData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceUefiData) command. You can inspect and modify the UEFI data by using the [python-uefivars tool](https://github.com/awslabs/python-uefivars) on GitHub. For more information, see [UEFI Secure Boot for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/uefi-secure-boot.html) in the *Amazon EC2 User Guide*. Type: String Length Constraints: Minimum length of 0. Maximum length of 64000. Required: No **VirtualizationType** The type of virtualization (`hvm` \$1 `paravirtual`). Default: `paravirtual` Type: String Required: No ## Response Elements The following elements are returned by the service. **imageId** The ID of the newly registered AMI. Type: String **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example registers the AMI specified in the `my-new-image.manifest.xml` manifest file, located in the bucket called `myawsbucket`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RegisterImage &ImageLocation=myawsbucket/my-new-image.manifest.xml &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-1a2b3c4d ``` ### Example 2 This example specifies a snapshot for the root device of an Amazon EBS-backed AMI. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RegisterImage &RootDeviceName=/dev/sda1 &BlockDeviceMapping.1.DeviceName=/dev/sda1 &BlockDeviceMapping.1.Ebs.SnapshotId=snap-1234567890abcdef0 &Name=MyImage &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-1a2b3c4d ``` ### Example 3 This example registers an AMI with a block device mapping for three Amazon EBS volumes. The first volume is the root device volume based on an Amazon EBS snapshot. The second volume is based on another snapshot. The third volume is an empty 100 GiB Amazon EBS volume. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RegisterImage &RootDeviceName=/dev/sda1 &BlockDeviceMapping.1.DeviceName=/dev/sda1 &BlockDeviceMapping.1.Ebs.SnapshotId=snap-1234567890abcdef0 &BlockDeviceMapping.2.DeviceName=/dev/sdb &BlockDeviceMapping.2.Ebs.SnapshotId=snap-1234567890abcdef1 &BlockDeviceMapping.3.DeviceName=/dev/sdc &BlockDeviceMapping.3.Ebs.VolumeSize=100 &Name=MyImage &AUTHPARAMS ``` #### Sample Response ``` 59dbff89-35bd-4eac-99ed-be587EXAMPLE ami-1a2b3c4d ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RegisterImage) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RegisterImage) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegisterImage) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RegisterImage) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegisterImage) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RegisterImage) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RegisterImage) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RegisterImage) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RegisterImage) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegisterImage) # RegisterInstanceEventNotificationAttributes Registers a set of tag keys to include in scheduled event notifications for your resources. To remove tags, use [DeregisterInstanceEventNotificationAttributes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DeregisterInstanceEventNotificationAttributes.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **InstanceTagAttribute** Information about the tag keys to register. Type: [RegisterInstanceTagAttributeRequest](API_RegisterInstanceTagAttributeRequest.md) object Required: No ## Response Elements The following elements are returned by the service. **instanceTagAttribute** The resulting set of tag keys. Type: [InstanceTagNotificationAttribute](API_InstanceTagNotificationAttribute.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegisterInstanceEventNotificationAttributes) # RegisterTransitGatewayMulticastGroupMembers Registers members (network interfaces) with the transit gateway multicast group. A member is a network interface associated with a supported EC2 instance that receives multicast traffic. For more information, see [Multicast on transit gateways](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-multicast-overview.html) in the * AWS Transit Gateways Guide*. After you add the members, use [SearchTransitGatewayMulticastGroups](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html) to verify that the members were added to the transit gateway multicast group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupIpAddress** The IP address assigned to the transit gateway multicast group. Type: String Required: No **NetworkInterfaceIds.N** The group members' network interface IDs to register with the transit gateway multicast group. Type: Array of strings Required: Yes **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **registeredMulticastGroupMembers** Information about the registered transit gateway multicast group members. Type: [TransitGatewayMulticastRegisteredGroupMembers](API_TransitGatewayMulticastRegisteredGroupMembers.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example registers the network interface as a group member `eni-0e246d3269EXAMPLE` with the multicast domain `tgw-mcast-domain-0c4905cef7EXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RegisterTransitGatewayMulticastGroupMembers &TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef7EXAMPLE &NetworkInterfaceIds=eni-0e246d3269EXAMPLE &AUTHPARAMS ``` #### Sample Response ``` 6f4167cd-0870-4858-8872-f1c34EXAMPLE 224.0.1.0 eni-0e246d3269EXAMPLE tgw-mcast-domain-0c4905cef7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupMembers) # RegisterTransitGatewayMulticastGroupSources Registers sources (network interfaces) with the specified transit gateway multicast group. A multicast source is a network interface attached to a supported instance that sends multicast traffic. For more information about supported instances, see [Multicast on transit gateways](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-multicast-overview.html) in the * AWS Transit Gateways Guide*. After you add the source, use [SearchTransitGatewayMulticastGroups](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SearchTransitGatewayMulticastGroups.html) to verify that the source was added to the multicast group. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **GroupIpAddress** The IP address assigned to the transit gateway multicast group. Type: String Required: No **NetworkInterfaceIds.N** The group sources' network interface IDs to register with the transit gateway multicast group. Type: Array of strings Required: Yes **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **registeredMulticastGroupSources** Information about the transit gateway multicast group sources. Type: [TransitGatewayMulticastRegisteredGroupSources](API_TransitGatewayMulticastRegisteredGroupSources.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example 1 This example registers the network interface as a group source `eni-07f290fc3cEXAMPLE` with the multicast domain `tgw-mcast-domain-0c4905cef7EXAMPLE`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RegisterTransitGatewayMulticastGroupSources &TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef7EXAMPLE &NetworkInterfaceIds=eni-07f290fc3cEXAMPLE &AUTHPARAMS ``` #### Sample Response ``` b66c84ed-eb8a-4e6d-8d79-2347fEXAMPLE 224.0.1.0 eni-07f290fc3cEXAMPLE tgw-mcast-domain-0c4905cef7EXAMPLE ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegisterTransitGatewayMulticastGroupSources) # RejectCapacityReservationBillingOwnership Rejects a request to assign billing of the available capacity of a shared Capacity Reservation to your account. For more information, see [ Billing assignment for shared Amazon EC2 Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/assign-billing.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **CapacityReservationId** The ID of the Capacity Reservation for which to reject the request. Type: String Required: Yes **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RejectCapacityReservationBillingOwnership) # RejectTransitGatewayMulticastDomainAssociations Rejects a request to associate cross-account subnets with a transit gateway multicast domain. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **SubnetIds.N** The IDs of the subnets to associate with the transit gateway multicast domain. Type: Array of strings Required: No **TransitGatewayAttachmentId** The ID of the transit gateway attachment. Type: String Required: No **TransitGatewayMulticastDomainId** The ID of the transit gateway multicast domain. Type: String Required: No ## Response Elements The following elements are returned by the service. **associations** Information about the multicast domain associations. Type: [TransitGatewayMulticastDomainAssociations](API_TransitGatewayMulticastDomainAssociations.md) object **requestId** The ID of the request. Type: String ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RejectTransitGatewayMulticastDomainAssociations) # RejectTransitGatewayPeeringAttachment Rejects a transit gateway peering attachment request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the transit gateway peering attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayPeeringAttachment** The transit gateway peering attachment. Type: [TransitGatewayPeeringAttachment](API_TransitGatewayPeeringAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example rejects the specified transit gateway peering attachment by specifying its attachment ID. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RejectTransitGatewayPeeringAttachment &TransitGatewayAttachmentId=tgw-attach-12345678901abcd12 &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RejectTransitGatewayPeeringAttachment) # RejectTransitGatewayVpcAttachment Rejects a request to attach a VPC to a transit gateway. The VPC attachment must be in the `pendingAcceptance` state. Use [DescribeTransitGatewayVpcAttachments](API_DescribeTransitGatewayVpcAttachments.md) to view your pending VPC attachment requests. Use [AcceptTransitGatewayVpcAttachment](API_AcceptTransitGatewayVpcAttachment.md) to accept a VPC attachment request. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **TransitGatewayAttachmentId** The ID of the attachment. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **transitGatewayVpcAttachment** Information about the attachment. Type: [TransitGatewayVpcAttachment](API_TransitGatewayVpcAttachment.md) object ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RejectTransitGatewayVpcAttachment) # RejectVpcEndpointConnections Rejects VPC endpoint connection requests to your VPC endpoint service. ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **ServiceId** The ID of the service. Type: String Required: Yes **VpcEndpointId.N** The IDs of the VPC endpoints. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **unsuccessful** Information about the endpoints that were not rejected, if applicable. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example rejects the request for VPC endpoint `vpce-0c1308d7312217cd7` to connect to your service `vpce-svc-03d5ebb7d9579a2b3`. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RejectVpcEndpointConnections &ServiceId=vpce-svc-03d5ebb7d9579a2b3 &VpcEndpointId.1=vpce-0c1308d7312217cd7 &AUTHPARAMS ``` #### Sample Response ``` 986a2264-8a40-4da8-8f11-e8aaexample ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RejectVpcEndpointConnections) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RejectVpcEndpointConnections) # RejectVpcPeeringConnection Rejects a VPC peering connection request. The VPC peering connection must be in the `pending-acceptance` state. Use the [DescribeVpcPeeringConnections](API_DescribeVpcPeeringConnections.md) request to view your outstanding VPC peering connection requests. To delete an active VPC peering connection, or to delete a VPC peering connection request that you initiated, use [DeleteVpcPeeringConnection](API_DeleteVpcPeeringConnection.md). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **VpcPeeringConnectionId** The ID of the VPC peering connection. Type: String Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Returns `true` if the request succeeds; otherwise, it returns an error. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example rejects the specified VPC peering connection request. #### Sample Request ``` https://ec2.amazonaws.com/?Action=RejectVpcPeeringConnection &vpcPeeringConnectionId=pcx-1a2b3c4d &AUTHPARAMS ``` #### Sample Response ``` 7a62c49f-347e-4fc4-9331-6e8eEXAMPLE true ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RejectVpcPeeringConnection) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RejectVpcPeeringConnection) # ReleaseAddress Releases the specified Elastic IP address. [Default VPC] Releasing an Elastic IP address automatically disassociates it from any instance that it's associated with. Alternatively, you can disassociate an Elastic IP address without releasing it. [Nondefault VPC] You must disassociate the Elastic IP address before you can release it. Otherwise, Amazon EC2 returns an error (`InvalidIPAddress.InUse`). After releasing an Elastic IP address, it is released to the IP address pool. Be sure to update your DNS records and any servers or devices that communicate with the address. If you attempt to release an Elastic IP address that you already released, you'll get an `AuthFailure` error if the address is already allocated to another AWS account. After you release an Elastic IP address, you might be able to recover it. For more information, see [Release an Elastic IP address](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-instance-addressing-eips-releasing.html). ## Request Parameters The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **AllocationId** The allocation ID. This parameter is required. Type: String Required: No **DryRun** Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`. Type: Boolean Required: No **NetworkBorderGroup** The set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses. If you provide an incorrect network border group, you receive an `InvalidAddress.NotFound` error. Type: String Required: No **PublicIp** Deprecated. Type: String Required: No ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **return** Is `true` if the request succeeds, and an error otherwise. Type: Boolean ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This example releases the specified Elastic IP address. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ReleaseAddress &AllocationId=eipalloc-5723d13e &AUTHPARAMS ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReleaseAddress) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReleaseAddress) # ReleaseHosts When you no longer want to use an On-Demand Dedicated Host it can be released. On-Demand billing is stopped and the host goes into `released` state. The host ID of Dedicated Hosts that have been released can no longer be specified in another request, for example, to modify the host. You must stop or terminate all instances on a host before it can be released. When Dedicated Hosts are released, it may take some time for them to stop counting toward your limit and you may receive capacity errors when trying to allocate new Dedicated Hosts. Wait a few minutes and then try again. Released hosts still appear in a [DescribeHosts](API_DescribeHosts.md) response. ## Request Parameters For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md). **HostId.N** The IDs of the Dedicated Hosts to release. Type: Array of strings Required: Yes ## Response Elements The following elements are returned by the service. **requestId** The ID of the request. Type: String **successful** The IDs of the Dedicated Hosts that were successfully released. Type: Array of strings **unsuccessful** The IDs of the Dedicated Hosts that could not be released, including an error message. Type: Array of [UnsuccessfulItem](API_UnsuccessfulItem.md) objects ## Errors For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors). ## Examples ### Example This releases a Dedicated Host successfully. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ReleaseHosts &HostId=h-00548908djdsgfs &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE h-00548908djdsgfs ``` ### Example This request is unsuccessful. #### Sample Request ``` https://ec2.amazonaws.com/?Action=ReleaseHosts &HostId=h-00548908djdsgfs &AUTHPARAMS ``` #### Sample Response ``` d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE Dedicated host 'h-00548908djdsgfs' cannot be released as it is occupied

Client.InvalidHost.Occupied
       h-00548908djdsgfs


```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReleaseHosts) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReleaseHosts) 

# ReleaseIpamPoolAllocation


Release an allocation within an IPAM pool. The Region you use should be the IPAM pool locale. The locale is the AWS Region where this IPAM pool is available for allocations. You can only use this action to release manual allocations. To remove an allocation for a resource without deleting the resource, set its monitored state to false using [ModifyIpamResourceCidr](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyIpamResourceCidr.html). For more information, see [Release an allocation](https://docs.aws.amazon.com/vpc/latest/ipam/release-alloc-ipam.html) in the *Amazon VPC IPAM User Guide*. 

**Note**  
All EC2 API actions follow an [eventual consistency](https://docs.aws.amazon.com/ec2/latest/devguide/eventual-consistency.html) model.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Cidr**   
The CIDR of the allocation you want to release.  
Type: String  
Required: Yes

 **DryRun**   
A check for whether you have the required permissions for the action without actually making the request and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **IpamPoolAllocationId**   
The ID of the allocation.  
Type: String  
Required: Yes

 **IpamPoolId**   
The ID of the IPAM pool which contains the allocation you want to release.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **success**   
Indicates if the release was successful.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReleaseIpamPoolAllocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReleaseIpamPoolAllocation) 

# ReplaceIamInstanceProfileAssociation


Replaces an IAM instance profile for the specified running instance. You can use this action to change the IAM instance profile that's associated with an instance without having to disassociate the existing IAM instance profile first.

Use [DescribeIamInstanceProfileAssociations](API_DescribeIamInstanceProfileAssociations.md) to get the association ID.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AssociationId**   
The ID of the existing IAM instance profile association.  
Type: String  
Required: Yes

 **IamInstanceProfile**   
The IAM instance profile.  
Type: [IamInstanceProfileSpecification](API_IamInstanceProfileSpecification.md) object  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **iamInstanceProfileAssociation**   
Information about the IAM instance profile association.  
Type: [IamInstanceProfileAssociation](API_IamInstanceProfileAssociation.md) object

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example replaces the IAM instance profile represented by the association `iip-assoc-060bae234aac2e7fa` with the IAM instance profile named `AdminProfile`.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReplaceIamInstanceProfileAssociation
&AssociationId=iip-assoc-060bae234aac2e7fa
&IamInstanceProfile.Name=AdminProfile
&AUTHPARAMS
```

#### Sample Response


```

    ba40aa4c-d788-4f24-8a34-example
    
        iip-assoc-08049da59357d598c
        
            arn:aws:iam::123456789012:instance-profile/AdminRole
            AIPAI5IVIHMFFYY2DKV5Y
        
        i-1234567890abcdef0
        associating
    

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceIamInstanceProfileAssociation) 

# ReplaceImageCriteriaInAllowedImagesSettings


Sets or replaces the criteria for Allowed AMIs.

**Note**  
The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account.

For more information, see [Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html) in *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **ImageCriterion.N**   
The list of criteria that are evaluated to determine whether AMIs are discoverable and usable in the account in the specified AWS Region.  
Type: Array of [ImageCriterionRequest](API_ImageCriterionRequest.md) objects  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, it returns an error.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceImageCriteriaInAllowedImagesSettings) 

# ReplaceNetworkAclAssociation


Changes which network ACL a subnet is associated with. By default when you create a subnet, it's automatically associated with the default network ACL. For more information, see [Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in the *Amazon VPC User Guide*.

This is an idempotent operation.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AssociationId**   
The ID of the current association between the original network ACL and the subnet.  
Type: String  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **NetworkAclId**   
The ID of the new network ACL to associate with the subnet.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **newAssociationId**   
The ID of the new association.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example starts with a network ACL associated with a subnet, and a corresponding association ID `aclassoc-e5b95c8c`. You want to associate a different network ACL (`acl-5fb85d36`) with the subnet. The result is a new association ID representing the new association.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReplaceNetworkAclAssociation
&AssociationId=aclassoc-e5b95c8c
&NetworkAclId=acl-5fb85d36
&AUTHPARAMS
```

#### Sample Response


```

   59dbff89-35bd-4eac-99ed-be587EXAMPLE 
   aclassoc-17b85d7e

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceNetworkAclAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceNetworkAclAssociation) 

# ReplaceNetworkAclEntry


Replaces an entry (rule) in a network ACL. For more information, see [Network ACLs](https://docs.aws.amazon.com/vpc/latest/userguide/vpc-network-acls.html) in the *Amazon VPC User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **CidrBlock**   
The IPv4 network range to allow or deny, in CIDR notation (for example `172.16.0.0/24`).  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **Egress**   
Indicates whether to replace the egress rule.  
Default: If no value is specified, we replace the ingress rule.  
Type: Boolean  
Required: Yes

 **Icmp**   
ICMP protocol: The ICMP or ICMPv6 type and code. Required if specifying protocol 1 (ICMP) or protocol 58 (ICMPv6) with an IPv6 CIDR block.  
Type: [IcmpTypeCode](API_IcmpTypeCode.md) object  
Required: No

 **Ipv6CidrBlock**   
The IPv6 network range to allow or deny, in CIDR notation (for example `2001:bd8:1234:1a00::/64`).  
Type: String  
Required: No

 **NetworkAclId**   
The ID of the ACL.  
Type: String  
Required: Yes

 **PortRange**   
TCP or UDP protocols: The range of ports the rule applies to. Required if specifying protocol 6 (TCP) or 17 (UDP).  
Type: [PortRange](API_PortRange.md) object  
Required: No

 **Protocol**   
The protocol number. A value of "-1" means all protocols. If you specify "-1" or a protocol number other than "6" (TCP), "17" (UDP), or "1" (ICMP), traffic on all ports is allowed, regardless of any ports or ICMP types or codes that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv4 CIDR block, traffic for all ICMP types and codes allowed, regardless of any that you specify. If you specify protocol "58" (ICMPv6) and specify an IPv6 CIDR block, you must specify an ICMP type and code.  
Type: String  
Required: Yes

 **RuleAction**   
Indicates whether to allow or deny the traffic that matches the rule.  
Type: String  
Valid Values: `allow | deny`   
Required: Yes

 **RuleNumber**   
The rule number of the entry to replace.  
Type: Integer  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example replaces the egress entry numbered `110` in the specified network ACL. The new rule denies egress traffic destined for any IPv4 address (`0.0.0.0/0`) on TCP port 139.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReplaceNetworkAclEntry
&NetworkAclId=acl-2cb85d45
&RuleNumber=110
&Protocol="6"
&RuleAction=deny
&Egress=true
&CidrBlock=0.0.0.0/0
&PortRange.From=139
&PortRange.To=139
&AUTHPARAMS
```

#### Sample Response


```

   59dbff89-35bd-4eac-99ed-be587EXAMPLE 
   true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceNetworkAclEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceNetworkAclEntry) 

# ReplaceRoute


Replaces an existing route within a route table in a VPC.

You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list, or reset the local route to its default target.

For more information, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **CarrierGatewayId**   
[IPv4 traffic only] The ID of a carrier gateway.  
Type: String  
Required: No

 **CoreNetworkArn**   
The Amazon Resource Name (ARN) of the core network.  
Type: String  
Required: No

 **DestinationCidrBlock**   
The IPv4 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.  
Type: String  
Required: No

 **DestinationIpv6CidrBlock**   
The IPv6 CIDR address block used for the destination match. The value that you provide must match the CIDR of an existing route in the table.  
Type: String  
Required: No

 **DestinationPrefixListId**   
The ID of the prefix list for the route.  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **EgressOnlyInternetGatewayId**   
[IPv6 traffic only] The ID of an egress-only internet gateway.  
Type: String  
Required: No

 **GatewayId**   
The ID of an internet gateway or virtual private gateway.  
Type: String  
Required: No

 **InstanceId**   
The ID of a NAT instance in your VPC.  
Type: String  
Required: No

 **LocalGatewayId**   
The ID of the local gateway.  
Type: String  
Required: No

 **LocalTarget**   
Specifies whether to reset the local route to its default target (`local`).  
Type: Boolean  
Required: No

 **NatGatewayId**   
[IPv4 traffic only] The ID of a NAT gateway.  
Type: String  
Required: No

 **NetworkInterfaceId**   
The ID of a network interface.  
Type: String  
Required: No

 **OdbNetworkArn**   
The Amazon Resource Name (ARN) of the ODB network.  
Type: String  
Required: No

 **RouteTableId**   
The ID of the route table.  
Type: String  
Required: Yes

 **TransitGatewayId**   
The ID of a transit gateway.  
Type: String  
Required: No

 **VpcEndpointId**   
The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.  
Type: String  
Required: No

 **VpcPeeringConnectionId**   
The ID of a VPC peering connection.  
Type: String  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example replaces a route in the specified route table. The new route matches the IPv4 CIDR `10.0.0.0/8` and sends the traffic to the virtual private gateway with the ID `vgw-123456abcde123456`.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReplaceRoute
&RouteTableId=rtb-11223344556677889
&DestinationCidrBlock=10.0.0.0/8
&GatewayId=vgw-123456abcde123456
&AUTHPARAMS
```

#### Sample Response


```

   59dbff89-35bd-4eac-99ed-be587EXAMPLE 
   true

```

### Example 2


This examples resets the target for the default local route.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReplaceRoute
&RouteTableId=rtb-11223344556677889
&DestinationCidrBlock=10.0.0.0/16
&LocalTarget=true
&AUTHPARAMS
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceRoute) 

# ReplaceRouteTableAssociation


Changes the route table associated with a given subnet, internet gateway, or virtual private gateway in a VPC. After the operation completes, the subnet or gateway uses the routes in the new route table. For more information about route tables, see [Route tables](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html) in the *Amazon VPC User Guide*.

You can also use this operation to change which table is the main route table in the VPC. Specify the main route table's association ID and the route table ID of the new main route table.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AssociationId**   
The association ID.  
Type: String  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **RouteTableId**   
The ID of the new route table to associate with the subnet.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **associationState**   
The state of the association.  
Type: [RouteTableAssociationState](API_RouteTableAssociationState.md) object

 **newAssociationId**   
The ID of the new association.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example starts with a route table associated with a subnet, and a corresponding association ID `rtbassoc-04ca27a6914a0b4f`. You want to associate a different route table (table `rtb-1a2b3c4d1a2b3c4d1`) to the subnet. The result is a new association ID representing the new association.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReplaceRouteTableAssociation
&AssociationId=rtbassoc-04ca27a6914a0b4f
&RouteTableId=rtb-1a2b3c4d1a2b3c4d1
&AUTHPARAMS
```

#### Sample Response


```

   59dbff89-35bd-4eac-99ed-be587EXAMPLE 
   rtbassoc-11223344556677889

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceRouteTableAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceRouteTableAssociation) 

# ReplaceTransitGatewayRoute


Replaces the specified route in the specified transit gateway route table.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Blackhole**   
Indicates whether traffic matching this route is to be dropped.  
Type: Boolean  
Required: No

 **DestinationCidrBlock**   
The CIDR range used for the destination match. Routing decisions are based on the most specific match.  
Type: String  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **TransitGatewayAttachmentId**   
The ID of the attachment.  
Type: String  
Required: No

 **TransitGatewayRouteTableId**   
The ID of the route table.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **route**   
Information about the modified route.  
Type: [TransitGatewayRoute](API_TransitGatewayRoute.md) object

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceTransitGatewayRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceTransitGatewayRoute) 

# ReplaceVpnTunnel


Trigger replacement of specified VPN tunnel.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **ApplyPendingMaintenance**   
Trigger pending tunnel endpoint maintenance.  
Type: Boolean  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **VpnConnectionId**   
The ID of the Site-to-Site VPN connection.   
Type: String  
Required: Yes

 **VpnTunnelOutsideIpAddress**   
The external IP address of the VPN tunnel.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Confirmation of replace tunnel operation.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReplaceVpnTunnel) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceVpnTunnel) 

# ReportInstanceStatus


Submits feedback about the status of an instance. The instance must be in the `running` state. If your experience with the instance differs from the instance status returned by [DescribeInstanceStatus](API_DescribeInstanceStatus.md), use [ReportInstanceStatus](#API_ReportInstanceStatus) to report your experience with the instance. Amazon EC2 collects this information to improve the accuracy of status checks.

Use of this action does not change the value returned by [DescribeInstanceStatus](API_DescribeInstanceStatus.md).

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Description**   
 *This parameter has been deprecated.*   
Descriptive text about the health state of your instance.  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **EndTime**   
The time at which the reported instance health state ended.  
Type: Timestamp  
Required: No

 **InstanceId.N**   
The instances.  
Type: Array of strings  
Required: Yes

 **ReasonCode.N**   
The reason codes that describe the health state of your instance.  
+  `instance-stuck-in-state`: My instance is stuck in a state.
+  `unresponsive`: My instance is unresponsive.
+  `not-accepting-credentials`: My instance is not accepting my credentials.
+  `password-not-available`: A password is not available for my instance.
+  `performance-network`: My instance is experiencing performance problems that I believe are network related.
+  `performance-instance-store`: My instance is experiencing performance problems that I believe are related to the instance stores.
+  `performance-ebs-volume`: My instance is experiencing performance problems that I believe are related to an EBS volume.
+  `performance-other`: My instance is experiencing performance problems.
+  `other`: [explain using the description parameter]
Type: Array of strings  
Valid Values: `instance-stuck-in-state | unresponsive | not-accepting-credentials | password-not-available | performance-network | performance-instance-store | performance-ebs-volume | performance-other | other`   
Required: Yes

 **StartTime**   
The time at which the reported instance health state began.  
Type: Timestamp  
Required: No

 **Status**   
The status of all instances listed.  
Type: String  
Valid Values: `ok | impaired`   
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example reports instance health state for two instances.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReportInstanceStatus
&Status=impaired
&InstanceId.1=i-1234567890abcdef0
&InstanceId.2=i-0598c7d356eba48d7
&AUTHPARAMS
```

### Example 2


This example reports instance health state for two instances with reason codes.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ReportInstanceStatus
&Description=Description+of+my+issue.
&Status=impaired
&InstanceId.1=i-1234567890abcdef0
&InstanceId.2=i-0598c7d356eba48d7
&ReasonCode.1=instance-performance-network
&ReasonCode.2=instance-performance-disk
&AUTHPARAMS
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ReportInstanceStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReportInstanceStatus) 

# RequestSpotFleet


Creates a Spot Fleet request.

The Spot Fleet request specifies the total target capacity and the On-Demand target capacity. Amazon EC2 calculates the difference between the total capacity and On-Demand capacity, and launches the difference as Spot capacity.

You can submit a single request that includes multiple launch specifications that vary by instance type, AMI, Availability Zone, or subnet.

By default, the Spot Fleet requests Spot Instances in the Spot Instance pool where the price per unit is the lowest. Each launch specification can include its own instance weighting that reflects the value of the instance type to your application workload.

Alternatively, you can specify that the Spot Fleet distribute the target capacity across the Spot pools included in its launch specifications. By ensuring that the Spot Instances in your Spot Fleet are in different Spot pools, you can improve the availability of your fleet.

You can specify tags for the Spot Fleet request and instances launched by the fleet. You cannot tag other resource types in a Spot Fleet request because only the `spot-fleet-request` and `instance` resource types are supported.

For more information, see [Spot Fleet requests](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html) in the *Amazon EC2 User Guide*.

**Important**  
We strongly discourage using the RequestSpotFleet API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see [Which is the best Spot request method to use?](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use) in the *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **SpotFleetRequestConfig**   
The configuration for the Spot Fleet request.  
Type: [SpotFleetRequestConfigData](API_SpotFleetRequestConfigData.md) object  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **spotFleetRequestId**   
The ID of the Spot Fleet request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example creates a Spot Fleet request with two launch specifications.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RequestSpotFleet
&SpotFleetRequestConfig.IamFleetRole=arn:aws:iam::123456789011:role/spot-fleet-role
&SpotFleetRequestConfig.TargetCapacity=5
&SpotFleetRequestConfig.LaunchSpecifications.1.ImageId=ami-1ecae776
&SpotFleetRequestConfig.LaunchSpecifications.1.InstanceType=m4.large
&SpotFleetRequestConfig.LaunchSpecifications.1.SubnetId=subnet-1a2b3c4d
&SpotFleetRequestConfig.LaunchSpecifications.2.ImageId=ami-1ecae776
&SpotFleetRequestConfig.LaunchSpecifications.2.InstanceType=m3.medium
&SpotFleetRequestConfig.LaunchSpecifications.2.SubnetId=subnet-1a2b3c4d
&AUTHPARAMS
```

#### Sample Response


```

    60262cc5-2bd4-4c8d-98ed-example
    sfr-123f8fc2-cb31-425e-abcd-example2710

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RequestSpotFleet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RequestSpotFleet) 

# RequestSpotInstances


Creates a Spot Instance request.

For more information, see [Work with Spot Instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-requests.html) in the *Amazon EC2 User Guide*.

**Important**  
We strongly discourage using the RequestSpotInstances API because it is a legacy API with no planned investment. For options for requesting Spot Instances, see [Which is the best Spot request method to use?](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-best-practices.html#which-spot-request-method-to-use) in the *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AvailabilityZoneGroup**   
The user-specified name for a logical grouping of requests.  
When you specify an Availability Zone group in a Spot Instance request, all Spot Instances in the request are launched in the same Availability Zone. Instance proximity is maintained with this parameter, but the choice of Availability Zone is not. The group applies only to requests for Spot Instances of the same instance type. Any additional Spot Instance requests that are specified with the same Availability Zone group name are launched in that same Availability Zone, as long as at least one instance from the group is still active.  
If there is no active instance running in the Availability Zone group that you specify for a new Spot Instance request (all instances are terminated, the request is expired, or the maximum price you specified falls below current Spot price), then Amazon EC2 launches the instance in any Availability Zone where the constraint can be met. Consequently, the subsequent set of Spot Instances could be placed in a different zone from the original request, even if you specified the same Availability Zone group.  
Default: Instances are launched in any available Availability Zone.  
Type: String  
Required: No

 **BlockDurationMinutes**   
Deprecated.  
Type: Integer  
Required: No

 **ClientToken**   
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [Ensuring idempotency in Amazon EC2 API requests](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Run_Instance_Idempotency.html) in the *Amazon EC2 User Guide*.  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **InstanceCount**   
The maximum number of Spot Instances to launch.  
Default: 1  
Type: Integer  
Required: No

 **InstanceInterruptionBehavior**   
The behavior when a Spot Instance is interrupted. The default is `terminate`.  
Type: String  
Valid Values: `hibernate | stop | terminate`   
Required: No

 **LaunchGroup**   
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.  
Default: Instances are launched and terminated individually  
Type: String  
Required: No

 **LaunchSpecification**   
The launch specification.  
Type: [RequestSpotLaunchSpecification](API_RequestSpotLaunchSpecification.md) object  
Required: No

 **SpotPrice**   
The maximum price per unit hour that you are willing to pay for a Spot Instance. We do not recommend using this parameter because it can lead to increased interruptions. If you do not specify this parameter, you will pay the current Spot price.  
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.
Type: String  
Required: No

 **TagSpecification.N**   
The key-value pair for tagging the Spot Instance request on creation. The value for `ResourceType` must be `spot-instances-request`, otherwise the Spot Instance request fails. To tag the Spot Instance request after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).   
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 **Type**   
The Spot Instance request type.  
Default: `one-time`   
Type: String  
Valid Values: `one-time | persistent`   
Required: No

 **ValidFrom**   
The start date of the request. If this is a one-time request, the request becomes active at this date and time and remains active until all instances launch, the request expires, or the request is canceled. If the request is persistent, the request becomes active at this date and time and remains active until it expires or is canceled.  
The specified start date and time cannot be equal to the current date and time. You must specify a start date and time that occurs after the current date and time.  
Type: Timestamp  
Required: No

 **ValidUntil**   
The end date of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).  
+ For a persistent request, the request remains active until the `ValidUntil` date and time is reached. Otherwise, the request remains active until you cancel it. 
+ For a one-time request, the request remains active until all instances launch, the request is canceled, or the `ValidUntil` date and time is reached. By default, the request is valid for 7 days from the date the request was created.
Type: Timestamp  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **spotInstanceRequestSet**   
The Spot Instance requests.  
Type: Array of [SpotInstanceRequest](API_SpotInstanceRequest.md) objects

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example creates a one-time Spot Instance request for two instances. It does not include an Availability Zone or subnet, so Amazon EC2 selects an Availability Zone for you and launches the instances in the default subnet of the selected Availability Zone.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RequestSpotInstances
&InstanceCount=2
&Type=one-time
&LaunchSpecification.ImageId=ami-1a2b3c4d
&LaunchSpecification.KeyName=my-key-pair
&LaunchSpecification.SecurityGroupId.1=sg-1a2b3c4d
&LaunchSpecification.InstanceType=m3.medium
&LaunchSpecification.IamInstanceProfile.Name=s3access
&AUTHPARAMS
```

### Example 2


The following example includes an Availability Zone. Amazon EC2 launches the instances in the default subnet of the specified Availability Zone.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RequestSpotInstances
&InstanceCount=2
&Type=one-time
&LaunchSpecification.ImageId=ami-1a2b3c4d
&LaunchSpecification.KeyName=my-key-pair
&LaunchSpecification.SecurityGroupId.1=sg-1a2b3c4d
&LaunchSpecification.InstanceType=m3.medium
&LaunchSpecification.Placement.AvailabilityZone=us-west-2a
&LaunchSpecification.IamInstanceProfile.Name=s3access
&AUTHPARAMS
```

### Example 3


The following example includes a subnet. Amazon EC2 launches the instances in the specified subnet.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RequestSpotInstances
&InstanceCount=2
&Type=one-time
&LaunchSpecification.ImageId=ami-1a2b3c4d
&LaunchSpecification.KeyName=my-key-pair
&LaunchSpecification.SecurityGroupId.1=sg-1a2b3c4d
&LaunchSpecification.InstanceType=m3.medium
&LaunchSpecification.SubnetId=subnet-1a2b3c4d
&LaunchSpecification.IamInstanceProfile.Name=s3access
&AUTHPARAMS
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RequestSpotInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RequestSpotInstances) 

# ResetAddressAttribute


Resets the attribute of the specified IP address. For requirements, see [Using reverse DNS for email applications](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html#Using_Elastic_Addressing_Reverse_DNS).

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AllocationId**   
[EC2-VPC] The allocation ID.  
Type: String  
Required: Yes

 **Attribute**   
The attribute of the IP address.  
Type: String  
Valid Values: `domain-name`   
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

## Response Elements


The following elements are returned by the service.

 **address**   
Information about the IP address.  
Type: [AddressAttribute](API_AddressAttribute.md) object

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ResetAddressAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResetAddressAttribute) 

# ResetEbsDefaultKmsKeyId


Resets the default AWS KMS key for EBS encryption for your account in this Region to the AWS managed KMS key for EBS.

After resetting the default KMS key to the AWS managed KMS key, you can continue to encrypt by a customer managed KMS key by specifying it when you create the volume. For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*.

## Request Parameters


For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

## Response Elements


The following elements are returned by the service.

 **kmsKeyId**   
The Amazon Resource Name (ARN) of the default KMS key for EBS encryption by default.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResetEbsDefaultKmsKeyId) 

# ResetFpgaImageAttribute


Resets the specified attribute of the specified Amazon FPGA Image (AFI) to its default value. You can only reset the load permission attribute.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Attribute**   
The attribute.  
Type: String  
Valid Values: `loadPermission`   
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **FpgaImageId**   
The ID of the AFI.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example resets the load permissions for the specified AFI.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ResetFpgaImageAttribute
&FpgaImageId=afi-0d123e21abcc85abc
&Attribute=loadPermission
&AUTHPARAMS
```

#### Sample Response


```

    ccb58a32-30ee-4f9b-831c-639example
    true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ResetFpgaImageAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResetFpgaImageAttribute) 

# ResetImageAttribute


Resets an attribute of an AMI to its default value.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Attribute**   
The attribute to reset (currently you can only reset the launch permission attribute).  
Type: String  
Valid Values: `launchPermission`   
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **ImageId**   
The ID of the AMI.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example resets the `launchPermission` attribute for the specified AMI.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ResetImageAttribute
&ImageId=ami-61a54008
&Attribute=launchPermission
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE 
  true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ResetImageAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResetImageAttribute) 

# ResetInstanceAttribute


Resets an attribute of an instance to its default value. To reset the `kernel` or `ramdisk`, the instance must be in a stopped state. To reset the `sourceDestCheck`, the instance can be either running or stopped.

The `sourceDestCheck` attribute controls whether source/destination checking is enabled. The default value is `true`, which means checking is enabled. This value must be `false` for a NAT instance to perform NAT. For more information, see [NAT instances](https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_NAT_Instance.html) in the *Amazon VPC User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Attribute**   
The attribute to reset.  
Type: String  
Valid Values: `kernel | ramdisk | sourceDestCheck`   
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **InstanceId**   
The ID of the instance.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example resets the `sourceDestCheck` attribute.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ResetInstanceAttribute
&InstanceId=i-1234567890abcdef0
&Attribute=sourceDestCheck
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE
  true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ResetInstanceAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResetInstanceAttribute) 

# ResetNetworkInterfaceAttribute


Resets a network interface attribute. You can specify only one attribute at a time.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **NetworkInterfaceId**   
The ID of the network interface.  
Type: String  
Required: Yes

 **SourceDestCheck**   
The source/destination checking attribute. Resets the value to `true`.  
Type: String  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResetNetworkInterfaceAttribute) 

# ResetSnapshotAttribute


Resets permission settings for the specified snapshot.

For more information about modifying snapshot permissions, see [Share a snapshot](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-modifying-snapshot-permissions.html) in the *Amazon EBS User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Attribute**   
The attribute to reset. Currently, only the attribute for permission to create volumes can be reset.  
Type: String  
Valid Values: `productCodes | createVolumePermission`   
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **SnapshotId**   
The ID of the snapshot.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example resets the permissions for `snap-1234567890abcdef0`, making it a private snapshot that can only be used by the account that created it.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=ResetSnapshotAttribute
&SnapshotId=snap-1234567890abcdef0
&Attribute=createVolumePermission
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE 
  true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/ResetSnapshotAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResetSnapshotAttribute) 

# RestoreAddressToClassic


**Note**  
This action is deprecated.

Restores an Elastic IP address that was previously moved to the EC2-VPC platform back to the EC2-Classic platform. You cannot move an Elastic IP address that was originally allocated for use in EC2-VPC. The Elastic IP address must not be associated with an instance or network interface.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **PublicIp**   
The Elastic IP address.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **publicIp**   
The Elastic IP address.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

 **status**   
The move status for the IP address.  
Type: String  
Valid Values: `MoveInProgress | InVpc | InClassic` 

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RestoreAddressToClassic) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RestoreAddressToClassic) 

# RestoreImageFromRecycleBin


Restores an AMI from the Recycle Bin. For more information, see [Recover deleted Amazon EBS snapshots and EBS-back AMIs with Recycle Bin](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/recycle-bin.html) in the *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **ImageId**   
The ID of the AMI to restore.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, it returns an error.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RestoreImageFromRecycleBin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RestoreImageFromRecycleBin) 

# RestoreManagedPrefixListVersion


Restores the entries from a previous version of a managed prefix list to a new version of the prefix list.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **CurrentVersion**   
The current version number for the prefix list.  
Type: Long  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **PrefixListId**   
The ID of the prefix list.  
Type: String  
Required: Yes

 **PreviousVersion**   
The version to restore.  
Type: Long  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **prefixList**   
Information about the prefix list.  
Type: [ManagedPrefixList](API_ManagedPrefixList.md) object

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example restores the entries from version 1 of the specified prefix list.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RestoreManagedPrefixListVersion
&PrefixListId=pl-0123123123123aabb
&CurrentVersion=3
&PreviousVersion=1
&AUTHPARAMS
```

#### Sample Response


```

    aeb3faff-8938-41a0-9747-example
    
        IPv4
        10
        123456789012
        arn:aws:ec2:us-east-1:123456789012:prefix-list/pl-0123123123123aabb
        pl-0123123123123aabb
        tgw-attachments
        restore-in-progress
        3
    

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RestoreManagedPrefixListVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RestoreManagedPrefixListVersion) 

# RestoreSnapshotFromRecycleBin


Restores a snapshot from the Recycle Bin. For more information, see [Restore snapshots from the Recycle Bin](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-snaps.html#recycle-bin-restore-snaps) in the *Amazon EBS User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **SnapshotId**   
The ID of the snapshot to restore.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **description**   
The description for the snapshot.  
Type: String

 **encrypted**   
Indicates whether the snapshot is encrypted.  
Type: Boolean

 **outpostArn**   
The ARN of the Outpost on which the snapshot is stored. For more information, see [Amazon EBS local snapshots on Outposts](https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html) in the *Amazon EBS User Guide*.  
Type: String

 **ownerId**   
The ID of the AWS account that owns the EBS snapshot.  
Type: String

 **progress**   
The progress of the snapshot, as a percentage.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

 **snapshotId**   
The ID of the snapshot.  
Type: String

 **sseType**   
Reserved for future use.  
Type: String  
Valid Values: `sse-ebs | sse-kms | none` 

 **startTime**   
The time stamp when the snapshot was initiated.  
Type: Timestamp

 **status**   
The state of the snapshot.  
Type: String  
Valid Values: `pending | completed | error | recoverable | recovering` 

 **volumeId**   
The ID of the volume that was used to create the snapshot.  
Type: String

 **volumeSize**   
The size of the volume, in GiB.  
Type: Integer

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RestoreSnapshotFromRecycleBin) 

# RestoreSnapshotTier


Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

For more information see [ Restore an archived snapshot](https://docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#restore-archived-snapshot) and [ modify the restore period or restore type for a temporarily restored snapshot](https://docs.aws.amazon.com/ebs/latest/userguide/working-with-snapshot-archiving.html#modify-temp-restore-period) in the *Amazon EBS User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **PermanentRestore**   
Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify `true` and omit the **RestoreSnapshotTierRequest\$1TemporaryRestoreDays** parameter.  
Type: Boolean  
Required: No

 **SnapshotId**   
The ID of the snapshot to restore.  
Type: String  
Required: Yes

 **TemporaryRestoreDays**   
Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.  
To temporarily restore an archived snapshot, specify the number of days and omit the **PermanentRestore** parameter or set it to `false`.  
Type: Integer  
Required: No

## Response Elements


The following elements are returned by the service.

 **isPermanentRestore**   
Indicates whether the snapshot is permanently restored. `true` indicates a permanent restore. `false` indicates a temporary restore.  
Type: Boolean

 **requestId**   
The ID of the request.  
Type: String

 **restoreDuration**   
For temporary restores only. The number of days for which the archived snapshot is temporarily restored.  
Type: Integer

 **restoreStartTime**   
The date and time when the snapshot restore process started.  
Type: Timestamp

 **snapshotId**   
The ID of the snapshot.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RestoreSnapshotTier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RestoreSnapshotTier) 

# RestoreVolumeFromRecycleBin


Restores a volume from the Recycle Bin. For more information, see [Restore volumes from the Recycle Bin](https://docs.aws.amazon.com/ebs/latest/userguide/recycle-bin-working-with-volumes.html#recycle-bin-restore-volumes) in the *Amazon EBS User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **VolumeId**   
The ID of the volume to restore.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, it returns an error.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RestoreVolumeFromRecycleBin) 

# RevokeClientVpnIngress


Removes an ingress authorization rule from a Client VPN endpoint. 

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AccessGroupId**   
The ID of the Active Directory group for which to revoke access.   
Type: String  
Required: No

 **ClientVpnEndpointId**   
The ID of the Client VPN endpoint with which the authorization rule is associated.  
Type: String  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **RevokeAllGroups**   
Indicates whether access should be revoked for all groups for a single `TargetNetworkCidr` that earlier authorized ingress for all groups using `AuthorizeAllGroups`. This does not impact other authorization rules that allowed ingress to the same `TargetNetworkCidr` with a specific `AccessGroupId`.  
Type: Boolean  
Required: No

 **TargetNetworkCidr**   
The IPv4 address range, in CIDR notation, of the network for which access is being removed.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **status**   
The current state of the authorization rule.  
Type: [ClientVpnAuthorizationRuleStatus](API_ClientVpnAuthorizationRuleStatus.md) object

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example removes an authorization rule from a Client VPN endpoint.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RevokeClientVpnIngress
&ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE
&TargetNetworkCidr=10.0.0.0/16
&RevokeAllGroups=true
&AUTHPARAMS
```

#### Sample Response


```

    691de4ea-32ef-447b-b4f8-d8463XAMPLE
    
        revoking
    

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RevokeClientVpnIngress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RevokeClientVpnIngress) 

# RevokeSecurityGroupEgress


Removes the specified outbound (egress) rules from the specified security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and destination (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

 AWS recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **CidrIp**   
Not supported. Use a set of IP permissions to specify the CIDR.  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **FromPort**   
Not supported. Use a set of IP permissions to specify the port.  
Type: Integer  
Required: No

 **GroupId**   
The ID of the security group.  
Type: String  
Required: Yes

 **IpPermissions.N**   
The sets of IP permissions. You can't specify a destination security group and a CIDR IP address range in the same set of permissions.  
Type: Array of [IpPermission](API_IpPermission.md) objects  
Required: No

 **IpProtocol**   
Not supported. Use a set of IP permissions to specify the protocol name or number.  
Type: String  
Required: No

 **SecurityGroupRuleId.N**   
The IDs of the security group rules.  
Type: Array of strings  
Required: No

 **SourceSecurityGroupName**   
Not supported. Use a set of IP permissions to specify a destination security group.  
Type: String  
Required: No

 **SourceSecurityGroupOwnerId**   
Not supported. Use a set of IP permissions to specify a destination security group.  
Type: String  
Required: No

 **ToPort**   
Not supported. Use a set of IP permissions to specify the port.  
Type: Integer  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, returns an error.  
Type: Boolean

 **revokedSecurityGroupRuleSet**   
Details about the revoked security group rules.  
Type: Array of [RevokedSecurityGroupRule](API_RevokedSecurityGroupRule.md) objects

 **unknownIpPermissionSet**   
The outbound rules that were unknown to the service. In some cases, `unknownIpPermissionSet` might be in a different format from the request parameter.   
Type: Array of [IpPermission](API_IpPermission.md) objects

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example revokes the access that the specified security group has to the `205.192.0.0/16` and `205.159.0.0/16` IPv4 address ranges on TCP port 80.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RevokeSecurityGroupEgress
&GroupId=sg-1a2b3c4d
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=80
&IpPermissions.1.ToPort=80
&IpPermissions.1.IpRanges.1.CidrIp=205.192.0.0/16
&IpPermissions.1.IpRanges.2.CidrIp=205.159.0.0/16
&AUTHPARAMS
```

### Example 2


This example revokes the access that the specified security group has to the security group with the ID `sg-9a8d7f5c` on TCP port 1433.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RevokeSecurityGroupEgress
&GroupId=sg-1a2b3c4d
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=1433
&IpPermissions.1.ToPort=1433
&IpPermissions.1.Groups.1.GroupId=sg-9a8d7f5c
&AUTHPARAMS
```

### Example 3


This example revokes TCP port 22 access to the `203.0.113.4/32` address range for the security group `sg-112233`. The security group rule includes the description 'Access to office CT12'. Specifying the description to revoke the rule is optional, but if you do specify the description, it must match the existing rule's value exactly.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RevokeSecurityGroupEgress
&GroupId=sg-112233
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=22
&IpPermissions.1.ToPort=22
&IpPermissions.1.IpRanges.1.CidrIp=203.0.113.4/32
&IpPermissions.1.IpRanges.1.Description=Access to office CT12
&AUTHPARAMS
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RevokeSecurityGroupEgress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RevokeSecurityGroupEgress) 

# RevokeSecurityGroupIngress


Removes the specified inbound (ingress) rules from a security group.

You can specify rules using either rule IDs or security group rule properties. If you use rule properties, the values that you specify (for example, ports) must match the existing rule's values exactly. Each rule has a protocol, from and to ports, and source (CIDR range, security group, or prefix list). For the TCP and UDP protocols, you must also specify the destination port or range of ports. For the ICMP protocol, you must also specify the ICMP type and code. If the security group rule has a description, you do not need to specify the description to revoke the rule.

For a default VPC, if the values you specify do not match the existing rule's values, no error is returned, and the output describes the security group rules that were not revoked.

For a non-default VPC, if the values you specify do not match the existing rule's values, an `InvalidPermission.NotFound` client error is returned, and no rules are revoked.

 AWS recommends that you describe the security group to verify that the rules were removed.

Rule changes are propagated to instances within the security group as quickly as possible. However, a small delay might occur.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **CidrIp**   
The CIDR IP address range. You can't specify this parameter when specifying a source security group.  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **FromPort**   
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP, this is the ICMP type or -1 (all ICMP types).  
Type: Integer  
Required: No

 **GroupId**   
The ID of the security group.  
Type: String  
Required: No

 **GroupName**   
[Default VPC] The name of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.  
Type: String  
Required: No

 **IpPermissions.N**   
The sets of IP permissions. You can't specify a source security group and a CIDR IP address range in the same set of permissions.  
Type: Array of [IpPermission](API_IpPermission.md) objects  
Required: No

 **IpProtocol**   
The IP protocol name (`tcp`, `udp`, `icmp`) or number (see [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)). Use `-1` to specify all.  
Type: String  
Required: No

 **SecurityGroupRuleId.N**   
The IDs of the security group rules.  
Type: Array of strings  
Required: No

 **SourceSecurityGroupName**   
[Default VPC] The name of the source security group. You can't specify this parameter in combination with the following parameters: the CIDR IP address range, the start of the port range, the IP protocol, and the end of the port range. The source security group must be in the same VPC. To revoke a specific rule for an IP protocol and port range, use a set of IP permissions instead.  
Type: String  
Required: No

 **SourceSecurityGroupOwnerId**   
Not supported.  
Type: String  
Required: No

 **ToPort**   
If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP, this is the ICMP code or -1 (all ICMP codes).  
Type: Integer  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, returns an error.  
Type: Boolean

 **revokedSecurityGroupRuleSet**   
Details about the revoked security group rules.  
Type: Array of [RevokedSecurityGroupRule](API_RevokedSecurityGroupRule.md) objects

 **unknownIpPermissionSet**   
The inbound rules that were unknown to the service. In some cases, `unknownIpPermissionSet` might be in a different format from the request parameter.   
Type: Array of [IpPermission](API_IpPermission.md) objects

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example revokes TCP port 80 access from the `205.192.0.0/16` IPv4 address range for the security group named `websrv`. If the security group is for a VPC, specify the ID of the security group instead of the name.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RevokeSecurityGroupIngress
&GroupName=websrv
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=80
&IpPermissions.1.ToPort=80
&IpPermissions.1.IpRanges.1.CidrIp=205.192.0.0/16
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE 
  true

```

### Example 2


This example revokes TCP port 22 (SSH) access from IPv6 range `2001:db8:1234:1a00::/64`. 

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RevokeSecurityGroupIngress
&GroupName=websrv
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=80
&IpPermissions.1.ToPort=80
&IpPermissions.1.Ipv6Ranges.1.CidrIpv6=2001:db8:1234:1a00::/64
&AUTHPARAMS
```

### Example 3


This example revokes TCP port 22 access from the `203.0.113.4/32` address range for the security group `sg-112233`. The security group rule includes the description 'Access from workstation 1a2b'. Specifying the description to revoke the rule is optional, but if you do specify the description, it must match the existing rule's value exactly.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RevokeSecurityGroupIngress
&GroupId=sg-112233
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=22
&IpPermissions.1.ToPort=22
&IpPermissions.1.IpRanges.1.CidrIp=203.0.113.4/32
&IpPermissions.1.IpRanges.1.Description=Access from workstation 1a2b
&AUTHPARAMS
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RevokeSecurityGroupIngress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RevokeSecurityGroupIngress) 

# RunInstances


Launches the specified number of instances using an AMI for which you have permissions.

You can specify a number of options, or leave the default options. The following rules apply:
+ If you don't specify a subnet ID, we choose a default subnet from your default VPC for you. If you don't have a default VPC, you must specify a subnet ID in the request.
+ All instances have a network interface with a primary private IPv4 address. If you don't specify this address, we choose one from the IPv4 range of your subnet.
+ Not all instance types support IPv6 addresses. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html).
+ If you don't specify a security group ID, we use the default security group for the VPC. For more information, see [Security groups](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html).
+ If any of the AMIs have a product code attached for which the user has not subscribed, the request fails.

You can create a [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html), which is a resource that contains the parameters to launch an instance. When you launch an instance using [RunInstances](#API_RunInstances), you can specify the launch template instead of specifying the launch parameters.

To ensure faster instance launches, break up large requests into smaller batches. For example, create five separate launch requests for 100 instances each instead of one launch request for 500 instances.

 `RunInstances` is subject to both request rate limiting and resource rate limiting. For more information, see [Request throttling](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-throttling.html).

An instance is ready for you to use when it's in the `running` state. You can check the state of your instance using [DescribeInstances](API_DescribeInstances.md). You can tag instances and EBS volumes during launch, after launch, or both. For more information, see [CreateTags](API_CreateTags.md) and [Tagging your Amazon EC2 resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html).

Linux instances have access to the public key of the key pair at boot. You can use this key to provide secure access to the instance. Amazon EC2 public images use this feature to provide secure access without passwords. For more information, see [Key pairs](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-key-pairs.html).

For troubleshooting, see [What to do if an instance immediately terminates](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_InstanceStraightToTerminated.html), and [Troubleshooting connecting to your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesConnecting.html).

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AdditionalInfo**   
Reserved.  
Type: String  
Required: No

 **BlockDeviceMapping.N**   
The block device mapping, which defines the EBS volumes and instance store volumes to attach to the instance at launch. For more information, see [Block device mappings](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User Guide*.  
Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects  
Required: No

 **CapacityReservationSpecification**   
Information about the Capacity Reservation targeting option. If you do not specify this parameter, the instance's Capacity Reservation preference defaults to `open`, which enables it to run in any open Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, and tenancy).  
Type: [CapacityReservationSpecification](API_CapacityReservationSpecification.md) object  
Required: No

 **ClientToken**   
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency.  
For more information, see [Ensuring idempotency in Amazon EC2 API requests](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html).  
Constraints: Maximum 64 ASCII characters  
Type: String  
Required: No

 **CpuOptions**   
The CPU options for the instance. For more information, see [Optimize CPU options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-optimize-cpu.html) in the *Amazon EC2 User Guide*.  
Type: [CpuOptionsRequest](API_CpuOptionsRequest.md) object  
Required: No

 **CreditSpecification**   
The credit option for CPU usage of the burstable performance instance. Valid values are `standard` and `unlimited`. To change this attribute after launch, use [ ModifyInstanceCreditSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyInstanceCreditSpecification.html). For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html) in the *Amazon EC2 User Guide*.  
Default: `standard` (T2 instances) or `unlimited` (T3/T3a/T4g instances)  
For T3 instances with `host` tenancy, only `standard` is supported.  
Type: [CreditSpecificationRequest](API_CreditSpecificationRequest.md) object  
Required: No

 **DisableApiStop**   
Indicates whether an instance is enabled for stop protection. For more information, see [Enable stop protection for your EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-stop-protection.html).  
Type: Boolean  
Required: No

 **DisableApiTermination**   
Indicates whether termination protection is enabled for the instance. The default is `false`, which means that you can terminate the instance using the Amazon EC2 console, command line tools, or API. You can enable termination protection when you launch an instance, while the instance is running, or while the instance is stopped.  
Type: Boolean  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **EbsOptimized**   
Indicates whether the instance is optimized for Amazon EBS I/O. This optimization provides dedicated throughput to Amazon EBS and an optimized configuration stack to provide optimal Amazon EBS I/O performance. This optimization isn't available with all instance types. Additional usage charges apply when using an EBS-optimized instance.  
Default: `false`   
Type: Boolean  
Required: No

 **ElasticGpuSpecification.N**   
 *This parameter has been deprecated.*   
An elastic GPU to associate with the instance.  
Amazon Elastic Graphics reached end of life on January 8, 2024.
Type: Array of [ElasticGpuSpecification](API_ElasticGpuSpecification.md) objects  
Required: No

 **ElasticInferenceAccelerator.N**   
 *This parameter has been deprecated.*   
An elastic inference accelerator to associate with the instance.  
Amazon Elastic Inference is no longer available.
Type: Array of [ElasticInferenceAccelerator](API_ElasticInferenceAccelerator.md) objects  
Required: No

 **EnablePrimaryIpv6**   
If you’re launching an instance into a dual-stack or IPv6-only subnet, you can enable assigning a primary IPv6 address. A primary IPv6 address is an IPv6 GUA address associated with an ENI that you have enabled to use a primary IPv6 address. Use this option if an instance relies on its IPv6 address not changing. When you launch the instance, AWS will automatically assign an IPv6 address associated with the ENI attached to your instance to be the primary IPv6 address. Once you enable an IPv6 GUA address to be a primary IPv6, you cannot disable it. When you enable an IPv6 GUA address to be a primary IPv6, the first IPv6 GUA will be made the primary IPv6 address until the instance is terminated or the network interface is detached. If you have multiple IPv6 addresses associated with an ENI attached to your instance and you enable a primary IPv6 address, the first IPv6 GUA address associated with the ENI becomes the primary IPv6 address.  
Type: Boolean  
Required: No

 **EnclaveOptions**   
Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [AWS Nitro Enclaves User Guide](https://docs.aws.amazon.com/enclaves/latest/user/).  
You can't enable AWS Nitro Enclaves and hibernation on the same instance.  
Type: [EnclaveOptionsRequest](API_EnclaveOptionsRequest.md) object  
Required: No

 **HibernationOptions**   
Indicates whether an instance is enabled for hibernation. This parameter is valid only if the instance meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.  
You can't enable hibernation and AWS Nitro Enclaves on the same instance.  
Type: [HibernationOptionsRequest](API_HibernationOptionsRequest.md) object  
Required: No

 **IamInstanceProfile**   
The name or Amazon Resource Name (ARN) of an IAM instance profile.  
Type: [IamInstanceProfileSpecification](API_IamInstanceProfileSpecification.md) object  
Required: No

 **ImageId**   
The ID of the AMI. An AMI ID is required to launch an instance and must be specified here or in a launch template.  
Type: String  
Required: No

 **InstanceInitiatedShutdownBehavior**   
Indicates whether an instance stops or terminates when you initiate shutdown from the instance (using the operating system command for system shutdown).  
Default: `stop`   
Type: String  
Valid Values: `stop | terminate`   
Required: No

 **InstanceMarketOptions**   
The market (purchasing) option for the instances.  
Type: [InstanceMarketOptionsRequest](API_InstanceMarketOptionsRequest.md) object  
Required: No

 **InstanceType**   
The instance type. For more information, see [Amazon EC2 Instance Types Guide](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-types.html).  
Type: String  
Valid Values: `a1.medium | a1.large | a1.xlarge | a1.2xlarge | a1.4xlarge | a1.metal | c1.medium | c1.xlarge | c3.large | c3.xlarge | c3.2xlarge | c3.4xlarge | c3.8xlarge | c4.large | c4.xlarge | c4.2xlarge | c4.4xlarge | c4.8xlarge | c5.large | c5.xlarge | c5.2xlarge | c5.4xlarge | c5.9xlarge | c5.12xlarge | c5.18xlarge | c5.24xlarge | c5.metal | c5a.large | c5a.xlarge | c5a.2xlarge | c5a.4xlarge | c5a.8xlarge | c5a.12xlarge | c5a.16xlarge | c5a.24xlarge | c5ad.large | c5ad.xlarge | c5ad.2xlarge | c5ad.4xlarge | c5ad.8xlarge | c5ad.12xlarge | c5ad.16xlarge | c5ad.24xlarge | c5d.large | c5d.xlarge | c5d.2xlarge | c5d.4xlarge | c5d.9xlarge | c5d.12xlarge | c5d.18xlarge | c5d.24xlarge | c5d.metal | c5n.large | c5n.xlarge | c5n.2xlarge | c5n.4xlarge | c5n.9xlarge | c5n.18xlarge | c5n.metal | c6g.medium | c6g.large | c6g.xlarge | c6g.2xlarge | c6g.4xlarge | c6g.8xlarge | c6g.12xlarge | c6g.16xlarge | c6g.metal | c6gd.medium | c6gd.large | c6gd.xlarge | c6gd.2xlarge | c6gd.4xlarge | c6gd.8xlarge | c6gd.12xlarge | c6gd.16xlarge | c6gd.metal | c6gn.medium | c6gn.large | c6gn.xlarge | c6gn.2xlarge | c6gn.4xlarge | c6gn.8xlarge | c6gn.12xlarge | c6gn.16xlarge | c6i.large | c6i.xlarge | c6i.2xlarge | c6i.4xlarge | c6i.8xlarge | c6i.12xlarge | c6i.16xlarge | c6i.24xlarge | c6i.32xlarge | c6i.metal | cc1.4xlarge | cc2.8xlarge | cg1.4xlarge | cr1.8xlarge | d2.xlarge | d2.2xlarge | d2.4xlarge | d2.8xlarge | d3.xlarge | d3.2xlarge | d3.4xlarge | d3.8xlarge | d3en.xlarge | d3en.2xlarge | d3en.4xlarge | d3en.6xlarge | d3en.8xlarge | d3en.12xlarge | dl1.24xlarge | f1.2xlarge | f1.4xlarge | f1.16xlarge | g2.2xlarge | g2.8xlarge | g3.4xlarge | g3.8xlarge | g3.16xlarge | g3s.xlarge | g4ad.xlarge | g4ad.2xlarge | g4ad.4xlarge | g4ad.8xlarge | g4ad.16xlarge | g4dn.xlarge | g4dn.2xlarge | g4dn.4xlarge | g4dn.8xlarge | g4dn.12xlarge | g4dn.16xlarge | g4dn.metal | g5.xlarge | g5.2xlarge | g5.4xlarge | g5.8xlarge | g5.12xlarge | g5.16xlarge | g5.24xlarge | g5.48xlarge | g5g.xlarge | g5g.2xlarge | g5g.4xlarge | g5g.8xlarge | g5g.16xlarge | g5g.metal | hi1.4xlarge | hpc6a.48xlarge | hs1.8xlarge | h1.2xlarge | h1.4xlarge | h1.8xlarge | h1.16xlarge | i2.xlarge | i2.2xlarge | i2.4xlarge | i2.8xlarge | i3.large | i3.xlarge | i3.2xlarge | i3.4xlarge | i3.8xlarge | i3.16xlarge | i3.metal | i3en.large | i3en.xlarge | i3en.2xlarge | i3en.3xlarge | i3en.6xlarge | i3en.12xlarge | i3en.24xlarge | i3en.metal | im4gn.large | im4gn.xlarge | im4gn.2xlarge | im4gn.4xlarge | im4gn.8xlarge | im4gn.16xlarge | inf1.xlarge | inf1.2xlarge | inf1.6xlarge | inf1.24xlarge | is4gen.medium | is4gen.large | is4gen.xlarge | is4gen.2xlarge | is4gen.4xlarge | is4gen.8xlarge | m1.small | m1.medium | m1.large | m1.xlarge | m2.xlarge | m2.2xlarge | m2.4xlarge | m3.medium | m3.large | m3.xlarge | m3.2xlarge | m4.large | m4.xlarge | m4.2xlarge | m4.4xlarge | m4.10xlarge | m4.16xlarge | m5.large | m5.xlarge | m5.2xlarge | m5.4xlarge | m5.8xlarge | m5.12xlarge | m5.16xlarge | m5.24xlarge | m5.metal | m5a.large | m5a.xlarge | m5a.2xlarge | m5a.4xlarge | m5a.8xlarge | m5a.12xlarge | m5a.16xlarge | m5a.24xlarge | m5ad.large | m5ad.xlarge | m5ad.2xlarge | m5ad.4xlarge | m5ad.8xlarge | m5ad.12xlarge | m5ad.16xlarge | m5ad.24xlarge | m5d.large | m5d.xlarge | m5d.2xlarge | m5d.4xlarge | m5d.8xlarge | m5d.12xlarge | m5d.16xlarge | m5d.24xlarge | m5d.metal | m5dn.large | m5dn.xlarge | m5dn.2xlarge | m5dn.4xlarge | m5dn.8xlarge | m5dn.12xlarge | m5dn.16xlarge | m5dn.24xlarge | m5dn.metal | m5n.large | m5n.xlarge | m5n.2xlarge | m5n.4xlarge | m5n.8xlarge | m5n.12xlarge | m5n.16xlarge | m5n.24xlarge | m5n.metal | m5zn.large | m5zn.xlarge | m5zn.2xlarge | m5zn.3xlarge | m5zn.6xlarge | m5zn.12xlarge | m5zn.metal | m6a.large | m6a.xlarge | m6a.2xlarge | m6a.4xlarge | m6a.8xlarge | m6a.12xlarge | m6a.16xlarge | m6a.24xlarge | m6a.32xlarge | m6a.48xlarge | m6g.metal | m6g.medium | m6g.large | m6g.xlarge | m6g.2xlarge | m6g.4xlarge | m6g.8xlarge | m6g.12xlarge | m6g.16xlarge | m6gd.metal | m6gd.medium | m6gd.large | m6gd.xlarge | m6gd.2xlarge | m6gd.4xlarge | m6gd.8xlarge | m6gd.12xlarge | m6gd.16xlarge | m6i.large | m6i.xlarge | m6i.2xlarge | m6i.4xlarge | m6i.8xlarge | m6i.12xlarge | m6i.16xlarge | m6i.24xlarge | m6i.32xlarge | m6i.metal | mac1.metal | p2.xlarge | p2.8xlarge | p2.16xlarge | p3.2xlarge | p3.8xlarge | p3.16xlarge | p3dn.24xlarge | p4d.24xlarge | r3.large | r3.xlarge | r3.2xlarge | r3.4xlarge | r3.8xlarge | r4.large | r4.xlarge | r4.2xlarge | r4.4xlarge | r4.8xlarge | r4.16xlarge | r5.large | r5.xlarge | r5.2xlarge | r5.4xlarge | r5.8xlarge | r5.12xlarge | r5.16xlarge | r5.24xlarge | r5.metal | r5a.large | r5a.xlarge | r5a.2xlarge | r5a.4xlarge | r5a.8xlarge | r5a.12xlarge | r5a.16xlarge | r5a.24xlarge | r5ad.large | r5ad.xlarge | r5ad.2xlarge | r5ad.4xlarge | r5ad.8xlarge | r5ad.12xlarge | r5ad.16xlarge | r5ad.24xlarge | r5b.large | r5b.xlarge | r5b.2xlarge | r5b.4xlarge | r5b.8xlarge | r5b.12xlarge | r5b.16xlarge | r5b.24xlarge | r5b.metal | r5d.large | r5d.xlarge | r5d.2xlarge | r5d.4xlarge | r5d.8xlarge | r5d.12xlarge | r5d.16xlarge | r5d.24xlarge | r5d.metal | r5dn.large | r5dn.xlarge | r5dn.2xlarge | r5dn.4xlarge | r5dn.8xlarge | r5dn.12xlarge | r5dn.16xlarge | r5dn.24xlarge | r5dn.metal | r5n.large | r5n.xlarge | r5n.2xlarge | r5n.4xlarge | r5n.8xlarge | r5n.12xlarge | r5n.16xlarge | r5n.24xlarge | r5n.metal | r6g.medium | r6g.large | r6g.xlarge | r6g.2xlarge | r6g.4xlarge | r6g.8xlarge | r6g.12xlarge | r6g.16xlarge | r6g.metal | r6gd.medium | r6gd.large | r6gd.xlarge | r6gd.2xlarge | r6gd.4xlarge | r6gd.8xlarge | r6gd.12xlarge | r6gd.16xlarge | r6gd.metal | r6i.large | r6i.xlarge | r6i.2xlarge | r6i.4xlarge | r6i.8xlarge | r6i.12xlarge | r6i.16xlarge | r6i.24xlarge | r6i.32xlarge | r6i.metal | t1.micro | t2.nano | t2.micro | t2.small | t2.medium | t2.large | t2.xlarge | t2.2xlarge | t3.nano | t3.micro | t3.small | t3.medium | t3.large | t3.xlarge | t3.2xlarge | t3a.nano | t3a.micro | t3a.small | t3a.medium | t3a.large | t3a.xlarge | t3a.2xlarge | t4g.nano | t4g.micro | t4g.small | t4g.medium | t4g.large | t4g.xlarge | t4g.2xlarge | u-6tb1.56xlarge | u-6tb1.112xlarge | u-9tb1.112xlarge | u-12tb1.112xlarge | u-6tb1.metal | u-9tb1.metal | u-12tb1.metal | u-18tb1.metal | u-24tb1.metal | vt1.3xlarge | vt1.6xlarge | vt1.24xlarge | x1.16xlarge | x1.32xlarge | x1e.xlarge | x1e.2xlarge | x1e.4xlarge | x1e.8xlarge | x1e.16xlarge | x1e.32xlarge | x2iezn.2xlarge | x2iezn.4xlarge | x2iezn.6xlarge | x2iezn.8xlarge | x2iezn.12xlarge | x2iezn.metal | x2gd.medium | x2gd.large | x2gd.xlarge | x2gd.2xlarge | x2gd.4xlarge | x2gd.8xlarge | x2gd.12xlarge | x2gd.16xlarge | x2gd.metal | z1d.large | z1d.xlarge | z1d.2xlarge | z1d.3xlarge | z1d.6xlarge | z1d.12xlarge | z1d.metal | x2idn.16xlarge | x2idn.24xlarge | x2idn.32xlarge | x2iedn.xlarge | x2iedn.2xlarge | x2iedn.4xlarge | x2iedn.8xlarge | x2iedn.16xlarge | x2iedn.24xlarge | x2iedn.32xlarge | c6a.large | c6a.xlarge | c6a.2xlarge | c6a.4xlarge | c6a.8xlarge | c6a.12xlarge | c6a.16xlarge | c6a.24xlarge | c6a.32xlarge | c6a.48xlarge | c6a.metal | m6a.metal | i4i.large | i4i.xlarge | i4i.2xlarge | i4i.4xlarge | i4i.8xlarge | i4i.16xlarge | i4i.32xlarge | i4i.metal | x2idn.metal | x2iedn.metal | c7g.medium | c7g.large | c7g.xlarge | c7g.2xlarge | c7g.4xlarge | c7g.8xlarge | c7g.12xlarge | c7g.16xlarge | mac2.metal | c6id.large | c6id.xlarge | c6id.2xlarge | c6id.4xlarge | c6id.8xlarge | c6id.12xlarge | c6id.16xlarge | c6id.24xlarge | c6id.32xlarge | c6id.metal | m6id.large | m6id.xlarge | m6id.2xlarge | m6id.4xlarge | m6id.8xlarge | m6id.12xlarge | m6id.16xlarge | m6id.24xlarge | m6id.32xlarge | m6id.metal | r6id.large | r6id.xlarge | r6id.2xlarge | r6id.4xlarge | r6id.8xlarge | r6id.12xlarge | r6id.16xlarge | r6id.24xlarge | r6id.32xlarge | r6id.metal | r6a.large | r6a.xlarge | r6a.2xlarge | r6a.4xlarge | r6a.8xlarge | r6a.12xlarge | r6a.16xlarge | r6a.24xlarge | r6a.32xlarge | r6a.48xlarge | r6a.metal | p4de.24xlarge | u-3tb1.56xlarge | u-18tb1.112xlarge | u-24tb1.112xlarge | trn1.2xlarge | trn1.32xlarge | hpc6id.32xlarge | c6in.large | c6in.xlarge | c6in.2xlarge | c6in.4xlarge | c6in.8xlarge | c6in.12xlarge | c6in.16xlarge | c6in.24xlarge | c6in.32xlarge | m6in.large | m6in.xlarge | m6in.2xlarge | m6in.4xlarge | m6in.8xlarge | m6in.12xlarge | m6in.16xlarge | m6in.24xlarge | m6in.32xlarge | m6idn.large | m6idn.xlarge | m6idn.2xlarge | m6idn.4xlarge | m6idn.8xlarge | m6idn.12xlarge | m6idn.16xlarge | m6idn.24xlarge | m6idn.32xlarge | r6in.large | r6in.xlarge | r6in.2xlarge | r6in.4xlarge | r6in.8xlarge | r6in.12xlarge | r6in.16xlarge | r6in.24xlarge | r6in.32xlarge | r6idn.large | r6idn.xlarge | r6idn.2xlarge | r6idn.4xlarge | r6idn.8xlarge | r6idn.12xlarge | r6idn.16xlarge | r6idn.24xlarge | r6idn.32xlarge | c7g.metal | m7g.medium | m7g.large | m7g.xlarge | m7g.2xlarge | m7g.4xlarge | m7g.8xlarge | m7g.12xlarge | m7g.16xlarge | m7g.metal | r7g.medium | r7g.large | r7g.xlarge | r7g.2xlarge | r7g.4xlarge | r7g.8xlarge | r7g.12xlarge | r7g.16xlarge | r7g.metal | c6in.metal | m6in.metal | m6idn.metal | r6in.metal | r6idn.metal | inf2.xlarge | inf2.8xlarge | inf2.24xlarge | inf2.48xlarge | trn1n.32xlarge | i4g.large | i4g.xlarge | i4g.2xlarge | i4g.4xlarge | i4g.8xlarge | i4g.16xlarge | hpc7g.4xlarge | hpc7g.8xlarge | hpc7g.16xlarge | c7gn.medium | c7gn.large | c7gn.xlarge | c7gn.2xlarge | c7gn.4xlarge | c7gn.8xlarge | c7gn.12xlarge | c7gn.16xlarge | p5.48xlarge | m7i.large | m7i.xlarge | m7i.2xlarge | m7i.4xlarge | m7i.8xlarge | m7i.12xlarge | m7i.16xlarge | m7i.24xlarge | m7i.48xlarge | m7i-flex.large | m7i-flex.xlarge | m7i-flex.2xlarge | m7i-flex.4xlarge | m7i-flex.8xlarge | m7a.medium | m7a.large | m7a.xlarge | m7a.2xlarge | m7a.4xlarge | m7a.8xlarge | m7a.12xlarge | m7a.16xlarge | m7a.24xlarge | m7a.32xlarge | m7a.48xlarge | m7a.metal-48xl | hpc7a.12xlarge | hpc7a.24xlarge | hpc7a.48xlarge | hpc7a.96xlarge | c7gd.medium | c7gd.large | c7gd.xlarge | c7gd.2xlarge | c7gd.4xlarge | c7gd.8xlarge | c7gd.12xlarge | c7gd.16xlarge | m7gd.medium | m7gd.large | m7gd.xlarge | m7gd.2xlarge | m7gd.4xlarge | m7gd.8xlarge | m7gd.12xlarge | m7gd.16xlarge | r7gd.medium | r7gd.large | r7gd.xlarge | r7gd.2xlarge | r7gd.4xlarge | r7gd.8xlarge | r7gd.12xlarge | r7gd.16xlarge | r7a.medium | r7a.large | r7a.xlarge | r7a.2xlarge | r7a.4xlarge | r7a.8xlarge | r7a.12xlarge | r7a.16xlarge | r7a.24xlarge | r7a.32xlarge | r7a.48xlarge | c7i.large | c7i.xlarge | c7i.2xlarge | c7i.4xlarge | c7i.8xlarge | c7i.12xlarge | c7i.16xlarge | c7i.24xlarge | c7i.48xlarge | mac2-m2pro.metal | r7iz.large | r7iz.xlarge | r7iz.2xlarge | r7iz.4xlarge | r7iz.8xlarge | r7iz.12xlarge | r7iz.16xlarge | r7iz.32xlarge | c7a.medium | c7a.large | c7a.xlarge | c7a.2xlarge | c7a.4xlarge | c7a.8xlarge | c7a.12xlarge | c7a.16xlarge | c7a.24xlarge | c7a.32xlarge | c7a.48xlarge | c7a.metal-48xl | r7a.metal-48xl | r7i.large | r7i.xlarge | r7i.2xlarge | r7i.4xlarge | r7i.8xlarge | r7i.12xlarge | r7i.16xlarge | r7i.24xlarge | r7i.48xlarge | dl2q.24xlarge | mac2-m2.metal | i4i.12xlarge | i4i.24xlarge | c7i.metal-24xl | c7i.metal-48xl | m7i.metal-24xl | m7i.metal-48xl | r7i.metal-24xl | r7i.metal-48xl | r7iz.metal-16xl | r7iz.metal-32xl | c7gd.metal | m7gd.metal | r7gd.metal | g6.xlarge | g6.2xlarge | g6.4xlarge | g6.8xlarge | g6.12xlarge | g6.16xlarge | g6.24xlarge | g6.48xlarge | gr6.4xlarge | gr6.8xlarge | c7i-flex.large | c7i-flex.xlarge | c7i-flex.2xlarge | c7i-flex.4xlarge | c7i-flex.8xlarge | u7i-12tb.224xlarge | u7in-16tb.224xlarge | u7in-24tb.224xlarge | u7in-32tb.224xlarge | u7ib-12tb.224xlarge | c7gn.metal | r8g.medium | r8g.large | r8g.xlarge | r8g.2xlarge | r8g.4xlarge | r8g.8xlarge | r8g.12xlarge | r8g.16xlarge | r8g.24xlarge | r8g.48xlarge | r8g.metal-24xl | r8g.metal-48xl | mac2-m1ultra.metal | g6e.xlarge | g6e.2xlarge | g6e.4xlarge | g6e.8xlarge | g6e.12xlarge | g6e.16xlarge | g6e.24xlarge | g6e.48xlarge | c8g.medium | c8g.large | c8g.xlarge | c8g.2xlarge | c8g.4xlarge | c8g.8xlarge | c8g.12xlarge | c8g.16xlarge | c8g.24xlarge | c8g.48xlarge | c8g.metal-24xl | c8g.metal-48xl | m8g.medium | m8g.large | m8g.xlarge | m8g.2xlarge | m8g.4xlarge | m8g.8xlarge | m8g.12xlarge | m8g.16xlarge | m8g.24xlarge | m8g.48xlarge | m8g.metal-24xl | m8g.metal-48xl | x8g.medium | x8g.large | x8g.xlarge | x8g.2xlarge | x8g.4xlarge | x8g.8xlarge | x8g.12xlarge | x8g.16xlarge | x8g.24xlarge | x8g.48xlarge | x8g.metal-24xl | x8g.metal-48xl | i7ie.large | i7ie.xlarge | i7ie.2xlarge | i7ie.3xlarge | i7ie.6xlarge | i7ie.12xlarge | i7ie.18xlarge | i7ie.24xlarge | i7ie.48xlarge | i8g.large | i8g.xlarge | i8g.2xlarge | i8g.4xlarge | i8g.8xlarge | i8g.12xlarge | i8g.16xlarge | i8g.24xlarge | i8g.metal-24xl | u7i-6tb.112xlarge | u7i-8tb.112xlarge | u7inh-32tb.480xlarge | p5e.48xlarge | p5en.48xlarge | f2.12xlarge | f2.48xlarge | trn2.48xlarge | c7i-flex.12xlarge | c7i-flex.16xlarge | m7i-flex.12xlarge | m7i-flex.16xlarge | i7ie.metal-24xl | i7ie.metal-48xl | i8g.48xlarge | c8gd.medium | c8gd.large | c8gd.xlarge | c8gd.2xlarge | c8gd.4xlarge | c8gd.8xlarge | c8gd.12xlarge | c8gd.16xlarge | c8gd.24xlarge | c8gd.48xlarge | c8gd.metal-24xl | c8gd.metal-48xl | i7i.large | i7i.xlarge | i7i.2xlarge | i7i.4xlarge | i7i.8xlarge | i7i.12xlarge | i7i.16xlarge | i7i.24xlarge | i7i.48xlarge | i7i.metal-24xl | i7i.metal-48xl | p6-b200.48xlarge | m8gd.medium | m8gd.large | m8gd.xlarge | m8gd.2xlarge | m8gd.4xlarge | m8gd.8xlarge | m8gd.12xlarge | m8gd.16xlarge | m8gd.24xlarge | m8gd.48xlarge | m8gd.metal-24xl | m8gd.metal-48xl | r8gd.medium | r8gd.large | r8gd.xlarge | r8gd.2xlarge | r8gd.4xlarge | r8gd.8xlarge | r8gd.12xlarge | r8gd.16xlarge | r8gd.24xlarge | r8gd.48xlarge | r8gd.metal-24xl | r8gd.metal-48xl | c8gn.medium | c8gn.large | c8gn.xlarge | c8gn.2xlarge | c8gn.4xlarge | c8gn.8xlarge | c8gn.12xlarge | c8gn.16xlarge | c8gn.24xlarge | c8gn.48xlarge | c8gn.metal-24xl | c8gn.metal-48xl | f2.6xlarge | p6e-gb200.36xlarge | g6f.large | g6f.xlarge | g6f.2xlarge | g6f.4xlarge | gr6f.4xlarge | p5.4xlarge | r8i.large | r8i.xlarge | r8i.2xlarge | r8i.4xlarge | r8i.8xlarge | r8i.12xlarge | r8i.16xlarge | r8i.24xlarge | r8i.32xlarge | r8i.48xlarge | r8i.96xlarge | r8i.metal-48xl | r8i.metal-96xl | r8i-flex.large | r8i-flex.xlarge | r8i-flex.2xlarge | r8i-flex.4xlarge | r8i-flex.8xlarge | r8i-flex.12xlarge | r8i-flex.16xlarge`   
Required: No

 **Ipv6Address.N**   
The IPv6 addresses from the range of the subnet to associate with the primary network interface. You cannot specify this option and the option to assign a number of IPv6 addresses in the same request. You cannot specify this option if you've specified a minimum number of instances to launch.  
You cannot specify this option and the network interfaces option in the same request.  
Type: Array of [InstanceIpv6Address](API_InstanceIpv6Address.md) objects  
Required: No

 **Ipv6AddressCount**   
The number of IPv6 addresses to associate with the primary network interface. Amazon EC2 chooses the IPv6 addresses from the range of your subnet. You cannot specify this option and the option to assign specific IPv6 addresses in the same request. You can specify this option if you've specified a minimum number of instances to launch.  
You cannot specify this option and the network interfaces option in the same request.  
Type: Integer  
Required: No

 **KernelId**   
The ID of the kernel.  
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 **KeyName**   
The name of the key pair. For more information, see [Create a key pair for your EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/create-key-pairs.html).  
If you do not specify a key pair, you can't connect to the instance unless you choose an AMI that is configured to allow users another way to log in.
Type: String  
Required: No

 **LaunchTemplate**   
The launch template. Any additional parameters that you specify for the new instance overwrite the corresponding parameters included in the launch template.  
Type: [LaunchTemplateSpecification](API_LaunchTemplateSpecification.md) object  
Required: No

 **LicenseSpecification.N**   
The license configurations.  
Type: Array of [LicenseConfigurationRequest](API_LicenseConfigurationRequest.md) objects  
Required: No

 **MaintenanceOptions**   
The maintenance and recovery options for the instance.  
Type: [InstanceMaintenanceOptionsRequest](API_InstanceMaintenanceOptionsRequest.md) object  
Required: No

 **MaxCount**   
The maximum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can launch in the target Availability Zone, Amazon EC2 launches the largest possible number of instances above the specified minimum count.  
Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see [Amazon EC2 instance type quotas](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-instance-quotas.html).  
Type: Integer  
Required: Yes

 **MetadataOptions**   
The metadata options for the instance. For more information, see [Configure the Instance Metadata Service options](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-options.html).  
Type: [InstanceMetadataOptionsRequest](API_InstanceMetadataOptionsRequest.md) object  
Required: No

 **MinCount**   
The minimum number of instances to launch. If you specify a value that is more capacity than Amazon EC2 can provide in the target Availability Zone, Amazon EC2 does not launch any instances.  
Constraints: Between 1 and the quota for the specified instance type for your account for this Region. For more information, see [Amazon EC2 instance type quotas](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-instance-quotas.html).  
Type: Integer  
Required: Yes

 **Monitoring**   
Specifies whether detailed monitoring is enabled for the instance.  
Type: [RunInstancesMonitoringEnabled](API_RunInstancesMonitoringEnabled.md) object  
Required: No

 **NetworkInterface.N**   
The network interfaces to associate with the instance.  
Type: Array of [InstanceNetworkInterfaceSpecification](API_InstanceNetworkInterfaceSpecification.md) objects  
Required: No

 **NetworkPerformanceOptions**   
Contains settings for the network performance options for the instance.  
Type: [InstanceNetworkPerformanceOptionsRequest](API_InstanceNetworkPerformanceOptionsRequest.md) object  
Required: No

 **Operator**   
Reserved for internal use.  
Type: [OperatorRequest](API_OperatorRequest.md) object  
Required: No

 **Placement**   
The placement for the instance.  
Type: [Placement](API_Placement.md) object  
Required: No

 **PrivateDnsNameOptions**   
The options for the instance hostname. The default values are inherited from the subnet. Applies only if creating a network interface, not attaching an existing one.  
Type: [PrivateDnsNameOptionsRequest](API_PrivateDnsNameOptionsRequest.md) object  
Required: No

 **PrivateIpAddress**   
The primary IPv4 address. You must specify a value from the IPv4 address range of the subnet.  
Only one private IP address can be designated as primary. You can't specify this option if you've specified the option to designate a private IP address as the primary IP address in a network interface specification. You cannot specify this option if you're launching more than one instance in the request.  
You cannot specify this option and the network interfaces option in the same request.  
Type: String  
Required: No

 **RamdiskId**   
The ID of the RAM disk to select. Some kernels require additional drivers at launch. Check the kernel requirements for information about whether you need to specify a RAM disk. To find kernel requirements, go to the AWS Resource Center and search for the kernel ID.  
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [PV-GRUB](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/UserProvidedkernels.html) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 **SecondaryInterface.N**   
The secondary interfaces to associate with the instance.  
Type: Array of [InstanceSecondaryInterfaceSpecificationRequest](API_InstanceSecondaryInterfaceSpecificationRequest.md) objects  
Required: No

 **SecurityGroup.N**   
[Default VPC] The names of the security groups.  
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.  
Default: Amazon EC2 uses the default security group.  
Type: Array of strings  
Required: No

 **SecurityGroupId.N**   
The IDs of the security groups.  
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.  
Type: Array of strings  
Required: No

 **SubnetId**   
The ID of the subnet to launch the instance into.  
If you specify a network interface, you must specify any subnets as part of the network interface instead of using this parameter.  
Type: String  
Required: No

 **TagSpecification.N**   
The tags to apply to the resources that are created during instance launch.  
You can specify tags for the following resources only:  
+ Instances
+ Volumes
+ Spot Instance requests
+ Network interfaces
To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).  
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 **UserData**   
The user data to make available to the instance. User data must be base64-encoded. Depending on the tool or SDK that you're using, the base64-encoding might be performed for you. For more information, see [Run commands at launch using instance user data](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html).  
Type: String  
Required: No

## Response Elements


The following elements are returned by the service.

 **groupSet**   
Not supported.  
Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects

 **instancesSet**   
The instances.  
Type: Array of [Instance](API_Instance.md) objects

 **ownerId**   
The ID of the AWS account that owns the reservation.  
Type: String

 **requesterId**   
The ID of the requester that launched the instances on your behalf (for example, AWS Management Console or Auto Scaling).  
Type: String

 **requestId**   
The ID of the request.  
Type: String

 **reservationId**   
The ID of the reservation.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example launches three instances using the specified AMI.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-60a54009
&MaxCount=3
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&Placement.AvailabilityZone=us-east-1d
&AUTHPARAMS
```

### Example 2


This example launches an instance into the specified subnet. Because no network interface is specified, a new network interface is created.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-31814f58
&InstanceType=t2.micro
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&SubnetId=subnet-b2a249da
&AUTHPARAMS
```

### Example 3


This example launches an instance into the specified subnet. The network interface specifies a primary private IPv4 address of `10.0.2.106` and two secondary private IPv4 addresses (`10.0.2.107` and `10.0.2.108`).

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-beb0caec
&InstanceType=t2.small
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&NetworkInterface.1.DeviceIndex=0
&NetworkInterface.1.PrivateIpAddresses.1.Primary=true
&NetworkInterface.1.PrivateIpAddresses.1.PrivateIpAddress=10.0.2.106
&NetworkInterface.1.PrivateIpAddresses.2.Primary=false
&NetworkInterface.1.PrivateIpAddresses.2.PrivateIpAddress=10.0.2.107
&NetworkInterface.1.PrivateIpAddresses.3.Primary=false
&NetworkInterface.1.PrivateIpAddresses.3.PrivateIpAddress=10.0.2.108
&NetworkInterface.1.SubnetId=subnet-a61dafcf
&AUTHPARAMS
```

### Example 4


This example launches a Dedicated Instance into the specified subnet.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-2a1fec43
&InstanceType=m6i.8xlarge
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&SubnetId=subnet-dea63cb7
&Placement.Tenancy=dedicated
&AUTHPARAMS
```

### Example 5


This request launches an instance into the specified subnet, and requests a public IPv4 address for a new network interface with the device index of 0.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-1a2b3c4d
&InstanceType=m6i.8xlarge
&MaxCount=1
&MinCount=1
&NetworkInterface.1.DeviceIndex=0
&NetworkInterface.1.AssociatePublicIpAddress=true
&NetworkInterface.1.SubnetId=subnet-1a2b3c4d
&AUTHPARAMS
```

### Example 6


This request launches an instance with a block device mapping. There are two instance store volumes mapped to `/dev/sdc` and `/dev/sdd`, and a 100-GB EBS volume mapped to `/dev/sdf`. The EBS volume attached to the instance is encrypted using a customer managed KMS key.

For more information about block device mappings, see [EbsBlockDevice](API_EbsBlockDevice.md) and [Modifying block device mappings during launch](https://docs.aws.amazon.com/cli/latest/userguide/cli-services-ec2-instances.html#modify-block-device).

For more information, see [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html).

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-1a2b3c4d
&InstanceType=m6id.12xlarge
&BlockDeviceMapping.1.DeviceName=%2Fdev%2Fsdc
&BlockDeviceMapping.1.VirtualName=ephemeral0
&BlockDeviceMapping.2.DeviceName=%2Fdev%2Fsdd
&BlockDeviceMapping.2.VirtualName=ephemeral1
&BlockDeviceMapping.3.DeviceName=%2Fdev%2Fsdf
&BlockDeviceMapping.3.Ebs.DeleteOnTermination=false
&BlockDeviceMapping.3.Ebs.VolumeSize=100
&BlockDeviceMapping.3.Ebs.Encrypted=true
&BlockDeviceMapping.3.Ebs.KmsKeyId=arn%3Aaws%3Akms%3Aus-east-1%3A009400881653%3Akey%2Fa48a521f-3aff-4b34-a159-376ac5d37812
&EbsOptimized=false
&MinCount=1
&MaxCount=1
&DisableApiTermination=false
&Monitoring.Enabled=false
&AUTHPARAMS
```

### Example 7


This request launches two instances and applies a tag with a key of `webserver` and a value of `production` to the instances. The request also applies a tag with a key of `cost-center` and a value of `cc123` to the volumes that are created (in this case, the root volume for each instance).

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-31814f58
&InstanceType=t2.large
&MaxCount=2
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&SubnetId=subnet-b2a249da
&TagSpecification.1.ResourceType=instance
&TagSpecification.1.Tag.1.Key=webserver
&TagSpecification.1.Tag.1.Value=production
&TagSpecification.2.ResourceType=volume
&TagSpecification.2.Tag.1.Key=cost-center
&TagSpecification.2.Tag.1.Value=cc123
&AUTHPARAMS
```

### Example 8


This request launches a burstable performance instance with the credit option for CPU usage set to `unlimited`.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-31814f58
&InstanceType=t2.micro
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&CreditSpecification.CpuCredits=unlimited
&AUTHPARAMS
```

### Example 9


This request launches an instance into the specified partition placement group but does not specify the partition.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-31814f58
&InstanceType=t3.large
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&Placement=HDFS-Group-A
&AUTHPARAMS
```

### Example 10


This request launches an instance into the specified partition placement group and into the specified partition.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-31814f58
&InstanceType=t3.large
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&Placement=HDFS-Group-A
&Partition=2
&AUTHPARAMS
```

### Example 11


This example launches an instance with a metadata type requiring a session token for metadata retrieval requests.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-1a2b3c4d
&InstanceType=c6i.large
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&MetadataOptions.HttpTokens=required
&AUTHPARAMS
```

### Example 12


This example launches an instance with instance metadata access turned off.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-1a2b3c4d 
&InstanceType=c6i.large
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&MetadataOptions.HttpEndpoint=disabled
&AUTHPARAMS
```

### Example 13


This example launches an instance with a metadata type requiring a session token for metadata retrieval requests and a metadata hop limit of `3`.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-1a2b3c4d
&InstanceType=c6i.large
&MaxCount=1
&MinCount=1
&KeyName=my-key-pair
&SecurityGroupId.1=sg-0598c7d3
&MetadataOptions.HttpTokens=required
&MetadataOptions.HttpPutResponseHopLimit=3
&AUTHPARAMS
```

### Example 14


This example launches an instance and assigns two security groups and an IPv6 address to the primary network interface.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
&ImageId=ami-00112233445566aab
&InstanceType=t2.micro
&MinCount=1
&MaxCount=1
&NetworkInterface.1.DeviceIndex=0
&NetworkInterface.1.SecurityGroupId.1=sg-444455556666cccdd
&NetworkInterface.1.SecurityGroupId.2=sg-111122223333aaabb
&NetworkInterface.1.Ipv6Addresses.1.Ipv6Address=2001:db8:1234:1a00::123
&NetworkInterface.1.SubnetId=subnet-aabbccdd112233445
&AUTHPARAMS
```

### Example 15


This example launches a single instance with 8 secondary interfaces, each on a separate network card and configured for automatic deletion on termination.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=RunInstances
  &ImageId=ami-beb0caec
  &InstanceType=
  &MaxCount=1
  &MinCount=1
  &Placement.AvailabilityZoneId=use2-az1
  &NetworkInterface.1.DeviceIndex=0
  &NetworkInterface.1.SubnetId=subnet-a61dafcf
  &NetworkInterface.1.DeleteOnTermination
  &SecondaryInterface.1.SecondarySubnetId=ss-073988ab526b59d2c
  &SecondaryInterface.1.NetworkCardIndex=1
  &SecondaryInterface.1.DeviceIndex=0
  &SecondaryInterface.1.InterfaceType=secondary
  &SecondaryInterface.1.DeleteOnTermination=true
  &SecondaryInterface.1.PrivateIpAddressCount=1
  &SecondaryInterface.2.SecondarySubnetId=ss-061ba0b5a43c9eabe
  &SecondaryInterface.2.NetworkCardIndex=2
  &SecondaryInterface.2.DeviceIndex=0
  &SecondaryInterface.2.InterfaceType=secondary
  &SecondaryInterface.2.DeleteOnTermination=true
  &SecondaryInterface.2.PrivateIpAddressCount=1
  &SecondaryInterface.3.SecondarySubnetId=ss-060c8c15859a0c8e5
  &SecondaryInterface.3.NetworkCardIndex=3
  &SecondaryInterface.3.DeviceIndex=0
  &SecondaryInterface.3.InterfaceType=secondary
  &SecondaryInterface.3.DeleteOnTermination=true
  &SecondaryInterface.3.PrivateIpAddressCount=1
  &SecondaryInterface.4.SecondarySubnetId=ss-0dafcecef369ae17d
  &SecondaryInterface.4.NetworkCardIndex=4
  &SecondaryInterface.4.DeviceIndex=0
  &SecondaryInterface.4.InterfaceType=secondary
  &SecondaryInterface.4.DeleteOnTermination=true
  &SecondaryInterface.4.PrivateIpAddressCount=1
  &SecondaryInterface.5.SecondarySubnetId=ss-073988ab526b59d2e
  &SecondaryInterface.5.NetworkCardIndex=5
  &SecondaryInterface.5.DeviceIndex=0
  &SecondaryInterface.5.InterfaceType=secondary
  &SecondaryInterface.5.DeleteOnTermination=true
  &SecondaryInterface.5.PrivateIpAddressCount=1
  &SecondaryInterface.6.SecondarySubnetId=ss-061ba0b5a43c9eabf
  &SecondaryInterface.6.NetworkCardIndex=6
  &SecondaryInterface.6.DeviceIndex=0
  &SecondaryInterface.6.InterfaceType=secondary
  &SecondaryInterface.6.DeleteOnTermination=true
  &SecondaryInterface.6.PrivateIpAddressCount=1
  &SecondaryInterface.7.SecondarySubnetId=ss-060c8c15859a0c8e1
  &SecondaryInterface.7.NetworkCardIndex=7
  &SecondaryInterface.7.DeviceIndex=0
  &SecondaryInterface.7.InterfaceType=secondary
  &SecondaryInterface.7.DeleteOnTermination=true
  &SecondaryInterface.7.PrivateIpAddressCount=1
  &SecondaryInterface.8.SecondarySubnetId=ss-0dafcecef369ae172
  &SecondaryInterface.8.NetworkCardIndex=8
  &SecondaryInterface.8.DeviceIndex=0
  &SecondaryInterface.8.InterfaceType=secondary
  &SecondaryInterface.8.DeleteOnTermination=true
  &SecondaryInterface.8.PrivateIpAddressCount=1
  &AUTHPARAMS
```

#### Sample Response


```

  d61f4ee4-1e53-4bf8-9cf2-08c5e2f03da4
  r-0ddcaaa5e0c45ca09
  123456789012
  
  
    
      i-05e4d39f17ac88e74
      ami-beb0caec
      
        0
        pending
      
      ip-172-31-63-109.us-west-2.compute.internal
      
      
      0
      
      
        false
      
      
      2026-01-07T12:19:54.000Z
      
        us-east-2a
        use2-az1
        
        default
      
      
        disabled
      
      subnet-a61dafcf
      vpc-0564039f140880335
      172.31.63.109
      true
      
        
          sg-087603de13e5e0723
          default
        
      
      
        pending
        pending
      
      x86_64
      ebs
      /dev/xvda
      
      hvm
      
      xen
      
        
          eni-0e58a9ead2097b866
          subnet-a61dafcf
          vpc-0564039f140880335
          
          123456789012
          in-use
          0e:2d:76:a2:bf:d3
          172.31.63.109
          ip-172-31-63-109.us-west-2.compute.internal
          true
          
            
              sg-087603de13e5e0723
              default
            
          
          
            eni-attach-0366b9a273aec9b6d
            0
            attaching
            2026-01-07T12:19:54.000Z
            true
            0
          
          
            
              172.31.63.109
              ip-172-31-63-109.us-west-2.compute.internal
              true
            
          
          
          interface
          
            false
          
        
      
      
        
          si-01ccd067bff3abaf8
          02:04:f6:35:eb:32
          123456789012
          
            
              11.0.1.251
            
          
          true
          available
          ss-073988ab526b59d2c
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            1
          
        
        
          si-0b918509a38139722
          02:04:70:38:b6:1a
          123456789012
          
            
              11.0.2.251
            
          
          true
          available
          ss-061ba0b5a43c9eabe
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            2
          
        
        
          si-0d042753b88c81245
          02:04:7d:07:d9:01
          123456789012
          
            
              11.0.3.251
            
          
          true
          available
          ss-060c8c15859a0c8e5
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            3
          
        
        
          si-70dafcecef67ae17d
          02:04:8f:53:73:02
          123456789012
          
            
              11.0.4.251
            
          
          true
          available
          ss-0dafcecef369ae17d
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            4
          
        
        
          si-0f4f36a50046f21b8
          02:04:8f:53:73:03
          123456789012
          
            
              11.0.4.230
            
          
          true
          available
          ss-073988ab526b59d2e
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            5
          
        
        
          si-006736a50046f21b9
          02:04:8f:53:73:04
          123456789012
          
            
              11.0.4.231
            
          
          true
          available
          ss-061ba0b5a43c9eabf
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            6
          
        
        
          si-0fff36a5d046f2110
          02:04:8f:53:73:05
          123456789012
          
            
              11.0.4.232
            
          
          true
          available
          ss-060c8c15859a0c8e1
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            7
          
        
        
          si-afcf36a50046f2111
          02:04:8f:53:73:06
          123456789012
          
            
              11.0.4.233
            
          
          true
          available
          ss-0dafcecef369ae172
          sn-01cdb8e434dffbb26
          secondary
          
            true
            0
            8
          
        
      
      false
      true
      
        96
        2
      
      
        open
      
      
        false
      
      
        pending
        required
        2
        enabled
        enabled
        disabled
        disabled
      
      
        default
        default
      
      legacy-bios
      
        ip-name
        false
        false
      
    
  

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RunInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RunInstances) 

# RunScheduledInstances


Launches the specified Scheduled Instances.

Before you can launch a Scheduled Instance, you must purchase it and obtain an identifier using [PurchaseScheduledInstances](API_PurchaseScheduledInstances.md).

You must launch a Scheduled Instance during its scheduled time period. You can't stop or reboot a Scheduled Instance, but you can terminate it as needed. If you terminate a Scheduled Instance before the current scheduled time period ends, you can launch it again after a few minutes.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **ClientToken**   
Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **InstanceCount**   
The number of instances.  
Default: 1  
Type: Integer  
Required: No

 **LaunchSpecification**   
The launch specification. You must match the instance type, Availability Zone, network, and platform of the schedule that you purchased.  
Type: [ScheduledInstancesLaunchSpecification](API_ScheduledInstancesLaunchSpecification.md) object  
Required: Yes

 **ScheduledInstanceId**   
The Scheduled Instance ID.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **instanceIdSet**   
The IDs of the newly launched instances.  
Type: Array of strings

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/RunScheduledInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RunScheduledInstances) 

# SearchLocalGatewayRoutes


Searches for routes in the specified local gateway route table.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **Filter.N**   
One or more filters.  
+  `prefix-list-id` - The ID of the prefix list.
+  `route-search.exact-match` - The exact match of the specified filter.
+  `route-search.longest-prefix-match` - The longest prefix that matches the route.
+  `route-search.subnet-of-match` - The routes with a subnet that match the specified CIDR filter.
+  `route-search.supernet-of-match` - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify `supernet-of-match` as 10.0.1.0/30, then the result returns 10.0.1.0/29.
+  `state` - The state of the route.
+  `type` - The route type.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 **LocalGatewayRouteTableId**   
The ID of the local gateway route table.  
Type: String  
Required: Yes

 **MaxResults**   
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Type: Integer  
Required: No

 **NextToken**   
The token for the next page of results.  
Type: String  
Required: No

## Response Elements


The following elements are returned by the service.

 **nextToken**   
The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

 **routeSet**   
Information about the routes.  
Type: Array of [LocalGatewayRoute](API_LocalGatewayRoute.md) objects

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/SearchLocalGatewayRoutes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SearchLocalGatewayRoutes) 

# SearchTransitGatewayMulticastGroups


Searches one or more transit gateway multicast groups and returns the group membership information.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **Filter.N**   
One or more filters. The possible values are:  
+  `group-ip-address` - The IP address of the transit gateway multicast group.
+  `is-group-member` - The resource is a group member. Valid values are `true` \$1 `false`.
+  `is-group-source` - The resource is a group source. Valid values are `true` \$1 `false`.
+  `member-type` - The member type. Valid values are `igmp` \$1 `static`.
+  `resource-id` - The ID of the resource.
+  `resource-type` - The type of resource. Valid values are `vpc` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `tgw-peering`.
+  `source-type` - The source type. Valid values are `igmp` \$1 `static`.
+  `subnet-id` - The ID of the subnet.
+  `transit-gateway-attachment-id` - The id of the transit gateway attachment.
Type: Array of [Filter](API_Filter.md) objects  
Required: No

 **MaxResults**   
The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned `nextToken` value.  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 1000.  
Required: No

 **NextToken**   
The token for the next page of results.  
Type: String  
Required: No

 **TransitGatewayMulticastDomainId**   
The ID of the transit gateway multicast domain.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **multicastGroups**   
Information about the transit gateway multicast group.  
Type: Array of [TransitGatewayMulticastGroup](API_TransitGatewayMulticastGroup.md) objects

 **nextToken**   
The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example returns the group membership information for the specified multicast domain.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=SearchTransitGatewayMulticastGroups
&TransitGatewayMulticastDomainId=tgw-mcast-domain-0c4905cef79d6e597
&AUTHPARAMS
```

#### Sample Response


```

    19af1e8f-f80b-479d-9cf4-c7d19EXAMPLE
    
        
            224.0.1.0
            true
            false
            static
            eni-07f290fc3cEXAMPLE
            subnet-000de86e3bEXAMPLE
            tgw-attach-028c1dd0f8EXAMPLE
        
        
            224.0.1.0
            false
            true
            eni-0e246d32695012e81
            static
            subnet-000de86e3bEXAMPLE
            tgw-attach-028c1dd0f8EXAMPLE
        
    

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SearchTransitGatewayMulticastGroups) 

# SearchTransitGatewayRoutes


Searches for routes in the specified transit gateway route table.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **Filter.N**   
One or more filters. The possible values are:  
+  `attachment.transit-gateway-attachment-id`- The id of the transit gateway attachment.
+  `attachment.resource-id` - The resource id of the transit gateway attachment.
+  `attachment.resource-type` - The attachment resource type. Valid values are `vpc` \$1 `vpn` \$1 `direct-connect-gateway` \$1 `peering` \$1 `connect`.
+  `prefix-list-id` - The ID of the prefix list.
+  `route-search.exact-match` - The exact match of the specified filter.
+  `route-search.longest-prefix-match` - The longest prefix that matches the route.
+  `route-search.subnet-of-match` - The routes with a subnet that match the specified CIDR filter.
+  `route-search.supernet-of-match` - The routes with a CIDR that encompass the CIDR filter. For example, if you have 10.0.1.0/29 and 10.0.1.0/31 routes in your route table and you specify supernet-of-match as 10.0.1.0/30, then the result returns 10.0.1.0/29.
+  `state` - The state of the route (`active` \$1 `blackhole`).
+  `type` - The type of route (`propagated` \$1 `static`).
Type: Array of [Filter](API_Filter.md) objects  
Required: Yes

 **MaxResults**   
The maximum number of routes to return. If a value is not provided, the default is 1000.  
Type: Integer  
Valid Range: Minimum value of 5. Maximum value of 1000.  
Required: No

 **NextToken**   
The token for the next page of results.  
Type: String  
Required: No

 **TransitGatewayRouteTableId**   
The ID of the transit gateway route table.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **additionalRoutesAvailable**   
Indicates whether there are additional routes available.  
Type: Boolean

 **nextToken**   
The token to use to retrieve the next page of results. This value is `null` when there are no more results to return.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

 **routeSet**   
Information about the routes.  
Type: Array of [TransitGatewayRoute](API_TransitGatewayRoute.md) objects

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/SearchTransitGatewayRoutes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SearchTransitGatewayRoutes) 

# SendDiagnosticInterrupt


Sends a diagnostic interrupt to the specified Amazon EC2 instance to trigger a *kernel panic* (on Linux instances), or a *blue screen*/*stop error* (on Windows instances). For instances based on Intel and AMD processors, the interrupt is received as a *non-maskable interrupt* (NMI).

In general, the operating system crashes and reboots when a kernel panic or stop error is triggered. The operating system can also be configured to perform diagnostic tasks, such as generating a memory dump file, loading a secondary kernel, or obtaining a call trace.

Before sending a diagnostic interrupt to your instance, ensure that its operating system is configured to perform the required diagnostic tasks.

For more information about configuring your operating system to generate a crash dump when a kernel panic or stop error occurs, see [Send a diagnostic interrupt (for advanced users)](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/diagnostic-interrupt.html) in the *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **InstanceId**   
The ID of the instance.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example sends a diagnostic interrupt to the specified instance.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=SendDiagnosticInterrupt
&InstanceId=i-1234567890abcdef0
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE
  true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/SendDiagnosticInterrupt) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SendDiagnosticInterrupt) 

# StartDeclarativePoliciesReport


Generates an account status report. The report is generated asynchronously, and can take several hours to complete.

The report provides the current status of all attributes supported by declarative policies for the accounts within the specified scope. The scope is determined by the specified `TargetId`, which can represent an individual account, or all the accounts that fall under the specified organizational unit (OU) or root (the entire AWS Organization).

The report is saved to your specified S3 bucket, using the following path structure (with the capitalized placeholders representing your specific values):

 `s3://AMZN-S3-DEMO-BUCKET/YOUR-OPTIONAL-S3-PREFIX/ec2_TARGETID_REPORTID_YYYYMMDDTHHMMZ.csv` 

**Prerequisites for generating a report**
+ The `StartDeclarativePoliciesReport` API can only be called by the management account or delegated administrators for the organization.
+ An S3 bucket must be available before generating the report (you can create a new one or use an existing one), it must be in the same Region where the report generation request is made, and it must have an appropriate bucket policy. For a sample S3 policy, see *Sample Amazon S3 policy* under [Examples](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_StartDeclarativePoliciesReport.html#API_StartDeclarativePoliciesReport_Examples).
+ Trusted access must be enabled for the service for which the declarative policy will enforce a baseline configuration. If you use the AWS Organizations console, this is done automatically when you enable declarative policies. The API uses the following service principal to identify the EC2 service: `ec2.amazonaws.com`. For more information on how to enable trusted access with the AWS CLI and AWS SDKs, see [Using Organizations with other AWS services](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_integrate_services.html) in the * AWS Organizations User Guide*.
+ Only one report per organization can be generated at a time. Attempting to generate a report while another is in progress will result in an error.

For more information, including the required IAM permissions to run this API, see [Generating the account status report for declarative policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_declarative_status-report.html) in the * AWS Organizations User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **S3Bucket**   
The name of the S3 bucket where the report will be saved. The bucket must be in the same Region where the report generation request is made.  
Type: String  
Required: Yes

 **S3Prefix**   
The prefix for your S3 object.  
Type: String  
Required: No

 **TagSpecification.N**   
The tags to apply.  
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 **TargetId**   
The root ID, organizational unit ID, or account ID.  
Format:  
+ For root: `r-ab12` 
+ For OU: `ou-ab12-cdef1234` 
+ For account: `123456789012` 
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **reportId**   
The ID of the report.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Sample Amazon S3 policy


Before generating a report, you must grant the EC2 Declarative Policies principal access to the Amazon S3 bucket where the report will be stored. To do this, attach the following policy to the bucket. Remember to replace *amzn-s3-demo-bucket* in the policy with your actual S3 bucket name, and *identity\$1ARN* with the [IAM identity](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns) used to call the `StartDeclarativePoliciesReport` API. The statement in the `Condition` element ensures that the service can call the operation on your behalf using the credentials used to call the `StartDeclarativePoliciesReport` API.

```
{
    "Version": "2012-10-17",		 	 	 
    "Statement": [{
        "Sid": "DeclarativePoliciesReportDelivery",
        "Effect": "Allow",
        "Principal": {
            "AWS": "identity_ARN"
        },
        "Action": [
            "s3:PutObject"
        ],
        "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/*",
        "Condition": {
            "StringEquals": {
                "aws:CalledViaLast": "report.declarative-policies-ec2.amazonaws.com"
            }
        }
    }]
}
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/StartDeclarativePoliciesReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StartDeclarativePoliciesReport) 

# StartInstances


Starts an Amazon EBS-backed instance that you've previously stopped.

Instances that use Amazon EBS volumes as their root devices can be quickly stopped and started. When an instance is stopped, the compute resources are released and you are not billed for instance usage. However, your root partition Amazon EBS volume remains and continues to persist your data, and you are charged for Amazon EBS volume usage. You can restart your instance at any time. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, and thereafter charges per second for instance usage.

Before stopping an instance, make sure it is in a state from which it can be restarted. Stopping an instance does not preserve data stored in RAM.

Performing this operation on an instance that uses an instance store as its root device returns an error.

If you attempt to start a T3 instance with `host` tenancy and the `unlimited` CPU credit option, the request fails. The `unlimited` CPU credit option is not supported on Dedicated Hosts. Before you start the instance, either change its CPU credit option to `standard`, or change its tenancy to `default` or `dedicated`.

For more information, see [Stop and start Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) in the *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AdditionalInfo**   
Reserved.  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **InstanceId.N**   
The IDs of the instances.  
Type: Array of strings  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **instancesSet**   
Information about the started instances.  
Type: Array of [InstanceStateChange](API_InstanceStateChange.md) objects

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example starts the specified instance.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=StartInstances
&InstanceId.1=i-1234567890abcdef0
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE
  
    
      i-1234567890abcdef0
      
          0
          pending
      
      
          80
          stopped
      
    
  

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/StartInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StartInstances) 

# StartNetworkInsightsAccessScopeAnalysis


Starts analyzing the specified Network Access Scope.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **ClientToken**   
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html).  
Type: String  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **NetworkInsightsAccessScopeId**   
The ID of the Network Access Scope.  
Type: String  
Required: Yes

 **TagSpecification.N**   
The tags to apply.  
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

## Response Elements


The following elements are returned by the service.

 **networkInsightsAccessScopeAnalysis**   
The Network Access Scope analysis.  
Type: [NetworkInsightsAccessScopeAnalysis](API_NetworkInsightsAccessScopeAnalysis.md) object

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StartNetworkInsightsAccessScopeAnalysis) 

# StartNetworkInsightsAnalysis


Starts analyzing the specified path. If the path is reachable, the operation returns the shortest feasible path.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **AdditionalAccount.N**   
The member accounts that contain resources that the path can traverse.  
Type: Array of strings  
Required: No

 **ClientToken**   
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see [How to ensure idempotency](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html).  
Type: String  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **FilterInArn.N**   
The Amazon Resource Names (ARN) of the resources that the path must traverse.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 **FilterOutArn.N**   
The Amazon Resource Names (ARN) of the resources that the path will ignore.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 **NetworkInsightsPathId**   
The ID of the path.  
Type: String  
Required: Yes

 **TagSpecification.N**   
The tags to apply.  
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

## Response Elements


The following elements are returned by the service.

 **networkInsightsAnalysis**   
Information about the network insights analysis.  
Type: [NetworkInsightsAnalysis](API_NetworkInsightsAnalysis.md) object

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/StartNetworkInsightsAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StartNetworkInsightsAnalysis) 

# StartVpcEndpointServicePrivateDnsVerification


Initiates the verification process to prove that the service provider owns the private DNS name domain for the endpoint service.

The service provider must successfully perform the verification before the consumer can use the name to access the service.

Before the service provider runs this command, they must add a record to the DNS server.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **ServiceId**   
The ID of the endpoint service.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, it returns an error.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StartVpcEndpointServicePrivateDnsVerification) 

# StopInstances


Stops an Amazon EBS-backed instance. You can restart your instance at any time using the [StartInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_StartInstances.html) API. For more information, see [Stop and start Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Stop_Start.html) in the *Amazon EC2 User Guide*.

When you stop or hibernate an instance, we shut it down. By default, this includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the `skipOsShutdown` parameter; however, this might risk data integrity.

You can use the StopInstances operation together with the `Hibernate` parameter to hibernate an instance if the instance is [enabled for hibernation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/enabling-hibernation.html) and meets the [hibernation prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hibernating-prerequisites.html). Stopping an instance doesn't preserve data stored in RAM, while hibernation does. If hibernation fails, a normal shutdown occurs. For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.

If your instance appears stuck in the `stopping` state, there might be an issue with the underlying host computer. You can use the StopInstances operation together with the Force parameter to force stop your instance. For more information, see [Troubleshoot Amazon EC2 instance stop issues](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html) in the *Amazon EC2 User Guide*.

Stopping and hibernating an instance differs from rebooting or terminating it. For example, a stopped or hibernated instance retains its root volume and any data volumes, unlike terminated instances where these volumes are automatically deleted. For more information about the differences between stopping, hibernating, rebooting, and terminating instances, see [Amazon EC2 instance state changes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) in the *Amazon EC2 User Guide*.

We don't charge for instance usage or data transfer fees when an instance is stopped. However, the root volume and any data volumes remain and continue to persist your data, and you're charged for volume usage. Every time you start your instance, Amazon EC2 charges a one-minute minimum for instance usage, followed by per-second billing.

You can't stop or hibernate instance store-backed instances.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **Force**   
Forces the instance to stop. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.  
After using this option, you must perform file system check and repair procedures. This option is not recommended for Windows instances. For more information, see [Troubleshoot Amazon EC2 instance stop issues](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesStopping.html) in the *Amazon EC2 User Guide*.  
Default: `false`   
Type: Boolean  
Required: No

 **Hibernate**   
Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate successfully, a normal shutdown occurs. For more information, see [Hibernate your Amazon EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Hibernate.html) in the *Amazon EC2 User Guide*.  
 Default: `false`   
Type: Boolean  
Required: No

 **InstanceId.N**   
The IDs of the instances.  
Type: Array of strings  
Required: Yes

 **SkipOsShutdown**   
Specifies whether to bypass the graceful OS shutdown process when the instance is stopped.  
Bypassing the graceful OS shutdown might result in data loss or corruption (for example, memory contents not flushed to disk or loss of in-flight IOs) or skipped shutdown scripts.
Default: `false`   
Type: Boolean  
Required: No

## Response Elements


The following elements are returned by the service.

 **instancesSet**   
Information about the stopped instances.  
Type: Array of [InstanceStateChange](API_InstanceStateChange.md) objects

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example stops the specified instance.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=StopInstances
&InstanceId.1=i-1234567890abcdef0
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE
  
    
      i-1234567890abcdef0
      
          64
          stopping
      
      
          16
          running
      
    
  

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/StopInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StopInstances) 

# TerminateClientVpnConnections


Terminates active Client VPN endpoint connections. This action can be used to terminate a specific client connection, or up to five connections established by a specific user.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **ClientVpnEndpointId**   
The ID of the Client VPN endpoint to which the client is connected.  
Type: String  
Required: Yes

 **ConnectionId**   
The ID of the client connection to be terminated.  
Type: String  
Required: No

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **Username**   
The name of the user who initiated the connection. Use this option to terminate all active connections for the specified user. This option can only be used if the user has established up to five connections.  
Type: String  
Required: No

## Response Elements


The following elements are returned by the service.

 **clientVpnEndpointId**   
The ID of the Client VPN endpoint.  
Type: String

 **connectionStatuses**   
The current state of the client connections.  
Type: Array of [TerminateConnectionStatus](API_TerminateConnectionStatus.md) objects

 **requestId**   
The ID of the request.  
Type: String

 **username**   
The user who established the terminated client connections.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example terminates a Client VPN endpoint connection.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=TerminateClientVpnConnections
&ClientVpnEndpointId=cvpn-endpoint-00c5d11fc4EXAMPLE
&ConnectionId=cvpn-connection-010b1282b7EXAMPLE
&AUTHPARAMS
```

#### Sample Response


```

	cvpn-endpoint-00c5d11fc4EXAMPLE
	
		
			cvpn-connection-010b1282b7EXAMPLE
		       
				terminating
		       
		       
			       active
		       
	       
    
	00d80748-708d-40f7-8635-f34acEXAMPLE

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/TerminateClientVpnConnections) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TerminateClientVpnConnections) 

# TerminateInstances


Terminates (deletes) the specified instances. This operation is [idempotent](https://docs.aws.amazon.com/ec2/latest/devguide/ec2-api-idempotency.html); if you terminate an instance more than once, each call succeeds.

**Important**  
 **Terminating an instance is permanent and irreversible.**   
After you terminate an instance, you can no longer connect to it, and it can't be recovered. All attached Amazon EBS volumes that are configured to be deleted on termination are also permanently deleted and can't be recovered. All data stored on instance store volumes is permanently lost. For more information, see [ How instance termination works](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/how-ec2-instance-termination-works.html).  
Before you terminate an instance, ensure that you have backed up all data that you need to retain after the termination to persistent storage.

If you specify multiple instances and the request fails (for example, because of a single incorrect instance ID), none of the instances are terminated.

If you terminate multiple instances across multiple Availability Zones, and one or more of the specified instances are enabled for termination protection, the request fails with the following results:
+ The specified instances that are in the same Availability Zone as the protected instance are not terminated.
+ The specified instances that are in different Availability Zones, where no other specified instances are protected, are successfully terminated.

For example, say you have the following instances:
+ Instance A: `us-east-1a`; Not protected
+ Instance B: `us-east-1a`; Not protected
+ Instance C: `us-east-1b`; Protected
+ Instance D: `us-east-1b`; not protected

If you attempt to terminate all of these instances in the same request, the request reports failure with the following results:
+ Instance A and Instance B are successfully terminated because none of the specified instances in `us-east-1a` are enabled for termination protection.
+ Instance C and Instance D fail to terminate because at least one of the specified instances in `us-east-1b` (Instance C) is enabled for termination protection.

Terminated instances remain visible after termination (for approximately one hour).

By default, Amazon EC2 deletes all EBS volumes that were attached when the instance launched. Volumes attached after instance launch continue running.

By default, the TerminateInstances operation includes a graceful operating system (OS) shutdown. To bypass the graceful shutdown, use the `skipOsShutdown` parameter; however, this might risk data integrity.

You can stop, start, and terminate EBS-backed instances. You can only terminate instance store-backed instances. What happens to an instance differs if you stop or terminate it. For example, when you stop an instance, the root device and any other devices attached to the instance persist. When you terminate an instance, any attached EBS volumes with the `DeleteOnTermination` block device mapping parameter set to `true` are automatically deleted. For more information about the differences between stopping and terminating instances, see [Amazon EC2 instance state changes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-lifecycle.html) in the *Amazon EC2 User Guide*.

When you terminate an instance, we attempt to terminate it forcibly after a short while. If your instance appears stuck in the shutting-down state after a period of time, there might be an issue with the underlying host computer. For more information about terminating and troubleshooting terminating your instances, see [Terminate Amazon EC2 instances](https://docs.aws.amazon.com/) and [Troubleshooting terminating your instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/TroubleshootingInstancesShuttingDown.html) in the *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **Force**   
Forces the instances to terminate. The instance will first attempt a graceful shutdown, which includes flushing file system caches and metadata. If the graceful shutdown fails to complete within the timeout period, the instance shuts down forcibly without flushing the file system caches and metadata.  
Type: Boolean  
Required: No

 **InstanceId.N**   
The IDs of the instances.  
Constraints: Up to 1000 instance IDs. We recommend breaking up this request into smaller batches.  
Type: Array of strings  
Required: Yes

 **SkipOsShutdown**   
Specifies whether to bypass the graceful OS shutdown process when the instance is terminated.  
Default: `false`   
Type: Boolean  
Required: No

## Response Elements


The following elements are returned by the service.

 **instancesSet**   
Information about the terminated instances.  
Type: Array of [InstanceStateChange](API_InstanceStateChange.md) objects

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example terminates the specified instance.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=TerminateInstances
&InstanceId.1=i-1234567890abcdef0
&AUTHPARAMS
```

#### Sample Response


```

  59dbff89-35bd-4eac-99ed-be587EXAMPLE
  
    
      i-1234567890abcdef0
      
        32
        shutting-down
      
      
        16
        running
      
    
  

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/TerminateInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TerminateInstances) 

# UnassignIpv6Addresses


Unassigns the specified IPv6 addresses or Prefix Delegation prefixes from a network interface.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Ipv6Addresses.N**   
The IPv6 addresses to unassign from the network interface.  
Type: Array of strings  
Required: No

 **Ipv6Prefix.N**   
The IPv6 prefixes to unassign from the network interface.  
Type: Array of strings  
Required: No

 **NetworkInterfaceId**   
The ID of the network interface.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **networkInterfaceId**   
The ID of the network interface.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

 **unassignedIpv6Addresses**   
The IPv6 addresses that have been unassigned from the network interface.  
Type: Array of strings

 **unassignedIpv6PrefixSet**   
The IPv6 prefixes that have been unassigned from the network interface.  
Type: Array of strings

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


The following example unassigns two IPv6 addresses from the specified network interface.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UnassignIpv6Addresses
&NetworkInterfaceId=eni-197d9972
&Ipv6Addresses.1=2001:db8:1234:1a00::123 
&Ipv6Addresses.2=2001:db8:1234:1a00::456 
&AUTHPARAMS
```

#### Sample Response


```

    94d446d7-fc8e-4918-94f9-example
    eni-197d9972
    
        2001:db8:1234:1a00::123
        2001:db8:1234:1a00::456
    

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UnassignIpv6Addresses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnassignIpv6Addresses) 

# UnassignPrivateIpAddresses


Unassigns the specified secondary private IP addresses or IPv4 Prefix Delegation prefixes from a network interface.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Ipv4Prefix.N**   
The IPv4 prefixes to unassign from the network interface.  
Type: Array of strings  
Required: No

 **NetworkInterfaceId**   
The ID of the network interface.  
Type: String  
Required: Yes

 **PrivateIpAddress.N**   
The secondary private IP addresses to unassign from the network interface. You can specify this option multiple times to unassign more than one IP address.  
Type: Array of strings  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Is `true` if the request succeeds, and an error otherwise.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


The following example unassigns two secondary private IP addresses from the specified network interface.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UnassignPrivateIpAddresses
&NetworkInterfaceId=eni-197d9972
&PrivateIpAddress.1=10.0.2.60 
&PrivateIpAddress.2=10.0.2.65 
&AUTHPARAMS
```

#### Sample Response


```

   59dbff89-35bd-4eac-99ed-be587EXAMPLE 
   true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UnassignPrivateIpAddresses) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnassignPrivateIpAddresses) 

# UnassignPrivateNatGatewayAddress


Unassigns secondary private IPv4 addresses from a private NAT gateway. You cannot unassign your primary private IP. For more information, see [Edit secondary IP address associations](https://docs.aws.amazon.com/vpc/latest/userguide/nat-gateway-working-with.html#nat-gateway-edit-secondary) in the *Amazon VPC User Guide*.

While unassigning is in progress, you cannot assign/unassign additional IP addresses while the connections are being drained. You are, however, allowed to delete the NAT gateway.

A private IP address will only be released at the end of MaxDrainDurationSeconds. The private IP addresses stay associated and support the existing connections, but do not support any new connections (new connections are distributed across the remaining assigned private IP address). After the existing connections drain out, the private IP addresses are released.





## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **MaxDrainDurationSeconds**   
The maximum amount of time to wait (in seconds) before forcibly releasing the IP addresses if connections are still in progress. Default value is 350 seconds.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 4000.  
Required: No

 **NatGatewayId**   
The ID of the NAT gateway.  
Type: String  
Required: Yes

 **PrivateIpAddress.N**   
The private IPv4 addresses you want to unassign.  
Type: Array of strings  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **natGatewayAddressSet**   
Information about the NAT gateway IP addresses.  
Type: Array of [NatGatewayAddress](API_NatGatewayAddress.md) objects

 **natGatewayId**   
The ID of the NAT gateway.  
Type: String

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnassignPrivateNatGatewayAddress) 

# UnlockSnapshot


Unlocks a snapshot that is locked in governance mode or that is locked in compliance mode but still in the cooling-off period. You can't unlock a snapshot that is locked in compliance mode after the cooling-off period has expired.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **SnapshotId**   
The ID of the snapshot to unlock.  
Type: String  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **snapshotId**   
The ID of the snapshot.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UnlockSnapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnlockSnapshot) 

# UnmonitorInstances


Disables detailed monitoring for a running instance. For more information, see [Monitoring your instances and volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-cloudwatch.html) in the *Amazon EC2 User Guide*.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the operation, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **InstanceId.N**   
The IDs of the instances.  
Type: Array of strings  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **instancesSet**   
The monitoring information.  
Type: Array of [InstanceMonitoring](API_InstanceMonitoring.md) objects

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example disables detailed monitoring for the specified instances.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UnmonitorInstances
&InstanceId.1=i-1234567890abcdef0
&InstanceId.2=i-0598c7d356eba48d7
&AUTHPARAMS
```

#### Sample Response


```

   59dbff89-35bd-4eac-99ed-be587EXAMPLE
   
      
         i-1234567890abcdef0
         
            disabled
         
      
      
         i-0598c7d356eba48d7
         
            disabled
         
      
   

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UnmonitorInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnmonitorInstances) 

# UpdateCapacityManagerMonitoredTagKeys


 Activates or deactivates tag keys for monitoring by EC2 Capacity Manager. Activated tag keys are included as dimensions in capacity metric data, enabling you to group and filter metrics by tag values. 

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **ActivateTagKey.N**   
 The tag keys to activate for monitoring. Once activated, these tag keys will be included as dimensions in capacity metric data.   
Type: Array of strings  
Required: No

 **ClientToken**   
 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.   
Type: String  
Required: No

 **DeactivateTagKey.N**   
 The tag keys to deactivate. Deactivated tag keys will no longer be included as dimensions in capacity metric data.   
Type: Array of strings  
Required: No

 **DryRun**   
 Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.   
Type: Boolean  
Required: No

## Response Elements


The following elements are returned by the service.

 **capacityManagerTagKeySet**   
 The list of tag keys affected by the update, including their current status and metadata.   
Type: Array of [CapacityManagerMonitoredTagKey](API_CapacityManagerMonitoredTagKey.md) objects

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example activates the `Environment` and `CostCenter` tag keys for monitoring, and deactivates the `Team` tag key.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UpdateCapacityManagerMonitoredTagKeys
&ActivateTagKey.1=Environment
&ActivateTagKey.2=CostCenter
&DeactivateTagKey.1=Team
&AUTHPARAMS
```

#### Sample Response


```

    d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE
    
        
            Environment
            activating
            
            false
        
        
            CostCenter
            activating
            
            false
        
        
            Team
            deactivating
            
            false
        
    

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UpdateCapacityManagerMonitoredTagKeys) 

# UpdateCapacityManagerOrganizationsAccess


 Updates the Organizations access setting for EC2 Capacity Manager. This controls whether Capacity Manager can aggregate data from all accounts in your AWS Organization or only from the current account. 

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **ClientToken**   
 Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.   
Type: String  
Required: No

 **DryRun**   
 Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.   
Type: Boolean  
Required: No

 **OrganizationsAccess**   
 Specifies whether to enable or disable cross-account access for AWS Organizations. When enabled, Capacity Manager aggregates data from all accounts in your organization.   
Type: Boolean  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **capacityManagerStatus**   
 The current status of Capacity Manager after the update operation.   
Type: String  
Valid Values: `enabled | disabled` 

 **organizationsAccess**   
 The updated Organizations access setting indicating whether cross-account data aggregation is enabled.   
Type: Boolean

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example enables Organizations access for cross-account data aggregation.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UpdateCapacityManagerOrganizationsAccess
&OrganizationsAccess=true
&AUTHPARAMS
```

#### Sample Response


```

    d4904fd9-82c2-4ea5-adfe-a9cc3EXAMPLE
    enabled
    true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UpdateCapacityManagerOrganizationsAccess) 

# UpdateInterruptibleCapacityReservationAllocation


 Modifies the number of instances allocated to an interruptible reservation, allowing you to add more capacity or reclaim capacity to your source Capacity Reservation. 

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **CapacityReservationId**   
 The ID of the source Capacity Reservation containing the interruptible allocation to modify.   
Type: String  
Required: Yes

 **DryRun**   
 Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.   
Type: Boolean  
Required: No

 **TargetInstanceCount**   
 The new number of instances to allocate. Enter a higher number to add more capacity to share, or a lower number to reclaim capacity to your source Capacity Reservation.   
Type: Integer  
Required: Yes

## Response Elements


The following elements are returned by the service.

 **instanceCount**   
 The current number of instances allocated to the interruptible reservation.   
Type: Integer

 **interruptibleCapacityReservationId**   
 The ID of the interruptible Capacity Reservation that was modified.   
Type: String

 **interruptionType**   
 The interruption type for the interruptible reservation.   
Type: String  
Valid Values: `adhoc` 

 **requestId**   
The ID of the request.  
Type: String

 **sourceCapacityReservationId**   
 The ID of the source Capacity Reservation to which capacity was reclaimed or from which capacity was allocated.   
Type: String

 **status**   
 The current status of the allocation (updating during reclamation, active when complete).   
Type: String  
Valid Values: `pending | active | updating | canceling | canceled | failed` 

 **targetInstanceCount**   
 The requested number of instances for the interruptible Capacity Reservation.   
Type: Integer

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UpdateInterruptibleCapacityReservationAllocation) 

# UpdateSecurityGroupRuleDescriptionsEgress


Updates the description of an egress (outbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **GroupId**   
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.  
Type: String  
Required: No

 **GroupName**   
[Default VPC] The name of the security group. You must specify either the security group ID or the security group name.  
Type: String  
Required: No

 **IpPermissions.N**   
The IP permissions for the security group rule. You must specify either the IP permissions or the description.  
Type: Array of [IpPermission](API_IpPermission.md) objects  
Required: No

 **SecurityGroupRuleDescription.N**   
The description for the egress security group rules. You must specify either the description or the IP permissions.  
Type: Array of [SecurityGroupRuleDescription](API_SecurityGroupRuleDescription.md) objects  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, returns an error.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example


This example updates the description for the security group rule that allows outbound access over port 80 to the `205.192.0.0/16` IPv4 address range. The description '`Outbound HTTP access to server 2`' replaces any existing description for the rule.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UpdateSecurityGroupRuleDescriptionsEgress
&GroupId=sg-112233
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=80
&IpPermissions.1.ToPort=80
&IpPermissions.1.IpRanges.1.CidrIp=205.192.0.0/16
&IpPermissions.1.IpRanges.1.Description=Outbound HTTP access to server 2
&AUTHPARAMS
```

#### Sample Response


```

    1480cf25-4fbe-4168-aa9c-365example
    true

```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsEgress) 

# UpdateSecurityGroupRuleDescriptionsIngress


Updates the description of an ingress (inbound) security group rule. You can replace an existing description, or add a description to a rule that did not have one previously. You can remove a description for a security group rule by omitting the description parameter in the request.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

 **GroupId**   
The ID of the security group. You must specify either the security group ID or the security group name in the request. For security groups in a nondefault VPC, you must specify the security group ID.  
Type: String  
Required: No

 **GroupName**   
[Default VPC] The name of the security group. You must specify either the security group ID or the security group name. For security groups in a nondefault VPC, you must specify the security group ID.  
Type: String  
Required: No

 **IpPermissions.N**   
The IP permissions for the security group rule. You must specify either IP permissions or a description.  
Type: Array of [IpPermission](API_IpPermission.md) objects  
Required: No

 **SecurityGroupRuleDescription.N**   
The description for the ingress security group rules. You must specify either a description or IP permissions.  
Type: Array of [SecurityGroupRuleDescription](API_SecurityGroupRuleDescription.md) objects  
Required: No

## Response Elements


The following elements are returned by the service.

 **requestId**   
The ID of the request.  
Type: String

 **return**   
Returns `true` if the request succeeds; otherwise, returns an error.  
Type: Boolean

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## Examples


### Example 1


This example updates the description for the security group rule that allows inbound access over port 22 from the `203.0.113.0/16` IPv4 address range. The description '`SSH access from ABC office`' replaces any existing description for the rule.

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UpdateSecurityGroupRuleDescriptionsIngress
&GroupId=sg-112233
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=22
&IpPermissions.1.ToPort=22
&IpPermissions.1.IpRanges.1.CidrIp=203.0.113.0/16
&IpPermissions.1.IpRanges.1.Description=SSH access from ABC office
&AUTHPARAMS
```

#### Sample Response


```

    b4a57536-2e4a-4cbe-82f0-399example
    true

```

### Example 2


This example removes the description for the specified security group rule. 

#### Sample Request


```
https://ec2.amazonaws.com/?Action=UpdateSecurityGroupRuleDescriptionsIngress
&GroupId=sg-112233
&IpPermissions.1.IpProtocol=tcp
&IpPermissions.1.FromPort=22
&IpPermissions.1.ToPort=22
&IpPermissions.1.IpRanges.1.CidrIp=203.0.113.4/32
&AUTHPARAMS
```

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UpdateSecurityGroupRuleDescriptionsIngress) 

# WithdrawByoipCidr


Stops advertising an address range that is provisioned as an address pool.

You can perform this operation at most once every 10 seconds, even if you specify different address ranges each time.

It can take a few minutes before traffic to the specified addresses stops routing to AWS because of BGP propagation delays.

## Request Parameters


The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, see [Common Query Parameters](CommonParameters.md).

 **Cidr**   
The address range, in CIDR notation.  
Type: String  
Required: Yes

 **DryRun**   
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is `DryRunOperation`. Otherwise, it is `UnauthorizedOperation`.  
Type: Boolean  
Required: No

## Response Elements


The following elements are returned by the service.

 **byoipCidr**   
Information about the address pool.  
Type: [ByoipCidr](API_ByoipCidr.md) object

 **requestId**   
The ID of the request.  
Type: String

## Errors


For information about the errors that are common to all actions, see [Common client error codes](errors-overview.md#CommonErrors).

## See Also


For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/ec2-2016-11-15/WithdrawByoipCidr) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/WithdrawByoipCidr)