

# Data Types
<a name="API_Types"></a>

The Amazon Elastic Compute Cloud API contains several data types that various actions use. This section describes each data type in detail.

**Note**  
The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order.

The following data types are supported:
+  [AcceleratorCount](API_AcceleratorCount.md) 
+  [AcceleratorCountRequest](API_AcceleratorCountRequest.md) 
+  [AcceleratorTotalMemoryMiB](API_AcceleratorTotalMemoryMiB.md) 
+  [AcceleratorTotalMemoryMiBRequest](API_AcceleratorTotalMemoryMiBRequest.md) 
+  [AccessScopeAnalysisFinding](API_AccessScopeAnalysisFinding.md) 
+  [AccessScopePath](API_AccessScopePath.md) 
+  [AccessScopePathRequest](API_AccessScopePathRequest.md) 
+  [AccountAttribute](API_AccountAttribute.md) 
+  [AccountAttributeValue](API_AccountAttributeValue.md) 
+  [ActiveInstance](API_ActiveInstance.md) 
+  [ActiveVpnTunnelStatus](API_ActiveVpnTunnelStatus.md) 
+  [AddedPrincipal](API_AddedPrincipal.md) 
+  [AddIpamOperatingRegion](API_AddIpamOperatingRegion.md) 
+  [AddIpamOrganizationalUnitExclusion](API_AddIpamOrganizationalUnitExclusion.md) 
+  [AdditionalDetail](API_AdditionalDetail.md) 
+  [AddPrefixListEntry](API_AddPrefixListEntry.md) 
+  [Address](API_Address.md) 
+  [AddressAttribute](API_AddressAttribute.md) 
+  [AddressTransfer](API_AddressTransfer.md) 
+  [AllowedPrincipal](API_AllowedPrincipal.md) 
+  [AlternatePathHint](API_AlternatePathHint.md) 
+  [AnalysisAclRule](API_AnalysisAclRule.md) 
+  [AnalysisComponent](API_AnalysisComponent.md) 
+  [AnalysisLoadBalancerListener](API_AnalysisLoadBalancerListener.md) 
+  [AnalysisLoadBalancerTarget](API_AnalysisLoadBalancerTarget.md) 
+  [AnalysisPacketHeader](API_AnalysisPacketHeader.md) 
+  [AnalysisRouteTableRoute](API_AnalysisRouteTableRoute.md) 
+  [AnalysisSecurityGroupRule](API_AnalysisSecurityGroupRule.md) 
+  [AsnAssociation](API_AsnAssociation.md) 
+  [AsnAuthorizationContext](API_AsnAuthorizationContext.md) 
+  [AssignedPrivateIpAddress](API_AssignedPrivateIpAddress.md) 
+  [AssociatedRole](API_AssociatedRole.md) 
+  [AssociatedTargetNetwork](API_AssociatedTargetNetwork.md) 
+  [AssociationStatus](API_AssociationStatus.md) 
+  [AthenaIntegration](API_AthenaIntegration.md) 
+  [AttachmentEnaSrdSpecification](API_AttachmentEnaSrdSpecification.md) 
+  [AttachmentEnaSrdUdpSpecification](API_AttachmentEnaSrdUdpSpecification.md) 
+  [AttributeBooleanValue](API_AttributeBooleanValue.md) 
+  [AttributeSummary](API_AttributeSummary.md) 
+  [AttributeValue](API_AttributeValue.md) 
+  [AuthorizationRule](API_AuthorizationRule.md) 
+  [AvailabilityZone](API_AvailabilityZone.md) 
+  [AvailabilityZoneAddress](API_AvailabilityZoneAddress.md) 
+  [AvailabilityZoneGeography](API_AvailabilityZoneGeography.md) 
+  [AvailabilityZoneMessage](API_AvailabilityZoneMessage.md) 
+  [AvailabilityZoneSubGeography](API_AvailabilityZoneSubGeography.md) 
+  [AvailableCapacity](API_AvailableCapacity.md) 
+  [BaselineEbsBandwidthMbps](API_BaselineEbsBandwidthMbps.md) 
+  [BaselineEbsBandwidthMbpsRequest](API_BaselineEbsBandwidthMbpsRequest.md) 
+  [BaselinePerformanceFactors](API_BaselinePerformanceFactors.md) 
+  [BaselinePerformanceFactorsRequest](API_BaselinePerformanceFactorsRequest.md) 
+  [BlobAttributeValue](API_BlobAttributeValue.md) 
+  [BlockDeviceMapping](API_BlockDeviceMapping.md) 
+  [BlockDeviceMappingResponse](API_BlockDeviceMappingResponse.md) 
+  [BlockPublicAccessStates](API_BlockPublicAccessStates.md) 
+  [BundleTask](API_BundleTask.md) 
+  [BundleTaskError](API_BundleTaskError.md) 
+  [Byoasn](API_Byoasn.md) 
+  [ByoipCidr](API_ByoipCidr.md) 
+  [CancelCapacityReservationFleetError](API_CancelCapacityReservationFleetError.md) 
+  [CancelledSpotInstanceRequest](API_CancelledSpotInstanceRequest.md) 
+  [CancelSpotFleetRequestsError](API_CancelSpotFleetRequestsError.md) 
+  [CancelSpotFleetRequestsErrorItem](API_CancelSpotFleetRequestsErrorItem.md) 
+  [CancelSpotFleetRequestsSuccessItem](API_CancelSpotFleetRequestsSuccessItem.md) 
+  [CapacityAllocation](API_CapacityAllocation.md) 
+  [CapacityAllocationMetadataEntry](API_CapacityAllocationMetadataEntry.md) 
+  [CapacityBlock](API_CapacityBlock.md) 
+  [CapacityBlockExtension](API_CapacityBlockExtension.md) 
+  [CapacityBlockExtensionOffering](API_CapacityBlockExtensionOffering.md) 
+  [CapacityBlockOffering](API_CapacityBlockOffering.md) 
+  [CapacityBlockStatus](API_CapacityBlockStatus.md) 
+  [CapacityManagerCondition](API_CapacityManagerCondition.md) 
+  [CapacityManagerDataExportResponse](API_CapacityManagerDataExportResponse.md) 
+  [CapacityManagerDimension](API_CapacityManagerDimension.md) 
+  [CapacityManagerMonitoredTagKey](API_CapacityManagerMonitoredTagKey.md) 
+  [CapacityManagerTagDimension](API_CapacityManagerTagDimension.md) 
+  [CapacityReservation](API_CapacityReservation.md) 
+  [CapacityReservationBillingRequest](API_CapacityReservationBillingRequest.md) 
+  [CapacityReservationCommitmentInfo](API_CapacityReservationCommitmentInfo.md) 
+  [CapacityReservationFleet](API_CapacityReservationFleet.md) 
+  [CapacityReservationFleetCancellationState](API_CapacityReservationFleetCancellationState.md) 
+  [CapacityReservationGroup](API_CapacityReservationGroup.md) 
+  [CapacityReservationInfo](API_CapacityReservationInfo.md) 
+  [CapacityReservationOptions](API_CapacityReservationOptions.md) 
+  [CapacityReservationOptionsRequest](API_CapacityReservationOptionsRequest.md) 
+  [CapacityReservationSpecification](API_CapacityReservationSpecification.md) 
+  [CapacityReservationSpecificationResponse](API_CapacityReservationSpecificationResponse.md) 
+  [CapacityReservationStatus](API_CapacityReservationStatus.md) 
+  [CapacityReservationTarget](API_CapacityReservationTarget.md) 
+  [CapacityReservationTargetResponse](API_CapacityReservationTargetResponse.md) 
+  [CapacityReservationTopology](API_CapacityReservationTopology.md) 
+  [CarrierGateway](API_CarrierGateway.md) 
+  [CertificateAuthentication](API_CertificateAuthentication.md) 
+  [CertificateAuthenticationRequest](API_CertificateAuthenticationRequest.md) 
+  [CidrAuthorizationContext](API_CidrAuthorizationContext.md) 
+  [CidrBlock](API_CidrBlock.md) 
+  [ClassicLinkDnsSupport](API_ClassicLinkDnsSupport.md) 
+  [ClassicLinkInstance](API_ClassicLinkInstance.md) 
+  [ClassicLoadBalancer](API_ClassicLoadBalancer.md) 
+  [ClassicLoadBalancersConfig](API_ClassicLoadBalancersConfig.md) 
+  [ClientCertificateRevocationListStatus](API_ClientCertificateRevocationListStatus.md) 
+  [ClientConnectOptions](API_ClientConnectOptions.md) 
+  [ClientConnectResponseOptions](API_ClientConnectResponseOptions.md) 
+  [ClientData](API_ClientData.md) 
+  [ClientLoginBannerOptions](API_ClientLoginBannerOptions.md) 
+  [ClientLoginBannerResponseOptions](API_ClientLoginBannerResponseOptions.md) 
+  [ClientRouteEnforcementOptions](API_ClientRouteEnforcementOptions.md) 
+  [ClientRouteEnforcementResponseOptions](API_ClientRouteEnforcementResponseOptions.md) 
+  [ClientVpnAuthentication](API_ClientVpnAuthentication.md) 
+  [ClientVpnAuthenticationRequest](API_ClientVpnAuthenticationRequest.md) 
+  [ClientVpnAuthorizationRuleStatus](API_ClientVpnAuthorizationRuleStatus.md) 
+  [ClientVpnConnection](API_ClientVpnConnection.md) 
+  [ClientVpnConnectionStatus](API_ClientVpnConnectionStatus.md) 
+  [ClientVpnEndpoint](API_ClientVpnEndpoint.md) 
+  [ClientVpnEndpointAttributeStatus](API_ClientVpnEndpointAttributeStatus.md) 
+  [ClientVpnEndpointStatus](API_ClientVpnEndpointStatus.md) 
+  [ClientVpnRoute](API_ClientVpnRoute.md) 
+  [ClientVpnRouteStatus](API_ClientVpnRouteStatus.md) 
+  [CloudWatchLogOptions](API_CloudWatchLogOptions.md) 
+  [CloudWatchLogOptionsSpecification](API_CloudWatchLogOptionsSpecification.md) 
+  [CoipAddressUsage](API_CoipAddressUsage.md) 
+  [CoipCidr](API_CoipCidr.md) 
+  [CoipPool](API_CoipPool.md) 
+  [ConnectionLogOptions](API_ConnectionLogOptions.md) 
+  [ConnectionLogResponseOptions](API_ConnectionLogResponseOptions.md) 
+  [ConnectionNotification](API_ConnectionNotification.md) 
+  [ConnectionTrackingConfiguration](API_ConnectionTrackingConfiguration.md) 
+  [ConnectionTrackingSpecification](API_ConnectionTrackingSpecification.md) 
+  [ConnectionTrackingSpecificationRequest](API_ConnectionTrackingSpecificationRequest.md) 
+  [ConnectionTrackingSpecificationResponse](API_ConnectionTrackingSpecificationResponse.md) 
+  [ConversionTask](API_ConversionTask.md) 
+  [CpuOptions](API_CpuOptions.md) 
+  [CpuOptionsRequest](API_CpuOptionsRequest.md) 
+  [CpuPerformanceFactor](API_CpuPerformanceFactor.md) 
+  [CpuPerformanceFactorRequest](API_CpuPerformanceFactorRequest.md) 
+  [CreateFleetError](API_CreateFleetError.md) 
+  [CreateFleetInstance](API_CreateFleetInstance.md) 
+  [CreateTransitGatewayConnectRequestOptions](API_CreateTransitGatewayConnectRequestOptions.md) 
+  [CreateTransitGatewayMulticastDomainRequestOptions](API_CreateTransitGatewayMulticastDomainRequestOptions.md) 
+  [CreateTransitGatewayPeeringAttachmentRequestOptions](API_CreateTransitGatewayPeeringAttachmentRequestOptions.md) 
+  [CreateTransitGatewayVpcAttachmentRequestOptions](API_CreateTransitGatewayVpcAttachmentRequestOptions.md) 
+  [CreateVerifiedAccessEndpointCidrOptions](API_CreateVerifiedAccessEndpointCidrOptions.md) 
+  [CreateVerifiedAccessEndpointEniOptions](API_CreateVerifiedAccessEndpointEniOptions.md) 
+  [CreateVerifiedAccessEndpointLoadBalancerOptions](API_CreateVerifiedAccessEndpointLoadBalancerOptions.md) 
+  [CreateVerifiedAccessEndpointPortRange](API_CreateVerifiedAccessEndpointPortRange.md) 
+  [CreateVerifiedAccessEndpointRdsOptions](API_CreateVerifiedAccessEndpointRdsOptions.md) 
+  [CreateVerifiedAccessNativeApplicationOidcOptions](API_CreateVerifiedAccessNativeApplicationOidcOptions.md) 
+  [CreateVerifiedAccessTrustProviderDeviceOptions](API_CreateVerifiedAccessTrustProviderDeviceOptions.md) 
+  [CreateVerifiedAccessTrustProviderOidcOptions](API_CreateVerifiedAccessTrustProviderOidcOptions.md) 
+  [CreateVolumePermission](API_CreateVolumePermission.md) 
+  [CreateVolumePermissionModifications](API_CreateVolumePermissionModifications.md) 
+  [CreationDateCondition](API_CreationDateCondition.md) 
+  [CreationDateConditionRequest](API_CreationDateConditionRequest.md) 
+  [CreditSpecification](API_CreditSpecification.md) 
+  [CreditSpecificationRequest](API_CreditSpecificationRequest.md) 
+  [CustomerGateway](API_CustomerGateway.md) 
+  [DataQuery](API_DataQuery.md) 
+  [DataResponse](API_DataResponse.md) 
+  [DeclarativePoliciesReport](API_DeclarativePoliciesReport.md) 
+  [DefaultConnectionTrackingConfiguration](API_DefaultConnectionTrackingConfiguration.md) 
+  [DeleteFleetError](API_DeleteFleetError.md) 
+  [DeleteFleetErrorItem](API_DeleteFleetErrorItem.md) 
+  [DeleteFleetSuccessItem](API_DeleteFleetSuccessItem.md) 
+  [DeleteLaunchTemplateVersionsResponseErrorItem](API_DeleteLaunchTemplateVersionsResponseErrorItem.md) 
+  [DeleteLaunchTemplateVersionsResponseSuccessItem](API_DeleteLaunchTemplateVersionsResponseSuccessItem.md) 
+  [DeleteQueuedReservedInstancesError](API_DeleteQueuedReservedInstancesError.md) 
+  [DeleteSnapshotReturnCode](API_DeleteSnapshotReturnCode.md) 
+  [DeprecationTimeCondition](API_DeprecationTimeCondition.md) 
+  [DeprecationTimeConditionRequest](API_DeprecationTimeConditionRequest.md) 
+  [DeregisterInstanceTagAttributeRequest](API_DeregisterInstanceTagAttributeRequest.md) 
+  [DescribeFastLaunchImagesSuccessItem](API_DescribeFastLaunchImagesSuccessItem.md) 
+  [DescribeFastSnapshotRestoreSuccessItem](API_DescribeFastSnapshotRestoreSuccessItem.md) 
+  [DescribeFleetError](API_DescribeFleetError.md) 
+  [DescribeFleetsInstances](API_DescribeFleetsInstances.md) 
+  [DestinationOptionsRequest](API_DestinationOptionsRequest.md) 
+  [DestinationOptionsResponse](API_DestinationOptionsResponse.md) 
+  [DeviceOptions](API_DeviceOptions.md) 
+  [DhcpConfiguration](API_DhcpConfiguration.md) 
+  [DhcpOptions](API_DhcpOptions.md) 
+  [DimensionCondition](API_DimensionCondition.md) 
+  [DirectoryServiceAuthentication](API_DirectoryServiceAuthentication.md) 
+  [DirectoryServiceAuthenticationRequest](API_DirectoryServiceAuthenticationRequest.md) 
+  [DisableFastSnapshotRestoreErrorItem](API_DisableFastSnapshotRestoreErrorItem.md) 
+  [DisableFastSnapshotRestoreStateError](API_DisableFastSnapshotRestoreStateError.md) 
+  [DisableFastSnapshotRestoreStateErrorItem](API_DisableFastSnapshotRestoreStateErrorItem.md) 
+  [DisableFastSnapshotRestoreSuccessItem](API_DisableFastSnapshotRestoreSuccessItem.md) 
+  [DiskImage](API_DiskImage.md) 
+  [DiskImageDescription](API_DiskImageDescription.md) 
+  [DiskImageDetail](API_DiskImageDetail.md) 
+  [DiskImageVolumeDescription](API_DiskImageVolumeDescription.md) 
+  [DiskInfo](API_DiskInfo.md) 
+  [DnsEntry](API_DnsEntry.md) 
+  [DnsOptions](API_DnsOptions.md) 
+  [DnsOptionsSpecification](API_DnsOptionsSpecification.md) 
+  [DnsServersOptionsModifyStructure](API_DnsServersOptionsModifyStructure.md) 
+  [EbsBlockDevice](API_EbsBlockDevice.md) 
+  [EbsBlockDeviceResponse](API_EbsBlockDeviceResponse.md) 
+  [EbsCardInfo](API_EbsCardInfo.md) 
+  [EbsInfo](API_EbsInfo.md) 
+  [EbsInstanceBlockDevice](API_EbsInstanceBlockDevice.md) 
+  [EbsInstanceBlockDeviceSpecification](API_EbsInstanceBlockDeviceSpecification.md) 
+  [EbsOptimizedInfo](API_EbsOptimizedInfo.md) 
+  [EbsStatusDetails](API_EbsStatusDetails.md) 
+  [EbsStatusSummary](API_EbsStatusSummary.md) 
+  [Ec2InstanceConnectEndpoint](API_Ec2InstanceConnectEndpoint.md) 
+  [EfaInfo](API_EfaInfo.md) 
+  [EgressOnlyInternetGateway](API_EgressOnlyInternetGateway.md) 
+  [ElasticGpuAssociation](API_ElasticGpuAssociation.md) 
+  [ElasticGpuHealth](API_ElasticGpuHealth.md) 
+  [ElasticGpus](API_ElasticGpus.md) 
+  [ElasticGpuSpecification](API_ElasticGpuSpecification.md) 
+  [ElasticGpuSpecificationResponse](API_ElasticGpuSpecificationResponse.md) 
+  [ElasticInferenceAccelerator](API_ElasticInferenceAccelerator.md) 
+  [ElasticInferenceAcceleratorAssociation](API_ElasticInferenceAcceleratorAssociation.md) 
+  [EnableFastSnapshotRestoreErrorItem](API_EnableFastSnapshotRestoreErrorItem.md) 
+  [EnableFastSnapshotRestoreStateError](API_EnableFastSnapshotRestoreStateError.md) 
+  [EnableFastSnapshotRestoreStateErrorItem](API_EnableFastSnapshotRestoreStateErrorItem.md) 
+  [EnableFastSnapshotRestoreSuccessItem](API_EnableFastSnapshotRestoreSuccessItem.md) 
+  [EnaSrdSpecification](API_EnaSrdSpecification.md) 
+  [EnaSrdSpecificationRequest](API_EnaSrdSpecificationRequest.md) 
+  [EnaSrdUdpSpecification](API_EnaSrdUdpSpecification.md) 
+  [EnaSrdUdpSpecificationRequest](API_EnaSrdUdpSpecificationRequest.md) 
+  [EnclaveOptions](API_EnclaveOptions.md) 
+  [EnclaveOptionsRequest](API_EnclaveOptionsRequest.md) 
+  [EncryptionSupport](API_EncryptionSupport.md) 
+  [EventInformation](API_EventInformation.md) 
+  [Explanation](API_Explanation.md) 
+  [ExportImageTask](API_ExportImageTask.md) 
+  [ExportTask](API_ExportTask.md) 
+  [ExportTaskS3Location](API_ExportTaskS3Location.md) 
+  [ExportTaskS3LocationRequest](API_ExportTaskS3LocationRequest.md) 
+  [ExportToS3Task](API_ExportToS3Task.md) 
+  [ExportToS3TaskSpecification](API_ExportToS3TaskSpecification.md) 
+  [ExternalAuthorityConfiguration](API_ExternalAuthorityConfiguration.md) 
+  [FailedCapacityReservationFleetCancellationResult](API_FailedCapacityReservationFleetCancellationResult.md) 
+  [FailedQueuedPurchaseDeletion](API_FailedQueuedPurchaseDeletion.md) 
+  [FastLaunchLaunchTemplateSpecificationRequest](API_FastLaunchLaunchTemplateSpecificationRequest.md) 
+  [FastLaunchLaunchTemplateSpecificationResponse](API_FastLaunchLaunchTemplateSpecificationResponse.md) 
+  [FastLaunchSnapshotConfigurationRequest](API_FastLaunchSnapshotConfigurationRequest.md) 
+  [FastLaunchSnapshotConfigurationResponse](API_FastLaunchSnapshotConfigurationResponse.md) 
+  [FederatedAuthentication](API_FederatedAuthentication.md) 
+  [FederatedAuthenticationRequest](API_FederatedAuthenticationRequest.md) 
+  [Filter](API_Filter.md) 
+  [FilterPortRange](API_FilterPortRange.md) 
+  [FirewallStatefulRule](API_FirewallStatefulRule.md) 
+  [FirewallStatelessRule](API_FirewallStatelessRule.md) 
+  [FleetBlockDeviceMappingRequest](API_FleetBlockDeviceMappingRequest.md) 
+  [FleetCapacityReservation](API_FleetCapacityReservation.md) 
+  [FleetData](API_FleetData.md) 
+  [FleetEbsBlockDeviceRequest](API_FleetEbsBlockDeviceRequest.md) 
+  [FleetLaunchTemplateConfig](API_FleetLaunchTemplateConfig.md) 
+  [FleetLaunchTemplateConfigRequest](API_FleetLaunchTemplateConfigRequest.md) 
+  [FleetLaunchTemplateOverrides](API_FleetLaunchTemplateOverrides.md) 
+  [FleetLaunchTemplateOverridesRequest](API_FleetLaunchTemplateOverridesRequest.md) 
+  [FleetLaunchTemplateSpecification](API_FleetLaunchTemplateSpecification.md) 
+  [FleetLaunchTemplateSpecificationRequest](API_FleetLaunchTemplateSpecificationRequest.md) 
+  [FleetSpotCapacityRebalance](API_FleetSpotCapacityRebalance.md) 
+  [FleetSpotCapacityRebalanceRequest](API_FleetSpotCapacityRebalanceRequest.md) 
+  [FleetSpotMaintenanceStrategies](API_FleetSpotMaintenanceStrategies.md) 
+  [FleetSpotMaintenanceStrategiesRequest](API_FleetSpotMaintenanceStrategiesRequest.md) 
+  [FlowLog](API_FlowLog.md) 
+  [FpgaDeviceInfo](API_FpgaDeviceInfo.md) 
+  [FpgaDeviceMemoryInfo](API_FpgaDeviceMemoryInfo.md) 
+  [FpgaImage](API_FpgaImage.md) 
+  [FpgaImageAttribute](API_FpgaImageAttribute.md) 
+  [FpgaImageState](API_FpgaImageState.md) 
+  [FpgaInfo](API_FpgaInfo.md) 
+  [GpuDeviceInfo](API_GpuDeviceInfo.md) 
+  [GpuDeviceMemoryInfo](API_GpuDeviceMemoryInfo.md) 
+  [GpuInfo](API_GpuInfo.md) 
+  [GroupIdentifier](API_GroupIdentifier.md) 
+  [HibernationOptions](API_HibernationOptions.md) 
+  [HibernationOptionsRequest](API_HibernationOptionsRequest.md) 
+  [HistoryRecord](API_HistoryRecord.md) 
+  [HistoryRecordEntry](API_HistoryRecordEntry.md) 
+  [Host](API_Host.md) 
+  [HostInstance](API_HostInstance.md) 
+  [HostOffering](API_HostOffering.md) 
+  [HostProperties](API_HostProperties.md) 
+  [HostReservation](API_HostReservation.md) 
+  [IamInstanceProfile](API_IamInstanceProfile.md) 
+  [IamInstanceProfileAssociation](API_IamInstanceProfileAssociation.md) 
+  [IamInstanceProfileSpecification](API_IamInstanceProfileSpecification.md) 
+  [IcmpTypeCode](API_IcmpTypeCode.md) 
+  [IdFormat](API_IdFormat.md) 
+  [IKEVersionsListValue](API_IKEVersionsListValue.md) 
+  [IKEVersionsRequestListValue](API_IKEVersionsRequestListValue.md) 
+  [Image](API_Image.md) 
+  [ImageAncestryEntry](API_ImageAncestryEntry.md) 
+  [ImageCriterion](API_ImageCriterion.md) 
+  [ImageCriterionRequest](API_ImageCriterionRequest.md) 
+  [ImageDiskContainer](API_ImageDiskContainer.md) 
+  [ImageMetadata](API_ImageMetadata.md) 
+  [ImageRecycleBinInfo](API_ImageRecycleBinInfo.md) 
+  [ImageReference](API_ImageReference.md) 
+  [ImageUsageReport](API_ImageUsageReport.md) 
+  [ImageUsageReportEntry](API_ImageUsageReportEntry.md) 
+  [ImageUsageResourceType](API_ImageUsageResourceType.md) 
+  [ImageUsageResourceTypeOption](API_ImageUsageResourceTypeOption.md) 
+  [ImageUsageResourceTypeOptionRequest](API_ImageUsageResourceTypeOptionRequest.md) 
+  [ImageUsageResourceTypeRequest](API_ImageUsageResourceTypeRequest.md) 
+  [ImportImageLicenseConfigurationRequest](API_ImportImageLicenseConfigurationRequest.md) 
+  [ImportImageLicenseConfigurationResponse](API_ImportImageLicenseConfigurationResponse.md) 
+  [ImportImageTask](API_ImportImageTask.md) 
+  [ImportInstanceLaunchSpecification](API_ImportInstanceLaunchSpecification.md) 
+  [ImportInstanceTaskDetails](API_ImportInstanceTaskDetails.md) 
+  [ImportInstanceVolumeDetailItem](API_ImportInstanceVolumeDetailItem.md) 
+  [ImportSnapshotTask](API_ImportSnapshotTask.md) 
+  [ImportVolumeTaskDetails](API_ImportVolumeTaskDetails.md) 
+  [InferenceAcceleratorInfo](API_InferenceAcceleratorInfo.md) 
+  [InferenceDeviceInfo](API_InferenceDeviceInfo.md) 
+  [InferenceDeviceMemoryInfo](API_InferenceDeviceMemoryInfo.md) 
+  [InitializationStatusDetails](API_InitializationStatusDetails.md) 
+  [Instance](API_Instance.md) 
+  [InstanceAttachmentEnaSrdSpecification](API_InstanceAttachmentEnaSrdSpecification.md) 
+  [InstanceAttachmentEnaSrdUdpSpecification](API_InstanceAttachmentEnaSrdUdpSpecification.md) 
+  [InstanceBlockDeviceMapping](API_InstanceBlockDeviceMapping.md) 
+  [InstanceBlockDeviceMappingSpecification](API_InstanceBlockDeviceMappingSpecification.md) 
+  [InstanceCapacity](API_InstanceCapacity.md) 
+  [InstanceConnectEndpointDnsNames](API_InstanceConnectEndpointDnsNames.md) 
+  [InstanceConnectEndpointPublicDnsNames](API_InstanceConnectEndpointPublicDnsNames.md) 
+  [InstanceCount](API_InstanceCount.md) 
+  [InstanceCreditSpecification](API_InstanceCreditSpecification.md) 
+  [InstanceCreditSpecificationRequest](API_InstanceCreditSpecificationRequest.md) 
+  [InstanceEventWindow](API_InstanceEventWindow.md) 
+  [InstanceEventWindowAssociationRequest](API_InstanceEventWindowAssociationRequest.md) 
+  [InstanceEventWindowAssociationTarget](API_InstanceEventWindowAssociationTarget.md) 
+  [InstanceEventWindowDisassociationRequest](API_InstanceEventWindowDisassociationRequest.md) 
+  [InstanceEventWindowStateChange](API_InstanceEventWindowStateChange.md) 
+  [InstanceEventWindowTimeRange](API_InstanceEventWindowTimeRange.md) 
+  [InstanceEventWindowTimeRangeRequest](API_InstanceEventWindowTimeRangeRequest.md) 
+  [InstanceExportDetails](API_InstanceExportDetails.md) 
+  [InstanceFamilyCreditSpecification](API_InstanceFamilyCreditSpecification.md) 
+  [InstanceImageMetadata](API_InstanceImageMetadata.md) 
+  [InstanceIpv4Prefix](API_InstanceIpv4Prefix.md) 
+  [InstanceIpv6Address](API_InstanceIpv6Address.md) 
+  [InstanceIpv6AddressRequest](API_InstanceIpv6AddressRequest.md) 
+  [InstanceIpv6Prefix](API_InstanceIpv6Prefix.md) 
+  [InstanceMaintenanceOptions](API_InstanceMaintenanceOptions.md) 
+  [InstanceMaintenanceOptionsRequest](API_InstanceMaintenanceOptionsRequest.md) 
+  [InstanceMarketOptionsRequest](API_InstanceMarketOptionsRequest.md) 
+  [InstanceMetadataDefaultsResponse](API_InstanceMetadataDefaultsResponse.md) 
+  [InstanceMetadataOptionsRequest](API_InstanceMetadataOptionsRequest.md) 
+  [InstanceMetadataOptionsResponse](API_InstanceMetadataOptionsResponse.md) 
+  [InstanceMonitoring](API_InstanceMonitoring.md) 
+  [InstanceNetworkInterface](API_InstanceNetworkInterface.md) 
+  [InstanceNetworkInterfaceAssociation](API_InstanceNetworkInterfaceAssociation.md) 
+  [InstanceNetworkInterfaceAttachment](API_InstanceNetworkInterfaceAttachment.md) 
+  [InstanceNetworkInterfaceSpecification](API_InstanceNetworkInterfaceSpecification.md) 
+  [InstanceNetworkPerformanceOptions](API_InstanceNetworkPerformanceOptions.md) 
+  [InstanceNetworkPerformanceOptionsRequest](API_InstanceNetworkPerformanceOptionsRequest.md) 
+  [InstancePrivateIpAddress](API_InstancePrivateIpAddress.md) 
+  [InstanceRequirements](API_InstanceRequirements.md) 
+  [InstanceRequirementsRequest](API_InstanceRequirementsRequest.md) 
+  [InstanceRequirementsWithMetadataRequest](API_InstanceRequirementsWithMetadataRequest.md) 
+  [InstanceSecondaryInterface](API_InstanceSecondaryInterface.md) 
+  [InstanceSecondaryInterfaceAttachment](API_InstanceSecondaryInterfaceAttachment.md) 
+  [InstanceSecondaryInterfacePrivateIpAddress](API_InstanceSecondaryInterfacePrivateIpAddress.md) 
+  [InstanceSecondaryInterfacePrivateIpAddressRequest](API_InstanceSecondaryInterfacePrivateIpAddressRequest.md) 
+  [InstanceSecondaryInterfaceSpecificationRequest](API_InstanceSecondaryInterfaceSpecificationRequest.md) 
+  [InstanceSpecification](API_InstanceSpecification.md) 
+  [InstanceState](API_InstanceState.md) 
+  [InstanceStateChange](API_InstanceStateChange.md) 
+  [InstanceStatus](API_InstanceStatus.md) 
+  [InstanceStatusDetails](API_InstanceStatusDetails.md) 
+  [InstanceStatusEvent](API_InstanceStatusEvent.md) 
+  [InstanceStatusSummary](API_InstanceStatusSummary.md) 
+  [InstanceStorageInfo](API_InstanceStorageInfo.md) 
+  [InstanceTagNotificationAttribute](API_InstanceTagNotificationAttribute.md) 
+  [InstanceTopology](API_InstanceTopology.md) 
+  [InstanceTypeInfo](API_InstanceTypeInfo.md) 
+  [InstanceTypeInfoFromInstanceRequirements](API_InstanceTypeInfoFromInstanceRequirements.md) 
+  [InstanceTypeOffering](API_InstanceTypeOffering.md) 
+  [InstanceUsage](API_InstanceUsage.md) 
+  [IntegrateServices](API_IntegrateServices.md) 
+  [InternetGateway](API_InternetGateway.md) 
+  [InternetGatewayAttachment](API_InternetGatewayAttachment.md) 
+  [InterruptibleCapacityAllocation](API_InterruptibleCapacityAllocation.md) 
+  [InterruptionInfo](API_InterruptionInfo.md) 
+  [Ipam](API_Ipam.md) 
+  [IpamAddressHistoryRecord](API_IpamAddressHistoryRecord.md) 
+  [IpamCidrAuthorizationContext](API_IpamCidrAuthorizationContext.md) 
+  [IpamDiscoveredAccount](API_IpamDiscoveredAccount.md) 
+  [IpamDiscoveredPublicAddress](API_IpamDiscoveredPublicAddress.md) 
+  [IpamDiscoveredResourceCidr](API_IpamDiscoveredResourceCidr.md) 
+  [IpamDiscoveryFailureReason](API_IpamDiscoveryFailureReason.md) 
+  [IpamExternalResourceVerificationToken](API_IpamExternalResourceVerificationToken.md) 
+  [IpamOperatingRegion](API_IpamOperatingRegion.md) 
+  [IpamOrganizationalUnitExclusion](API_IpamOrganizationalUnitExclusion.md) 
+  [IpamPolicy](API_IpamPolicy.md) 
+  [IpamPolicyAllocationRule](API_IpamPolicyAllocationRule.md) 
+  [IpamPolicyAllocationRuleRequest](API_IpamPolicyAllocationRuleRequest.md) 
+  [IpamPolicyDocument](API_IpamPolicyDocument.md) 
+  [IpamPolicyOrganizationTarget](API_IpamPolicyOrganizationTarget.md) 
+  [IpamPool](API_IpamPool.md) 
+  [IpamPoolAllocation](API_IpamPoolAllocation.md) 
+  [IpamPoolCidr](API_IpamPoolCidr.md) 
+  [IpamPoolCidrFailureReason](API_IpamPoolCidrFailureReason.md) 
+  [IpamPoolSourceResource](API_IpamPoolSourceResource.md) 
+  [IpamPoolSourceResourceRequest](API_IpamPoolSourceResourceRequest.md) 
+  [IpamPrefixListResolver](API_IpamPrefixListResolver.md) 
+  [IpamPrefixListResolverRule](API_IpamPrefixListResolverRule.md) 
+  [IpamPrefixListResolverRuleCondition](API_IpamPrefixListResolverRuleCondition.md) 
+  [IpamPrefixListResolverRuleConditionRequest](API_IpamPrefixListResolverRuleConditionRequest.md) 
+  [IpamPrefixListResolverRuleRequest](API_IpamPrefixListResolverRuleRequest.md) 
+  [IpamPrefixListResolverTarget](API_IpamPrefixListResolverTarget.md) 
+  [IpamPrefixListResolverVersion](API_IpamPrefixListResolverVersion.md) 
+  [IpamPrefixListResolverVersionEntry](API_IpamPrefixListResolverVersionEntry.md) 
+  [IpamPublicAddressSecurityGroup](API_IpamPublicAddressSecurityGroup.md) 
+  [IpamPublicAddressTag](API_IpamPublicAddressTag.md) 
+  [IpamPublicAddressTags](API_IpamPublicAddressTags.md) 
+  [IpamResourceCidr](API_IpamResourceCidr.md) 
+  [IpamResourceDiscovery](API_IpamResourceDiscovery.md) 
+  [IpamResourceDiscoveryAssociation](API_IpamResourceDiscoveryAssociation.md) 
+  [IpamResourceTag](API_IpamResourceTag.md) 
+  [IpamScope](API_IpamScope.md) 
+  [IpamScopeExternalAuthorityConfiguration](API_IpamScopeExternalAuthorityConfiguration.md) 
+  [IpPermission](API_IpPermission.md) 
+  [IpRange](API_IpRange.md) 
+  [Ipv4PrefixSpecification](API_Ipv4PrefixSpecification.md) 
+  [Ipv4PrefixSpecificationRequest](API_Ipv4PrefixSpecificationRequest.md) 
+  [Ipv4PrefixSpecificationResponse](API_Ipv4PrefixSpecificationResponse.md) 
+  [Ipv6CidrAssociation](API_Ipv6CidrAssociation.md) 
+  [Ipv6CidrBlock](API_Ipv6CidrBlock.md) 
+  [Ipv6Pool](API_Ipv6Pool.md) 
+  [Ipv6PrefixSpecification](API_Ipv6PrefixSpecification.md) 
+  [Ipv6PrefixSpecificationRequest](API_Ipv6PrefixSpecificationRequest.md) 
+  [Ipv6PrefixSpecificationResponse](API_Ipv6PrefixSpecificationResponse.md) 
+  [Ipv6Range](API_Ipv6Range.md) 
+  [KeyPairInfo](API_KeyPairInfo.md) 
+  [LastError](API_LastError.md) 
+  [LaunchPermission](API_LaunchPermission.md) 
+  [LaunchPermissionModifications](API_LaunchPermissionModifications.md) 
+  [LaunchSpecification](API_LaunchSpecification.md) 
+  [LaunchTemplate](API_LaunchTemplate.md) 
+  [LaunchTemplateAndOverridesResponse](API_LaunchTemplateAndOverridesResponse.md) 
+  [LaunchTemplateBlockDeviceMapping](API_LaunchTemplateBlockDeviceMapping.md) 
+  [LaunchTemplateBlockDeviceMappingRequest](API_LaunchTemplateBlockDeviceMappingRequest.md) 
+  [LaunchTemplateCapacityReservationSpecificationRequest](API_LaunchTemplateCapacityReservationSpecificationRequest.md) 
+  [LaunchTemplateCapacityReservationSpecificationResponse](API_LaunchTemplateCapacityReservationSpecificationResponse.md) 
+  [LaunchTemplateConfig](API_LaunchTemplateConfig.md) 
+  [LaunchTemplateCpuOptions](API_LaunchTemplateCpuOptions.md) 
+  [LaunchTemplateCpuOptionsRequest](API_LaunchTemplateCpuOptionsRequest.md) 
+  [LaunchTemplateEbsBlockDevice](API_LaunchTemplateEbsBlockDevice.md) 
+  [LaunchTemplateEbsBlockDeviceRequest](API_LaunchTemplateEbsBlockDeviceRequest.md) 
+  [LaunchTemplateElasticInferenceAccelerator](API_LaunchTemplateElasticInferenceAccelerator.md) 
+  [LaunchTemplateElasticInferenceAcceleratorResponse](API_LaunchTemplateElasticInferenceAcceleratorResponse.md) 
+  [LaunchTemplateEnaSrdSpecification](API_LaunchTemplateEnaSrdSpecification.md) 
+  [LaunchTemplateEnaSrdUdpSpecification](API_LaunchTemplateEnaSrdUdpSpecification.md) 
+  [LaunchTemplateEnclaveOptions](API_LaunchTemplateEnclaveOptions.md) 
+  [LaunchTemplateEnclaveOptionsRequest](API_LaunchTemplateEnclaveOptionsRequest.md) 
+  [LaunchTemplateHibernationOptions](API_LaunchTemplateHibernationOptions.md) 
+  [LaunchTemplateHibernationOptionsRequest](API_LaunchTemplateHibernationOptionsRequest.md) 
+  [LaunchTemplateIamInstanceProfileSpecification](API_LaunchTemplateIamInstanceProfileSpecification.md) 
+  [LaunchTemplateIamInstanceProfileSpecificationRequest](API_LaunchTemplateIamInstanceProfileSpecificationRequest.md) 
+  [LaunchTemplateInstanceMaintenanceOptions](API_LaunchTemplateInstanceMaintenanceOptions.md) 
+  [LaunchTemplateInstanceMaintenanceOptionsRequest](API_LaunchTemplateInstanceMaintenanceOptionsRequest.md) 
+  [LaunchTemplateInstanceMarketOptions](API_LaunchTemplateInstanceMarketOptions.md) 
+  [LaunchTemplateInstanceMarketOptionsRequest](API_LaunchTemplateInstanceMarketOptionsRequest.md) 
+  [LaunchTemplateInstanceMetadataOptions](API_LaunchTemplateInstanceMetadataOptions.md) 
+  [LaunchTemplateInstanceMetadataOptionsRequest](API_LaunchTemplateInstanceMetadataOptionsRequest.md) 
+  [LaunchTemplateInstanceNetworkInterfaceSpecification](API_LaunchTemplateInstanceNetworkInterfaceSpecification.md) 
+  [LaunchTemplateInstanceNetworkInterfaceSpecificationRequest](API_LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.md) 
+  [LaunchTemplateInstanceSecondaryInterfaceSpecification](API_LaunchTemplateInstanceSecondaryInterfaceSpecification.md) 
+  [LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest](API_LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest.md) 
+  [LaunchTemplateLicenseConfiguration](API_LaunchTemplateLicenseConfiguration.md) 
+  [LaunchTemplateLicenseConfigurationRequest](API_LaunchTemplateLicenseConfigurationRequest.md) 
+  [LaunchTemplateNetworkPerformanceOptions](API_LaunchTemplateNetworkPerformanceOptions.md) 
+  [LaunchTemplateNetworkPerformanceOptionsRequest](API_LaunchTemplateNetworkPerformanceOptionsRequest.md) 
+  [LaunchTemplateOverrides](API_LaunchTemplateOverrides.md) 
+  [LaunchTemplatePlacement](API_LaunchTemplatePlacement.md) 
+  [LaunchTemplatePlacementRequest](API_LaunchTemplatePlacementRequest.md) 
+  [LaunchTemplatePrivateDnsNameOptions](API_LaunchTemplatePrivateDnsNameOptions.md) 
+  [LaunchTemplatePrivateDnsNameOptionsRequest](API_LaunchTemplatePrivateDnsNameOptionsRequest.md) 
+  [LaunchTemplatesMonitoring](API_LaunchTemplatesMonitoring.md) 
+  [LaunchTemplatesMonitoringRequest](API_LaunchTemplatesMonitoringRequest.md) 
+  [LaunchTemplateSpecification](API_LaunchTemplateSpecification.md) 
+  [LaunchTemplateSpotMarketOptions](API_LaunchTemplateSpotMarketOptions.md) 
+  [LaunchTemplateSpotMarketOptionsRequest](API_LaunchTemplateSpotMarketOptionsRequest.md) 
+  [LaunchTemplateTagSpecification](API_LaunchTemplateTagSpecification.md) 
+  [LaunchTemplateTagSpecificationRequest](API_LaunchTemplateTagSpecificationRequest.md) 
+  [LaunchTemplateVersion](API_LaunchTemplateVersion.md) 
+  [LicenseConfiguration](API_LicenseConfiguration.md) 
+  [LicenseConfigurationRequest](API_LicenseConfigurationRequest.md) 
+  [LoadBalancersConfig](API_LoadBalancersConfig.md) 
+  [LoadPermission](API_LoadPermission.md) 
+  [LoadPermissionModifications](API_LoadPermissionModifications.md) 
+  [LoadPermissionRequest](API_LoadPermissionRequest.md) 
+  [LocalGateway](API_LocalGateway.md) 
+  [LocalGatewayRoute](API_LocalGatewayRoute.md) 
+  [LocalGatewayRouteTable](API_LocalGatewayRouteTable.md) 
+  [LocalGatewayRouteTableVirtualInterfaceGroupAssociation](API_LocalGatewayRouteTableVirtualInterfaceGroupAssociation.md) 
+  [LocalGatewayRouteTableVpcAssociation](API_LocalGatewayRouteTableVpcAssociation.md) 
+  [LocalGatewayVirtualInterface](API_LocalGatewayVirtualInterface.md) 
+  [LocalGatewayVirtualInterfaceGroup](API_LocalGatewayVirtualInterfaceGroup.md) 
+  [LockedSnapshotsInfo](API_LockedSnapshotsInfo.md) 
+  [MacHost](API_MacHost.md) 
+  [MacModificationTask](API_MacModificationTask.md) 
+  [MacSystemIntegrityProtectionConfiguration](API_MacSystemIntegrityProtectionConfiguration.md) 
+  [MacSystemIntegrityProtectionConfigurationRequest](API_MacSystemIntegrityProtectionConfigurationRequest.md) 
+  [MaintenanceDetails](API_MaintenanceDetails.md) 
+  [ManagedPrefixList](API_ManagedPrefixList.md) 
+  [MediaAcceleratorInfo](API_MediaAcceleratorInfo.md) 
+  [MediaDeviceInfo](API_MediaDeviceInfo.md) 
+  [MediaDeviceMemoryInfo](API_MediaDeviceMemoryInfo.md) 
+  [MemoryGiBPerVCpu](API_MemoryGiBPerVCpu.md) 
+  [MemoryGiBPerVCpuRequest](API_MemoryGiBPerVCpuRequest.md) 
+  [MemoryInfo](API_MemoryInfo.md) 
+  [MemoryMiB](API_MemoryMiB.md) 
+  [MemoryMiBRequest](API_MemoryMiBRequest.md) 
+  [MetricDataResult](API_MetricDataResult.md) 
+  [MetricPoint](API_MetricPoint.md) 
+  [MetricValue](API_MetricValue.md) 
+  [ModifyTransitGatewayOptions](API_ModifyTransitGatewayOptions.md) 
+  [ModifyTransitGatewayVpcAttachmentRequestOptions](API_ModifyTransitGatewayVpcAttachmentRequestOptions.md) 
+  [ModifyVerifiedAccessEndpointCidrOptions](API_ModifyVerifiedAccessEndpointCidrOptions.md) 
+  [ModifyVerifiedAccessEndpointEniOptions](API_ModifyVerifiedAccessEndpointEniOptions.md) 
+  [ModifyVerifiedAccessEndpointLoadBalancerOptions](API_ModifyVerifiedAccessEndpointLoadBalancerOptions.md) 
+  [ModifyVerifiedAccessEndpointPortRange](API_ModifyVerifiedAccessEndpointPortRange.md) 
+  [ModifyVerifiedAccessEndpointRdsOptions](API_ModifyVerifiedAccessEndpointRdsOptions.md) 
+  [ModifyVerifiedAccessNativeApplicationOidcOptions](API_ModifyVerifiedAccessNativeApplicationOidcOptions.md) 
+  [ModifyVerifiedAccessTrustProviderDeviceOptions](API_ModifyVerifiedAccessTrustProviderDeviceOptions.md) 
+  [ModifyVerifiedAccessTrustProviderOidcOptions](API_ModifyVerifiedAccessTrustProviderOidcOptions.md) 
+  [ModifyVpnTunnelOptionsSpecification](API_ModifyVpnTunnelOptionsSpecification.md) 
+  [Monitoring](API_Monitoring.md) 
+  [MovingAddressStatus](API_MovingAddressStatus.md) 
+  [NatGateway](API_NatGateway.md) 
+  [NatGatewayAddress](API_NatGatewayAddress.md) 
+  [NatGatewayAttachedAppliance](API_NatGatewayAttachedAppliance.md) 
+  [NativeApplicationOidcOptions](API_NativeApplicationOidcOptions.md) 
+  [NetworkAcl](API_NetworkAcl.md) 
+  [NetworkAclAssociation](API_NetworkAclAssociation.md) 
+  [NetworkAclEntry](API_NetworkAclEntry.md) 
+  [NetworkBandwidthGbps](API_NetworkBandwidthGbps.md) 
+  [NetworkBandwidthGbpsRequest](API_NetworkBandwidthGbpsRequest.md) 
+  [NetworkCardInfo](API_NetworkCardInfo.md) 
+  [NetworkInfo](API_NetworkInfo.md) 
+  [NetworkInsightsAccessScope](API_NetworkInsightsAccessScope.md) 
+  [NetworkInsightsAccessScopeAnalysis](API_NetworkInsightsAccessScopeAnalysis.md) 
+  [NetworkInsightsAccessScopeContent](API_NetworkInsightsAccessScopeContent.md) 
+  [NetworkInsightsAnalysis](API_NetworkInsightsAnalysis.md) 
+  [NetworkInsightsPath](API_NetworkInsightsPath.md) 
+  [NetworkInterface](API_NetworkInterface.md) 
+  [NetworkInterfaceAssociation](API_NetworkInterfaceAssociation.md) 
+  [NetworkInterfaceAttachment](API_NetworkInterfaceAttachment.md) 
+  [NetworkInterfaceAttachmentChanges](API_NetworkInterfaceAttachmentChanges.md) 
+  [NetworkInterfaceCount](API_NetworkInterfaceCount.md) 
+  [NetworkInterfaceCountRequest](API_NetworkInterfaceCountRequest.md) 
+  [NetworkInterfaceIpv6Address](API_NetworkInterfaceIpv6Address.md) 
+  [NetworkInterfacePermission](API_NetworkInterfacePermission.md) 
+  [NetworkInterfacePermissionState](API_NetworkInterfacePermissionState.md) 
+  [NetworkInterfacePrivateIpAddress](API_NetworkInterfacePrivateIpAddress.md) 
+  [NeuronDeviceCoreInfo](API_NeuronDeviceCoreInfo.md) 
+  [NeuronDeviceInfo](API_NeuronDeviceInfo.md) 
+  [NeuronDeviceMemoryInfo](API_NeuronDeviceMemoryInfo.md) 
+  [NeuronInfo](API_NeuronInfo.md) 
+  [NewDhcpConfiguration](API_NewDhcpConfiguration.md) 
+  [NitroTpmInfo](API_NitroTpmInfo.md) 
+  [OidcOptions](API_OidcOptions.md) 
+  [OnDemandOptions](API_OnDemandOptions.md) 
+  [OnDemandOptionsRequest](API_OnDemandOptionsRequest.md) 
+  [OperatorRequest](API_OperatorRequest.md) 
+  [OperatorResponse](API_OperatorResponse.md) 
+  [OutpostLag](API_OutpostLag.md) 
+  [PacketHeaderStatement](API_PacketHeaderStatement.md) 
+  [PacketHeaderStatementRequest](API_PacketHeaderStatementRequest.md) 
+  [PathComponent](API_PathComponent.md) 
+  [PathFilter](API_PathFilter.md) 
+  [PathRequestFilter](API_PathRequestFilter.md) 
+  [PathStatement](API_PathStatement.md) 
+  [PathStatementRequest](API_PathStatementRequest.md) 
+  [PciId](API_PciId.md) 
+  [PeeringAttachmentStatus](API_PeeringAttachmentStatus.md) 
+  [PeeringConnectionOptions](API_PeeringConnectionOptions.md) 
+  [PeeringConnectionOptionsRequest](API_PeeringConnectionOptionsRequest.md) 
+  [PeeringTgwInfo](API_PeeringTgwInfo.md) 
+  [PerformanceFactorReference](API_PerformanceFactorReference.md) 
+  [PerformanceFactorReferenceRequest](API_PerformanceFactorReferenceRequest.md) 
+  [Phase1DHGroupNumbersListValue](API_Phase1DHGroupNumbersListValue.md) 
+  [Phase1DHGroupNumbersRequestListValue](API_Phase1DHGroupNumbersRequestListValue.md) 
+  [Phase1EncryptionAlgorithmsListValue](API_Phase1EncryptionAlgorithmsListValue.md) 
+  [Phase1EncryptionAlgorithmsRequestListValue](API_Phase1EncryptionAlgorithmsRequestListValue.md) 
+  [Phase1IntegrityAlgorithmsListValue](API_Phase1IntegrityAlgorithmsListValue.md) 
+  [Phase1IntegrityAlgorithmsRequestListValue](API_Phase1IntegrityAlgorithmsRequestListValue.md) 
+  [Phase2DHGroupNumbersListValue](API_Phase2DHGroupNumbersListValue.md) 
+  [Phase2DHGroupNumbersRequestListValue](API_Phase2DHGroupNumbersRequestListValue.md) 
+  [Phase2EncryptionAlgorithmsListValue](API_Phase2EncryptionAlgorithmsListValue.md) 
+  [Phase2EncryptionAlgorithmsRequestListValue](API_Phase2EncryptionAlgorithmsRequestListValue.md) 
+  [Phase2IntegrityAlgorithmsListValue](API_Phase2IntegrityAlgorithmsListValue.md) 
+  [Phase2IntegrityAlgorithmsRequestListValue](API_Phase2IntegrityAlgorithmsRequestListValue.md) 
+  [Placement](API_Placement.md) 
+  [PlacementGroup](API_PlacementGroup.md) 
+  [PlacementGroupInfo](API_PlacementGroupInfo.md) 
+  [PlacementResponse](API_PlacementResponse.md) 
+  [PoolCidrBlock](API_PoolCidrBlock.md) 
+  [PortRange](API_PortRange.md) 
+  [PrefixList](API_PrefixList.md) 
+  [PrefixListAssociation](API_PrefixListAssociation.md) 
+  [PrefixListEntry](API_PrefixListEntry.md) 
+  [PrefixListId](API_PrefixListId.md) 
+  [PriceSchedule](API_PriceSchedule.md) 
+  [PriceScheduleSpecification](API_PriceScheduleSpecification.md) 
+  [PricingDetail](API_PricingDetail.md) 
+  [PrincipalIdFormat](API_PrincipalIdFormat.md) 
+  [PrivateDnsDetails](API_PrivateDnsDetails.md) 
+  [PrivateDnsNameConfiguration](API_PrivateDnsNameConfiguration.md) 
+  [PrivateDnsNameOptionsOnLaunch](API_PrivateDnsNameOptionsOnLaunch.md) 
+  [PrivateDnsNameOptionsRequest](API_PrivateDnsNameOptionsRequest.md) 
+  [PrivateDnsNameOptionsResponse](API_PrivateDnsNameOptionsResponse.md) 
+  [PrivateIpAddressSpecification](API_PrivateIpAddressSpecification.md) 
+  [ProcessorInfo](API_ProcessorInfo.md) 
+  [ProductCode](API_ProductCode.md) 
+  [PropagatingVgw](API_PropagatingVgw.md) 
+  [ProvisionedBandwidth](API_ProvisionedBandwidth.md) 
+  [PtrUpdateStatus](API_PtrUpdateStatus.md) 
+  [PublicIpDnsNameOptions](API_PublicIpDnsNameOptions.md) 
+  [PublicIpv4Pool](API_PublicIpv4Pool.md) 
+  [PublicIpv4PoolRange](API_PublicIpv4PoolRange.md) 
+  [Purchase](API_Purchase.md) 
+  [PurchaseRequest](API_PurchaseRequest.md) 
+  [RecurringCharge](API_RecurringCharge.md) 
+  [ReferencedSecurityGroup](API_ReferencedSecurityGroup.md) 
+  [Region](API_Region.md) 
+  [RegionalSummary](API_RegionalSummary.md) 
+  [RegionGeography](API_RegionGeography.md) 
+  [RegisteredInstance](API_RegisteredInstance.md) 
+  [RegisterInstanceTagAttributeRequest](API_RegisterInstanceTagAttributeRequest.md) 
+  [RemoveIpamOperatingRegion](API_RemoveIpamOperatingRegion.md) 
+  [RemoveIpamOrganizationalUnitExclusion](API_RemoveIpamOrganizationalUnitExclusion.md) 
+  [RemovePrefixListEntry](API_RemovePrefixListEntry.md) 
+  [ReplaceRootVolumeTask](API_ReplaceRootVolumeTask.md) 
+  [RequestFilterPortRange](API_RequestFilterPortRange.md) 
+  [RequestIpamResourceTag](API_RequestIpamResourceTag.md) 
+  [RequestLaunchTemplateData](API_RequestLaunchTemplateData.md) 
+  [RequestSpotLaunchSpecification](API_RequestSpotLaunchSpecification.md) 
+  [Reservation](API_Reservation.md) 
+  [ReservationFleetInstanceSpecification](API_ReservationFleetInstanceSpecification.md) 
+  [ReservationValue](API_ReservationValue.md) 
+  [ReservedCapacityOptions](API_ReservedCapacityOptions.md) 
+  [ReservedCapacityOptionsRequest](API_ReservedCapacityOptionsRequest.md) 
+  [ReservedInstanceLimitPrice](API_ReservedInstanceLimitPrice.md) 
+  [ReservedInstanceReservationValue](API_ReservedInstanceReservationValue.md) 
+  [ReservedInstances](API_ReservedInstances.md) 
+  [ReservedInstancesConfiguration](API_ReservedInstancesConfiguration.md) 
+  [ReservedInstancesId](API_ReservedInstancesId.md) 
+  [ReservedInstancesListing](API_ReservedInstancesListing.md) 
+  [ReservedInstancesModification](API_ReservedInstancesModification.md) 
+  [ReservedInstancesModificationResult](API_ReservedInstancesModificationResult.md) 
+  [ReservedInstancesOffering](API_ReservedInstancesOffering.md) 
+  [ResourceStatement](API_ResourceStatement.md) 
+  [ResourceStatementRequest](API_ResourceStatementRequest.md) 
+  [ResourceTypeOption](API_ResourceTypeOption.md) 
+  [ResourceTypeRequest](API_ResourceTypeRequest.md) 
+  [ResponseError](API_ResponseError.md) 
+  [ResponseLaunchTemplateData](API_ResponseLaunchTemplateData.md) 
+  [RevokedSecurityGroupRule](API_RevokedSecurityGroupRule.md) 
+  [Route](API_Route.md) 
+  [RouteServer](API_RouteServer.md) 
+  [RouteServerAssociation](API_RouteServerAssociation.md) 
+  [RouteServerBfdStatus](API_RouteServerBfdStatus.md) 
+  [RouteServerBgpOptions](API_RouteServerBgpOptions.md) 
+  [RouteServerBgpOptionsRequest](API_RouteServerBgpOptionsRequest.md) 
+  [RouteServerBgpStatus](API_RouteServerBgpStatus.md) 
+  [RouteServerEndpoint](API_RouteServerEndpoint.md) 
+  [RouteServerPeer](API_RouteServerPeer.md) 
+  [RouteServerPropagation](API_RouteServerPropagation.md) 
+  [RouteServerRoute](API_RouteServerRoute.md) 
+  [RouteServerRouteInstallationDetail](API_RouteServerRouteInstallationDetail.md) 
+  [RouteTable](API_RouteTable.md) 
+  [RouteTableAssociation](API_RouteTableAssociation.md) 
+  [RouteTableAssociationState](API_RouteTableAssociationState.md) 
+  [RuleGroupRuleOptionsPair](API_RuleGroupRuleOptionsPair.md) 
+  [RuleGroupTypePair](API_RuleGroupTypePair.md) 
+  [RuleOption](API_RuleOption.md) 
+  [RunInstancesMonitoringEnabled](API_RunInstancesMonitoringEnabled.md) 
+  [S3ObjectTag](API_S3ObjectTag.md) 
+  [S3Storage](API_S3Storage.md) 
+  [ScheduledInstance](API_ScheduledInstance.md) 
+  [ScheduledInstanceAvailability](API_ScheduledInstanceAvailability.md) 
+  [ScheduledInstanceRecurrence](API_ScheduledInstanceRecurrence.md) 
+  [ScheduledInstanceRecurrenceRequest](API_ScheduledInstanceRecurrenceRequest.md) 
+  [ScheduledInstancesBlockDeviceMapping](API_ScheduledInstancesBlockDeviceMapping.md) 
+  [ScheduledInstancesEbs](API_ScheduledInstancesEbs.md) 
+  [ScheduledInstancesIamInstanceProfile](API_ScheduledInstancesIamInstanceProfile.md) 
+  [ScheduledInstancesIpv6Address](API_ScheduledInstancesIpv6Address.md) 
+  [ScheduledInstancesLaunchSpecification](API_ScheduledInstancesLaunchSpecification.md) 
+  [ScheduledInstancesMonitoring](API_ScheduledInstancesMonitoring.md) 
+  [ScheduledInstancesNetworkInterface](API_ScheduledInstancesNetworkInterface.md) 
+  [ScheduledInstancesPlacement](API_ScheduledInstancesPlacement.md) 
+  [ScheduledInstancesPrivateIpAddressConfig](API_ScheduledInstancesPrivateIpAddressConfig.md) 
+  [SecondaryInterface](API_SecondaryInterface.md) 
+  [SecondaryInterfaceAttachment](API_SecondaryInterfaceAttachment.md) 
+  [SecondaryInterfaceIpv4Address](API_SecondaryInterfaceIpv4Address.md) 
+  [SecondaryInterfacePrivateIpAddressSpecification](API_SecondaryInterfacePrivateIpAddressSpecification.md) 
+  [SecondaryInterfacePrivateIpAddressSpecificationRequest](API_SecondaryInterfacePrivateIpAddressSpecificationRequest.md) 
+  [SecondaryNetwork](API_SecondaryNetwork.md) 
+  [SecondaryNetworkIpv4CidrBlockAssociation](API_SecondaryNetworkIpv4CidrBlockAssociation.md) 
+  [SecondarySubnet](API_SecondarySubnet.md) 
+  [SecondarySubnetIpv4CidrBlockAssociation](API_SecondarySubnetIpv4CidrBlockAssociation.md) 
+  [SecurityGroup](API_SecurityGroup.md) 
+  [SecurityGroupForVpc](API_SecurityGroupForVpc.md) 
+  [SecurityGroupIdentifier](API_SecurityGroupIdentifier.md) 
+  [SecurityGroupReference](API_SecurityGroupReference.md) 
+  [SecurityGroupRule](API_SecurityGroupRule.md) 
+  [SecurityGroupRuleDescription](API_SecurityGroupRuleDescription.md) 
+  [SecurityGroupRuleRequest](API_SecurityGroupRuleRequest.md) 
+  [SecurityGroupRuleUpdate](API_SecurityGroupRuleUpdate.md) 
+  [SecurityGroupVpcAssociation](API_SecurityGroupVpcAssociation.md) 
+  [ServiceConfiguration](API_ServiceConfiguration.md) 
+  [ServiceDetail](API_ServiceDetail.md) 
+  [ServiceLinkVirtualInterface](API_ServiceLinkVirtualInterface.md) 
+  [ServiceTypeDetail](API_ServiceTypeDetail.md) 
+  [SlotDateTimeRangeRequest](API_SlotDateTimeRangeRequest.md) 
+  [SlotStartTimeRangeRequest](API_SlotStartTimeRangeRequest.md) 
+  [Snapshot](API_Snapshot.md) 
+  [SnapshotDetail](API_SnapshotDetail.md) 
+  [SnapshotDiskContainer](API_SnapshotDiskContainer.md) 
+  [SnapshotInfo](API_SnapshotInfo.md) 
+  [SnapshotRecycleBinInfo](API_SnapshotRecycleBinInfo.md) 
+  [SnapshotTaskDetail](API_SnapshotTaskDetail.md) 
+  [SnapshotTierStatus](API_SnapshotTierStatus.md) 
+  [SpotCapacityRebalance](API_SpotCapacityRebalance.md) 
+  [SpotDatafeedSubscription](API_SpotDatafeedSubscription.md) 
+  [SpotFleetLaunchSpecification](API_SpotFleetLaunchSpecification.md) 
+  [SpotFleetMonitoring](API_SpotFleetMonitoring.md) 
+  [SpotFleetRequestConfig](API_SpotFleetRequestConfig.md) 
+  [SpotFleetRequestConfigData](API_SpotFleetRequestConfigData.md) 
+  [SpotFleetTagSpecification](API_SpotFleetTagSpecification.md) 
+  [SpotInstanceRequest](API_SpotInstanceRequest.md) 
+  [SpotInstanceStateFault](API_SpotInstanceStateFault.md) 
+  [SpotInstanceStatus](API_SpotInstanceStatus.md) 
+  [SpotMaintenanceStrategies](API_SpotMaintenanceStrategies.md) 
+  [SpotMarketOptions](API_SpotMarketOptions.md) 
+  [SpotOptions](API_SpotOptions.md) 
+  [SpotOptionsRequest](API_SpotOptionsRequest.md) 
+  [SpotPlacement](API_SpotPlacement.md) 
+  [SpotPlacementScore](API_SpotPlacementScore.md) 
+  [SpotPrice](API_SpotPrice.md) 
+  [StaleIpPermission](API_StaleIpPermission.md) 
+  [StaleSecurityGroup](API_StaleSecurityGroup.md) 
+  [StateReason](API_StateReason.md) 
+  [Storage](API_Storage.md) 
+  [StorageLocation](API_StorageLocation.md) 
+  [StoreImageTaskResult](API_StoreImageTaskResult.md) 
+  [Subnet](API_Subnet.md) 
+  [SubnetAssociation](API_SubnetAssociation.md) 
+  [SubnetCidrBlockState](API_SubnetCidrBlockState.md) 
+  [SubnetCidrReservation](API_SubnetCidrReservation.md) 
+  [SubnetConfiguration](API_SubnetConfiguration.md) 
+  [SubnetIpPrefixes](API_SubnetIpPrefixes.md) 
+  [SubnetIpv6CidrBlockAssociation](API_SubnetIpv6CidrBlockAssociation.md) 
+  [Subscription](API_Subscription.md) 
+  [SuccessfulInstanceCreditSpecificationItem](API_SuccessfulInstanceCreditSpecificationItem.md) 
+  [SuccessfulQueuedPurchaseDeletion](API_SuccessfulQueuedPurchaseDeletion.md) 
+  [SupportedRegionDetail](API_SupportedRegionDetail.md) 
+  [Tag](API_Tag.md) 
+  [TagDescription](API_TagDescription.md) 
+  [TagSpecification](API_TagSpecification.md) 
+  [TargetCapacitySpecification](API_TargetCapacitySpecification.md) 
+  [TargetCapacitySpecificationRequest](API_TargetCapacitySpecificationRequest.md) 
+  [TargetConfiguration](API_TargetConfiguration.md) 
+  [TargetConfigurationRequest](API_TargetConfigurationRequest.md) 
+  [TargetGroup](API_TargetGroup.md) 
+  [TargetGroupsConfig](API_TargetGroupsConfig.md) 
+  [TargetNetwork](API_TargetNetwork.md) 
+  [TargetReservationValue](API_TargetReservationValue.md) 
+  [TerminateConnectionStatus](API_TerminateConnectionStatus.md) 
+  [ThroughResourcesStatement](API_ThroughResourcesStatement.md) 
+  [ThroughResourcesStatementRequest](API_ThroughResourcesStatementRequest.md) 
+  [TotalLocalStorageGB](API_TotalLocalStorageGB.md) 
+  [TotalLocalStorageGBRequest](API_TotalLocalStorageGBRequest.md) 
+  [TrafficMirrorFilter](API_TrafficMirrorFilter.md) 
+  [TrafficMirrorFilterRule](API_TrafficMirrorFilterRule.md) 
+  [TrafficMirrorPortRange](API_TrafficMirrorPortRange.md) 
+  [TrafficMirrorPortRangeRequest](API_TrafficMirrorPortRangeRequest.md) 
+  [TrafficMirrorSession](API_TrafficMirrorSession.md) 
+  [TrafficMirrorTarget](API_TrafficMirrorTarget.md) 
+  [TransitGateway](API_TransitGateway.md) 
+  [TransitGatewayAssociation](API_TransitGatewayAssociation.md) 
+  [TransitGatewayAttachment](API_TransitGatewayAttachment.md) 
+  [TransitGatewayAttachmentAssociation](API_TransitGatewayAttachmentAssociation.md) 
+  [TransitGatewayAttachmentBgpConfiguration](API_TransitGatewayAttachmentBgpConfiguration.md) 
+  [TransitGatewayAttachmentPropagation](API_TransitGatewayAttachmentPropagation.md) 
+  [TransitGatewayConnect](API_TransitGatewayConnect.md) 
+  [TransitGatewayConnectOptions](API_TransitGatewayConnectOptions.md) 
+  [TransitGatewayConnectPeer](API_TransitGatewayConnectPeer.md) 
+  [TransitGatewayConnectPeerConfiguration](API_TransitGatewayConnectPeerConfiguration.md) 
+  [TransitGatewayConnectRequestBgpOptions](API_TransitGatewayConnectRequestBgpOptions.md) 
+  [TransitGatewayMeteringPolicy](API_TransitGatewayMeteringPolicy.md) 
+  [TransitGatewayMeteringPolicyEntry](API_TransitGatewayMeteringPolicyEntry.md) 
+  [TransitGatewayMeteringPolicyRule](API_TransitGatewayMeteringPolicyRule.md) 
+  [TransitGatewayMulticastDeregisteredGroupMembers](API_TransitGatewayMulticastDeregisteredGroupMembers.md) 
+  [TransitGatewayMulticastDeregisteredGroupSources](API_TransitGatewayMulticastDeregisteredGroupSources.md) 
+  [TransitGatewayMulticastDomain](API_TransitGatewayMulticastDomain.md) 
+  [TransitGatewayMulticastDomainAssociation](API_TransitGatewayMulticastDomainAssociation.md) 
+  [TransitGatewayMulticastDomainAssociations](API_TransitGatewayMulticastDomainAssociations.md) 
+  [TransitGatewayMulticastDomainOptions](API_TransitGatewayMulticastDomainOptions.md) 
+  [TransitGatewayMulticastGroup](API_TransitGatewayMulticastGroup.md) 
+  [TransitGatewayMulticastRegisteredGroupMembers](API_TransitGatewayMulticastRegisteredGroupMembers.md) 
+  [TransitGatewayMulticastRegisteredGroupSources](API_TransitGatewayMulticastRegisteredGroupSources.md) 
+  [TransitGatewayOptions](API_TransitGatewayOptions.md) 
+  [TransitGatewayPeeringAttachment](API_TransitGatewayPeeringAttachment.md) 
+  [TransitGatewayPeeringAttachmentOptions](API_TransitGatewayPeeringAttachmentOptions.md) 
+  [TransitGatewayPolicyRule](API_TransitGatewayPolicyRule.md) 
+  [TransitGatewayPolicyRuleMetaData](API_TransitGatewayPolicyRuleMetaData.md) 
+  [TransitGatewayPolicyTable](API_TransitGatewayPolicyTable.md) 
+  [TransitGatewayPolicyTableAssociation](API_TransitGatewayPolicyTableAssociation.md) 
+  [TransitGatewayPolicyTableEntry](API_TransitGatewayPolicyTableEntry.md) 
+  [TransitGatewayPrefixListAttachment](API_TransitGatewayPrefixListAttachment.md) 
+  [TransitGatewayPrefixListReference](API_TransitGatewayPrefixListReference.md) 
+  [TransitGatewayPropagation](API_TransitGatewayPropagation.md) 
+  [TransitGatewayRequestOptions](API_TransitGatewayRequestOptions.md) 
+  [TransitGatewayRoute](API_TransitGatewayRoute.md) 
+  [TransitGatewayRouteAttachment](API_TransitGatewayRouteAttachment.md) 
+  [TransitGatewayRouteTable](API_TransitGatewayRouteTable.md) 
+  [TransitGatewayRouteTableAnnouncement](API_TransitGatewayRouteTableAnnouncement.md) 
+  [TransitGatewayRouteTableAssociation](API_TransitGatewayRouteTableAssociation.md) 
+  [TransitGatewayRouteTablePropagation](API_TransitGatewayRouteTablePropagation.md) 
+  [TransitGatewayRouteTableRoute](API_TransitGatewayRouteTableRoute.md) 
+  [TransitGatewayVpcAttachment](API_TransitGatewayVpcAttachment.md) 
+  [TransitGatewayVpcAttachmentOptions](API_TransitGatewayVpcAttachmentOptions.md) 
+  [TrunkInterfaceAssociation](API_TrunkInterfaceAssociation.md) 
+  [TunnelOption](API_TunnelOption.md) 
+  [UnsuccessfulInstanceCreditSpecificationItem](API_UnsuccessfulInstanceCreditSpecificationItem.md) 
+  [UnsuccessfulInstanceCreditSpecificationItemError](API_UnsuccessfulInstanceCreditSpecificationItemError.md) 
+  [UnsuccessfulItem](API_UnsuccessfulItem.md) 
+  [UnsuccessfulItemError](API_UnsuccessfulItemError.md) 
+  [UserBucket](API_UserBucket.md) 
+  [UserBucketDetails](API_UserBucketDetails.md) 
+  [UserData](API_UserData.md) 
+  [UserIdGroupPair](API_UserIdGroupPair.md) 
+  [ValidationError](API_ValidationError.md) 
+  [ValidationWarning](API_ValidationWarning.md) 
+  [VCpuCountRange](API_VCpuCountRange.md) 
+  [VCpuCountRangeRequest](API_VCpuCountRangeRequest.md) 
+  [VCpuInfo](API_VCpuInfo.md) 
+  [VerifiedAccessEndpoint](API_VerifiedAccessEndpoint.md) 
+  [VerifiedAccessEndpointCidrOptions](API_VerifiedAccessEndpointCidrOptions.md) 
+  [VerifiedAccessEndpointEniOptions](API_VerifiedAccessEndpointEniOptions.md) 
+  [VerifiedAccessEndpointLoadBalancerOptions](API_VerifiedAccessEndpointLoadBalancerOptions.md) 
+  [VerifiedAccessEndpointPortRange](API_VerifiedAccessEndpointPortRange.md) 
+  [VerifiedAccessEndpointRdsOptions](API_VerifiedAccessEndpointRdsOptions.md) 
+  [VerifiedAccessEndpointStatus](API_VerifiedAccessEndpointStatus.md) 
+  [VerifiedAccessEndpointTarget](API_VerifiedAccessEndpointTarget.md) 
+  [VerifiedAccessGroup](API_VerifiedAccessGroup.md) 
+  [VerifiedAccessInstance](API_VerifiedAccessInstance.md) 
+  [VerifiedAccessInstanceCustomSubDomain](API_VerifiedAccessInstanceCustomSubDomain.md) 
+  [VerifiedAccessInstanceLoggingConfiguration](API_VerifiedAccessInstanceLoggingConfiguration.md) 
+  [VerifiedAccessInstanceOpenVpnClientConfiguration](API_VerifiedAccessInstanceOpenVpnClientConfiguration.md) 
+  [VerifiedAccessInstanceOpenVpnClientConfigurationRoute](API_VerifiedAccessInstanceOpenVpnClientConfigurationRoute.md) 
+  [VerifiedAccessInstanceUserTrustProviderClientConfiguration](API_VerifiedAccessInstanceUserTrustProviderClientConfiguration.md) 
+  [VerifiedAccessLogCloudWatchLogsDestination](API_VerifiedAccessLogCloudWatchLogsDestination.md) 
+  [VerifiedAccessLogCloudWatchLogsDestinationOptions](API_VerifiedAccessLogCloudWatchLogsDestinationOptions.md) 
+  [VerifiedAccessLogDeliveryStatus](API_VerifiedAccessLogDeliveryStatus.md) 
+  [VerifiedAccessLogKinesisDataFirehoseDestination](API_VerifiedAccessLogKinesisDataFirehoseDestination.md) 
+  [VerifiedAccessLogKinesisDataFirehoseDestinationOptions](API_VerifiedAccessLogKinesisDataFirehoseDestinationOptions.md) 
+  [VerifiedAccessLogOptions](API_VerifiedAccessLogOptions.md) 
+  [VerifiedAccessLogs](API_VerifiedAccessLogs.md) 
+  [VerifiedAccessLogS3Destination](API_VerifiedAccessLogS3Destination.md) 
+  [VerifiedAccessLogS3DestinationOptions](API_VerifiedAccessLogS3DestinationOptions.md) 
+  [VerifiedAccessSseSpecificationRequest](API_VerifiedAccessSseSpecificationRequest.md) 
+  [VerifiedAccessSseSpecificationResponse](API_VerifiedAccessSseSpecificationResponse.md) 
+  [VerifiedAccessTrustProvider](API_VerifiedAccessTrustProvider.md) 
+  [VerifiedAccessTrustProviderCondensed](API_VerifiedAccessTrustProviderCondensed.md) 
+  [VgwTelemetry](API_VgwTelemetry.md) 
+  [Volume](API_Volume.md) 
+  [VolumeAttachment](API_VolumeAttachment.md) 
+  [VolumeDetail](API_VolumeDetail.md) 
+  [VolumeModification](API_VolumeModification.md) 
+  [VolumeRecycleBinInfo](API_VolumeRecycleBinInfo.md) 
+  [VolumeStatusAction](API_VolumeStatusAction.md) 
+  [VolumeStatusAttachmentStatus](API_VolumeStatusAttachmentStatus.md) 
+  [VolumeStatusDetails](API_VolumeStatusDetails.md) 
+  [VolumeStatusEvent](API_VolumeStatusEvent.md) 
+  [VolumeStatusInfo](API_VolumeStatusInfo.md) 
+  [VolumeStatusItem](API_VolumeStatusItem.md) 
+  [Vpc](API_Vpc.md) 
+  [VpcAttachment](API_VpcAttachment.md) 
+  [VpcBlockPublicAccessExclusion](API_VpcBlockPublicAccessExclusion.md) 
+  [VpcBlockPublicAccessOptions](API_VpcBlockPublicAccessOptions.md) 
+  [VpcCidrBlockAssociation](API_VpcCidrBlockAssociation.md) 
+  [VpcCidrBlockState](API_VpcCidrBlockState.md) 
+  [VpcClassicLink](API_VpcClassicLink.md) 
+  [VpcEncryptionControl](API_VpcEncryptionControl.md) 
+  [VpcEncryptionControlConfiguration](API_VpcEncryptionControlConfiguration.md) 
+  [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) 
+  [VpcEncryptionControlExclusions](API_VpcEncryptionControlExclusions.md) 
+  [VpcEncryptionNonCompliantResource](API_VpcEncryptionNonCompliantResource.md) 
+  [VpcEndpoint](API_VpcEndpoint.md) 
+  [VpcEndpointAssociation](API_VpcEndpointAssociation.md) 
+  [VpcEndpointConnection](API_VpcEndpointConnection.md) 
+  [VpcIpv6CidrBlockAssociation](API_VpcIpv6CidrBlockAssociation.md) 
+  [VpcPeeringConnection](API_VpcPeeringConnection.md) 
+  [VpcPeeringConnectionOptionsDescription](API_VpcPeeringConnectionOptionsDescription.md) 
+  [VpcPeeringConnectionStateReason](API_VpcPeeringConnectionStateReason.md) 
+  [VpcPeeringConnectionVpcInfo](API_VpcPeeringConnectionVpcInfo.md) 
+  [VpnConcentrator](API_VpnConcentrator.md) 
+  [VpnConnection](API_VpnConnection.md) 
+  [VpnConnectionDeviceType](API_VpnConnectionDeviceType.md) 
+  [VpnConnectionOptions](API_VpnConnectionOptions.md) 
+  [VpnConnectionOptionsSpecification](API_VpnConnectionOptionsSpecification.md) 
+  [VpnGateway](API_VpnGateway.md) 
+  [VpnStaticRoute](API_VpnStaticRoute.md) 
+  [VpnTunnelLogOptions](API_VpnTunnelLogOptions.md) 
+  [VpnTunnelLogOptionsSpecification](API_VpnTunnelLogOptionsSpecification.md) 
+  [VpnTunnelOptionsSpecification](API_VpnTunnelOptionsSpecification.md) 

# AcceleratorCount
<a name="API_AcceleratorCount"></a>

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.

## Contents
<a name="API_AcceleratorCount_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum number of accelerators. If this parameter is not specified, there is no maximum limit.  
Type: Integer  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum number of accelerators. If this parameter is not specified, there is no minimum limit.  
Type: Integer  
Required: No

## See Also
<a name="API_AcceleratorCount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceleratorCount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceleratorCount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceleratorCount) 

# AcceleratorCountRequest
<a name="API_AcceleratorCountRequest"></a>

The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance. To exclude accelerator-enabled instance types, set `Max` to `0`.

## Contents
<a name="API_AcceleratorCountRequest_Contents"></a>

 ** Max **   
The maximum number of accelerators. To specify no maximum limit, omit this parameter. To exclude accelerator-enabled instance types, set `Max` to `0`.  
Type: Integer  
Required: No

 ** Min **   
The minimum number of accelerators. To specify no minimum limit, omit this parameter.  
Type: Integer  
Required: No

## See Also
<a name="API_AcceleratorCountRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceleratorCountRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceleratorCountRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceleratorCountRequest) 

# AcceleratorTotalMemoryMiB
<a name="API_AcceleratorTotalMemoryMiB"></a>

The minimum and maximum amount of total accelerator memory, in MiB.

## Contents
<a name="API_AcceleratorTotalMemoryMiB_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum amount of accelerator memory, in MiB. If this parameter is not specified, there is no maximum limit.  
Type: Integer  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum amount of accelerator memory, in MiB. If this parameter is not specified, there is no minimum limit.  
Type: Integer  
Required: No

## See Also
<a name="API_AcceleratorTotalMemoryMiB_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceleratorTotalMemoryMiB) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceleratorTotalMemoryMiB) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceleratorTotalMemoryMiB) 

# AcceleratorTotalMemoryMiBRequest
<a name="API_AcceleratorTotalMemoryMiBRequest"></a>

The minimum and maximum amount of total accelerator memory, in MiB.

## Contents
<a name="API_AcceleratorTotalMemoryMiBRequest_Contents"></a>

 ** Max **   
The maximum amount of accelerator memory, in MiB. To specify no maximum limit, omit this parameter.  
Type: Integer  
Required: No

 ** Min **   
The minimum amount of accelerator memory, in MiB. To specify no minimum limit, omit this parameter.  
Type: Integer  
Required: No

## See Also
<a name="API_AcceleratorTotalMemoryMiBRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AcceleratorTotalMemoryMiBRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AcceleratorTotalMemoryMiBRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AcceleratorTotalMemoryMiBRequest) 

# AccessScopeAnalysisFinding
<a name="API_AccessScopeAnalysisFinding"></a>

Describes a finding for a Network Access Scope.

## Contents
<a name="API_AccessScopeAnalysisFinding_Contents"></a>

 ** FindingComponentSet.N **   
The finding components.  
Type: Array of [PathComponent](API_PathComponent.md) objects  
Required: No

 ** findingId **   
The ID of the finding.  
Type: String  
Required: No

 ** networkInsightsAccessScopeAnalysisId **   
The ID of the Network Access Scope analysis.  
Type: String  
Required: No

 ** networkInsightsAccessScopeId **   
The ID of the Network Access Scope.  
Type: String  
Required: No

## See Also
<a name="API_AccessScopeAnalysisFinding_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AccessScopeAnalysisFinding) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AccessScopeAnalysisFinding) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AccessScopeAnalysisFinding) 

# AccessScopePath
<a name="API_AccessScopePath"></a>

Describes a path.

## Contents
<a name="API_AccessScopePath_Contents"></a>

 ** destination **   
The destination.  
Type: [PathStatement](API_PathStatement.md) object  
Required: No

 ** source **   
The source.  
Type: [PathStatement](API_PathStatement.md) object  
Required: No

 ** ThroughResourceSet.N **   
The through resources.  
Type: Array of [ThroughResourcesStatement](API_ThroughResourcesStatement.md) objects  
Required: No

## See Also
<a name="API_AccessScopePath_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AccessScopePath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AccessScopePath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AccessScopePath) 

# AccessScopePathRequest
<a name="API_AccessScopePathRequest"></a>

Describes a path.

## Contents
<a name="API_AccessScopePathRequest_Contents"></a>

 ** Destination **   
The destination.  
Type: [PathStatementRequest](API_PathStatementRequest.md) object  
Required: No

 ** Source **   
The source.  
Type: [PathStatementRequest](API_PathStatementRequest.md) object  
Required: No

 ** ThroughResource.N **   
The through resources.  
Type: Array of [ThroughResourcesStatementRequest](API_ThroughResourcesStatementRequest.md) objects  
Required: No

## See Also
<a name="API_AccessScopePathRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AccessScopePathRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AccessScopePathRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AccessScopePathRequest) 

# AccountAttribute
<a name="API_AccountAttribute"></a>

Describes an account attribute.

## Contents
<a name="API_AccountAttribute_Contents"></a>

 ** attributeName **   
The name of the account attribute.  
Type: String  
Required: No

 ** AttributeValueSet.N **   
The values for the account attribute.  
Type: Array of [AccountAttributeValue](API_AccountAttributeValue.md) objects  
Required: No

## See Also
<a name="API_AccountAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AccountAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AccountAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AccountAttribute) 

# AccountAttributeValue
<a name="API_AccountAttributeValue"></a>

Describes a value of an account attribute.

## Contents
<a name="API_AccountAttributeValue_Contents"></a>

 ** attributeValue **   
The value of the attribute.  
Type: String  
Required: No

## See Also
<a name="API_AccountAttributeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AccountAttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AccountAttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AccountAttributeValue) 

# ActiveInstance
<a name="API_ActiveInstance"></a>

Describes a running instance in a Spot Fleet.

## Contents
<a name="API_ActiveInstance_Contents"></a>

 ** instanceHealth **   
The health status of the instance. If the status of either the instance status check or the system status check is `impaired`, the health status of the instance is `unhealthy`. Otherwise, the health status is `healthy`.  
Type: String  
Valid Values: `healthy | unhealthy`   
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** instanceType **   
The instance type.  
Type: String  
Required: No

 ** spotInstanceRequestId **   
The ID of the Spot Instance request.  
Type: String  
Required: No

## See Also
<a name="API_ActiveInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ActiveInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ActiveInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ActiveInstance) 

# ActiveVpnTunnelStatus
<a name="API_ActiveVpnTunnelStatus"></a>

Contains information about the current security configuration of an active VPN tunnel.

## Contents
<a name="API_ActiveVpnTunnelStatus_Contents"></a>

 ** ikeVersion **   
The version of the Internet Key Exchange (IKE) protocol being used.  
Type: String  
Required: No

 ** phase1DHGroup **   
The Diffie-Hellman group number being used in Phase 1 IKE negotiations.  
Type: Integer  
Required: No

 ** phase1EncryptionAlgorithm **   
The encryption algorithm negotiated in Phase 1 IKE negotiations.  
Type: String  
Required: No

 ** phase1IntegrityAlgorithm **   
The integrity algorithm negotiated in Phase 1 IKE negotiations.  
Type: String  
Required: No

 ** phase2DHGroup **   
The Diffie-Hellman group number being used in Phase 2 IKE negotiations.  
Type: Integer  
Required: No

 ** phase2EncryptionAlgorithm **   
The encryption algorithm negotiated in Phase 2 IKE negotiations.  
Type: String  
Required: No

 ** phase2IntegrityAlgorithm **   
The integrity algorithm negotiated in Phase 2 IKE negotiations.  
Type: String  
Required: No

 ** provisioningStatus **   
The current provisioning status of the VPN tunnel.  
Type: String  
Valid Values: `available | pending | failed`   
Required: No

 ** provisioningStatusReason **   
The reason for the current provisioning status.  
Type: String  
Required: No

## See Also
<a name="API_ActiveVpnTunnelStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ActiveVpnTunnelStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ActiveVpnTunnelStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ActiveVpnTunnelStatus) 

# AddedPrincipal
<a name="API_AddedPrincipal"></a>

Describes a principal.

## Contents
<a name="API_AddedPrincipal_Contents"></a>

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

 ** principalType **   
The type of principal.  
Type: String  
Valid Values: `All | Service | OrganizationUnit | Account | User | Role`   
Required: No

 ** serviceId **   
The ID of the service.  
Type: String  
Required: No

 ** servicePermissionId **   
The ID of the service permission.  
Type: String  
Required: No

## See Also
<a name="API_AddedPrincipal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AddedPrincipal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AddedPrincipal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AddedPrincipal) 

# AddIpamOperatingRegion
<a name="API_AddIpamOperatingRegion"></a>

Add an operating Region to an 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*. 

## Contents
<a name="API_AddIpamOperatingRegion_Contents"></a>

 ** RegionName **   
The name of the operating Region.  
Type: String  
Required: No

## See Also
<a name="API_AddIpamOperatingRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AddIpamOperatingRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AddIpamOperatingRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AddIpamOperatingRegion) 

# AddIpamOrganizationalUnitExclusion
<a name="API_AddIpamOrganizationalUnitExclusion"></a>

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*.

## Contents
<a name="API_AddIpamOrganizationalUnitExclusion_Contents"></a>

 ** OrganizationsEntityPath **   
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a `/`. Include all child OUs by ending the path with `/*`.  
+ Example 1
  + Path to a child OU: `o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/` 
  + In this example, `o-a1b2c3d4e5` is the organization ID, `r-f6g7h8i9j0example` is the root ID , `ou-ghi0-awsccccc` is an OU ID, and `ou-jkl0-awsddddd` is a child OU ID.
  + IPAM will not manage the IP addresses in accounts in the child OU.
+ Example 2
  + Path where all child OUs will be part of the exclusion: `o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*` 
  + In this example, IPAM will not manage the IP addresses in accounts in the OU (`ou-ghi0-awsccccc`) or in accounts in any OUs that are children of the OU.
For more information on how to construct an entity path, see [Understand the AWS Organizations entity path](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_last-accessed-view-data-orgs.html#access_policies_access-advisor-viewing-orgs-entity-path) in the * AWS Identity and Access Management User Guide*.  
Type: String  
Required: No

## See Also
<a name="API_AddIpamOrganizationalUnitExclusion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AddIpamOrganizationalUnitExclusion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AddIpamOrganizationalUnitExclusion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AddIpamOrganizationalUnitExclusion) 

# AdditionalDetail
<a name="API_AdditionalDetail"></a>

Describes an additional detail for a path analysis. For more information, see [Reachability Analyzer additional detail codes](https://docs.aws.amazon.com/vpc/latest/reachability/additional-detail-codes.html).

## Contents
<a name="API_AdditionalDetail_Contents"></a>

 ** additionalDetailType **   
The additional detail code.  
Type: String  
Required: No

 ** component **   
The path component.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** LoadBalancerSet.N **   
The load balancers.  
Type: Array of [AnalysisComponent](API_AnalysisComponent.md) objects  
Required: No

 ** RuleGroupRuleOptionsPairSet.N **   
The rule options.  
Type: Array of [RuleGroupRuleOptionsPair](API_RuleGroupRuleOptionsPair.md) objects  
Required: No

 ** RuleGroupTypePairSet.N **   
The rule group type.  
Type: Array of [RuleGroupTypePair](API_RuleGroupTypePair.md) objects  
Required: No

 ** RuleOptionSet.N **   
The rule options.  
Type: Array of [RuleOption](API_RuleOption.md) objects  
Required: No

 ** serviceName **   
The name of the VPC endpoint service.  
Type: String  
Required: No

 ** vpcEndpointService **   
The VPC endpoint service.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

## See Also
<a name="API_AdditionalDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AdditionalDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AdditionalDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AdditionalDetail) 

# AddPrefixListEntry
<a name="API_AddPrefixListEntry"></a>

An entry for a prefix list.

## Contents
<a name="API_AddPrefixListEntry_Contents"></a>

 ** Cidr **   
The CIDR block.  
Type: String  
Required: Yes

 ** Description **   
A description for the entry.  
Constraints: Up to 255 characters in length.  
Type: String  
Required: No

## See Also
<a name="API_AddPrefixListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AddPrefixListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AddPrefixListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AddPrefixListEntry) 

# Address
<a name="API_Address"></a>

Describes an Elastic IP address, or a carrier IP address.

## Contents
<a name="API_Address_Contents"></a>

 ** allocationId **   
The ID representing the allocation of the address.  
Type: String  
Required: No

 ** associationId **   
The ID representing the association of the address with an instance.  
Type: String  
Required: No

 ** carrierIp **   
The carrier IP address associated. This option is only available for network interfaces which reside in a subnet in a Wavelength Zone (for example an EC2 instance).   
Type: String  
Required: No

 ** customerOwnedIp **   
The customer-owned IP address.  
Type: String  
Required: No

 ** customerOwnedIpv4Pool **   
The ID of the customer-owned address pool.  
Type: String  
Required: No

 ** domain **   
The network (`vpc`).  
Type: String  
Valid Values: `vpc | standard`   
Required: No

 ** instanceId **   
The ID of the instance that the address is associated with (if any).  
Type: String  
Required: No

 ** networkBorderGroup **   
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses.  
Type: String  
Required: No

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

 ** networkInterfaceOwnerId **   
The ID of the AWS account that owns the network interface.  
Type: String  
Required: No

 ** privateIpAddress **   
The private IP address associated with the Elastic IP address.  
Type: String  
Required: No

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

 ** publicIpv4Pool **   
The ID of an address pool.  
Type: String  
Required: No

 ** serviceManaged **   
The service that manages the elastic IP address.  
The only option supported today is `alb`.
Type: String  
Valid Values: `alb | nlb | rnat | rds`   
Required: No

 ** subnetId **   
The ID of the subnet where the IP address is allocated.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the Elastic IP address.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_Address_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Address) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Address) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Address) 

# AddressAttribute
<a name="API_AddressAttribute"></a>

The attributes associated with an Elastic IP address.

## Contents
<a name="API_AddressAttribute_Contents"></a>

 ** allocationId **   
[EC2-VPC] The allocation ID.  
Type: String  
Required: No

 ** ptrRecord **   
The pointer (PTR) record for the IP address.  
Type: String  
Required: No

 ** ptrRecordUpdate **   
The updated PTR record for the IP address.  
Type: [PtrUpdateStatus](API_PtrUpdateStatus.md) object  
Required: No

 ** publicIp **   
The public IP address.  
Type: String  
Required: No

## See Also
<a name="API_AddressAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AddressAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AddressAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AddressAttribute) 

# AddressTransfer
<a name="API_AddressTransfer"></a>

Details on the 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*.

## Contents
<a name="API_AddressTransfer_Contents"></a>

 ** addressTransferStatus **   
The Elastic IP address transfer status.  
Type: String  
Valid Values: `pending | disabled | accepted`   
Required: No

 ** allocationId **   
The allocation ID of an Elastic IP address.  
Type: String  
Required: No

 ** publicIp **   
The Elastic IP address being transferred.  
Type: String  
Required: No

 ** transferAccountId **   
The ID of the account that you want to transfer the Elastic IP address to.  
Type: String  
Required: No

 ** transferOfferAcceptedTimestamp **   
The timestamp when the Elastic IP address transfer was accepted.  
Type: Timestamp  
Required: No

 ** transferOfferExpirationTimestamp **   
The timestamp when the Elastic IP address transfer expired. When the source account starts the transfer, the transfer account has seven hours to allocate the Elastic IP address to complete the transfer, or the Elastic IP address will return to its original owner.  
Type: Timestamp  
Required: No

## See Also
<a name="API_AddressTransfer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AddressTransfer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AddressTransfer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AddressTransfer) 

# AllowedPrincipal
<a name="API_AllowedPrincipal"></a>

Describes a principal.

## Contents
<a name="API_AllowedPrincipal_Contents"></a>

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

 ** principalType **   
The type of principal.  
Type: String  
Valid Values: `All | Service | OrganizationUnit | Account | User | Role`   
Required: No

 ** serviceId **   
The ID of the service.  
Type: String  
Required: No

 ** servicePermissionId **   
The ID of the service permission.  
Type: String  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_AllowedPrincipal_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AllowedPrincipal) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AllowedPrincipal) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AllowedPrincipal) 

# AlternatePathHint
<a name="API_AlternatePathHint"></a>

Describes an potential intermediate component of a feasible path.

## Contents
<a name="API_AlternatePathHint_Contents"></a>

 ** componentArn **   
The Amazon Resource Name (ARN) of the component.  
Type: String  
Required: No

 ** componentId **   
The ID of the component.  
Type: String  
Required: No

## See Also
<a name="API_AlternatePathHint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AlternatePathHint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AlternatePathHint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AlternatePathHint) 

# AnalysisAclRule
<a name="API_AnalysisAclRule"></a>

Describes a network access control (ACL) rule.

## Contents
<a name="API_AnalysisAclRule_Contents"></a>

 ** cidr **   
The IPv4 address range, in CIDR notation.  
Type: String  
Required: No

 ** egress **   
Indicates whether the rule is an outbound rule.  
Type: Boolean  
Required: No

 ** portRange **   
The range of ports.  
Type: [PortRange](API_PortRange.md) object  
Required: No

 ** protocol **   
The protocol.  
Type: String  
Required: No

 ** ruleAction **   
Indicates whether to allow or deny traffic that matches the rule.  
Type: String  
Required: No

 ** ruleNumber **   
The rule number.  
Type: Integer  
Required: No

## See Also
<a name="API_AnalysisAclRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AnalysisAclRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AnalysisAclRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AnalysisAclRule) 

# AnalysisComponent
<a name="API_AnalysisComponent"></a>

Describes a path component.

## Contents
<a name="API_AnalysisComponent_Contents"></a>

 ** arn **   
The Amazon Resource Name (ARN) of the component.  
Type: String  
Required: No

 ** id **   
The ID of the component.  
Type: String  
Required: No

 ** name **   
The name of the analysis component.  
Type: String  
Required: No

## See Also
<a name="API_AnalysisComponent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AnalysisComponent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AnalysisComponent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AnalysisComponent) 

# AnalysisLoadBalancerListener
<a name="API_AnalysisLoadBalancerListener"></a>

Describes a load balancer listener.

## Contents
<a name="API_AnalysisLoadBalancerListener_Contents"></a>

 ** instancePort **   
[Classic Load Balancers] The back-end port for the listener.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

 ** loadBalancerPort **   
The port on which the load balancer is listening.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

## See Also
<a name="API_AnalysisLoadBalancerListener_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AnalysisLoadBalancerListener) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AnalysisLoadBalancerListener) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AnalysisLoadBalancerListener) 

# AnalysisLoadBalancerTarget
<a name="API_AnalysisLoadBalancerTarget"></a>

Describes a load balancer target.

## Contents
<a name="API_AnalysisLoadBalancerTarget_Contents"></a>

 ** address **   
The IP address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** instance **   
Information about the instance.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** port **   
The port on which the target is listening.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

## See Also
<a name="API_AnalysisLoadBalancerTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AnalysisLoadBalancerTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AnalysisLoadBalancerTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AnalysisLoadBalancerTarget) 

# AnalysisPacketHeader
<a name="API_AnalysisPacketHeader"></a>

Describes a header. Reflects any changes made by a component as traffic passes through. The fields of an inbound header are null except for the first component of a path.

## Contents
<a name="API_AnalysisPacketHeader_Contents"></a>

 ** DestinationAddressSet.N **   
The destination addresses.  
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** DestinationPortRangeSet.N **   
The destination port ranges.  
Type: Array of [PortRange](API_PortRange.md) objects  
Required: No

 ** protocol **   
The protocol.  
Type: String  
Required: No

 ** SourceAddressSet.N **   
The source addresses.  
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** SourcePortRangeSet.N **   
The source port ranges.  
Type: Array of [PortRange](API_PortRange.md) objects  
Required: No

## See Also
<a name="API_AnalysisPacketHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AnalysisPacketHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AnalysisPacketHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AnalysisPacketHeader) 

# AnalysisRouteTableRoute
<a name="API_AnalysisRouteTableRoute"></a>

Describes a route table route.

## Contents
<a name="API_AnalysisRouteTableRoute_Contents"></a>

 ** carrierGatewayId **   
The ID of a carrier gateway.  
Type: String  
Required: No

 ** coreNetworkArn **   
The Amazon Resource Name (ARN) of a core network.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** destinationCidr **   
The destination IPv4 address, in CIDR notation.  
Type: String  
Required: No

 ** destinationPrefixListId **   
The prefix of the AWS service.  
Type: String  
Required: No

 ** egressOnlyInternetGatewayId **   
The ID of an egress-only internet gateway.  
Type: String  
Required: No

 ** gatewayId **   
The ID of the gateway, such as an internet gateway or virtual private gateway.  
Type: String  
Required: No

 ** instanceId **   
The ID of the instance, such as a NAT instance.  
Type: String  
Required: No

 ** localGatewayId **   
The ID of a local gateway.  
Type: String  
Required: No

 ** natGatewayId **   
The ID of a NAT gateway.  
Type: String  
Required: No

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

 ** origin **   
Describes how the route was created. The following are the possible values:  
+ CreateRouteTable - The route was automatically created when the route table was created.
+ CreateRoute - The route was manually added to the route table.
+ EnableVgwRoutePropagation - The route was propagated by route propagation.
Type: String  
Required: No

 ** state **   
The state. The following are the possible values:  
+ active
+ blackhole
Type: String  
Required: No

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

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

## See Also
<a name="API_AnalysisRouteTableRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AnalysisRouteTableRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AnalysisRouteTableRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AnalysisRouteTableRoute) 

# AnalysisSecurityGroupRule
<a name="API_AnalysisSecurityGroupRule"></a>

Describes a security group rule.

## Contents
<a name="API_AnalysisSecurityGroupRule_Contents"></a>

 ** cidr **   
The IPv4 address range, in CIDR notation.  
Type: String  
Required: No

 ** direction **   
The direction. The following are the possible values:  
+ egress
+ ingress
Type: String  
Required: No

 ** portRange **   
The port range.  
Type: [PortRange](API_PortRange.md) object  
Required: No

 ** prefixListId **   
The prefix list ID.  
Type: String  
Required: No

 ** protocol **   
The protocol name.  
Type: String  
Required: No

 ** securityGroupId **   
The security group ID.  
Type: String  
Required: No

## See Also
<a name="API_AnalysisSecurityGroupRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AnalysisSecurityGroupRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AnalysisSecurityGroupRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AnalysisSecurityGroupRule) 

# AsnAssociation
<a name="API_AsnAssociation"></a>

An Autonomous System Number (ASN) and BYOIP CIDR association.

## Contents
<a name="API_AsnAssociation_Contents"></a>

 ** asn **   
The association's ASN.  
Type: String  
Required: No

 ** cidr **   
The association's CIDR.  
Type: String  
Required: No

 ** state **   
The association's state.  
Type: String  
Valid Values: `disassociated | failed-disassociation | failed-association | pending-disassociation | pending-association | associated`   
Required: No

 ** statusMessage **   
The association's status message.  
Type: String  
Required: No

## See Also
<a name="API_AsnAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AsnAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AsnAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AsnAssociation) 

# AsnAuthorizationContext
<a name="API_AsnAuthorizationContext"></a>

Provides authorization for Amazon to bring an Autonomous System Number (ASN) to a specific AWS account using bring your own ASN (BYOASN). For details on the format of the message and signature, see [Tutorial: Bring your ASN to IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoasn.html) in the *Amazon VPC IPAM guide*.

## Contents
<a name="API_AsnAuthorizationContext_Contents"></a>

 ** Message **   
The authorization context's message.  
Type: String  
Required: Yes

 ** Signature **   
The authorization context's signature.  
Type: String  
Required: Yes

## See Also
<a name="API_AsnAuthorizationContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AsnAuthorizationContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AsnAuthorizationContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AsnAuthorizationContext) 

# AssignedPrivateIpAddress
<a name="API_AssignedPrivateIpAddress"></a>

Describes the private IP addresses assigned to a network interface.

## Contents
<a name="API_AssignedPrivateIpAddress_Contents"></a>

 ** privateIpAddress **   
The private IP address assigned to the network interface.  
Type: String  
Required: No

## See Also
<a name="API_AssignedPrivateIpAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssignedPrivateIpAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssignedPrivateIpAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssignedPrivateIpAddress) 

# AssociatedRole
<a name="API_AssociatedRole"></a>

Information about the associated IAM roles.

## Contents
<a name="API_AssociatedRole_Contents"></a>

 ** associatedRoleArn **   
The ARN of the associated IAM role.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** certificateS3BucketName **   
The name of the Amazon S3 bucket in which the Amazon S3 object is stored.  
Type: String  
Required: No

 ** certificateS3ObjectKey **   
The key of the Amazon S3 object 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  
Required: No

 ** encryptionKmsKeyId **   
The ID of the KMS key used to encrypt the private key.  
Type: String  
Required: No

## See Also
<a name="API_AssociatedRole_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociatedRole) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociatedRole) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociatedRole) 

# AssociatedTargetNetwork
<a name="API_AssociatedTargetNetwork"></a>

Describes a target network that is associated with a Client VPN endpoint. A target network is a subnet in a VPC.

## Contents
<a name="API_AssociatedTargetNetwork_Contents"></a>

 ** networkId **   
The ID of the subnet.  
Type: String  
Required: No

 ** networkType **   
The target network type.  
Type: String  
Valid Values: `vpc`   
Required: No

## See Also
<a name="API_AssociatedTargetNetwork_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociatedTargetNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociatedTargetNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociatedTargetNetwork) 

# AssociationStatus
<a name="API_AssociationStatus"></a>

Describes the state of a target network association.

## Contents
<a name="API_AssociationStatus_Contents"></a>

 ** code **   
The state of the target network association.  
Type: String  
Valid Values: `associating | associated | association-failed | disassociating | disassociated`   
Required: No

 ** message **   
A message about the status of the target network association, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_AssociationStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AssociationStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AssociationStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AssociationStatus) 

# AthenaIntegration
<a name="API_AthenaIntegration"></a>

Describes integration options for Amazon Athena.

## Contents
<a name="API_AthenaIntegration_Contents"></a>

 ** IntegrationResultS3DestinationArn **   
The location in Amazon S3 to store the generated CloudFormation template.  
Type: String  
Required: Yes

 ** PartitionLoadFrequency **   
The schedule for adding new partitions to the table.  
Type: String  
Valid Values: `none | daily | weekly | monthly`   
Required: Yes

 ** PartitionEndDate **   
The end date for the partition.  
Type: Timestamp  
Required: No

 ** PartitionStartDate **   
The start date for the partition.  
Type: Timestamp  
Required: No

## See Also
<a name="API_AthenaIntegration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AthenaIntegration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AthenaIntegration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AthenaIntegration) 

# AttachmentEnaSrdSpecification
<a name="API_AttachmentEnaSrdSpecification"></a>

ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.

## Contents
<a name="API_AttachmentEnaSrdSpecification_Contents"></a>

 ** enaSrdEnabled **   
Indicates whether ENA Express is enabled for the network interface.  
Type: Boolean  
Required: No

 ** enaSrdUdpSpecification **   
Configures ENA Express for UDP network traffic.  
Type: [AttachmentEnaSrdUdpSpecification](API_AttachmentEnaSrdUdpSpecification.md) object  
Required: No

## See Also
<a name="API_AttachmentEnaSrdSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachmentEnaSrdSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachmentEnaSrdSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachmentEnaSrdSpecification) 

# AttachmentEnaSrdUdpSpecification
<a name="API_AttachmentEnaSrdUdpSpecification"></a>

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.

## Contents
<a name="API_AttachmentEnaSrdUdpSpecification_Contents"></a>

 ** enaSrdUdpEnabled **   
Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.  
Type: Boolean  
Required: No

## See Also
<a name="API_AttachmentEnaSrdUdpSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttachmentEnaSrdUdpSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttachmentEnaSrdUdpSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttachmentEnaSrdUdpSpecification) 

# AttributeBooleanValue
<a name="API_AttributeBooleanValue"></a>

Describes a value for a resource attribute that is a Boolean value.

## Contents
<a name="API_AttributeBooleanValue_Contents"></a>

 ** Value ** (request), ** value ** (response)  
The attribute value. The valid values are `true` or `false`.  
Type: Boolean  
Required: No

## See Also
<a name="API_AttributeBooleanValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttributeBooleanValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttributeBooleanValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttributeBooleanValue) 

# AttributeSummary
<a name="API_AttributeSummary"></a>

A summary report for the attribute across all Regions.

## Contents
<a name="API_AttributeSummary_Contents"></a>

 ** attributeName **   
The name of the attribute.  
Type: String  
Required: No

 ** mostFrequentValue **   
The configuration value that is most frequently observed for the attribute.  
Type: String  
Required: No

 ** numberOfMatchedAccounts **   
The number of accounts with the same configuration value for the attribute that is most frequently observed.  
Type: Integer  
Required: No

 ** numberOfUnmatchedAccounts **   
The number of accounts with a configuration value different from the most frequently observed value for the attribute.  
Type: Integer  
Required: No

 ** RegionalSummarySet.N **   
The summary report for each Region for the attribute.  
Type: Array of [RegionalSummary](API_RegionalSummary.md) objects  
Required: No

## See Also
<a name="API_AttributeSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttributeSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttributeSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttributeSummary) 

# AttributeValue
<a name="API_AttributeValue"></a>

Describes a value for a resource attribute that is a String.

## Contents
<a name="API_AttributeValue_Contents"></a>

 ** Value ** (request), ** value ** (response)  
The attribute value. The value is case-sensitive.  
Type: String  
Required: No

## See Also
<a name="API_AttributeValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AttributeValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AttributeValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AttributeValue) 

# AuthorizationRule
<a name="API_AuthorizationRule"></a>

Information about an authorization rule.

## Contents
<a name="API_AuthorizationRule_Contents"></a>

 ** accessAll **   
Indicates whether the authorization rule grants access to all clients.  
Type: Boolean  
Required: No

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

 ** description **   
A brief description of the authorization rule.  
Type: String  
Required: No

 ** destinationCidr **   
The IPv4 address range, in CIDR notation, of the network to which the authorization rule applies.  
Type: String  
Required: No

 ** groupId **   
The ID of the Active Directory group to which the authorization rule grants access.  
Type: String  
Required: No

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

## See Also
<a name="API_AuthorizationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AuthorizationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AuthorizationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AuthorizationRule) 

# AvailabilityZone
<a name="API_AvailabilityZone"></a>

Describes Availability Zones, Local Zones, and Wavelength Zones.

## Contents
<a name="API_AvailabilityZone_Contents"></a>

 ** GeographySet.N **   
The geography information for the Availability Zone or Local Zone. The geography is returned as a list.  
Type: Array of [AvailabilityZoneGeography](API_AvailabilityZoneGeography.md) objects  
Required: No

 ** groupLongName **   
The long name of the Availability Zone group, Local Zone group, or Wavelength Zone group.  
Type: String  
Required: No

 ** groupName **   
The name of the zone group. For example:  
+ Availability Zones - `us-east-1-zg-1` 
+ Local Zones - `us-west-2-lax-1` 
+ Wavelength Zones - `us-east-1-wl1-bos-wlz-1` 
Type: String  
Required: No

 ** MessageSet.N **   
Any messages about the Availability Zone, Local Zone, or Wavelength Zone.  
Type: Array of [AvailabilityZoneMessage](API_AvailabilityZoneMessage.md) objects  
Required: No

 ** networkBorderGroup **   
The name of the network border group.  
Type: String  
Required: No

 ** optInStatus **   
For Availability Zones, this parameter always has the value of `opt-in-not-required`.  
For Local Zones and Wavelength Zones, this parameter is the opt-in status. The possible values are `opted-in` and `not-opted-in`.  
Type: String  
Valid Values: `opt-in-not-required | opted-in | not-opted-in`   
Required: No

 ** parentZoneId **   
The ID of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.  
Type: String  
Required: No

 ** parentZoneName **   
The name of the zone that handles some of the Local Zone or Wavelength Zone control plane operations, such as API calls.  
Type: String  
Required: No

 ** regionName **   
The name of the Region.  
Type: String  
Required: No

 ** SubGeographySet.N **   
The sub-geography information for the Availability Zone or Local Zone. The sub-geography is returned as a list.  
Type: Array of [AvailabilityZoneSubGeography](API_AvailabilityZoneSubGeography.md) objects  
Required: No

 ** zoneId **   
The ID of the Availability Zone, Local Zone, or Wavelength Zone.  
Type: String  
Required: No

 ** zoneName **   
The name of the Availability Zone, Local Zone, or Wavelength Zone.  
Type: String  
Required: No

 ** zoneState **   
The state of the Availability Zone, Local Zone, or Wavelength Zone. The possible values are `available`, `unavailable`, and `constrained`.  
Type: String  
Valid Values: `available | information | impaired | unavailable | constrained`   
Required: No

 ** zoneType **   
The type of zone.  
Valid values: `availability-zone` \$1 `local-zone` \$1 `wavelength-zone`   
Type: String  
Required: No

## See Also
<a name="API_AvailabilityZone_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AvailabilityZone) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AvailabilityZone) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AvailabilityZone) 

# AvailabilityZoneAddress
<a name="API_AvailabilityZoneAddress"></a>

For regional NAT gateways only: The configuration specifying which Elastic IP address (EIP) to use for handling outbound NAT traffic from a specific 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*.

## Contents
<a name="API_AvailabilityZoneAddress_Contents"></a>

 ** AllocationId.N **   
The allocation IDs of the Elastic IP addresses (EIPs) to be used for handling outbound NAT traffic in this specific Availability Zone.  
Type: Array of strings  
Required: No

 ** AvailabilityZone **   
For regional NAT gateways only: The Availability Zone where this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration 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 this specific NAT gateway configuration will be active. Each AZ in a regional NAT gateway has its own configuration 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

## See Also
<a name="API_AvailabilityZoneAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AvailabilityZoneAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AvailabilityZoneAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AvailabilityZoneAddress) 

# AvailabilityZoneGeography
<a name="API_AvailabilityZoneGeography"></a>

Describes the geography information for an Availability Zone or Local Zone.

## Contents
<a name="API_AvailabilityZoneGeography_Contents"></a>

 ** name **   
The name of the geography, for example, `United States of America`.  
Type: String  
Required: No

## See Also
<a name="API_AvailabilityZoneGeography_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AvailabilityZoneGeography) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AvailabilityZoneGeography) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AvailabilityZoneGeography) 

# AvailabilityZoneMessage
<a name="API_AvailabilityZoneMessage"></a>

Describes a message about an Availability Zone, Local Zone, or Wavelength Zone.

## Contents
<a name="API_AvailabilityZoneMessage_Contents"></a>

 ** message **   
The message about the Availability Zone, Local Zone, or Wavelength Zone.  
Type: String  
Required: No

## See Also
<a name="API_AvailabilityZoneMessage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AvailabilityZoneMessage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AvailabilityZoneMessage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AvailabilityZoneMessage) 

# AvailabilityZoneSubGeography
<a name="API_AvailabilityZoneSubGeography"></a>

Describes the sub-geography information for an Availability Zone or Local Zone.

## Contents
<a name="API_AvailabilityZoneSubGeography_Contents"></a>

 ** name **   
The name of the sub-geography, for example, `Oregon.`   
Type: String  
Required: No

## See Also
<a name="API_AvailabilityZoneSubGeography_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AvailabilityZoneSubGeography) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AvailabilityZoneSubGeography) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AvailabilityZoneSubGeography) 

# AvailableCapacity
<a name="API_AvailableCapacity"></a>

The capacity information for instances that can be launched onto the Dedicated Host. 

## Contents
<a name="API_AvailableCapacity_Contents"></a>

 ** AvailableInstanceCapacity.N **   
The number of instances that can be launched onto the Dedicated Host depending on the host's available capacity. For Dedicated Hosts that support multiple instance types, this parameter represents the number of instances for each instance size that is supported on the host.  
Type: Array of [InstanceCapacity](API_InstanceCapacity.md) objects  
Required: No

 ** availableVCpus **   
The number of vCPUs available for launching instances onto the Dedicated Host.  
Type: Integer  
Required: No

## See Also
<a name="API_AvailableCapacity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/AvailableCapacity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/AvailableCapacity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/AvailableCapacity) 

# BaselineEbsBandwidthMbps
<a name="API_BaselineEbsBandwidthMbps"></a>

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_BaselineEbsBandwidthMbps_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum baseline bandwidth, in Mbps. If this parameter is not specified, there is no maximum limit.  
Type: Integer  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum baseline bandwidth, in Mbps. If this parameter is not specified, there is no minimum limit.  
Type: Integer  
Required: No

## See Also
<a name="API_BaselineEbsBandwidthMbps_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BaselineEbsBandwidthMbps) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BaselineEbsBandwidthMbps) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BaselineEbsBandwidthMbps) 

# BaselineEbsBandwidthMbpsRequest
<a name="API_BaselineEbsBandwidthMbpsRequest"></a>

The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_BaselineEbsBandwidthMbpsRequest_Contents"></a>

 ** Max **   
The maximum baseline bandwidth, in Mbps. To specify no maximum limit, omit this parameter.  
Type: Integer  
Required: No

 ** Min **   
The minimum baseline bandwidth, in Mbps. To specify no minimum limit, omit this parameter.  
Type: Integer  
Required: No

## See Also
<a name="API_BaselineEbsBandwidthMbpsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BaselineEbsBandwidthMbpsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BaselineEbsBandwidthMbpsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BaselineEbsBandwidthMbpsRequest) 

# BaselinePerformanceFactors
<a name="API_BaselinePerformanceFactors"></a>

The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.

Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying `c6i` would use the CPU performance of the `c6i` family as the baseline reference.

## Contents
<a name="API_BaselinePerformanceFactors_Contents"></a>

 ** Cpu ** (request), ** cpu ** (response)  
The CPU performance to consider, using an instance family as the baseline reference.  
Type: [CpuPerformanceFactor](API_CpuPerformanceFactor.md) object  
Required: No

## See Also
<a name="API_BaselinePerformanceFactors_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BaselinePerformanceFactors) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BaselinePerformanceFactors) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BaselinePerformanceFactors) 

# BaselinePerformanceFactorsRequest
<a name="API_BaselinePerformanceFactorsRequest"></a>

The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application.

Currently, this parameter only supports CPU performance as a baseline performance factor. For example, specifying `c6i` would use the CPU performance of the `c6i` family as the baseline reference.

## Contents
<a name="API_BaselinePerformanceFactorsRequest_Contents"></a>

 ** Cpu **   
The CPU performance to consider, using an instance family as the baseline reference.  
Type: [CpuPerformanceFactorRequest](API_CpuPerformanceFactorRequest.md) object  
Required: No

## See Also
<a name="API_BaselinePerformanceFactorsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BaselinePerformanceFactorsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BaselinePerformanceFactorsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BaselinePerformanceFactorsRequest) 

# BlobAttributeValue
<a name="API_BlobAttributeValue"></a>

Describes Base64-encoded binary data.

## Contents
<a name="API_BlobAttributeValue_Contents"></a>

 **Value**   
The value of the data.  
Type: Base64-encoded binary data  
Required: No

# BlockDeviceMapping
<a name="API_BlockDeviceMapping"></a>

Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

## Contents
<a name="API_BlockDeviceMapping_Contents"></a>

 ** DeviceName ** (request), ** deviceName ** (response)  
The device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html).  
Type: String  
Required: No

 ** Ebs ** (request), ** ebs ** (response)  
Parameters used to automatically set up EBS volumes when the instance is launched.  
Type: [EbsBlockDevice](API_EbsBlockDevice.md) object  
Required: No

 ** NoDevice ** (request), ** noDevice ** (response)  
To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.  
Type: String  
Required: No

 ** VirtualName ** (request), ** virtualName ** (response)  
The virtual device name (`ephemeral`N). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1`. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.  
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.  
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.  
Type: String  
Required: No

## See Also
<a name="API_BlockDeviceMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BlockDeviceMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BlockDeviceMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BlockDeviceMapping) 

# BlockDeviceMappingResponse
<a name="API_BlockDeviceMappingResponse"></a>

Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

## Contents
<a name="API_BlockDeviceMappingResponse_Contents"></a>

 ** deviceName **   
The device name (for example, `/dev/sdh` or `xvdh`).  
Type: String  
Required: No

 ** ebs **   
Parameters used to automatically set up EBS volumes when the instance is launched.  
Type: [EbsBlockDeviceResponse](API_EbsBlockDeviceResponse.md) object  
Required: No

 ** noDevice **   
Suppresses the specified device included in the block device mapping.  
Type: String  
Required: No

 ** virtualName **   
The virtual device name.  
Type: String  
Required: No

## See Also
<a name="API_BlockDeviceMappingResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BlockDeviceMappingResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BlockDeviceMappingResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BlockDeviceMappingResponse) 

# BlockPublicAccessStates
<a name="API_BlockPublicAccessStates"></a>

The state of VPC Block Public Access (BPA).

## Contents
<a name="API_BlockPublicAccessStates_Contents"></a>

 ** 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: No

## See Also
<a name="API_BlockPublicAccessStates_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BlockPublicAccessStates) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BlockPublicAccessStates) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BlockPublicAccessStates) 

# BundleTask
<a name="API_BundleTask"></a>

Describes a bundle task.

## Contents
<a name="API_BundleTask_Contents"></a>

 ** bundleId **   
The ID of the bundle task.  
Type: String  
Required: No

 ** error **   
If the task fails, a description of the error.  
Type: [BundleTaskError](API_BundleTaskError.md) object  
Required: No

 ** instanceId **   
The ID of the instance associated with this bundle task.  
Type: String  
Required: No

 ** progress **   
The level of task completion, as a percent (for example, 20%).  
Type: String  
Required: No

 ** startTime **   
The time this task started.  
Type: Timestamp  
Required: No

 ** state **   
The state of the task.  
Type: String  
Valid Values: `pending | waiting-for-shutdown | bundling | storing | cancelling | complete | failed`   
Required: No

 ** storage **   
The Amazon S3 storage locations.  
Type: [Storage](API_Storage.md) object  
Required: No

 ** updateTime **   
The time of the most recent update for the task.  
Type: Timestamp  
Required: No

## See Also
<a name="API_BundleTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BundleTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BundleTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BundleTask) 

# BundleTaskError
<a name="API_BundleTaskError"></a>

Describes an error for [BundleInstance](API_BundleInstance.md).

## Contents
<a name="API_BundleTaskError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Required: No

 ** message **   
The error message.  
Type: String  
Required: No

## See Also
<a name="API_BundleTaskError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/BundleTaskError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/BundleTaskError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/BundleTaskError) 

# Byoasn
<a name="API_Byoasn"></a>

The Autonomous System Number (ASN) and BYOIP CIDR association.

## Contents
<a name="API_Byoasn_Contents"></a>

 ** asn **   
A public 2-byte or 4-byte ASN.  
Type: String  
Required: No

 ** ipamId **   
An IPAM ID.  
Type: String  
Required: No

 ** state **   
The provisioning state of the BYOASN.  
Type: String  
Valid Values: `deprovisioned | failed-deprovision | failed-provision | pending-deprovision | pending-provision | provisioned`   
Required: No

 ** statusMessage **   
The status message.  
Type: String  
Required: No

## See Also
<a name="API_Byoasn_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Byoasn) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Byoasn) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Byoasn) 

# ByoipCidr
<a name="API_ByoipCidr"></a>

Information about an address range that is provisioned for use with your AWS resources through bring your own IP addresses (BYOIP).

## Contents
<a name="API_ByoipCidr_Contents"></a>

 ** advertisementType **   
Specifies the advertisement method for the BYOIP CIDR. Valid values are:  
+  `unicast`: IP is advertised from a single location (regional services like EC2)
+  `anycast`: IP is advertised from multiple global locations simultaneously (global services like CloudFront)
For more information, see [Bring your own IP to CloudFront using IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/tutorials-byoip-cloudfront.html) in the *Amazon VPC IPAM User Guide*.  
Type: String  
Required: No

 ** AsnAssociationSet.N **   
The BYOIP CIDR associations with ASNs.  
Type: Array of [AsnAssociation](API_AsnAssociation.md) objects  
Required: No

 ** cidr **   
The address range, in CIDR notation.  
Type: String  
Required: No

 ** description **   
The description of the address range.  
Type: String  
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

 ** state **   
The state of the address range.  
+  `advertised`: The address range is being advertised to the internet by AWS.
+  `deprovisioned`: The address range is deprovisioned.
+  `failed-deprovision`: The request to deprovision the address range was unsuccessful. Ensure that all EIPs from the range have been deallocated and try again.
+  `failed-provision`: The request to provision the address range was unsuccessful.
+  `pending-deprovision`: You’ve submitted a request to deprovision an address range and it's pending.
+  `pending-provision`: You’ve submitted a request to provision an address range and it's pending.
+  `provisioned`: The address range is provisioned and can be advertised. The range is not currently advertised.
+  `provisioned-not-publicly-advertisable`: The address range is provisioned and cannot be advertised.
Type: String  
Valid Values: `advertised | deprovisioned | failed-deprovision | failed-provision | pending-advertising | pending-deprovision | pending-provision | pending-withdrawal | provisioned | provisioned-not-publicly-advertisable`   
Required: No

 ** statusMessage **   
Upon success, contains the ID of the address pool. Otherwise, contains an error message.  
Type: String  
Required: No

## See Also
<a name="API_ByoipCidr_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ByoipCidr) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ByoipCidr) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ByoipCidr) 

# CancelCapacityReservationFleetError
<a name="API_CancelCapacityReservationFleetError"></a>

Describes a Capacity Reservation Fleet cancellation error.

## Contents
<a name="API_CancelCapacityReservationFleetError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Required: No

 ** message **   
The error message.  
Type: String  
Required: No

## See Also
<a name="API_CancelCapacityReservationFleetError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelCapacityReservationFleetError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelCapacityReservationFleetError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelCapacityReservationFleetError) 

# CancelledSpotInstanceRequest
<a name="API_CancelledSpotInstanceRequest"></a>

Describes a request to cancel a Spot Instance.

## Contents
<a name="API_CancelledSpotInstanceRequest_Contents"></a>

 ** spotInstanceRequestId **   
The ID of the Spot Instance request.  
Type: String  
Required: No

 ** state **   
The state of the Spot Instance request.  
Type: String  
Valid Values: `active | open | closed | cancelled | completed`   
Required: No

## See Also
<a name="API_CancelledSpotInstanceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelledSpotInstanceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelledSpotInstanceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelledSpotInstanceRequest) 

# CancelSpotFleetRequestsError
<a name="API_CancelSpotFleetRequestsError"></a>

Describes a Spot Fleet error.

## Contents
<a name="API_CancelSpotFleetRequestsError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Valid Values: `fleetRequestIdDoesNotExist | fleetRequestIdMalformed | fleetRequestNotInCancellableState | unexpectedError`   
Required: No

 ** message **   
The description for the error code.  
Type: String  
Required: No

## See Also
<a name="API_CancelSpotFleetRequestsError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelSpotFleetRequestsError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelSpotFleetRequestsError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelSpotFleetRequestsError) 

# CancelSpotFleetRequestsErrorItem
<a name="API_CancelSpotFleetRequestsErrorItem"></a>

Describes a Spot Fleet request that was not successfully canceled.

## Contents
<a name="API_CancelSpotFleetRequestsErrorItem_Contents"></a>

 ** error **   
The error.  
Type: [CancelSpotFleetRequestsError](API_CancelSpotFleetRequestsError.md) object  
Required: No

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

## See Also
<a name="API_CancelSpotFleetRequestsErrorItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelSpotFleetRequestsErrorItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelSpotFleetRequestsErrorItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelSpotFleetRequestsErrorItem) 

# CancelSpotFleetRequestsSuccessItem
<a name="API_CancelSpotFleetRequestsSuccessItem"></a>

Describes a Spot Fleet request that was successfully canceled.

## Contents
<a name="API_CancelSpotFleetRequestsSuccessItem_Contents"></a>

 ** currentSpotFleetRequestState **   
The current state of the Spot Fleet request.  
Type: String  
Valid Values: `submitted | active | cancelled | failed | cancelled_running | cancelled_terminating | modifying`   
Required: No

 ** previousSpotFleetRequestState **   
The previous state of the Spot Fleet request.  
Type: String  
Valid Values: `submitted | active | cancelled | failed | cancelled_running | cancelled_terminating | modifying`   
Required: No

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

## See Also
<a name="API_CancelSpotFleetRequestsSuccessItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CancelSpotFleetRequestsSuccessItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CancelSpotFleetRequestsSuccessItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CancelSpotFleetRequestsSuccessItem) 

# CapacityAllocation
<a name="API_CapacityAllocation"></a>

Information about instance capacity usage for a Capacity Reservation.

## Contents
<a name="API_CapacityAllocation_Contents"></a>

 ** AllocationMetadataList.N **   
Additional metadata associated with the capacity allocation. Each entry contains a key-value pair providing context about the allocation.  
Type: Array of [CapacityAllocationMetadataEntry](API_CapacityAllocationMetadataEntry.md) objects  
Required: No

 ** allocationType **   
The usage type. `used` indicates that the instance capacity is in use by instances that are running in the Capacity Reservation.  
Type: String  
Valid Values: `used`   
Required: No

 ** count **   
The amount of instance capacity associated with the usage. For example a value of `4` indicates that instance capacity for 4 instances is currently in use.  
Type: Integer  
Required: No

## See Also
<a name="API_CapacityAllocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityAllocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityAllocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityAllocation) 

# CapacityAllocationMetadataEntry
<a name="API_CapacityAllocationMetadataEntry"></a>

A key-value pair that provides additional metadata about a capacity allocation.

## Contents
<a name="API_CapacityAllocationMetadataEntry_Contents"></a>

 ** key **   
The key of the metadata entry.  
Type: String  
Required: No

 ** value **   
The value of the metadata entry.  
Type: String  
Required: No

## See Also
<a name="API_CapacityAllocationMetadataEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityAllocationMetadataEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityAllocationMetadataEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityAllocationMetadataEntry) 

# CapacityBlock
<a name="API_CapacityBlock"></a>

Reserve powerful GPU instances on a future date to support your short duration machine learning (ML) workloads. Instances that run inside a Capacity Block are automatically placed close together inside [Amazon EC2 UltraClusters](http://aws.amazon.com/ec2/ultraclusters/), for low-latency, petabit-scale, non-blocking networking.

You can also reserve Amazon EC2 UltraServers. UltraServers connect multiple EC2 instances using a low-latency, high-bandwidth accelerator interconnect (NeuronLink). They are built to tackle very large-scale AI/ML workloads that require significant processing power. For more information, see Amazon EC2 UltraServers.

## Contents
<a name="API_CapacityBlock_Contents"></a>

 ** availabilityZone **   
The Availability Zone of the Capacity Block.  
Type: String  
Required: No

 ** availabilityZoneId **   
The Availability Zone ID of the Capacity Block.  
Type: String  
Required: No

 ** capacityBlockId **   
The ID of the Capacity Block.  
Type: String  
Required: No

 ** CapacityReservationIdSet.N **   
The ID of the Capacity Reservation.  
Type: Array of strings  
Required: No

 ** createDate **   
The date and time at which the Capacity Block was created.  
Type: Timestamp  
Required: No

 ** endDate **   
The date and time at which the Capacity Block expires. When a Capacity Block expires, all instances in the Capacity Block are terminated.  
Type: Timestamp  
Required: No

 ** startDate **   
The date and time at which the Capacity Block was started.  
Type: Timestamp  
Required: No

 ** state **   
The state of the Capacity Block.  
Type: String  
Valid Values: `active | expired | unavailable | cancelled | failed | scheduled | payment-pending | payment-failed`   
Required: No

 ** TagSet.N **   
The tags assigned to the Capacity Block.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** ultraserverType **   
The EC2 UltraServer type of the Capacity Block.  
Type: String  
Required: No

## See Also
<a name="API_CapacityBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityBlock) 

# CapacityBlockExtension
<a name="API_CapacityBlockExtension"></a>

Describes a Capacity Block extension. With an extension, you can extend the duration of time for an existing Capacity Block.

## Contents
<a name="API_CapacityBlockExtension_Contents"></a>

 ** availabilityZone **   
The Availability Zone of the Capacity Block extension.  
Type: String  
Required: No

 ** availabilityZoneId **   
The Availability Zone ID of the Capacity Block extension.  
Type: String  
Required: No

 ** capacityBlockExtensionDurationHours **   
The duration of the Capacity Block extension in hours.  
Type: Integer  
Required: No

 ** capacityBlockExtensionEndDate **   
The end date of the Capacity Block extension.  
Type: Timestamp  
Required: No

 ** capacityBlockExtensionOfferingId **   
The ID of the Capacity Block extension offering.  
Type: String  
Required: No

 ** capacityBlockExtensionPurchaseDate **   
The date when the Capacity Block extension was purchased.  
Type: Timestamp  
Required: No

 ** capacityBlockExtensionStartDate **   
The start date of the Capacity Block extension.  
Type: Timestamp  
Required: No

 ** capacityBlockExtensionStatus **   
The status of the Capacity Block extension. A Capacity Block extension can have one of the following statuses:  
+  `payment-pending` - The Capacity Block extension payment is processing. If your payment can't be processed within 12 hours, the Capacity Block extension is failed.
+  `payment-failed` - Payment for the Capacity Block extension request was not successful.
+  `payment-succeeded` - Payment for the Capacity Block extension request was successful. You receive an invoice that reflects the one-time upfront payment. In the invoice, you can associate the paid amount with the Capacity Block reservation ID.
Type: String  
Valid Values: `payment-pending | payment-failed | payment-succeeded`   
Required: No

 ** capacityReservationId **   
The reservation ID of the Capacity Block extension.  
Type: String  
Required: No

 ** currencyCode **   
The currency of the payment for the Capacity Block extension.  
Type: String  
Required: No

 ** instanceCount **   
The number of instances in the Capacity Block extension.  
Type: Integer  
Required: No

 ** instanceType **   
The instance type of the Capacity Block extension.  
Type: String  
Required: No

 ** upfrontFee **   
The total price to be paid up front.  
Type: String  
Required: No

 ** zoneType **   
The type of zone where the Capacity Block extension is located.  
Type: String  
Required: No

## See Also
<a name="API_CapacityBlockExtension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityBlockExtension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityBlockExtension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityBlockExtension) 

# CapacityBlockExtensionOffering
<a name="API_CapacityBlockExtensionOffering"></a>

The recommended Capacity Block extension that fits your search requirements.

## Contents
<a name="API_CapacityBlockExtensionOffering_Contents"></a>

 ** availabilityZone **   
The Availability Zone of the Capacity Block that will be extended.  
Type: String  
Required: No

 ** availabilityZoneId **   
The Availability Zone ID of the Capacity Block that will be extended.  
Type: String  
Required: No

 ** capacityBlockExtensionDurationHours **   
The amount of time of the Capacity Block extension offering in hours.  
Type: Integer  
Required: No

 ** capacityBlockExtensionEndDate **   
The date and time at which the Capacity Block extension expires. When a Capacity Block expires, the reserved capacity is released and you can no longer launch instances into it. The Capacity Block's state changes to `expired` when it reaches its end date  
Type: Timestamp  
Required: No

 ** capacityBlockExtensionOfferingId **   
The ID of the Capacity Block extension offering.  
Type: String  
Required: No

 ** capacityBlockExtensionStartDate **   
The date and time at which the Capacity Block extension will start. This date is also the same as the end date of the Capacity Block that will be extended.  
Type: Timestamp  
Required: No

 ** currencyCode **   
The currency of the payment for the Capacity Block extension offering.  
Type: String  
Required: No

 ** instanceCount **   
The number of instances in the Capacity Block extension offering.  
Type: Integer  
Required: No

 ** instanceType **   
The instance type of the Capacity Block that will be extended.  
Type: String  
Required: No

 ** startDate **   
The start date of the Capacity Block that will be extended.  
Type: Timestamp  
Required: No

 ** tenancy **   
Indicates the tenancy of the Capacity Block extension offering. A Capacity Block can have one of the following tenancy settings:  
+  `default` - The Capacity Block is created on hardware that is shared with other AWS accounts.
+  `dedicated` - The Capacity Block is created on single-tenant hardware that is dedicated to a single AWS account.
Type: String  
Valid Values: `default | dedicated`   
Required: No

 ** upfrontFee **   
The total price of the Capacity Block extension offering, to be paid up front.  
Type: String  
Required: No

 ** zoneType **   
The type of zone where the Capacity Block extension offering is available.  
Type: String  
Required: No

## See Also
<a name="API_CapacityBlockExtensionOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityBlockExtensionOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityBlockExtensionOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityBlockExtensionOffering) 

# CapacityBlockOffering
<a name="API_CapacityBlockOffering"></a>

The recommended Capacity Block that fits your search requirements.

## Contents
<a name="API_CapacityBlockOffering_Contents"></a>

 ** availabilityZone **   
The Availability Zone of the Capacity Block offering.  
Type: String  
Required: No

 ** capacityBlockDurationHours **   
The number of hours (in addition to `capacityBlockDurationMinutes`) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at **04:55** and ends at **11:30**, the hours field would be **6**.  
Type: Integer  
Required: No

 ** capacityBlockDurationMinutes **   
The number of minutes (in addition to `capacityBlockDurationHours`) for the duration of the Capacity Block reservation. For example, if a Capacity Block starts at **08:55** and ends at **11:30**, the minutes field would be **35**.  
Type: Integer  
Required: No

 ** capacityBlockOfferingId **   
The ID of the Capacity Block offering.  
Type: String  
Required: No

 ** currencyCode **   
The currency of the payment for the Capacity Block.  
Type: String  
Required: No

 ** endDate **   
The end date of the Capacity Block offering.  
Type: Timestamp  
Required: No

 ** instanceCount **   
The number of instances in the Capacity Block offering.  
Type: Integer  
Required: No

 ** instanceType **   
The instance type of the Capacity Block offering.  
Type: String  
Required: No

 ** startDate **   
The start date of the Capacity Block offering.  
Type: Timestamp  
Required: No

 ** tenancy **   
The tenancy of the Capacity Block.  
Type: String  
Valid Values: `default | dedicated`   
Required: No

 ** ultraserverCount **   
The number of EC2 UltraServers in the offering.  
Type: Integer  
Required: No

 ** ultraserverType **   
The EC2 UltraServer type of the Capacity Block offering.  
Type: String  
Required: No

 ** upfrontFee **   
The total price to be paid up front.  
Type: String  
Required: No

 ** zoneType **   
The type of zone where the Capacity Block offering is available.  
Type: String  
Required: No

## See Also
<a name="API_CapacityBlockOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityBlockOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityBlockOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityBlockOffering) 

# CapacityBlockStatus
<a name="API_CapacityBlockStatus"></a>

Describes the availability of capacity for a Capacity Block.

## Contents
<a name="API_CapacityBlockStatus_Contents"></a>

 ** capacityBlockId **   
The ID of the Capacity Block.  
Type: String  
Required: No

 ** CapacityReservationStatusSet.N **   
The availability of capacity for the Capacity Block reservations.  
Type: Array of [CapacityReservationStatus](API_CapacityReservationStatus.md) objects  
Required: No

 ** interconnectStatus **   
The status of the high-bandwidth accelerator interconnect. Possible states include:  
+  `ok` the accelerator interconnect is healthy.
+  `impaired` - accelerator interconnect communication is impaired.
+  `insufficient-data` - insufficient data to determine accelerator interconnect status.
Type: String  
Valid Values: `ok | impaired | insufficient-data`   
Required: No

 ** totalAvailableCapacity **   
The remaining capacity. Indicates the number of resources that can be launched into the Capacity Block.  
Type: Integer  
Required: No

 ** totalCapacity **   
The combined amount of `Available` and `Unavailable` capacity in the Capacity Block.  
Type: Integer  
Required: No

 ** totalUnavailableCapacity **   
The unavailable capacity. Indicates the instance capacity that is unavailable for use due to a system status check failure.  
Type: Integer  
Required: No

## See Also
<a name="API_CapacityBlockStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityBlockStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityBlockStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityBlockStatus) 

# CapacityManagerCondition
<a name="API_CapacityManagerCondition"></a>

 Represents a filter condition for Capacity Manager queries. Contains dimension-based filtering criteria used to narrow down metric data and dimension results. 

## Contents
<a name="API_CapacityManagerCondition_Contents"></a>

 ** DimensionCondition **   
 The dimension-based condition that specifies how to filter the data based on dimension values.   
Type: [DimensionCondition](API_DimensionCondition.md) object  
Required: No

## See Also
<a name="API_CapacityManagerCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityManagerCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityManagerCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityManagerCondition) 

# CapacityManagerDataExportResponse
<a name="API_CapacityManagerDataExportResponse"></a>

 Contains information about a Capacity Manager data export configuration, including export settings, delivery status, and recent export activity. 

## Contents
<a name="API_CapacityManagerDataExportResponse_Contents"></a>

 ** capacityManagerDataExportId **   
 The unique identifier for the data export configuration.   
Type: String  
Required: No

 ** createTime **   
 The timestamp when the data export configuration was created.   
Type: Timestamp  
Required: No

 ** latestDeliveryS3LocationUri **   
 The S3 URI of the most recently delivered export file.   
Type: String  
Required: No

 ** latestDeliveryStatus **   
 The status of the most recent export delivery.   
Type: String  
Valid Values: `pending | in-progress | delivered | failed`   
Required: No

 ** latestDeliveryStatusMessage **   
 A message describing the status of the most recent export delivery, including any error details if the delivery failed.   
Type: String  
Required: No

 ** latestDeliveryTime **   
 The timestamp when the most recent export was delivered to S3.   
Type: Timestamp  
Required: No

 ** outputFormat **   
 The file format of the exported data.   
Type: String  
Valid Values: `csv | parquet`   
Required: No

 ** s3BucketName **   
 The name of the S3 bucket where export files are delivered.   
Type: String  
Required: No

 ** s3BucketPrefix **   
 The S3 key prefix used for organizing export files within the bucket.   
Type: String  
Required: No

 ** schedule **   
 The frequency at which data exports are generated.   
Type: String  
Valid Values: `hourly`   
Required: No

 ** TagSet.N **   
 The tags associated with the data export configuration.   
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_CapacityManagerDataExportResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityManagerDataExportResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityManagerDataExportResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityManagerDataExportResponse) 

# CapacityManagerDimension
<a name="API_CapacityManagerDimension"></a>

 Represents dimension values for capacity metrics, including resource identifiers, geographic information, and reservation details used for grouping and filtering capacity data. 

## Contents
<a name="API_CapacityManagerDimension_Contents"></a>

 ** accountId **   
 The AWS account ID that owns the capacity resource.   
Type: String  
Required: No

 ** accountName **   
 The name of the AWS account that owns the capacity resource. This dimension is only available when Organizations access is enabled for Capacity Manager.   
Type: String  
Required: No

 ** availabilityZoneId **   
 The unique identifier of the Availability Zone where the capacity resource is located.   
Type: String  
Required: No

 ** instanceFamily **   
 The EC2 instance family of the capacity resource.   
Type: String  
Required: No

 ** instancePlatform **   
 The platform or operating system of the instance.   
Type: String  
Required: No

 ** instanceType **   
 The specific EC2 instance type of the capacity resource.   
Type: String  
Required: No

 ** reservationArn **   
 The Amazon Resource Name (ARN) of the capacity reservation. This provides a unique identifier that can be used across AWS services to reference the specific reservation.   
Type: String  
Required: No

 ** reservationCreateTimestamp **   
 The timestamp when the capacity reservation was originally created, in milliseconds since epoch. This differs from the start timestamp as reservations can be created before they become active.   
Type: Timestamp  
Required: No

 ** reservationEndDateType **   
 The type of end date for the capacity reservation. This indicates whether the reservation has a fixed end date, is open-ended, or follows a specific termination pattern.   
Type: String  
Valid Values: `limited | unlimited`   
Required: No

 ** reservationEndTimestamp **   
 The timestamp when the capacity reservation expires and is no longer available, in milliseconds since epoch. After this time, the reservation will not provide any capacity.   
Type: Timestamp  
Required: No

 ** reservationId **   
 The unique identifier of the capacity reservation.   
Type: String  
Required: No

 ** reservationInstanceMatchCriteria **   
 The instance matching criteria for the capacity reservation, determining how instances are matched to the reservation.   
Type: String  
Required: No

 ** reservationStartTimestamp **   
 The timestamp when the capacity reservation becomes active and available for use, in milliseconds since epoch. This is when the reservation begins providing capacity.   
Type: Timestamp  
Required: No

 ** reservationState **   
 The current state of the capacity reservation.   
Type: String  
Valid Values: `active | expired | cancelled | scheduled | pending | failed | delayed | unsupported | payment-pending | payment-failed | retired`   
Required: No

 ** reservationType **   
 The type of capacity reservation.   
Type: String  
Valid Values: `capacity-block | odcr`   
Required: No

 ** reservationUnusedFinancialOwner **   
 The AWS account ID that is financially responsible for unused capacity reservation costs.   
Type: String  
Required: No

 ** resourceRegion **   
 The AWS Region where the capacity resource is located.   
Type: String  
Required: No

 ** TagSet.N **   
 The tags associated with the capacity resource, represented as key-value pairs. Only tags that have been activated for monitoring via `UpdateCapacityManagerMonitoredTagKeys` are included.   
Type: Array of [CapacityManagerTagDimension](API_CapacityManagerTagDimension.md) objects  
Required: No

 ** tenancy **   
 The tenancy of the EC2 instances associated with this capacity dimension. Valid values are 'default' for shared tenancy, 'dedicated' for dedicated instances, or 'host' for dedicated hosts.   
Type: String  
Valid Values: `default | dedicated`   
Required: No

## See Also
<a name="API_CapacityManagerDimension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityManagerDimension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityManagerDimension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityManagerDimension) 

# CapacityManagerMonitoredTagKey
<a name="API_CapacityManagerMonitoredTagKey"></a>

 Describes a tag key that is being monitored by Capacity Manager, including its activation status and the earliest available data point. 

## Contents
<a name="API_CapacityManagerMonitoredTagKey_Contents"></a>

 ** capacityManagerProvided **   
 Indicates whether this tag key is provided by Capacity Manager by default, rather than being user-activated.   
Type: Boolean  
Required: No

 ** earliestDatapointTimestamp **   
 The earliest timestamp from which tag data is available for queries, in UTC ISO 8601 format.   
Type: Timestamp  
Required: No

 ** status **   
 The current status of the monitored tag key. Valid values are `activating`, `activated`, `deactivating`, and `suspended`.   
Type: String  
Valid Values: `activating | activated | deactivating | suspended`   
Required: No

 ** statusMessage **   
 A message providing additional details about the current status of the monitored tag key.   
Type: String  
Required: No

 ** tagKey **   
 The tag key being monitored.   
Type: String  
Required: No

## See Also
<a name="API_CapacityManagerMonitoredTagKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityManagerMonitoredTagKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityManagerMonitoredTagKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityManagerMonitoredTagKey) 

# CapacityManagerTagDimension
<a name="API_CapacityManagerTagDimension"></a>

 A key-value pair representing a tag associated with a capacity resource in Capacity Manager. 

## Contents
<a name="API_CapacityManagerTagDimension_Contents"></a>

 ** key **   
 The tag key.   
Type: String  
Required: No

 ** value **   
 The tag value.   
Type: String  
Required: No

## See Also
<a name="API_CapacityManagerTagDimension_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityManagerTagDimension) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityManagerTagDimension) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityManagerTagDimension) 

# CapacityReservation
<a name="API_CapacityReservation"></a>

Describes a Capacity Reservation.

## Contents
<a name="API_CapacityReservation_Contents"></a>

 ** availabilityZone **   
The Availability Zone in which the capacity is reserved.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone in which the capacity is reserved.  
Type: String  
Required: No

 ** availableInstanceCount **   
The remaining capacity. Indicates the number of instances that can be launched in the Capacity Reservation.  
Type: Integer  
Required: No

 ** CapacityAllocationSet.N **   
Information about instance capacity usage.  
Type: Array of [CapacityAllocation](API_CapacityAllocation.md) objects  
Required: No

 ** capacityBlockId **   
The ID of the Capacity Block.  
Type: String  
Required: No

 ** capacityReservationArn **   
The Amazon Resource Name (ARN) of the Capacity Reservation.  
Type: String  
Required: No

 ** capacityReservationFleetId **   
The ID of the Capacity Reservation Fleet to which the Capacity Reservation belongs. Only valid for Capacity Reservations that were created by a Capacity Reservation Fleet.  
Type: String  
Required: No

 ** capacityReservationId **   
The ID of the Capacity Reservation.  
Type: String  
Required: No

 ** commitmentInfo **   
Information about your commitment for a future-dated Capacity Reservation.  
Type: [CapacityReservationCommitmentInfo](API_CapacityReservationCommitmentInfo.md) object  
Required: No

 ** createDate **   
The date and time the Capacity Reservation was created.  
Type: Timestamp  
Required: No

 ** deliveryPreference **   
The delivery method for a future-dated Capacity Reservation. `incremental` indicates that the requested capacity is delivered in addition to any running instances and reserved capacity that you have in your account at the requested date and time.  
Type: String  
Valid Values: `fixed | incremental`   
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 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.  
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.
+  `limited` - The Capacity Reservation expires automatically at a specified date and time.
Type: String  
Valid Values: `unlimited | limited`   
Required: No

 ** ephemeralStorage **   
 *Deprecated.*   
Type: Boolean  
Required: No

 ** instanceMatchCriteria **   
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. 
Type: String  
Valid Values: `open | targeted`   
Required: No

 ** instancePlatform **   
The type of operating system for which the Capacity Reservation reserves 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: No

 ** instanceType **   
The type of instance for which the Capacity Reservation reserves capacity.  
Type: String  
Required: No

 ** interruptible **   
 Indicates whether this Capacity Reservation is interruptible, meaning instances may be terminated when the owner reclaims capacity.   
Type: Boolean  
Required: No

 ** interruptibleCapacityAllocation **   
 Contains allocation details for interruptible reservations, including current allocated instances and target instance counts within the interruptibleCapacityAllocation object.   
Type: [InterruptibleCapacityAllocation](API_InterruptibleCapacityAllocation.md) object  
Required: No

 ** interruptionInfo **   
 Information about the interruption configuration and association with the source reservation for interruptible Capacity Reservations.   
Type: [InterruptionInfo](API_InterruptionInfo.md) object  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost on which the Capacity Reservation was created.  
Type: String  
Pattern: `^arn:aws([a-z-]+)?:outposts:[a-z\d-]+:\d{12}:outpost/op-[a-f0-9]{17}$`   
Required: No

 ** ownerId **   
The ID of the AWS account that owns the Capacity Reservation.  
Type: String  
Required: No

 ** placementGroupArn **   
The Amazon Resource Name (ARN) of the cluster placement group in which the Capacity Reservation was created. 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

 ** reservationType **   
The type of Capacity Reservation.  
Type: String  
Valid Values: `default | capacity-block`   
Required: No

 ** startDate **   
The date and time the Capacity Reservation was started.  
Type: Timestamp  
Required: No

 ** 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`   
Required: No

 ** TagSet.N **   
Any tags assigned to the Capacity Reservation.  
Type: Array of [Tag](API_Tag.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

 ** totalInstanceCount **   
The total number of instances for which the Capacity Reservation reserves capacity.  
Type: Integer  
Required: No

 ** unusedReservationBillingOwnerId **   
The ID of the AWS account to which billing of the unused capacity of the Capacity Reservation is assigned.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]{12}`   
Required: No

## See Also
<a name="API_CapacityReservation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservation) 

# CapacityReservationBillingRequest
<a name="API_CapacityReservationBillingRequest"></a>

Information about a request to assign billing of the unused capacity of a Capacity Reservation.

## Contents
<a name="API_CapacityReservationBillingRequest_Contents"></a>

 ** capacityReservationId **   
The ID of the Capacity Reservation.  
Type: String  
Required: No

 ** capacityReservationInfo **   
Information about the Capacity Reservation.  
Type: [CapacityReservationInfo](API_CapacityReservationInfo.md) object  
Required: No

 ** lastUpdateTime **   
The date and time, in UTC time format, at which the request was initiated.  
Type: Timestamp  
Required: No

 ** requestedBy **   
The ID of the AWS account that initiated the request.  
Type: String  
Required: No

 ** status **   
The status of the request. For more information, see [ View billing assignment requests for a shared Amazon EC2 Capacity Reservation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/view-billing-transfers.html).  
Type: String  
Valid Values: `pending | accepted | rejected | cancelled | revoked | expired`   
Required: No

 ** statusMessage **   
Information about the status.  
Type: String  
Required: No

 ** unusedReservationBillingOwnerId **   
The ID of the AWS account to which the request was sent.  
Type: String  
Length Constraints: Fixed length of 12.  
Pattern: `[0-9]{12}`   
Required: No

## See Also
<a name="API_CapacityReservationBillingRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationBillingRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationBillingRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationBillingRequest) 

# CapacityReservationCommitmentInfo
<a name="API_CapacityReservationCommitmentInfo"></a>

Information about your commitment for a future-dated Capacity Reservation.

## Contents
<a name="API_CapacityReservationCommitmentInfo_Contents"></a>

 ** commitmentEndDate **   
The date and time at which the commitment duration expires, in the ISO8601 format in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`). You can't decrease the instance count or cancel the Capacity Reservation before this date and time.  
Type: Timestamp  
Required: No

 ** committedInstanceCount **   
The instance capacity that you committed to when you requested the future-dated Capacity Reservation.  
Type: Integer  
Required: No

## See Also
<a name="API_CapacityReservationCommitmentInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationCommitmentInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationCommitmentInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationCommitmentInfo) 

# CapacityReservationFleet
<a name="API_CapacityReservationFleet"></a>

Information about a Capacity Reservation Fleet.

## Contents
<a name="API_CapacityReservationFleet_Contents"></a>

 ** allocationStrategy **   
The strategy used by the Capacity Reservation Fleet to determine which of the specified instance types to use. For more information, see 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*.  
Type: String  
Required: No

 ** capacityReservationFleetArn **   
The ARN of the Capacity Reservation Fleet.  
Type: String  
Required: No

 ** capacityReservationFleetId **   
The ID of the Capacity Reservation Fleet.  
Type: String  
Required: No

 ** createTime **   
The date and time at which the Capacity Reservation Fleet was created.  
Type: Timestamp  
Required: No

 ** endDate **   
The date and time at which the Capacity Reservation Fleet expires.  
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

 ** InstanceTypeSpecificationSet.N **   
Information about the instance types for which to reserve the capacity.  
Type: Array of [FleetCapacityReservation](API_FleetCapacityReservation.md) objects  
Required: No

 ** state **   
The state of the Capacity Reservation Fleet. Possible states include:  
+  `submitted` - The Capacity Reservation Fleet request has been submitted and Amazon Elastic Compute Cloud is preparing to create the Capacity Reservations.
+  `modifying` - The Capacity Reservation Fleet is being modified. The Fleet remains in this state until the modification is complete.
+  `active` - The Capacity Reservation Fleet has fulfilled its total target capacity and it is attempting to maintain this capacity. The Fleet remains in this state until it is modified or deleted.
+  `partially_fulfilled` - The Capacity Reservation Fleet has partially fulfilled its total target capacity. There is insufficient Amazon EC2 to fulfill the total target capacity. The Fleet is attempting to asynchronously fulfill its total target capacity.
+  `expiring` - The Capacity Reservation Fleet has reach its end date and it is in the process of expiring. One or more of its Capacity reservations might still be active.
+  `expired` - The Capacity Reservation Fleet has reach its end date. The Fleet and its Capacity Reservations are expired. The Fleet can't create new Capacity Reservations.
+  `cancelling` - The Capacity Reservation Fleet is in the process of being cancelled. One or more of its Capacity reservations might still be active.
+  `cancelled` - The Capacity Reservation Fleet has been manually cancelled. The Fleet and its Capacity Reservations are cancelled and the Fleet can't create new Capacity Reservations.
+  `failed` - The Capacity Reservation Fleet failed to reserve capacity for the specified instance types.
Type: String  
Valid Values: `submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed`   
Required: No

 ** TagSet.N **   
The tags assigned to the Capacity Reservation Fleet.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** tenancy **   
The tenancy of the Capacity Reservation Fleet. Tenancies include:  
+  `default` - The Capacity Reservation Fleet is created on hardware that is shared with other AWS accounts.
+  `dedicated` - The Capacity Reservation Fleet is created on single-tenant hardware that is dedicated to a single AWS account.
Type: String  
Valid Values: `default`   
Required: No

 ** totalFulfilledCapacity **   
The capacity units that have been fulfilled.  
Type: Double  
Required: No

 ** totalTargetCapacity **   
The total number of capacity units for which the Capacity Reservation Fleet reserves capacity. 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

## See Also
<a name="API_CapacityReservationFleet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationFleet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationFleet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationFleet) 

# CapacityReservationFleetCancellationState
<a name="API_CapacityReservationFleetCancellationState"></a>

Describes a Capacity Reservation Fleet that was successfully cancelled.

## Contents
<a name="API_CapacityReservationFleetCancellationState_Contents"></a>

 ** capacityReservationFleetId **   
The ID of the Capacity Reservation Fleet that was successfully cancelled.  
Type: String  
Required: No

 ** currentFleetState **   
The current state of the Capacity Reservation Fleet.  
Type: String  
Valid Values: `submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed`   
Required: No

 ** previousFleetState **   
The previous state of the Capacity Reservation Fleet.  
Type: String  
Valid Values: `submitted | modifying | active | partially_fulfilled | expiring | expired | cancelling | cancelled | failed`   
Required: No

## See Also
<a name="API_CapacityReservationFleetCancellationState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationFleetCancellationState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationFleetCancellationState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationFleetCancellationState) 

# CapacityReservationGroup
<a name="API_CapacityReservationGroup"></a>

Describes a resource group to which a Capacity Reservation has been added.

## Contents
<a name="API_CapacityReservationGroup_Contents"></a>

 ** groupArn **   
The ARN of the resource group.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the resource group.  
Type: String  
Required: No

## See Also
<a name="API_CapacityReservationGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationGroup) 

# CapacityReservationInfo
<a name="API_CapacityReservationInfo"></a>

Information about a Capacity Reservation.

## Contents
<a name="API_CapacityReservationInfo_Contents"></a>

 ** availabilityZone **   
The Availability Zone for the Capacity Reservation.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** instanceType **   
The instance type for the Capacity Reservation.  
Type: String  
Required: No

 ** tenancy **   
The tenancy of the Capacity Reservation.  
Type: String  
Valid Values: `default | dedicated`   
Required: No

## See Also
<a name="API_CapacityReservationInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationInfo) 

# CapacityReservationOptions
<a name="API_CapacityReservationOptions"></a>

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

**Note**  
This strategy can only be used if the EC2 Fleet is of type `instant`.

For more information about Capacity Reservations, see [On-Demand Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide*. For examples of using Capacity Reservations in an EC2 Fleet, see [EC2 Fleet example configurations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_CapacityReservationOptions_Contents"></a>

 ** usageStrategy **   
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.  
If you specify `use-capacity-reservations-first`, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (`lowest-price` or `prioritized`) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (`lowest-price` or `prioritized`).  
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.  
Type: String  
Valid Values: `use-capacity-reservations-first`   
Required: No

## See Also
<a name="API_CapacityReservationOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationOptions) 

# CapacityReservationOptionsRequest
<a name="API_CapacityReservationOptionsRequest"></a>

Describes the strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.

**Note**  
This strategy can only be used if the EC2 Fleet is of type `instant`.

For more information about Capacity Reservations, see [On-Demand Capacity Reservations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-capacity-reservations.html) in the *Amazon EC2 User Guide*. For examples of using Capacity Reservations in an EC2 Fleet, see [EC2 Fleet example configurations](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-examples.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_CapacityReservationOptionsRequest_Contents"></a>

 ** UsageStrategy **   
Indicates whether to use unused Capacity Reservations for fulfilling On-Demand capacity.  
If you specify `use-capacity-reservations-first`, the fleet uses unused Capacity Reservations to fulfill On-Demand capacity up to the target On-Demand capacity. If multiple instance pools have unused Capacity Reservations, the On-Demand allocation strategy (`lowest-price` or `prioritized`) is applied. If the number of unused Capacity Reservations is less than the On-Demand target capacity, the remaining On-Demand target capacity is launched according to the On-Demand allocation strategy (`lowest-price` or `prioritized`).  
If you do not specify a value, the fleet fulfils the On-Demand capacity according to the chosen On-Demand allocation strategy.  
Type: String  
Valid Values: `use-capacity-reservations-first`   
Required: No

## See Also
<a name="API_CapacityReservationOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationOptionsRequest) 

# CapacityReservationSpecification
<a name="API_CapacityReservationSpecification"></a>

Describes an instance's Capacity Reservation targeting option. 

Use the `CapacityReservationPreference` parameter to configure the instance to run as an On-Demand Instance, to run in any `open` Capacity Reservation that has matching attributes, or to run only in a Capacity Reservation or Capacity Reservation group. Use the `CapacityReservationTarget` parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

You can only specify `CapacityReservationPreference` and `CapacityReservationTarget` if the `CapacityReservationPreference` is `capacity-reservations-only`.

## Contents
<a name="API_CapacityReservationSpecification_Contents"></a>

 ** CapacityReservationPreference **   
Indicates the instance's Capacity Reservation preferences. Possible preferences include:  
+  `capacity-reservations-only` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.
+  `open` - The instance can run in any `open` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, and tenancy). If capacity isn't available, the instance runs as an On-Demand Instance.
+  `none` - The instance doesn't run in a Capacity Reservation even if one is available. The instance runs as an On-Demand Instance.
Type: String  
Valid Values: `capacity-reservations-only | open | none`   
Required: No

 ** CapacityReservationTarget **   
Information about the target Capacity Reservation or Capacity Reservation group.  
Type: [CapacityReservationTarget](API_CapacityReservationTarget.md) object  
Required: No

## See Also
<a name="API_CapacityReservationSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationSpecification) 

# CapacityReservationSpecificationResponse
<a name="API_CapacityReservationSpecificationResponse"></a>

Describes the instance's Capacity Reservation targeting preferences. The action returns the `capacityReservationPreference` response element if the instance is configured to run in On-Demand capacity, or if it is configured in run in any `open` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). The action returns the `capacityReservationTarget` response element if the instance explicily targets a specific Capacity Reservation or Capacity Reservation group.

## Contents
<a name="API_CapacityReservationSpecificationResponse_Contents"></a>

 ** capacityReservationPreference **   
Describes the instance's Capacity Reservation preferences. Possible preferences include:  
+  `open` - The instance can run in any `open` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
+  `none` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Type: String  
Valid Values: `capacity-reservations-only | open | none`   
Required: No

 ** capacityReservationTarget **   
Information about the targeted Capacity Reservation or Capacity Reservation group.  
Type: [CapacityReservationTargetResponse](API_CapacityReservationTargetResponse.md) object  
Required: No

## See Also
<a name="API_CapacityReservationSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationSpecificationResponse) 

# CapacityReservationStatus
<a name="API_CapacityReservationStatus"></a>

Describes the availability of capacity for a Capacity Reservation.

## Contents
<a name="API_CapacityReservationStatus_Contents"></a>

 ** capacityReservationId **   
The ID of the Capacity Reservation.  
Type: String  
Required: No

 ** totalAvailableCapacity **   
The remaining capacity. Indicates the amount of resources that can be launched into the Capacity Reservation.  
Type: Integer  
Required: No

 ** totalCapacity **   
The combined amount of `Available` and `Unavailable` capacity in the Capacity Reservation.  
Type: Integer  
Required: No

 ** totalUnavailableCapacity **   
The used capacity. Indicates that the capacity is in use by resources that are running in the Capacity Reservation.  
Type: Integer  
Required: No

## See Also
<a name="API_CapacityReservationStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationStatus) 

# CapacityReservationTarget
<a name="API_CapacityReservationTarget"></a>

Describes a target Capacity Reservation or Capacity Reservation group.

## Contents
<a name="API_CapacityReservationTarget_Contents"></a>

 ** CapacityReservationId **   
The ID of the Capacity Reservation in which to run the instance.  
Type: String  
Required: No

 ** CapacityReservationResourceGroupArn **   
The ARN of the Capacity Reservation resource group in which to run the instance.  
Type: String  
Required: No

## See Also
<a name="API_CapacityReservationTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationTarget) 

# CapacityReservationTargetResponse
<a name="API_CapacityReservationTargetResponse"></a>

Describes a target Capacity Reservation or Capacity Reservation group.

## Contents
<a name="API_CapacityReservationTargetResponse_Contents"></a>

 ** capacityReservationId **   
The ID of the targeted Capacity Reservation.  
Type: String  
Required: No

 ** capacityReservationResourceGroupArn **   
The ARN of the targeted Capacity Reservation group.  
Type: String  
Required: No

## See Also
<a name="API_CapacityReservationTargetResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationTargetResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationTargetResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationTargetResponse) 

# CapacityReservationTopology
<a name="API_CapacityReservationTopology"></a>

Information about the Capacity Reservation topology.

## Contents
<a name="API_CapacityReservationTopology_Contents"></a>

 ** availabilityZone **   
The name of the Availability Zone or Local Zone that the Capacity Reservation is in.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone or Local Zone that the Capacity Reservation is in.  
Type: String  
Required: No

 ** capacityBlockId **   
The ID of the Capacity Block. This parameter is only supported for UltraServer instances and identifies instances within the UltraServer domain.  
Type: String  
Required: No

 ** capacityReservationId **   
The ID of the Capacity Reservation.  
Type: String  
Required: No

 ** groupName **   
The name of the placement group that the Capacity Reservation is in.  
Type: String  
Required: No

 ** instanceType **   
The instance type.  
Type: String  
Required: No

 ** NetworkNodeSet.N **   
The network nodes. The nodes are hashed based on your account. Capacity Reservations from different accounts running under the same server will return a different hashed list of strings.  
The value is `null` or empty if:  
+ The instance type is not supported.
+ The Capacity Reservation is in a state other than `active` or `pending`.
Type: Array of strings  
Required: No

 ** state **   
The current state of the Capacity Reservation. For the list of possible states, see [DescribeCapacityReservations](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeCapacityReservations.html).  
Type: String  
Required: No

## See Also
<a name="API_CapacityReservationTopology_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CapacityReservationTopology) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CapacityReservationTopology) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CapacityReservationTopology) 

# CarrierGateway
<a name="API_CarrierGateway"></a>

Describes a carrier gateway.

## Contents
<a name="API_CarrierGateway_Contents"></a>

 ** carrierGatewayId **   
The ID of the carrier gateway.  
Type: String  
Required: No

 ** ownerId **   
The AWS account ID of the owner of the carrier gateway.  
Type: String  
Required: No

 ** state **   
The state of the carrier gateway.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** TagSet.N **   
The tags assigned to the carrier gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC associated with the carrier gateway.  
Type: String  
Required: No

## See Also
<a name="API_CarrierGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CarrierGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CarrierGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CarrierGateway) 

# CertificateAuthentication
<a name="API_CertificateAuthentication"></a>

Information about the client certificate used for authentication.

## Contents
<a name="API_CertificateAuthentication_Contents"></a>

 ** clientRootCertificateChain **   
The ARN of the client certificate.   
Type: String  
Required: No

## See Also
<a name="API_CertificateAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CertificateAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CertificateAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CertificateAuthentication) 

# CertificateAuthenticationRequest
<a name="API_CertificateAuthenticationRequest"></a>

Information about the client certificate to be used for authentication.

## Contents
<a name="API_CertificateAuthenticationRequest_Contents"></a>

 ** ClientRootCertificateChainArn **   
The ARN of the client certificate. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).  
Type: String  
Required: No

## See Also
<a name="API_CertificateAuthenticationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CertificateAuthenticationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CertificateAuthenticationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CertificateAuthenticationRequest) 

# CidrAuthorizationContext
<a name="API_CidrAuthorizationContext"></a>

Provides authorization for Amazon to bring a specific IP address range to a specific AWS account using bring your own IP addresses (BYOIP). For more information, see [Configuring your BYOIP address range](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-byoip.html#prepare-for-byoip) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_CidrAuthorizationContext_Contents"></a>

 ** Message **   
The plain-text authorization message for the prefix and account.  
Type: String  
Required: Yes

 ** Signature **   
The signed authorization message for the prefix and account.  
Type: String  
Required: Yes

## See Also
<a name="API_CidrAuthorizationContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CidrAuthorizationContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CidrAuthorizationContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CidrAuthorizationContext) 

# CidrBlock
<a name="API_CidrBlock"></a>

Describes an IPv4 CIDR block.

## Contents
<a name="API_CidrBlock_Contents"></a>

 ** cidrBlock **   
The IPv4 CIDR block.  
Type: String  
Required: No

## See Also
<a name="API_CidrBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CidrBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CidrBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CidrBlock) 

# ClassicLinkDnsSupport
<a name="API_ClassicLinkDnsSupport"></a>

**Note**  
Deprecated.

Describes the ClassicLink DNS support status of a VPC.

## Contents
<a name="API_ClassicLinkDnsSupport_Contents"></a>

 ** classicLinkDnsSupported **   
Indicates whether ClassicLink DNS support is enabled for the VPC.  
Type: Boolean  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_ClassicLinkDnsSupport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClassicLinkDnsSupport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClassicLinkDnsSupport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClassicLinkDnsSupport) 

# ClassicLinkInstance
<a name="API_ClassicLinkInstance"></a>

**Note**  
Deprecated.

Describes a linked EC2-Classic instance.

## Contents
<a name="API_ClassicLinkInstance_Contents"></a>

 ** GroupSet.N **   
The security groups.  
Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the instance.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_ClassicLinkInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClassicLinkInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClassicLinkInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClassicLinkInstance) 

# ClassicLoadBalancer
<a name="API_ClassicLoadBalancer"></a>

Describes a Classic Load Balancer.

## Contents
<a name="API_ClassicLoadBalancer_Contents"></a>

 ** Name ** (request), ** name ** (response)  
The name of the load balancer.  
Type: String  
Required: No

## See Also
<a name="API_ClassicLoadBalancer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClassicLoadBalancer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClassicLoadBalancer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClassicLoadBalancer) 

# ClassicLoadBalancersConfig
<a name="API_ClassicLoadBalancersConfig"></a>

Describes the Classic Load Balancers to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these Classic Load Balancers.

## Contents
<a name="API_ClassicLoadBalancersConfig_Contents"></a>

 ** ClassicLoadBalancers.N **   
One or more Classic Load Balancers.  
Type: Array of [ClassicLoadBalancer](API_ClassicLoadBalancer.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

## See Also
<a name="API_ClassicLoadBalancersConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClassicLoadBalancersConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClassicLoadBalancersConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClassicLoadBalancersConfig) 

# ClientCertificateRevocationListStatus
<a name="API_ClientCertificateRevocationListStatus"></a>

Describes the state of a client certificate revocation list.

## Contents
<a name="API_ClientCertificateRevocationListStatus_Contents"></a>

 ** code **   
The state of the client certificate revocation list.  
Type: String  
Valid Values: `pending | active`   
Required: No

 ** message **   
A message about the status of the client certificate revocation list, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_ClientCertificateRevocationListStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientCertificateRevocationListStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientCertificateRevocationListStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientCertificateRevocationListStatus) 

# ClientConnectOptions
<a name="API_ClientConnectOptions"></a>

The options for managing connection authorization for new client connections.

## Contents
<a name="API_ClientConnectOptions_Contents"></a>

 ** Enabled **   
Indicates whether client connect options are enabled. The default is `false` (not enabled).  
Type: Boolean  
Required: No

 ** LambdaFunctionArn **   
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.  
Type: String  
Required: No

## See Also
<a name="API_ClientConnectOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientConnectOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientConnectOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientConnectOptions) 

# ClientConnectResponseOptions
<a name="API_ClientConnectResponseOptions"></a>

The options for managing connection authorization for new client connections.

## Contents
<a name="API_ClientConnectResponseOptions_Contents"></a>

 ** enabled **   
Indicates whether client connect options are enabled.  
Type: Boolean  
Required: No

 ** lambdaFunctionArn **   
The Amazon Resource Name (ARN) of the Lambda function used for connection authorization.  
Type: String  
Required: No

 ** status **   
The status of any updates to the client connect options.  
Type: [ClientVpnEndpointAttributeStatus](API_ClientVpnEndpointAttributeStatus.md) object  
Required: No

## See Also
<a name="API_ClientConnectResponseOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientConnectResponseOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientConnectResponseOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientConnectResponseOptions) 

# ClientData
<a name="API_ClientData"></a>

Describes the client-specific data.

## Contents
<a name="API_ClientData_Contents"></a>

 ** Comment **   
A user-defined comment about the disk upload.  
Type: String  
Required: No

 ** UploadEnd **   
The time that the disk upload ends.  
Type: Timestamp  
Required: No

 ** UploadSize **   
The size of the uploaded disk image, in GiB.  
Type: Double  
Required: No

 ** UploadStart **   
The time that the disk upload starts.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ClientData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientData) 

# ClientLoginBannerOptions
<a name="API_ClientLoginBannerOptions"></a>

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

## Contents
<a name="API_ClientLoginBannerOptions_Contents"></a>

 ** BannerText **   
Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.  
Type: String  
Required: No

 ** Enabled **   
Enable or disable a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.  
Valid values: `true | false`   
Default value: `false`   
Type: Boolean  
Required: No

## See Also
<a name="API_ClientLoginBannerOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientLoginBannerOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientLoginBannerOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientLoginBannerOptions) 

# ClientLoginBannerResponseOptions
<a name="API_ClientLoginBannerResponseOptions"></a>

Current state of options for customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

## Contents
<a name="API_ClientLoginBannerResponseOptions_Contents"></a>

 ** bannerText **   
Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.  
Type: String  
Required: No

 ** enabled **   
Current state of text banner feature.  
Valid values: `true | false`   
Type: Boolean  
Required: No

## See Also
<a name="API_ClientLoginBannerResponseOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientLoginBannerResponseOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientLoginBannerResponseOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientLoginBannerResponseOptions) 

# ClientRouteEnforcementOptions
<a name="API_ClientRouteEnforcementOptions"></a>

Client Route Enforcement is a feature of Client VPN that helps enforce administrator defined routes on devices connected through the VPN. This 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.

## Contents
<a name="API_ClientRouteEnforcementOptions_Contents"></a>

 ** Enforced **   
Enable or disable Client Route Enforcement. The state can either be `true` (enabled) or `false` (disabled). The default is `false`.  
Valid values: `true | false`   
Default value: `false`   
Type: Boolean  
Required: No

## See Also
<a name="API_ClientRouteEnforcementOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientRouteEnforcementOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientRouteEnforcementOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientRouteEnforcementOptions) 

# ClientRouteEnforcementResponseOptions
<a name="API_ClientRouteEnforcementResponseOptions"></a>

The current status of Client Route Enforcement. 

## Contents
<a name="API_ClientRouteEnforcementResponseOptions_Contents"></a>

 ** enforced **   
Status of the client route enforcement feature, indicating whether Client Route Enforcement is `true` (enabled) or `false` (disabled).  
Valid values: `true | false`   
Default value: `false`   
Type: Boolean  
Required: No

## See Also
<a name="API_ClientRouteEnforcementResponseOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientRouteEnforcementResponseOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientRouteEnforcementResponseOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientRouteEnforcementResponseOptions) 

# ClientVpnAuthentication
<a name="API_ClientVpnAuthentication"></a>

Describes the authentication methods used by a Client VPN endpoint. For more information, see [Authentication](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/client-authentication.html) in the * AWS Client VPN Administrator Guide*.

## Contents
<a name="API_ClientVpnAuthentication_Contents"></a>

 ** activeDirectory **   
Information about the Active Directory, if applicable.  
Type: [DirectoryServiceAuthentication](API_DirectoryServiceAuthentication.md) object  
Required: No

 ** federatedAuthentication **   
Information about the IAM SAML identity provider, if applicable.  
Type: [FederatedAuthentication](API_FederatedAuthentication.md) object  
Required: No

 ** mutualAuthentication **   
Information about the authentication certificates, if applicable.  
Type: [CertificateAuthentication](API_CertificateAuthentication.md) object  
Required: No

 ** type **   
The authentication type used.  
Type: String  
Valid Values: `certificate-authentication | directory-service-authentication | federated-authentication`   
Required: No

## See Also
<a name="API_ClientVpnAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnAuthentication) 

# ClientVpnAuthenticationRequest
<a name="API_ClientVpnAuthenticationRequest"></a>

Describes the authentication method to be used by a Client VPN endpoint. For more information, see [Authentication](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/authentication-authrization.html#client-authentication) in the * AWS Client VPN Administrator Guide*.

## Contents
<a name="API_ClientVpnAuthenticationRequest_Contents"></a>

 ** ActiveDirectory **   
Information about the Active Directory to be used, if applicable. You must provide this information if **Type** is `directory-service-authentication`.  
Type: [DirectoryServiceAuthenticationRequest](API_DirectoryServiceAuthenticationRequest.md) object  
Required: No

 ** FederatedAuthentication **   
Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if **Type** is `federated-authentication`.  
Type: [FederatedAuthenticationRequest](API_FederatedAuthenticationRequest.md) object  
Required: No

 ** MutualAuthentication **   
Information about the authentication certificates to be used, if applicable. You must provide this information if **Type** is `certificate-authentication`.  
Type: [CertificateAuthenticationRequest](API_CertificateAuthenticationRequest.md) object  
Required: No

 ** Type **   
The type of client authentication to be used.  
Type: String  
Valid Values: `certificate-authentication | directory-service-authentication | federated-authentication`   
Required: No

## See Also
<a name="API_ClientVpnAuthenticationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnAuthenticationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnAuthenticationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnAuthenticationRequest) 

# ClientVpnAuthorizationRuleStatus
<a name="API_ClientVpnAuthorizationRuleStatus"></a>

Describes the state of an authorization rule.

## Contents
<a name="API_ClientVpnAuthorizationRuleStatus_Contents"></a>

 ** code **   
The state of the authorization rule.  
Type: String  
Valid Values: `authorizing | active | failed | revoking`   
Required: No

 ** message **   
A message about the status of the authorization rule, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_ClientVpnAuthorizationRuleStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnAuthorizationRuleStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnAuthorizationRuleStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnAuthorizationRuleStatus) 

# ClientVpnConnection
<a name="API_ClientVpnConnection"></a>

Describes a client connection.

## Contents
<a name="API_ClientVpnConnection_Contents"></a>

 ** clientIp **   
The IP address of the client.  
Type: String  
Required: No

 ** clientIpv6Address **   
The IPv6 address assigned to the client connection when using a dual-stack Client VPN endpoint. This field is only populated when the endpoint is configured for dual-stack addressing, and the client is using IPv6 for connectivity.  
Type: String  
Required: No

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

 ** commonName **   
The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.  
Type: String  
Required: No

 ** connectionEndTime **   
The date and time the client connection was terminated.  
Type: String  
Required: No

 ** connectionEstablishedTime **   
The date and time the client connection was established.  
Type: String  
Required: No

 ** connectionId **   
The ID of the client connection.  
Type: String  
Required: No

 ** egressBytes **   
The number of bytes received by the client.  
Type: String  
Required: No

 ** egressPackets **   
The number of packets received by the client.  
Type: String  
Required: No

 ** ingressBytes **   
The number of bytes sent by the client.  
Type: String  
Required: No

 ** ingressPackets **   
The number of packets sent by the client.  
Type: String  
Required: No

 ** PostureComplianceStatusSet.N **   
The statuses returned by the client connect handler for posture compliance, if applicable.  
Type: Array of strings  
Required: No

 ** status **   
The current state of the client connection.  
Type: [ClientVpnConnectionStatus](API_ClientVpnConnectionStatus.md) object  
Required: No

 ** timestamp **   
The current date and time.  
Type: String  
Required: No

 ** username **   
The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.  
Type: String  
Required: No

## See Also
<a name="API_ClientVpnConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnConnection) 

# ClientVpnConnectionStatus
<a name="API_ClientVpnConnectionStatus"></a>

Describes the status of a client connection.

## Contents
<a name="API_ClientVpnConnectionStatus_Contents"></a>

 ** code **   
The state of the client connection.  
Type: String  
Valid Values: `active | failed-to-terminate | terminating | terminated`   
Required: No

 ** message **   
A message about the status of the client connection, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_ClientVpnConnectionStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnConnectionStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnConnectionStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnConnectionStatus) 

# ClientVpnEndpoint
<a name="API_ClientVpnEndpoint"></a>

Describes a Client VPN endpoint.

## Contents
<a name="API_ClientVpnEndpoint_Contents"></a>

 ** AssociatedTargetNetwork.N **   
 *This member has been deprecated.*   
Information about the associated target networks. A target network is a subnet in a VPC.  
Type: Array of [AssociatedTargetNetwork](API_AssociatedTargetNetwork.md) objects  
Required: No

 ** AuthenticationOptions.N **   
Information about the authentication method used by the Client VPN endpoint.  
Type: Array of [ClientVpnAuthentication](API_ClientVpnAuthentication.md) objects  
Required: No

 ** clientCidrBlock **   
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.  
Type: String  
Required: No

 ** clientConnectOptions **   
The options for managing connection authorization for new client connections.  
Type: [ClientConnectResponseOptions](API_ClientConnectResponseOptions.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: [ClientLoginBannerResponseOptions](API_ClientLoginBannerResponseOptions.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: [ClientRouteEnforcementResponseOptions](API_ClientRouteEnforcementResponseOptions.md) object  
Required: No

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

 ** connectionLogOptions **   
Information about the client connection logging options for the Client VPN endpoint.  
Type: [ConnectionLogResponseOptions](API_ConnectionLogResponseOptions.md) object  
Required: No

 ** creationTime **   
The date and time the Client VPN endpoint was created.  
Type: String  
Required: No

 ** deletionTime **   
The date and time the Client VPN endpoint was deleted, if applicable.  
Type: String  
Required: No

 ** description **   
A brief description of the endpoint.  
Type: String  
Required: No

 ** disconnectOnSessionTimeout **   
Indicates whether the client VPN session is disconnected after the maximum `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

 ** dnsName **   
The DNS name to be used by clients when connecting to the Client VPN endpoint.  
Type: String  
Required: No

 ** DnsServer.N **   
Information about the DNS servers to be used for DNS resolution.   
Type: Array of strings  
Required: No

 ** endpointIpAddressType **   
The IP address type of the Client VPN endpoint. Possible values are `ipv4` for IPv4 addressing only, `ipv6` for IPv6 addressing only, or `dual-stack `for both IPv4 and IPv6 addressing.  
Type: String  
Valid Values: `ipv4 | ipv6 | dual-stack`   
Required: No

 ** SecurityGroupIdSet.N **   
The IDs of the security groups for the target network.  
Type: Array of strings  
Required: No

 ** selfServicePortalUrl **   
The URL of the self-service portal.  
Type: String  
Required: No

 ** serverCertificateArn **   
The ARN of the server certificate.  
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 split-tunnel is enabled in the AWS Client VPN endpoint.  
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

 ** status **   
The current state of the Client VPN endpoint.  
Type: [ClientVpnEndpointStatus](API_ClientVpnEndpointStatus.md) object  
Required: No

 ** TagSet.N **   
Any tags assigned to the Client VPN endpoint.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trafficIpAddressType **   
The IP address type of the Client VPN endpoint. Possible values are either `ipv4` for IPv4 addressing only, `ipv6` for IPv6 addressing only, or `dual-stack` for both IPv4 and IPv6 addressing.  
Type: String  
Valid Values: `ipv4 | ipv6 | dual-stack`   
Required: No

 ** transportProtocol **   
The transport protocol used by the Client VPN endpoint.  
Type: String  
Valid Values: `tcp | udp`   
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

 ** vpnPort **   
The port number for the Client VPN endpoint.  
Type: Integer  
Required: No

 ** vpnProtocol **   
The protocol used by the VPN session.  
Type: String  
Valid Values: `openvpn`   
Required: No

## See Also
<a name="API_ClientVpnEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnEndpoint) 

# ClientVpnEndpointAttributeStatus
<a name="API_ClientVpnEndpointAttributeStatus"></a>

Describes the status of the Client VPN endpoint attribute.

## Contents
<a name="API_ClientVpnEndpointAttributeStatus_Contents"></a>

 ** code **   
The status code.  
Type: String  
Valid Values: `applying | applied`   
Required: No

 ** message **   
The status message.  
Type: String  
Required: No

## See Also
<a name="API_ClientVpnEndpointAttributeStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnEndpointAttributeStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnEndpointAttributeStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnEndpointAttributeStatus) 

# ClientVpnEndpointStatus
<a name="API_ClientVpnEndpointStatus"></a>

Describes the state of a Client VPN endpoint.

## Contents
<a name="API_ClientVpnEndpointStatus_Contents"></a>

 ** code **   
The state of the Client VPN endpoint. Possible states include:  
+  `pending-associate` - The Client VPN endpoint has been created but no target networks have been associated. The Client VPN endpoint cannot accept connections.
+  `available` - The Client VPN endpoint has been created and a target network has been associated. The Client VPN endpoint can accept connections.
+  `deleting` - The Client VPN endpoint is being deleted. The Client VPN endpoint cannot accept connections.
+  `deleted` - The Client VPN endpoint has been deleted. The Client VPN endpoint cannot accept connections.
Type: String  
Valid Values: `pending-associate | available | deleting | deleted`   
Required: No

 ** message **   
A message about the status of the Client VPN endpoint.  
Type: String  
Required: No

## See Also
<a name="API_ClientVpnEndpointStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnEndpointStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnEndpointStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnEndpointStatus) 

# ClientVpnRoute
<a name="API_ClientVpnRoute"></a>

Information about a Client VPN endpoint route.

## Contents
<a name="API_ClientVpnRoute_Contents"></a>

 ** clientVpnEndpointId **   
The ID of the Client VPN endpoint with which the route is associated.  
Type: String  
Required: No

 ** description **   
A brief description of the route.  
Type: String  
Required: No

 ** destinationCidr **   
The IPv4 address range, in CIDR notation, of the route destination.  
Type: String  
Required: No

 ** origin **   
Indicates how the route was associated with the Client VPN endpoint. `associate` indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. `add-route` indicates that the route was manually added using the **CreateClientVpnRoute** action.  
Type: String  
Required: No

 ** status **   
The current state of the route.  
Type: [ClientVpnRouteStatus](API_ClientVpnRouteStatus.md) object  
Required: No

 ** targetSubnet **   
The ID of the subnet through which traffic is routed.  
Type: String  
Required: No

 ** type **   
The route type.  
Type: String  
Required: No

## See Also
<a name="API_ClientVpnRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnRoute) 

# ClientVpnRouteStatus
<a name="API_ClientVpnRouteStatus"></a>

Describes the state of a Client VPN endpoint route.

## Contents
<a name="API_ClientVpnRouteStatus_Contents"></a>

 ** code **   
The state of the Client VPN endpoint route.  
Type: String  
Valid Values: `creating | active | failed | deleting`   
Required: No

 ** message **   
A message about the status of the Client VPN endpoint route, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_ClientVpnRouteStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ClientVpnRouteStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ClientVpnRouteStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ClientVpnRouteStatus) 

# CloudWatchLogOptions
<a name="API_CloudWatchLogOptions"></a>

Options for sending VPN tunnel logs to CloudWatch.

## Contents
<a name="API_CloudWatchLogOptions_Contents"></a>

 ** bgpLogEnabled **   
Indicates whether Border Gateway Protocol (BGP) logging is enabled for the VPN connection. Default value is `False`.  
Valid values: `True` \$1 `False`   
Type: Boolean  
Required: No

 ** bgpLogGroupArn **   
The Amazon Resource Name (ARN) of the CloudWatch log group for BGP logs.  
Type: String  
Required: No

 ** bgpLogOutputFormat **   
The output format for BGP logs sent to CloudWatch. Default format is `json`.  
Valid values: `json` \$1 `text`   
Type: String  
Required: No

 ** logEnabled **   
Status of VPN tunnel logging feature. Default value is `False`.  
Valid values: `True` \$1 `False`   
Type: Boolean  
Required: No

 ** logGroupArn **   
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.  
Type: String  
Required: No

 ** logOutputFormat **   
Configured log format. Default format is `json`.  
Valid values: `json` \$1 `text`   
Type: String  
Required: No

## See Also
<a name="API_CloudWatchLogOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CloudWatchLogOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CloudWatchLogOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CloudWatchLogOptions) 

# CloudWatchLogOptionsSpecification
<a name="API_CloudWatchLogOptionsSpecification"></a>

Options for sending VPN tunnel logs to CloudWatch.

## Contents
<a name="API_CloudWatchLogOptionsSpecification_Contents"></a>

 ** BgpLogEnabled **   
Specifies whether to enable BGP logging for the VPN connection. Default value is `False`.  
Valid values: `True` \$1 `False`   
Type: Boolean  
Required: No

 ** BgpLogGroupArn **   
The Amazon Resource Name (ARN) of the CloudWatch log group where BGP logs will be sent.  
Type: String  
Required: No

 ** BgpLogOutputFormat **   
The desired output format for BGP logs to be sent to CloudWatch. Default format is `json`.  
Valid values: `json` \$1 `text`   
Type: String  
Required: No

 ** LogEnabled **   
Enable or disable VPN tunnel logging feature. Default value is `False`.  
Valid values: `True` \$1 `False`   
Type: Boolean  
Required: No

 ** LogGroupArn **   
The Amazon Resource Name (ARN) of the CloudWatch log group to send logs to.  
Type: String  
Required: No

 ** LogOutputFormat **   
Set log format. Default format is `json`.  
Valid values: `json` \$1 `text`   
Type: String  
Required: No

## See Also
<a name="API_CloudWatchLogOptionsSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CloudWatchLogOptionsSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CloudWatchLogOptionsSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CloudWatchLogOptionsSpecification) 

# CoipAddressUsage
<a name="API_CoipAddressUsage"></a>

Describes address usage for a customer-owned address pool.

## Contents
<a name="API_CoipAddressUsage_Contents"></a>

 ** allocationId **   
The allocation ID of the address.  
Type: String  
Required: No

 ** awsAccountId **   
The AWS account ID.  
Type: String  
Required: No

 ** awsService **   
The AWS service.  
Type: String  
Required: No

 ** coIp **   
The customer-owned IP address.  
Type: String  
Required: No

## See Also
<a name="API_CoipAddressUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CoipAddressUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CoipAddressUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CoipAddressUsage) 

# CoipCidr
<a name="API_CoipCidr"></a>

 Information about a customer-owned IP address range. 

## Contents
<a name="API_CoipCidr_Contents"></a>

 ** cidr **   
 An address range in a customer-owned IP address space.   
Type: String  
Required: No

 ** coipPoolId **   
 The ID of the address pool.   
Type: String  
Required: No

 ** localGatewayRouteTableId **   
 The ID of the local gateway route table.   
Type: String  
Required: No

## See Also
<a name="API_CoipCidr_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CoipCidr) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CoipCidr) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CoipCidr) 

# CoipPool
<a name="API_CoipPool"></a>

Describes a customer-owned address pool.

## Contents
<a name="API_CoipPool_Contents"></a>

 ** localGatewayRouteTableId **   
The ID of the local gateway route table.  
Type: String  
Required: No

 ** poolArn **   
The ARN of the address pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** PoolCidrSet.N **   
The address ranges of the address pool.  
Type: Array of strings  
Required: No

 ** poolId **   
The ID of the address pool.  
Type: String  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_CoipPool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CoipPool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CoipPool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CoipPool) 

# ConnectionLogOptions
<a name="API_ConnectionLogOptions"></a>

Describes the client connection logging options for the Client VPN endpoint.

## Contents
<a name="API_ConnectionLogOptions_Contents"></a>

 ** CloudwatchLogGroup **   
The name of the CloudWatch Logs log group. Required if connection logging is enabled.  
Type: String  
Required: No

 ** CloudwatchLogStream **   
The name of the CloudWatch Logs log stream to which the connection data is published.  
Type: String  
Required: No

 ** Enabled **   
Indicates whether connection logging is enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_ConnectionLogOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConnectionLogOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConnectionLogOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConnectionLogOptions) 

# ConnectionLogResponseOptions
<a name="API_ConnectionLogResponseOptions"></a>

Information about the client connection logging options for a Client VPN endpoint.

## Contents
<a name="API_ConnectionLogResponseOptions_Contents"></a>

 ** CloudwatchLogGroup **   
The name of the Amazon CloudWatch Logs log group to which connection logging data is published.  
Type: String  
Required: No

 ** CloudwatchLogStream **   
The name of the Amazon CloudWatch Logs log stream to which connection logging data is published.  
Type: String  
Required: No

 ** Enabled **   
Indicates whether client connection logging is enabled for the Client VPN endpoint.  
Type: Boolean  
Required: No

## See Also
<a name="API_ConnectionLogResponseOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConnectionLogResponseOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConnectionLogResponseOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConnectionLogResponseOptions) 

# ConnectionNotification
<a name="API_ConnectionNotification"></a>

Describes a connection notification for a VPC endpoint or VPC endpoint service.

## Contents
<a name="API_ConnectionNotification_Contents"></a>

 ** ConnectionEvents.N **   
The events for the notification. Valid values are `Accept`, `Connect`, `Delete`, and `Reject`.  
Type: Array of strings  
Required: No

 ** connectionNotificationArn **   
The ARN of the SNS topic for the notification.  
Type: String  
Required: No

 ** connectionNotificationId **   
The ID of the notification.  
Type: String  
Required: No

 ** connectionNotificationState **   
The state of the notification.  
Type: String  
Valid Values: `Enabled | Disabled`   
Required: No

 ** connectionNotificationType **   
The type of notification.  
Type: String  
Valid Values: `Topic`   
Required: No

 ** serviceId **   
The ID of the endpoint service.  
Type: String  
Required: No

 ** serviceRegion **   
The Region for the endpoint service.  
Type: String  
Required: No

 ** vpcEndpointId **   
The ID of the VPC endpoint.  
Type: String  
Required: No

## See Also
<a name="API_ConnectionNotification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConnectionNotification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConnectionNotification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConnectionNotification) 

# ConnectionTrackingConfiguration
<a name="API_ConnectionTrackingConfiguration"></a>

A security group connection tracking configuration that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_ConnectionTrackingConfiguration_Contents"></a>

 ** tcpEstablishedTimeout **   
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.  
Type: Integer  
Required: No

 ** udpStreamTimeout **   
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.  
Type: Integer  
Required: No

 ** udpTimeout **   
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.  
Type: Integer  
Required: No

## See Also
<a name="API_ConnectionTrackingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConnectionTrackingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConnectionTrackingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConnectionTrackingConfiguration) 

# ConnectionTrackingSpecification
<a name="API_ConnectionTrackingSpecification"></a>

A security group connection tracking specification that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_ConnectionTrackingSpecification_Contents"></a>

 ** tcpEstablishedTimeout **   
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.  
Type: Integer  
Required: No

 ** udpStreamTimeout **   
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.  
Type: Integer  
Required: No

 ** udpTimeout **   
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.  
Type: Integer  
Required: No

## See Also
<a name="API_ConnectionTrackingSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConnectionTrackingSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConnectionTrackingSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConnectionTrackingSpecification) 

# ConnectionTrackingSpecificationRequest
<a name="API_ConnectionTrackingSpecificationRequest"></a>

A security group connection tracking specification request that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_ConnectionTrackingSpecificationRequest_Contents"></a>

 ** TcpEstablishedTimeout ** (request), ** TcpEstablishedTimeout ** (response)  
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.  
Type: Integer  
Required: No

 ** UdpStreamTimeout ** (request), ** UdpStreamTimeout ** (response)  
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.  
Type: Integer  
Required: No

 ** UdpTimeout ** (request), ** UdpTimeout ** (response)  
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.  
Type: Integer  
Required: No

## See Also
<a name="API_ConnectionTrackingSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConnectionTrackingSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConnectionTrackingSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConnectionTrackingSpecificationRequest) 

# ConnectionTrackingSpecificationResponse
<a name="API_ConnectionTrackingSpecificationResponse"></a>

A security group connection tracking specification response that enables you to set the idle timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_ConnectionTrackingSpecificationResponse_Contents"></a>

 ** tcpEstablishedTimeout **   
Timeout (in seconds) for idle TCP connections in an established state. Min: 60 seconds. Max: 432000 seconds (5 days). Default: 432000 seconds. Recommended: Less than 432000 seconds.  
Type: Integer  
Required: No

 ** udpStreamTimeout **   
Timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction. Min: 60 seconds. Max: 180 seconds (3 minutes). Default: 180 seconds.  
Type: Integer  
Required: No

 ** udpTimeout **   
Timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction. Min: 30 seconds. Max: 60 seconds. Default: 30 seconds.  
Type: Integer  
Required: No

## See Also
<a name="API_ConnectionTrackingSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConnectionTrackingSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConnectionTrackingSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConnectionTrackingSpecificationResponse) 

# ConversionTask
<a name="API_ConversionTask"></a>

Describes a conversion task.

## Contents
<a name="API_ConversionTask_Contents"></a>

 ** conversionTaskId **   
The ID of the conversion task.  
Type: String  
Required: No

 ** expirationTime **   
The time when the task expires. If the upload isn't complete before the expiration time, we automatically cancel the task.  
Type: String  
Required: No

 ** importInstance **   
If the task is for importing an instance, this contains information about the import instance task.  
Type: [ImportInstanceTaskDetails](API_ImportInstanceTaskDetails.md) object  
Required: No

 ** importVolume **   
If the task is for importing a volume, this contains information about the import volume task.  
Type: [ImportVolumeTaskDetails](API_ImportVolumeTaskDetails.md) object  
Required: No

 ** state **   
The state of the conversion task.  
Type: String  
Valid Values: `active | cancelling | cancelled | completed`   
Required: No

 ** statusMessage **   
The status message related to the conversion task.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the task.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ConversionTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ConversionTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ConversionTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ConversionTask) 

# CpuOptions
<a name="API_CpuOptions"></a>

The CPU options for the instance.

## Contents
<a name="API_CpuOptions_Contents"></a>

 ** amdSevSnp **   
Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** coreCount **   
The number of CPU cores for the instance.  
Type: Integer  
Required: No

 ** nestedVirtualization **   
Indicates whether the instance is enabled for nested virtualization.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** threadsPerCore **   
The number of threads per CPU core.  
Type: Integer  
Required: No

## See Also
<a name="API_CpuOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CpuOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CpuOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CpuOptions) 

# CpuOptionsRequest
<a name="API_CpuOptionsRequest"></a>

The CPU options for the instance. Both the core count and threads per core must be specified in the request.

## Contents
<a name="API_CpuOptionsRequest_Contents"></a>

 ** AmdSevSnp **   
Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** CoreCount **   
The number of CPU cores for the instance.  
Type: Integer  
Required: No

 ** NestedVirtualization **   
Indicates whether to enable the instance for nested virtualization. Nested virtualization is supported only on 8th generation Intel-based instance types (c8i, m8i, r8i, and their flex variants). 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 per CPU core. To disable multithreading for the instance, specify a value of `1`. Otherwise, specify the default value of `2`.  
Type: Integer  
Required: No

## See Also
<a name="API_CpuOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CpuOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CpuOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CpuOptionsRequest) 

# CpuPerformanceFactor
<a name="API_CpuPerformanceFactor"></a>

The CPU performance to consider, using an instance family as the baseline reference.

## Contents
<a name="API_CpuPerformanceFactor_Contents"></a>

 ** ReferenceSet.N **   
Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.  
Currently, only one instance family can be specified in the list.
Type: Array of [PerformanceFactorReference](API_PerformanceFactorReference.md) objects  
Required: No

## See Also
<a name="API_CpuPerformanceFactor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CpuPerformanceFactor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CpuPerformanceFactor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CpuPerformanceFactor) 

# CpuPerformanceFactorRequest
<a name="API_CpuPerformanceFactorRequest"></a>

The CPU performance to consider, using an instance family as the baseline reference.

## Contents
<a name="API_CpuPerformanceFactorRequest_Contents"></a>

 ** Reference.N **   
Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture differences.  
Currently, only one instance family can be specified in the list.
Type: Array of [PerformanceFactorReferenceRequest](API_PerformanceFactorReferenceRequest.md) objects  
Required: No

## See Also
<a name="API_CpuPerformanceFactorRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CpuPerformanceFactorRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CpuPerformanceFactorRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CpuPerformanceFactorRequest) 

# CreateFleetError
<a name="API_CreateFleetError"></a>

Describes the instances that could not be launched by the fleet.

## Contents
<a name="API_CreateFleetError_Contents"></a>

 ** errorCode **   
The error code that indicates why the instance could not be launched. For more information about error codes, see [Error codes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html).  
Type: String  
Required: No

 ** errorMessage **   
The error message that describes why the instance could not be launched. For more information about error messages, see [Error codes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html).  
Type: String  
Required: No

 ** launchTemplateAndOverrides **   
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.  
Type: [LaunchTemplateAndOverridesResponse](API_LaunchTemplateAndOverridesResponse.md) object  
Required: No

 ** lifecycle **   
Indicates if the instance that could not be launched was a Spot, On-Demand, Capacity Block, or Interruptible Capacity Reservation instance.  
Type: String  
Valid Values: `spot | on-demand | interruptible-capacity-reservation`   
Required: No

## See Also
<a name="API_CreateFleetError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateFleetError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateFleetError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateFleetError) 

# CreateFleetInstance
<a name="API_CreateFleetInstance"></a>

Describes the instances that were launched by the fleet.

## Contents
<a name="API_CreateFleetInstance_Contents"></a>

 ** InstanceIds.N **   
The IDs of the instances.  
Type: Array of strings  
Required: No

 ** instanceType **   
The instance type.  
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

 ** launchTemplateAndOverrides **   
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.  
Type: [LaunchTemplateAndOverridesResponse](API_LaunchTemplateAndOverridesResponse.md) object  
Required: No

 ** lifecycle **   
Indicates if the instance that was launched is a Spot, On-Demand, Capacity Block, or Interruptible Capacity Reservation instance.  
Type: String  
Valid Values: `spot | on-demand | interruptible-capacity-reservation`   
Required: No

 ** platform **   
The value is `windows` for Windows instances in an EC2 Fleet. Otherwise, the value is blank.  
Type: String  
Valid Values: `Windows`   
Required: No

## See Also
<a name="API_CreateFleetInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateFleetInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateFleetInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateFleetInstance) 

# CreateTransitGatewayConnectRequestOptions
<a name="API_CreateTransitGatewayConnectRequestOptions"></a>

The options for a Connect attachment.

## Contents
<a name="API_CreateTransitGatewayConnectRequestOptions_Contents"></a>

 ** Protocol **   
The tunnel protocol.  
Type: String  
Valid Values: `gre`   
Required: Yes

## See Also
<a name="API_CreateTransitGatewayConnectRequestOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayConnectRequestOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayConnectRequestOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayConnectRequestOptions) 

# CreateTransitGatewayMulticastDomainRequestOptions
<a name="API_CreateTransitGatewayMulticastDomainRequestOptions"></a>

The options for the transit gateway multicast domain.

## Contents
<a name="API_CreateTransitGatewayMulticastDomainRequestOptions_Contents"></a>

 ** AutoAcceptSharedAssociations **   
Indicates whether to automatically accept cross-account subnet associations that are associated with the transit gateway multicast domain.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** Igmpv2Support **   
Specify whether to enable Internet Group Management Protocol (IGMP) version 2 for the transit gateway multicast domain.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** StaticSourcesSupport **   
Specify whether to enable support for statically configuring multicast group sources for a domain.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_CreateTransitGatewayMulticastDomainRequestOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayMulticastDomainRequestOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayMulticastDomainRequestOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayMulticastDomainRequestOptions) 

# CreateTransitGatewayPeeringAttachmentRequestOptions
<a name="API_CreateTransitGatewayPeeringAttachmentRequestOptions"></a>

Describes whether dynamic routing is enabled or disabled for the transit gateway peering request.

## Contents
<a name="API_CreateTransitGatewayPeeringAttachmentRequestOptions_Contents"></a>

 ** DynamicRouting **   
Indicates whether dynamic routing is enabled or disabled.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_CreateTransitGatewayPeeringAttachmentRequestOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayPeeringAttachmentRequestOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayPeeringAttachmentRequestOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayPeeringAttachmentRequestOptions) 

# CreateTransitGatewayVpcAttachmentRequestOptions
<a name="API_CreateTransitGatewayVpcAttachmentRequestOptions"></a>

Describes the options for a VPC attachment.

## Contents
<a name="API_CreateTransitGatewayVpcAttachmentRequestOptions_Contents"></a>

 ** ApplianceModeSupport **   
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is `disable`.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DnsSupport **   
Enable or disable DNS support. The default is `enable`.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** Ipv6Support **   
Enable or disable IPv6 support. The default is `disable`.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** SecurityGroupReferencingSupport **   
Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.  
This option is set to `enable` by default. However, at the transit gateway level the default is set to `disable`.  
For more information about security group referencing, see [Security group referencing ](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#vpc-attachment-security) in the * AWS Transit Gateways Guide*.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_CreateTransitGatewayVpcAttachmentRequestOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateTransitGatewayVpcAttachmentRequestOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateTransitGatewayVpcAttachmentRequestOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateTransitGatewayVpcAttachmentRequestOptions) 

# CreateVerifiedAccessEndpointCidrOptions
<a name="API_CreateVerifiedAccessEndpointCidrOptions"></a>

Describes the CIDR options for a Verified Access endpoint.

## Contents
<a name="API_CreateVerifiedAccessEndpointCidrOptions_Contents"></a>

 ** Cidr **   
The CIDR.  
Type: String  
Required: No

 ** PortRange.N **   
The port ranges.  
Type: Array of [CreateVerifiedAccessEndpointPortRange](API_CreateVerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** Protocol **   
The protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

 ** SubnetId.N **   
The IDs of the subnets.  
Type: Array of strings  
Required: No

## See Also
<a name="API_CreateVerifiedAccessEndpointCidrOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessEndpointCidrOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessEndpointCidrOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessEndpointCidrOptions) 

# CreateVerifiedAccessEndpointEniOptions
<a name="API_CreateVerifiedAccessEndpointEniOptions"></a>

Describes the network interface options when creating an AWS Verified Access endpoint using the `network-interface` type.

## Contents
<a name="API_CreateVerifiedAccessEndpointEniOptions_Contents"></a>

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

 ** Port **   
The IP port number.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** PortRange.N **   
The port ranges.  
Type: Array of [CreateVerifiedAccessEndpointPortRange](API_CreateVerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** Protocol **   
The IP protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

## See Also
<a name="API_CreateVerifiedAccessEndpointEniOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessEndpointEniOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessEndpointEniOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessEndpointEniOptions) 

# CreateVerifiedAccessEndpointLoadBalancerOptions
<a name="API_CreateVerifiedAccessEndpointLoadBalancerOptions"></a>

Describes the load balancer options when creating an AWS Verified Access endpoint using the `load-balancer` type.

## Contents
<a name="API_CreateVerifiedAccessEndpointLoadBalancerOptions_Contents"></a>

 ** LoadBalancerArn **   
The ARN of the load balancer.  
Type: String  
Required: No

 ** Port **   
The IP port number.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** PortRange.N **   
The port ranges.  
Type: Array of [CreateVerifiedAccessEndpointPortRange](API_CreateVerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** Protocol **   
The IP protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

 ** SubnetId.N **   
The IDs of the subnets. You can specify only one subnet per Availability Zone.  
Type: Array of strings  
Required: No

## See Also
<a name="API_CreateVerifiedAccessEndpointLoadBalancerOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessEndpointLoadBalancerOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessEndpointLoadBalancerOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessEndpointLoadBalancerOptions) 

# CreateVerifiedAccessEndpointPortRange
<a name="API_CreateVerifiedAccessEndpointPortRange"></a>

Describes the port range for a Verified Access endpoint.

## Contents
<a name="API_CreateVerifiedAccessEndpointPortRange_Contents"></a>

 ** FromPort **   
The start of the port range.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** ToPort **   
The end of the port range.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

## See Also
<a name="API_CreateVerifiedAccessEndpointPortRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessEndpointPortRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessEndpointPortRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessEndpointPortRange) 

# CreateVerifiedAccessEndpointRdsOptions
<a name="API_CreateVerifiedAccessEndpointRdsOptions"></a>

Describes the RDS options for a Verified Access endpoint.

## Contents
<a name="API_CreateVerifiedAccessEndpointRdsOptions_Contents"></a>

 ** Port **   
The port.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** Protocol **   
The protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

 ** RdsDbClusterArn **   
The ARN of the DB cluster.  
Type: String  
Required: No

 ** RdsDbInstanceArn **   
The ARN of the RDS instance.  
Type: String  
Required: No

 ** RdsDbProxyArn **   
The ARN of the RDS proxy.  
Type: String  
Required: No

 ** RdsEndpoint **   
The RDS endpoint.  
Type: String  
Required: No

 ** SubnetId.N **   
The IDs of the subnets. You can specify only one subnet per Availability Zone.  
Type: Array of strings  
Required: No

## See Also
<a name="API_CreateVerifiedAccessEndpointRdsOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessEndpointRdsOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessEndpointRdsOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessEndpointRdsOptions) 

# CreateVerifiedAccessNativeApplicationOidcOptions
<a name="API_CreateVerifiedAccessNativeApplicationOidcOptions"></a>

Describes the OpenID Connect (OIDC) options.

## Contents
<a name="API_CreateVerifiedAccessNativeApplicationOidcOptions_Contents"></a>

 ** AuthorizationEndpoint **   
The authorization endpoint of the IdP.  
Type: String  
Required: No

 ** ClientId **   
The OAuth 2.0 client identifier.  
Type: String  
Required: No

 ** ClientSecret **   
The OAuth 2.0 client secret.  
Type: String  
Required: No

 ** Issuer **   
The OIDC issuer identifier of the IdP.  
Type: String  
Required: No

 ** PublicSigningKeyEndpoint **   
The public signing key endpoint.  
Type: String  
Required: No

 ** Scope **   
The set of user claims to be requested from the IdP.  
Type: String  
Required: No

 ** TokenEndpoint **   
The token endpoint of the IdP.  
Type: String  
Required: No

 ** UserInfoEndpoint **   
The user info endpoint of the IdP.  
Type: String  
Required: No

## See Also
<a name="API_CreateVerifiedAccessNativeApplicationOidcOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessNativeApplicationOidcOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessNativeApplicationOidcOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessNativeApplicationOidcOptions) 

# CreateVerifiedAccessTrustProviderDeviceOptions
<a name="API_CreateVerifiedAccessTrustProviderDeviceOptions"></a>

Describes the options when creating an AWS Verified Access trust provider using the `device` type.

## Contents
<a name="API_CreateVerifiedAccessTrustProviderDeviceOptions_Contents"></a>

 ** PublicSigningKeyUrl **   
 The URL AWS Verified Access will use to verify the authenticity of the device tokens.   
Type: String  
Required: No

 ** TenantId **   
The ID of the tenant application with the device-identity provider.  
Type: String  
Required: No

## See Also
<a name="API_CreateVerifiedAccessTrustProviderDeviceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessTrustProviderDeviceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessTrustProviderDeviceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessTrustProviderDeviceOptions) 

# CreateVerifiedAccessTrustProviderOidcOptions
<a name="API_CreateVerifiedAccessTrustProviderOidcOptions"></a>

Describes the options when creating an AWS Verified Access trust provider using the `user` type.

## Contents
<a name="API_CreateVerifiedAccessTrustProviderOidcOptions_Contents"></a>

 ** AuthorizationEndpoint **   
The OIDC authorization endpoint.  
Type: String  
Required: No

 ** ClientId **   
The client identifier.  
Type: String  
Required: No

 ** ClientSecret **   
The client secret.  
Type: String  
Required: No

 ** Issuer **   
The OIDC issuer.  
Type: String  
Required: No

 ** Scope **   
OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.  
Type: String  
Required: No

 ** TokenEndpoint **   
The OIDC token endpoint.  
Type: String  
Required: No

 ** UserInfoEndpoint **   
The OIDC user info endpoint.  
Type: String  
Required: No

## See Also
<a name="API_CreateVerifiedAccessTrustProviderOidcOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVerifiedAccessTrustProviderOidcOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVerifiedAccessTrustProviderOidcOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVerifiedAccessTrustProviderOidcOptions) 

# CreateVolumePermission
<a name="API_CreateVolumePermission"></a>

Describes the user or group to be added or removed from the list of create volume permissions for a volume.

## Contents
<a name="API_CreateVolumePermission_Contents"></a>

 ** Group ** (request), ** group ** (response)  
The group to be added or removed. The possible value is `all`.  
Type: String  
Valid Values: `all`   
Required: No

 ** UserId ** (request), ** userId ** (response)  
The ID of the AWS account to be added or removed.  
Type: String  
Required: No

## See Also
<a name="API_CreateVolumePermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVolumePermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVolumePermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVolumePermission) 

# CreateVolumePermissionModifications
<a name="API_CreateVolumePermissionModifications"></a>

Describes modifications to the list of create volume permissions for a volume.

## Contents
<a name="API_CreateVolumePermissionModifications_Contents"></a>

 ** Add.N **   
Adds the specified AWS account ID or group to the list.  
Type: Array of [CreateVolumePermission](API_CreateVolumePermission.md) objects  
Required: No

 ** Remove.N **   
Removes the specified AWS account ID or group from the list.  
Type: Array of [CreateVolumePermission](API_CreateVolumePermission.md) objects  
Required: No

## See Also
<a name="API_CreateVolumePermissionModifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreateVolumePermissionModifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreateVolumePermissionModifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreateVolumePermissionModifications) 

# CreationDateCondition
<a name="API_CreationDateCondition"></a>

The maximum age for allowed images.

## Contents
<a name="API_CreationDateCondition_Contents"></a>

 ** maximumDaysSinceCreated **   
The maximum number of days that have elapsed since the image was created. For example, a value of `300` allows images that were created within the last 300 days.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_CreationDateCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreationDateCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreationDateCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreationDateCondition) 

# CreationDateConditionRequest
<a name="API_CreationDateConditionRequest"></a>

The maximum age for allowed images.

## Contents
<a name="API_CreationDateConditionRequest_Contents"></a>

 ** MaximumDaysSinceCreated **   
The maximum number of days that have elapsed since the image was created. For example, a value of `300` allows images that were created within the last 300 days.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_CreationDateConditionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreationDateConditionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreationDateConditionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreationDateConditionRequest) 

# CreditSpecification
<a name="API_CreditSpecification"></a>

Describes the credit option for CPU usage of a T instance.

## Contents
<a name="API_CreditSpecification_Contents"></a>

 ** cpuCredits **   
The credit option for CPU usage of a T instance.  
Valid values: `standard` \$1 `unlimited`   
Type: String  
Required: No

## See Also
<a name="API_CreditSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreditSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreditSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreditSpecification) 

# CreditSpecificationRequest
<a name="API_CreditSpecificationRequest"></a>

The credit option for CPU usage of a T instance.

## Contents
<a name="API_CreditSpecificationRequest_Contents"></a>

 ** CpuCredits **   
The credit option for CPU usage of a T instance.  
Valid values: `standard` \$1 `unlimited`   
Type: String  
Required: Yes

## See Also
<a name="API_CreditSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CreditSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CreditSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CreditSpecificationRequest) 

# CustomerGateway
<a name="API_CustomerGateway"></a>

Describes a customer gateway.

## Contents
<a name="API_CustomerGateway_Contents"></a>

 ** bgpAsn **   
The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).  
Valid values: `1` to `2,147,483,647`   
Type: String  
Required: No

 ** bgpAsnExtended **   
The customer gateway device's Border Gateway Protocol (BGP) Autonomous System Number (ASN).  
Valid values: `2,147,483,648` to `4,294,967,295`   
Type: String  
Required: No

 ** certificateArn **   
The Amazon Resource Name (ARN) for the customer gateway certificate.  
Type: String  
Required: No

 ** customerGatewayId **   
The ID of the customer gateway.  
Type: String  
Required: No

 ** deviceName **   
The name of customer gateway device.  
Type: String  
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 `PublicIpv4`, you can use a public IPv4 address. If `OutsideIpAddressType` is set to `Ipv6`, you can use a public IPv6 address.   
Type: String  
Required: No

 ** state **   
The current state of the customer gateway (`pending | available | deleting | deleted`).  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the customer gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** type **   
The type of VPN connection the customer gateway supports (`ipsec.1`).  
Type: String  
Required: No

## See Also
<a name="API_CustomerGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/CustomerGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/CustomerGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/CustomerGateway) 

# DataQuery
<a name="API_DataQuery"></a>

A query used for retrieving network health data. 

## Contents
<a name="API_DataQuery_Contents"></a>

 ** Destination **   
The Region or Availability Zone that's the target for the data query. For example, `eu-north-1`.  
Type: String  
Required: No

 ** Id **   
A user-defined ID associated with a data query that's returned in the `dataResponse` identifying the query. For example, if you set the Id to `MyQuery01`in the query, the `dataResponse` identifies the query as `MyQuery01`.  
Type: String  
Required: No

 ** Metric **   
The metric used for the network performance request.  
Type: String  
Valid Values: `aggregate-latency`   
Required: No

 ** Period **   
The aggregation period used for the data query.  
Type: String  
Valid Values: `five-minutes | fifteen-minutes | one-hour | three-hours | one-day | one-week`   
Required: No

 ** Source **   
The Region or Availability Zone that's the source for the data query. For example, `us-east-1`.  
Type: String  
Required: No

 ** Statistic **   
The metric data aggregation period, `p50`, between the specified `startDate` and `endDate`. For example, a metric of `five_minutes` is the median of all the data points gathered within those five minutes. `p50` is the only supported metric.  
Type: String  
Valid Values: `p50`   
Required: No

## See Also
<a name="API_DataQuery_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DataQuery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DataQuery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DataQuery) 

# DataResponse
<a name="API_DataResponse"></a>

The response to a `DataQuery`.

## Contents
<a name="API_DataResponse_Contents"></a>

 ** destination **   
The Region or Availability Zone that's the destination for the data query. For example, `eu-west-1`.  
Type: String  
Required: No

 ** id **   
The ID passed in the `DataQuery`.  
Type: String  
Required: No

 ** metric **   
The metric used for the network performance request.  
Type: String  
Valid Values: `aggregate-latency`   
Required: No

 ** MetricPointSet.N **   
A list of `MetricPoint` objects.  
Type: Array of [MetricPoint](API_MetricPoint.md) objects  
Required: No

 ** period **   
The period used for the network performance request.  
Type: String  
Valid Values: `five-minutes | fifteen-minutes | one-hour | three-hours | one-day | one-week`   
Required: No

 ** source **   
The Region or Availability Zone that's the source for the data query. For example, `us-east-1`.  
Type: String  
Required: No

 ** statistic **   
The statistic used for the network performance request.  
Type: String  
Valid Values: `p50`   
Required: No

## See Also
<a name="API_DataResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DataResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DataResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DataResponse) 

# DeclarativePoliciesReport
<a name="API_DeclarativePoliciesReport"></a>

Describes the metadata of the account status report.

## Contents
<a name="API_DeclarativePoliciesReport_Contents"></a>

 ** endTime **   
The time when the report generation ended.  
Type: Timestamp  
Required: No

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

 ** s3Bucket **   
The name of the Amazon S3 bucket where the report is located.  
Type: String  
Required: No

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

 ** startTime **   
The time when the report generation started.  
Type: Timestamp  
Required: No

 ** status **   
The current status of the report.  
Type: String  
Valid Values: `running | cancelled | complete | error`   
Required: No

 ** TagSet.N **   
Any tags assigned to the report.  
Type: Array of [Tag](API_Tag.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: No

## See Also
<a name="API_DeclarativePoliciesReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeclarativePoliciesReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeclarativePoliciesReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeclarativePoliciesReport) 

# DefaultConnectionTrackingConfiguration
<a name="API_DefaultConnectionTrackingConfiguration"></a>

Indicates default conntrack information for the instance type. For more information, see [ Connection tracking timeouts ](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the Amazon EC2 User Guide. 

## Contents
<a name="API_DefaultConnectionTrackingConfiguration_Contents"></a>

 ** defaultTcpEstablishedTimeout **   
Default timeout (in seconds) for idle TCP connections in an established state.  
Type: Integer  
Required: No

 ** defaultUdpStreamTimeout **   
Default timeout (in seconds) for idle UDP flows classified as streams which have seen more than one request-response transaction.  
Type: Integer  
Required: No

 ** defaultUdpTimeout **   
Default timeout (in seconds) for idle UDP flows that have seen traffic only in a single direction or a single request-response transaction.  
Type: Integer  
Required: No

## See Also
<a name="API_DefaultConnectionTrackingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DefaultConnectionTrackingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DefaultConnectionTrackingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DefaultConnectionTrackingConfiguration) 

# DeleteFleetError
<a name="API_DeleteFleetError"></a>

Describes an EC2 Fleet error.

## Contents
<a name="API_DeleteFleetError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Valid Values: `fleetIdDoesNotExist | fleetIdMalformed | fleetNotInDeletableState | unexpectedError`   
Required: No

 ** message **   
The description for the error code.  
Type: String  
Required: No

## See Also
<a name="API_DeleteFleetError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteFleetError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteFleetError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteFleetError) 

# DeleteFleetErrorItem
<a name="API_DeleteFleetErrorItem"></a>

Describes an EC2 Fleet that was not successfully deleted.

## Contents
<a name="API_DeleteFleetErrorItem_Contents"></a>

 ** error **   
The error.  
Type: [DeleteFleetError](API_DeleteFleetError.md) object  
Required: No

 ** fleetId **   
The ID of the EC2 Fleet.  
Type: String  
Required: No

## See Also
<a name="API_DeleteFleetErrorItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteFleetErrorItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteFleetErrorItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteFleetErrorItem) 

# DeleteFleetSuccessItem
<a name="API_DeleteFleetSuccessItem"></a>

Describes an EC2 Fleet that was successfully deleted.

## Contents
<a name="API_DeleteFleetSuccessItem_Contents"></a>

 ** currentFleetState **   
The current state of the EC2 Fleet.  
Type: String  
Valid Values: `submitted | active | deleted | failed | deleted_running | deleted_terminating | modifying`   
Required: No

 ** fleetId **   
The ID of the EC2 Fleet.  
Type: String  
Required: No

 ** previousFleetState **   
The previous state of the EC2 Fleet.  
Type: String  
Valid Values: `submitted | active | deleted | failed | deleted_running | deleted_terminating | modifying`   
Required: No

## See Also
<a name="API_DeleteFleetSuccessItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteFleetSuccessItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteFleetSuccessItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteFleetSuccessItem) 

# DeleteLaunchTemplateVersionsResponseErrorItem
<a name="API_DeleteLaunchTemplateVersionsResponseErrorItem"></a>

Describes a launch template version that could not be deleted.

## Contents
<a name="API_DeleteLaunchTemplateVersionsResponseErrorItem_Contents"></a>

 ** launchTemplateId **   
The ID of the launch template.  
Type: String  
Required: No

 ** launchTemplateName **   
The name of the launch template.  
Type: String  
Required: No

 ** responseError **   
Information about the error.  
Type: [ResponseError](API_ResponseError.md) object  
Required: No

 ** versionNumber **   
The version number of the launch template.  
Type: Long  
Required: No

## See Also
<a name="API_DeleteLaunchTemplateVersionsResponseErrorItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLaunchTemplateVersionsResponseErrorItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLaunchTemplateVersionsResponseErrorItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLaunchTemplateVersionsResponseErrorItem) 

# DeleteLaunchTemplateVersionsResponseSuccessItem
<a name="API_DeleteLaunchTemplateVersionsResponseSuccessItem"></a>

Describes a launch template version that was successfully deleted.

## Contents
<a name="API_DeleteLaunchTemplateVersionsResponseSuccessItem_Contents"></a>

 ** launchTemplateId **   
The ID of the launch template.  
Type: String  
Required: No

 ** launchTemplateName **   
The name of the launch template.  
Type: String  
Required: No

 ** versionNumber **   
The version number of the launch template.  
Type: Long  
Required: No

## See Also
<a name="API_DeleteLaunchTemplateVersionsResponseSuccessItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteLaunchTemplateVersionsResponseSuccessItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteLaunchTemplateVersionsResponseSuccessItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteLaunchTemplateVersionsResponseSuccessItem) 

# DeleteQueuedReservedInstancesError
<a name="API_DeleteQueuedReservedInstancesError"></a>

Describes the error for a Reserved Instance whose queued purchase could not be deleted.

## Contents
<a name="API_DeleteQueuedReservedInstancesError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Valid Values: `reserved-instances-id-invalid | reserved-instances-not-in-queued-state | unexpected-error`   
Required: No

 ** message **   
The error message.  
Type: String  
Required: No

## See Also
<a name="API_DeleteQueuedReservedInstancesError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteQueuedReservedInstancesError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteQueuedReservedInstancesError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteQueuedReservedInstancesError) 

# DeleteSnapshotReturnCode
<a name="API_DeleteSnapshotReturnCode"></a>

The snapshot ID and its deletion result code.

## Contents
<a name="API_DeleteSnapshotReturnCode_Contents"></a>

 ** returnCode **   
The result code from the snapshot deletion attempt. Possible values:  
+  `success` - The snapshot was successfully deleted.
+  `skipped` - The snapshot was not deleted because it's associated with other AMIs.
+  `missing-permissions` - The snapshot was not deleted because the role lacks `DeleteSnapshot` permissions. For more information, see [How Amazon EBS works with IAM](https://docs.aws.amazon.com/ebs/latest/userguide/security_iam_service-with-iam.html).
+  `internal-error` - The snapshot was not deleted due to a server error.
+  `client-error` - The snapshot was not deleted due to a client configuration error.
For details about an error, check the `DeleteSnapshot` event in the CloudTrail event history. For more information, see [View event history](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/tutorial-event-history.html) in the * AWS CloudTrail User Guide*.  
Type: String  
Valid Values: `success | skipped | missing-permissions | internal-error | client-error`   
Required: No

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

## See Also
<a name="API_DeleteSnapshotReturnCode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeleteSnapshotReturnCode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeleteSnapshotReturnCode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeleteSnapshotReturnCode) 

# DeprecationTimeCondition
<a name="API_DeprecationTimeCondition"></a>

The maximum period since deprecation for allowed images.

## Contents
<a name="API_DeprecationTimeCondition_Contents"></a>

 ** maximumDaysSinceDeprecated **   
The maximum number of days that have elapsed since the image was deprecated. When set to `0`, no deprecated images are allowed.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_DeprecationTimeCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeprecationTimeCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeprecationTimeCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeprecationTimeCondition) 

# DeprecationTimeConditionRequest
<a name="API_DeprecationTimeConditionRequest"></a>

The maximum period since deprecation for allowed images.

## Contents
<a name="API_DeprecationTimeConditionRequest_Contents"></a>

 ** MaximumDaysSinceDeprecated **   
The maximum number of days that have elapsed since the image was deprecated. Set to `0` to exclude all deprecated images.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 2147483647.  
Required: No

## See Also
<a name="API_DeprecationTimeConditionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeprecationTimeConditionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeprecationTimeConditionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeprecationTimeConditionRequest) 

# DeregisterInstanceTagAttributeRequest
<a name="API_DeregisterInstanceTagAttributeRequest"></a>

Information about the tag keys to deregister for the current Region. You can either specify individual tag keys or deregister all tag keys in the current Region. You must specify either `IncludeAllTagsOfInstance` or `InstanceTagKeys` in the request

## Contents
<a name="API_DeregisterInstanceTagAttributeRequest_Contents"></a>

 ** IncludeAllTagsOfInstance **   
Indicates whether to deregister all tag keys in the current Region. Specify `false` to deregister all tag keys.  
Type: Boolean  
Required: No

 ** InstanceTagKey.N **   
Information about the tag keys to deregister.  
Type: Array of strings  
Required: No

## See Also
<a name="API_DeregisterInstanceTagAttributeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeregisterInstanceTagAttributeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeregisterInstanceTagAttributeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeregisterInstanceTagAttributeRequest) 

# DescribeFastLaunchImagesSuccessItem
<a name="API_DescribeFastLaunchImagesSuccessItem"></a>

Describe details about a Windows image with Windows fast launch enabled that meets the requested criteria. Criteria are defined by the `DescribeFastLaunchImages` action filters.

## Contents
<a name="API_DescribeFastLaunchImagesSuccessItem_Contents"></a>

 ** imageId **   
The image ID that identifies the Windows fast launch enabled image.  
Type: String  
Required: No

 ** launchTemplate **   
The launch template that the Windows fast launch enabled AMI uses when it launches Windows instances from pre-provisioned snapshots.  
Type: [FastLaunchLaunchTemplateSpecificationResponse](API_FastLaunchLaunchTemplateSpecificationResponse.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.  
Type: Integer  
Required: No

 ** ownerId **   
The owner ID for the Windows fast launch enabled AMI.  
Type: String  
Required: No

 ** resourceType **   
The resource type that Amazon EC2 uses for pre-provisioning the Windows AMI. Supported values include: `snapshot`.  
Type: String  
Valid Values: `snapshot`   
Required: No

 ** snapshotConfiguration **   
A group of parameters that are used for pre-provisioning the associated Windows AMI using snapshots.  
Type: [FastLaunchSnapshotConfigurationResponse](API_FastLaunchSnapshotConfigurationResponse.md) object  
Required: No

 ** 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`   
Required: No

 ** stateTransitionReason **   
The reason that Windows fast launch for the AMI changed to the current state.  
Type: String  
Required: No

 ** stateTransitionTime **   
The time that Windows fast launch for the AMI changed to the current state.  
Type: Timestamp  
Required: No

## See Also
<a name="API_DescribeFastLaunchImagesSuccessItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFastLaunchImagesSuccessItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFastLaunchImagesSuccessItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFastLaunchImagesSuccessItem) 

# DescribeFastSnapshotRestoreSuccessItem
<a name="API_DescribeFastSnapshotRestoreSuccessItem"></a>

Describes fast snapshot restores for a snapshot.

## Contents
<a name="API_DescribeFastSnapshotRestoreSuccessItem_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** disabledTime **   
The time at which fast snapshot restores entered the `disabled` state.  
Type: Timestamp  
Required: No

 ** disablingTime **   
The time at which fast snapshot restores entered the `disabling` state.  
Type: Timestamp  
Required: No

 ** enabledTime **   
The time at which fast snapshot restores entered the `enabled` state.  
Type: Timestamp  
Required: No

 ** enablingTime **   
The time at which fast snapshot restores entered the `enabling` state.  
Type: Timestamp  
Required: No

 ** optimizingTime **   
The time at which fast snapshot restores entered the `optimizing` state.  
Type: Timestamp  
Required: No

 ** ownerAlias **   
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that enabled fast snapshot restores on the snapshot.  
Type: String  
Required: No

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

 ** state **   
The state of fast snapshot restores.  
Type: String  
Valid Values: `enabling | optimizing | enabled | disabling | disabled`   
Required: No

 ** stateTransitionReason **   
The reason for the state transition. The possible values are as follows:  
+  `Client.UserInitiated` - The state successfully transitioned to `enabling` or `disabling`.
+  `Client.UserInitiated - Lifecycle state transition` - The state successfully transitioned to `optimizing`, `enabled`, or `disabled`.
Type: String  
Required: No

## See Also
<a name="API_DescribeFastSnapshotRestoreSuccessItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFastSnapshotRestoreSuccessItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFastSnapshotRestoreSuccessItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFastSnapshotRestoreSuccessItem) 

# DescribeFleetError
<a name="API_DescribeFleetError"></a>

Describes the instances that could not be launched by the fleet.

## Contents
<a name="API_DescribeFleetError_Contents"></a>

 ** errorCode **   
The error code that indicates why the instance could not be launched. For more information about error codes, see [Error codes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html).  
Type: String  
Required: No

 ** errorMessage **   
The error message that describes why the instance could not be launched. For more information about error messages, see [Error codes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html.html).  
Type: String  
Required: No

 ** launchTemplateAndOverrides **   
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.  
Type: [LaunchTemplateAndOverridesResponse](API_LaunchTemplateAndOverridesResponse.md) object  
Required: No

 ** lifecycle **   
Indicates if the instance that could not be launched was a Spot, On-Demand, Capacity Block, or Interruptible Capacity Reservation instance.  
Type: String  
Valid Values: `spot | on-demand | interruptible-capacity-reservation`   
Required: No

## See Also
<a name="API_DescribeFleetError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFleetError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFleetError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFleetError) 

# DescribeFleetsInstances
<a name="API_DescribeFleetsInstances"></a>

Describes the instances that were launched by the fleet.

## Contents
<a name="API_DescribeFleetsInstances_Contents"></a>

 ** InstanceIds.N **   
The IDs of the instances.  
Type: Array of strings  
Required: No

 ** instanceType **   
The instance type.  
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

 ** launchTemplateAndOverrides **   
The launch templates and overrides that were used for launching the instances. The values that you specify in the Overrides replace the values in the launch template.  
Type: [LaunchTemplateAndOverridesResponse](API_LaunchTemplateAndOverridesResponse.md) object  
Required: No

 ** lifecycle **   
Indicates if the instance that was launched is a Spot, On-Demand, Capacity Block, or Interruptible Capacity Reservation instance.  
Type: String  
Valid Values: `spot | on-demand | interruptible-capacity-reservation`   
Required: No

 ** platform **   
The value is `windows` for Windows instances in an EC2 Fleet. Otherwise, the value is blank.  
Type: String  
Valid Values: `Windows`   
Required: No

## See Also
<a name="API_DescribeFleetsInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DescribeFleetsInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DescribeFleetsInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DescribeFleetsInstances) 

# DestinationOptionsRequest
<a name="API_DestinationOptionsRequest"></a>

Describes the destination options for a flow log.

## Contents
<a name="API_DestinationOptionsRequest_Contents"></a>

 ** FileFormat **   
The format for the flow log. The default is `plain-text`.  
Type: String  
Valid Values: `plain-text | parquet`   
Required: No

 ** HiveCompatiblePartitions **   
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3. The default is `false`.  
Type: Boolean  
Required: No

 ** PerHourPartition **   
Indicates whether to partition the flow log per hour. This reduces the cost and response time for queries. The default is `false`.  
Type: Boolean  
Required: No

## See Also
<a name="API_DestinationOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DestinationOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DestinationOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DestinationOptionsRequest) 

# DestinationOptionsResponse
<a name="API_DestinationOptionsResponse"></a>

Describes the destination options for a flow log.

## Contents
<a name="API_DestinationOptionsResponse_Contents"></a>

 ** fileFormat **   
The format for the flow log.  
Type: String  
Valid Values: `plain-text | parquet`   
Required: No

 ** hiveCompatiblePartitions **   
Indicates whether to use Hive-compatible prefixes for flow logs stored in Amazon S3.  
Type: Boolean  
Required: No

 ** perHourPartition **   
Indicates whether to partition the flow log per hour.  
Type: Boolean  
Required: No

## See Also
<a name="API_DestinationOptionsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DestinationOptionsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DestinationOptionsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DestinationOptionsResponse) 

# DeviceOptions
<a name="API_DeviceOptions"></a>

Describes the options for an AWS Verified Access device-identity based trust provider.

## Contents
<a name="API_DeviceOptions_Contents"></a>

 ** publicSigningKeyUrl **   
 The URL AWS Verified Access will use to verify the authenticity of the device tokens.   
Type: String  
Required: No

 ** tenantId **   
The ID of the tenant application with the device-identity provider.  
Type: String  
Required: No

## See Also
<a name="API_DeviceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DeviceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DeviceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DeviceOptions) 

# DhcpConfiguration
<a name="API_DhcpConfiguration"></a>

Describes a DHCP configuration option.

## Contents
<a name="API_DhcpConfiguration_Contents"></a>

 ** key **   
The name of a DHCP option.  
Type: String  
Required: No

 ** ValueSet.N **   
The values for the DHCP option.  
Type: Array of [AttributeValue](API_AttributeValue.md) objects  
Required: No

## See Also
<a name="API_DhcpConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DhcpConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DhcpConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DhcpConfiguration) 

# DhcpOptions
<a name="API_DhcpOptions"></a>

The set of DHCP options.

## Contents
<a name="API_DhcpOptions_Contents"></a>

 ** DhcpConfigurationSet.N **   
The DHCP options in the set.  
Type: Array of [DhcpConfiguration](API_DhcpConfiguration.md) objects  
Required: No

 ** dhcpOptionsId **   
The ID of the set of DHCP options.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the DHCP options set.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the DHCP options set.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_DhcpOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DhcpOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DhcpOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DhcpOptions) 

# DimensionCondition
<a name="API_DimensionCondition"></a>

 Specifies a condition for filtering capacity data based on dimension values. Used to create precise filters for metric queries and dimension lookups. 

## Contents
<a name="API_DimensionCondition_Contents"></a>

 ** Comparison **   
 The comparison operator to use for the filter.   
Type: String  
Valid Values: `equals | in`   
Required: No

 ** Dimension **   
 The name of the dimension to filter by.   
Type: String  
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

 ** Value.N **   
 The list of values to match against the specified dimension. For 'equals' comparison, only the first value is used. For 'in' comparison, any matching value will satisfy the condition.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Length Constraints: Minimum length of 0. Maximum length of 300.  
Required: No

## See Also
<a name="API_DimensionCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DimensionCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DimensionCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DimensionCondition) 

# DirectoryServiceAuthentication
<a name="API_DirectoryServiceAuthentication"></a>

Describes an Active Directory.

## Contents
<a name="API_DirectoryServiceAuthentication_Contents"></a>

 ** directoryId **   
The ID of the Active Directory used for authentication.  
Type: String  
Required: No

## See Also
<a name="API_DirectoryServiceAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DirectoryServiceAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DirectoryServiceAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DirectoryServiceAuthentication) 

# DirectoryServiceAuthenticationRequest
<a name="API_DirectoryServiceAuthenticationRequest"></a>

Describes the Active Directory to be used for client authentication.

## Contents
<a name="API_DirectoryServiceAuthenticationRequest_Contents"></a>

 ** DirectoryId **   
The ID of the Active Directory to be used for authentication.  
Type: String  
Required: No

## See Also
<a name="API_DirectoryServiceAuthenticationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DirectoryServiceAuthenticationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DirectoryServiceAuthenticationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DirectoryServiceAuthenticationRequest) 

# DisableFastSnapshotRestoreErrorItem
<a name="API_DisableFastSnapshotRestoreErrorItem"></a>

Contains information about the errors that occurred when disabling fast snapshot restores.

## Contents
<a name="API_DisableFastSnapshotRestoreErrorItem_Contents"></a>

 ** FastSnapshotRestoreStateErrorSet.N **   
The errors.  
Type: Array of [DisableFastSnapshotRestoreStateErrorItem](API_DisableFastSnapshotRestoreStateErrorItem.md) objects  
Required: No

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

## See Also
<a name="API_DisableFastSnapshotRestoreErrorItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableFastSnapshotRestoreErrorItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableFastSnapshotRestoreErrorItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableFastSnapshotRestoreErrorItem) 

# DisableFastSnapshotRestoreStateError
<a name="API_DisableFastSnapshotRestoreStateError"></a>

Describes an error that occurred when disabling fast snapshot restores.

## Contents
<a name="API_DisableFastSnapshotRestoreStateError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Required: No

 ** message **   
The error message.  
Type: String  
Required: No

## See Also
<a name="API_DisableFastSnapshotRestoreStateError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableFastSnapshotRestoreStateError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableFastSnapshotRestoreStateError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableFastSnapshotRestoreStateError) 

# DisableFastSnapshotRestoreStateErrorItem
<a name="API_DisableFastSnapshotRestoreStateErrorItem"></a>

Contains information about an error that occurred when disabling fast snapshot restores.

## Contents
<a name="API_DisableFastSnapshotRestoreStateErrorItem_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** error **   
The error.  
Type: [DisableFastSnapshotRestoreStateError](API_DisableFastSnapshotRestoreStateError.md) object  
Required: No

## See Also
<a name="API_DisableFastSnapshotRestoreStateErrorItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableFastSnapshotRestoreStateErrorItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableFastSnapshotRestoreStateErrorItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableFastSnapshotRestoreStateErrorItem) 

# DisableFastSnapshotRestoreSuccessItem
<a name="API_DisableFastSnapshotRestoreSuccessItem"></a>

Describes fast snapshot restores that were successfully disabled.

## Contents
<a name="API_DisableFastSnapshotRestoreSuccessItem_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** disabledTime **   
The time at which fast snapshot restores entered the `disabled` state.  
Type: Timestamp  
Required: No

 ** disablingTime **   
The time at which fast snapshot restores entered the `disabling` state.  
Type: Timestamp  
Required: No

 ** enabledTime **   
The time at which fast snapshot restores entered the `enabled` state.  
Type: Timestamp  
Required: No

 ** enablingTime **   
The time at which fast snapshot restores entered the `enabling` state.  
Type: Timestamp  
Required: No

 ** optimizingTime **   
The time at which fast snapshot restores entered the `optimizing` state.  
Type: Timestamp  
Required: No

 ** ownerAlias **   
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that enabled fast snapshot restores on the snapshot.  
Type: String  
Required: No

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

 ** state **   
The state of fast snapshot restores for the snapshot.  
Type: String  
Valid Values: `enabling | optimizing | enabled | disabling | disabled`   
Required: No

 ** stateTransitionReason **   
The reason for the state transition. The possible values are as follows:  
+  `Client.UserInitiated` - The state successfully transitioned to `enabling` or `disabling`.
+  `Client.UserInitiated - Lifecycle state transition` - The state successfully transitioned to `optimizing`, `enabled`, or `disabled`.
Type: String  
Required: No

## See Also
<a name="API_DisableFastSnapshotRestoreSuccessItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DisableFastSnapshotRestoreSuccessItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DisableFastSnapshotRestoreSuccessItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DisableFastSnapshotRestoreSuccessItem) 

# DiskImage
<a name="API_DiskImage"></a>

Describes a disk image.

## Contents
<a name="API_DiskImage_Contents"></a>

 ** Description **   
A description of the disk image.  
Type: String  
Required: No

 ** Image **   
Information about the disk image.  
Type: [DiskImageDetail](API_DiskImageDetail.md) object  
Required: No

 ** Volume **   
Information about the volume.  
Type: [VolumeDetail](API_VolumeDetail.md) object  
Required: No

## See Also
<a name="API_DiskImage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DiskImage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DiskImage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DiskImage) 

# DiskImageDescription
<a name="API_DiskImageDescription"></a>

Describes a disk image.

## Contents
<a name="API_DiskImageDescription_Contents"></a>

 ** checksum **   
The checksum computed for the disk image.  
Type: String  
Required: No

 ** format **   
The disk image format.  
Type: String  
Valid Values: `VMDK | RAW | VHD`   
Required: No

 ** importManifestUrl **   
A presigned URL for the import manifest stored in Amazon S3. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the [Authenticating REST Requests](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) topic in the *Amazon Simple Storage Service Developer Guide*.  
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).  
Type: String  
Required: No

 ** size **   
The size of the disk image, in GiB.  
Type: Long  
Required: No

## See Also
<a name="API_DiskImageDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DiskImageDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DiskImageDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DiskImageDescription) 

# DiskImageDetail
<a name="API_DiskImageDetail"></a>

Describes a disk image.

## Contents
<a name="API_DiskImageDetail_Contents"></a>

 ** Bytes **   
The size of the disk image, in GiB.  
Type: Long  
Required: Yes

 ** Format **   
The disk image format.  
Type: String  
Valid Values: `VMDK | RAW | VHD`   
Required: Yes

 ** ImportManifestUrl **   
A presigned URL for the import manifest stored in Amazon S3 and presented here as an Amazon S3 presigned URL. For information about creating a presigned URL for an Amazon S3 object, read the "Query String Request Authentication Alternative" section of the [Authenticating REST Requests](https://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html) topic in the *Amazon Simple Storage Service Developer Guide*.  
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).  
Type: String  
Required: Yes

## See Also
<a name="API_DiskImageDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DiskImageDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DiskImageDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DiskImageDetail) 

# DiskImageVolumeDescription
<a name="API_DiskImageVolumeDescription"></a>

Describes a disk image volume.

## Contents
<a name="API_DiskImageVolumeDescription_Contents"></a>

 ** id **   
The volume identifier.  
Type: String  
Required: No

 ** size **   
The size of the volume, in GiB.  
Type: Long  
Required: No

## See Also
<a name="API_DiskImageVolumeDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DiskImageVolumeDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DiskImageVolumeDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DiskImageVolumeDescription) 

# DiskInfo
<a name="API_DiskInfo"></a>

Describes a disk.

## Contents
<a name="API_DiskInfo_Contents"></a>

 ** count **   
The number of disks with this configuration.  
Type: Integer  
Required: No

 ** sizeInGB **   
The size of the disk in GB.  
Type: Long  
Required: No

 ** type **   
The type of disk.  
Type: String  
Valid Values: `hdd | ssd`   
Required: No

## See Also
<a name="API_DiskInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DiskInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DiskInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DiskInfo) 

# DnsEntry
<a name="API_DnsEntry"></a>

Describes a DNS entry.

## Contents
<a name="API_DnsEntry_Contents"></a>

 ** dnsName **   
The DNS name.  
Type: String  
Required: No

 ** hostedZoneId **   
The ID of the private hosted zone.  
Type: String  
Required: No

## See Also
<a name="API_DnsEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DnsEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DnsEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DnsEntry) 

# DnsOptions
<a name="API_DnsOptions"></a>

Describes the DNS options for an endpoint.

## Contents
<a name="API_DnsOptions_Contents"></a>

 ** dnsRecordIpType **   
The DNS records created for the endpoint.  
Type: String  
Valid Values: `ipv4 | dualstack | ipv6 | service-defined`   
Required: No

 ** privateDnsOnlyForInboundResolverEndpoint **   
Indicates whether to enable private DNS only for inbound endpoints.  
Type: Boolean  
Required: No

 ** privateDnsPreference **   
 The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.   
+  `ALL_DOMAINS` - VPC Lattice provisions private hosted zones for all custom domain names.
+  `VERIFIED_DOMAINS_ONLY` - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.
+  `VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS` - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
+  `SPECIFIED_DOMAINS_ONLY` - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
Type: String  
Required: No

 ** PrivateDnsSpecifiedDomainSet.N **   
 Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is `VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS` or `SPECIFIED_DOMAINS_ONLY`.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

## See Also
<a name="API_DnsOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DnsOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DnsOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DnsOptions) 

# DnsOptionsSpecification
<a name="API_DnsOptionsSpecification"></a>

Describes the DNS options for an endpoint.

## Contents
<a name="API_DnsOptionsSpecification_Contents"></a>

 ** DnsRecordIpType **   
The DNS records created for the endpoint.  
Type: String  
Valid Values: `ipv4 | dualstack | ipv6 | service-defined`   
Required: No

 ** PrivateDnsOnlyForInboundResolverEndpoint **   
Indicates whether to enable private DNS only for inbound endpoints. This option is available only for services that support both gateway and interface endpoints. It routes traffic that originates from the VPC to the gateway endpoint and traffic that originates from on-premises to the interface endpoint.  
Type: Boolean  
Required: No

 ** PrivateDnsPreference **   
 The preference for which private domains have a private hosted zone created for and associated with the specified VPC. Only supported when private DNS is enabled and when the VPC endpoint type is ServiceNetwork or Resource.   
+  `ALL_DOMAINS` - VPC Lattice provisions private hosted zones for all custom domain names.
+  `VERIFIED_DOMAINS_ONLY` - VPC Lattice provisions a private hosted zone only if custom domain name has been verified by the provider.
+  `VERIFIED_DOMAINS_AND_SPECIFIED_DOMAINS` - VPC Lattice provisions private hosted zones for all verified custom domain names and other domain names that the resource consumer specifies. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
+  `SPECIFIED_DOMAINS_ONLY` - VPC Lattice provisions a private hosted zone for domain names specified by the resource consumer. The resource consumer specifies the domain names in the PrivateDnsSpecifiedDomains parameter.
Type: String  
Required: No

 ** PrivateDnsSpecifiedDomain.N **   
 Indicates which of the private domains to create private hosted zones for and associate with the specified VPC. Only supported when private DNS is enabled and the private DNS preference is verified-domains-and-specified-domains or specified-domains-only.   
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 10 items.  
Required: No

## See Also
<a name="API_DnsOptionsSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DnsOptionsSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DnsOptionsSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DnsOptionsSpecification) 

# DnsServersOptionsModifyStructure
<a name="API_DnsServersOptionsModifyStructure"></a>

Information about the DNS server to be used.

## Contents
<a name="API_DnsServersOptionsModifyStructure_Contents"></a>

 ** CustomDnsServers.N **   
The IPv4 address range, in CIDR notation, of the DNS servers to be used. You can specify up to two DNS servers. Ensure that the DNS servers can be reached by the clients. The specified values overwrite the existing values.  
Type: Array of strings  
Required: No

 ** Enabled **   
Indicates whether DNS servers should be used. Specify `False` to delete the existing DNS servers.  
Type: Boolean  
Required: No

## See Also
<a name="API_DnsServersOptionsModifyStructure_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/DnsServersOptionsModifyStructure) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/DnsServersOptionsModifyStructure) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/DnsServersOptionsModifyStructure) 

# EbsBlockDevice
<a name="API_EbsBlockDevice"></a>

Describes a block device for an EBS volume.

## Contents
<a name="API_EbsBlockDevice_Contents"></a>

 ** AvailabilityZone ** (request), ** availabilityZone ** (response)  
The Availability Zone where the EBS volume will be created (for example, `us-east-1a`).  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region.  
This parameter is not supported when using [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html), [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html), [DescribeImages](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html), [RequestSpotInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html), and [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: String  
Required: No

 ** AvailabilityZoneId ** (request), ** AvailabilityZoneId ** (response)  
The ID of the Availability Zone where the EBS volume will be created (for example, `use1-az1`).  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both. If neither is specified, Amazon EC2 automatically selects an Availability Zone within the Region.  
This parameter is not supported when using [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html), [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html), [DescribeImages](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html), [RequestSpotInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html), and [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: String  
Required: No

 ** DeleteOnTermination ** (request), ** deleteOnTermination ** (response)  
Indicates whether the EBS volume is deleted on instance termination. For more information, see [Preserving Amazon EBS volumes on instance termination](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/terminating-instances.html#preserving-volumes-on-termination) in the *Amazon EC2 User Guide*.  
Type: Boolean  
Required: No

 ** EbsCardIndex ** (request), ** EbsCardIndex ** (response)  
The index of the EBS card. Some instance types support multiple EBS cards. The default EBS card index is 0.  
Type: Integer  
Required: No

 ** Encrypted ** (request), ** encrypted ** (response)  
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html#encryption-parameters) in the *Amazon EBS User Guide*.  
In no case can you remove encryption from an encrypted volume.  
Encrypted volumes can only 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).  
This parameter is not returned by [DescribeImageAttribute](API_DescribeImageAttribute.md).  
For [CreateImage](API_CreateImage.md) and [RegisterImage](API_RegisterImage.md), whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.  
+ If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either `true` for an encrypted volume, or `false` for an unencrypted volume. If you omit this parameter, it defaults to `false` (unencrypted).
+ If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
+ If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify `false`. If you specify `true`, the request will fail. In this case, we recommend that you omit the parameter.
+ If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either `true` or `false`. However, if you specify `false`, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Type: Boolean  
Required: No

 ** Iops ** (request), ** iops ** (response)  
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.  
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
For `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.  
This parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS.  
Type: Integer  
Required: No

 ** KmsKeyId ** (request), ** kmsKeyId ** (response)  
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.  
This parameter is only supported on `BlockDeviceMapping` objects called by [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet.html), and [RequestSpotInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html).  
Type: String  
Required: No

 ** OutpostArn ** (request), ** outpostArn ** (response)  
The ARN of the Outpost on which the snapshot is stored.  
This parameter is not supported when using [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html).  
Type: String  
Required: No

 ** SnapshotId ** (request), ** snapshotId ** (response)  
The ID of the snapshot.  
Type: String  
Required: No

 ** Throughput ** (request), ** throughput ** (response)  
The throughput that the volume supports, in MiB/s.  
This parameter is valid only for `gp3` volumes.  
Valid Range: Minimum value of 125. Maximum value of 2,000.  
Type: Integer  
Required: No

 ** VolumeInitializationRate ** (request), ** VolumeInitializationRate ** (response)  
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. 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*.  
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.
This parameter is not supported when using [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html) and [DescribeImages](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html).  
Valid range: 100 - 300 MiB/s  
Type: Integer  
Required: No

 ** VolumeSize ** (request), ** volumeSize ** (response)  
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. You can specify a volume size that is equal to or larger than the snapshot size.  
The following are the supported 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
Type: Integer  
Required: No

 ** VolumeType ** (request), ** volumeType ** (response)  
The volume type. 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*.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

## See Also
<a name="API_EbsBlockDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsBlockDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsBlockDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsBlockDevice) 

# EbsBlockDeviceResponse
<a name="API_EbsBlockDeviceResponse"></a>

Describes a block device for an EBS volume.

## Contents
<a name="API_EbsBlockDeviceResponse_Contents"></a>

 ** deleteOnTermination **   
Indicates whether the volume is deleted on instance termination.  
Type: Boolean  
Required: No

 ** encrypted **   
Indicates whether the volume is encrypted.  
Type: Boolean  
Required: No

 ** 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  
Required: No

 ** kmsKeyId **   
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.  
Type: String  
Required: No

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

 ** throughput **   
The throughput that the volume supports, in MiB/s.  
Type: Integer  
Required: No

 ** volumeSize **   
The size of the volume, in GiBs.  
Type: Integer  
Required: No

 ** volumeType **   
The volume type. 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*.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

## See Also
<a name="API_EbsBlockDeviceResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsBlockDeviceResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsBlockDeviceResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsBlockDeviceResponse) 

# EbsCardInfo
<a name="API_EbsCardInfo"></a>

Describes the performance characteristics of an EBS card on the instance type.

## Contents
<a name="API_EbsCardInfo_Contents"></a>

 ** baselineBandwidthInMbps **   
The baseline bandwidth performance for the EBS card, in Mbps.  
Type: Integer  
Required: No

 ** baselineIops **   
The baseline IOPS performance for the EBS card.  
Type: Integer  
Required: No

 ** baselineThroughputInMBps **   
The baseline throughput performance for the EBS card, in MBps.  
Type: Double  
Required: No

 ** ebsCardIndex **   
The index of the EBS card.  
Type: Integer  
Required: No

 ** maximumBandwidthInMbps **   
The maximum bandwidth performance for the EBS card, in Mbps.  
Type: Integer  
Required: No

 ** maximumIops **   
The maximum IOPS performance for the EBS card.  
Type: Integer  
Required: No

 ** maximumThroughputInMBps **   
The maximum throughput performance for the EBS card, in MBps.  
Type: Double  
Required: No

## See Also
<a name="API_EbsCardInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsCardInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsCardInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsCardInfo) 

# EbsInfo
<a name="API_EbsInfo"></a>

Describes the Amazon EBS features supported by the instance type.

## Contents
<a name="API_EbsInfo_Contents"></a>

 ** attachmentLimitType **   
Indicates whether the instance type features a shared or dedicated Amazon EBS volume attachment limit. For more information, see [Amazon EBS volume limits for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/volume_limits.html) in the *Amazon EC2 User Guide*.  
Type: String  
Valid Values: `shared | dedicated`   
Required: No

 ** EbsCardSet.N **   
Describes the EBS cards available for the instance type.  
Type: Array of [EbsCardInfo](API_EbsCardInfo.md) objects  
Required: No

 ** ebsOptimizedInfo **   
Describes the optimized EBS performance for the instance type.  
Type: [EbsOptimizedInfo](API_EbsOptimizedInfo.md) object  
Required: No

 ** ebsOptimizedSupport **   
Indicates whether the instance type is Amazon EBS-optimized. For more information, see [Amazon EBS-optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSOptimized.html) in *Amazon EC2 User Guide*.  
Type: String  
Valid Values: `unsupported | supported | default`   
Required: No

 ** encryptionSupport **   
Indicates whether Amazon EBS encryption is supported.  
Type: String  
Valid Values: `unsupported | supported`   
Required: No

 ** maximumEbsAttachments **   
Indicates the maximum number of Amazon EBS volumes that can be attached to the instance type. For more information, see [Amazon EBS volume limits for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/volume_limits.html) in the *Amazon EC2 User Guide*.  
Type: Integer  
Required: No

 ** maximumEbsCards **   
Indicates the number of EBS cards supported by the instance type.  
Type: Integer  
Required: No

 ** nvmeSupport **   
Indicates whether non-volatile memory express (NVMe) is supported.  
Type: String  
Valid Values: `unsupported | supported | required`   
Required: No

## See Also
<a name="API_EbsInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsInfo) 

# EbsInstanceBlockDevice
<a name="API_EbsInstanceBlockDevice"></a>

Describes a parameter used to set up an EBS volume in a block device mapping.

## Contents
<a name="API_EbsInstanceBlockDevice_Contents"></a>

 ** associatedResource **   
The ARN of the AWS-managed resource to which the volume is attached.  
Type: String  
Required: No

 ** attachTime **   
The time stamp when the attachment initiated.  
Type: Timestamp  
Required: No

 ** deleteOnTermination **   
Indicates whether the volume is deleted on instance termination.  
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

 ** operator **   
The service provider that manages the EBS volume.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** status **   
The attachment state.  
Type: String  
Valid Values: `attaching | attached | detaching | detached`   
Required: No

 ** volumeId **   
The ID of the EBS volume.  
Type: String  
Required: No

 ** volumeOwnerId **   
The ID of the AWS account that owns the volume.  
This parameter is returned only for volumes that are attached to AWS-managed resources.  
Type: String  
Required: No

## See Also
<a name="API_EbsInstanceBlockDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsInstanceBlockDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsInstanceBlockDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsInstanceBlockDevice) 

# EbsInstanceBlockDeviceSpecification
<a name="API_EbsInstanceBlockDeviceSpecification"></a>

Describes information used to set up an EBS volume specified in a block device mapping.

## Contents
<a name="API_EbsInstanceBlockDeviceSpecification_Contents"></a>

 ** DeleteOnTermination **   
Indicates whether the volume is deleted on instance termination.  
Type: Boolean  
Required: No

 ** VolumeId **   
The ID of the EBS volume.  
Type: String  
Required: No

## See Also
<a name="API_EbsInstanceBlockDeviceSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsInstanceBlockDeviceSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsInstanceBlockDeviceSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsInstanceBlockDeviceSpecification) 

# EbsOptimizedInfo
<a name="API_EbsOptimizedInfo"></a>

Describes the optimized EBS performance for supported instance types.

## Contents
<a name="API_EbsOptimizedInfo_Contents"></a>

 ** baselineBandwidthInMbps **   
The baseline bandwidth performance for an EBS-optimized instance type, in Mbps.  
Type: Integer  
Required: No

 ** baselineIops **   
The baseline input/output storage operations per seconds for an EBS-optimized instance type.  
Type: Integer  
Required: No

 ** baselineThroughputInMBps **   
The baseline throughput performance for an EBS-optimized instance type, in MB/s.  
Type: Double  
Required: No

 ** maximumBandwidthInMbps **   
The maximum bandwidth performance for an EBS-optimized instance type, in Mbps.  
Type: Integer  
Required: No

 ** maximumIops **   
The maximum input/output storage operations per second for an EBS-optimized instance type.  
Type: Integer  
Required: No

 ** maximumThroughputInMBps **   
The maximum throughput performance for an EBS-optimized instance type, in MB/s.  
Type: Double  
Required: No

## See Also
<a name="API_EbsOptimizedInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsOptimizedInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsOptimizedInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsOptimizedInfo) 

# EbsStatusDetails
<a name="API_EbsStatusDetails"></a>

Describes the attached EBS status check for an instance.

## Contents
<a name="API_EbsStatusDetails_Contents"></a>

 ** impairedSince **   
The date and time when the attached EBS status check failed.  
Type: Timestamp  
Required: No

 ** name **   
The name of the attached EBS status check.  
Type: String  
Valid Values: `reachability`   
Required: No

 ** status **   
The result of the attached EBS status check.  
Type: String  
Valid Values: `passed | failed | insufficient-data | initializing`   
Required: No

## See Also
<a name="API_EbsStatusDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsStatusDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsStatusDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsStatusDetails) 

# EbsStatusSummary
<a name="API_EbsStatusSummary"></a>

Provides a summary of the attached EBS volume status for an instance.

## Contents
<a name="API_EbsStatusSummary_Contents"></a>

 ** Details.N **   
Details about the attached EBS status check for an instance.  
Type: Array of [EbsStatusDetails](API_EbsStatusDetails.md) objects  
Required: No

 ** status **   
The current status.  
Type: String  
Valid Values: `ok | impaired | insufficient-data | not-applicable | initializing`   
Required: No

## See Also
<a name="API_EbsStatusSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EbsStatusSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EbsStatusSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EbsStatusSummary) 

# Ec2InstanceConnectEndpoint
<a name="API_Ec2InstanceConnectEndpoint"></a>

Describes an EC2 Instance Connect Endpoint.

## Contents
<a name="API_Ec2InstanceConnectEndpoint_Contents"></a>

 ** availabilityZone **   
The Availability Zone of the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone of the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

 ** createdAt **   
The date and time that the EC2 Instance Connect Endpoint was created.  
Type: Timestamp  
Required: No

 ** dnsName **   
The DNS name of the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

 ** fipsDnsName **   
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

 ** instanceConnectEndpointArn **   
The Amazon Resource Name (ARN) of the EC2 Instance Connect Endpoint.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** instanceConnectEndpointId **   
The ID of the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

 ** ipAddressType **   
The IP address type of the endpoint.  
Type: String  
Valid Values: `ipv4 | dualstack | ipv6`   
Required: No

 ** NetworkInterfaceIdSet.N **   
The ID of the elastic network interface that Amazon EC2 automatically created when creating the EC2 Instance Connect Endpoint.  
Type: Array of strings  
Required: No

 ** ownerId **   
The ID of the AWS account that created the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

 ** preserveClientIp **   
Indicates whether your client's 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.
Default: `false`   
Type: Boolean  
Required: No

 ** publicDnsNames **   
The public DNS names of the endpoint.  
Type: [InstanceConnectEndpointPublicDnsNames](API_InstanceConnectEndpointPublicDnsNames.md) object  
Required: No

 ** SecurityGroupIdSet.N **   
The security groups associated with the endpoint. If you didn't specify a security group, the default security group for your VPC is associated with the endpoint.  
Type: Array of strings  
Required: No

 ** state **   
The current state of the EC2 Instance Connect Endpoint.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed | update-in-progress | update-complete | update-failed`   
Required: No

 ** stateMessage **   
The message for the current state of the EC2 Instance Connect Endpoint. Can include a failure message.  
Type: String  
Required: No

 ** subnetId **   
The ID of the subnet in which the EC2 Instance Connect Endpoint was created.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the EC2 Instance Connect Endpoint.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC in which the EC2 Instance Connect Endpoint was created.  
Type: String  
Required: No

## See Also
<a name="API_Ec2InstanceConnectEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ec2InstanceConnectEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ec2InstanceConnectEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ec2InstanceConnectEndpoint) 

# EfaInfo
<a name="API_EfaInfo"></a>

Describes the Elastic Fabric Adapters for the instance type.

## Contents
<a name="API_EfaInfo_Contents"></a>

 ** maximumEfaInterfaces **   
The maximum number of Elastic Fabric Adapters for the instance type.  
Type: Integer  
Required: No

## See Also
<a name="API_EfaInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EfaInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EfaInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EfaInfo) 

# EgressOnlyInternetGateway
<a name="API_EgressOnlyInternetGateway"></a>

Describes an egress-only internet gateway.

## Contents
<a name="API_EgressOnlyInternetGateway_Contents"></a>

 ** AttachmentSet.N **   
Information about the attachment of the egress-only internet gateway.  
Type: Array of [InternetGatewayAttachment](API_InternetGatewayAttachment.md) objects  
Required: No

 ** egressOnlyInternetGatewayId **   
The ID of the egress-only internet gateway.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the egress-only internet gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_EgressOnlyInternetGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EgressOnlyInternetGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EgressOnlyInternetGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EgressOnlyInternetGateway) 

# ElasticGpuAssociation
<a name="API_ElasticGpuAssociation"></a>

**Note**  
Amazon Elastic Graphics reached end of life on January 8, 2024.

Describes the association between an instance and an Elastic Graphics accelerator.

## Contents
<a name="API_ElasticGpuAssociation_Contents"></a>

 ** elasticGpuAssociationId **   
The ID of the association.  
Type: String  
Required: No

 ** elasticGpuAssociationState **   
The state of the association between the instance and the Elastic Graphics accelerator.  
Type: String  
Required: No

 ** elasticGpuAssociationTime **   
The time the Elastic Graphics accelerator was associated with the instance.  
Type: String  
Required: No

 ** elasticGpuId **   
The ID of the Elastic Graphics accelerator.  
Type: String  
Required: No

## See Also
<a name="API_ElasticGpuAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ElasticGpuAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ElasticGpuAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ElasticGpuAssociation) 

# ElasticGpuHealth
<a name="API_ElasticGpuHealth"></a>

**Note**  
Amazon Elastic Graphics reached end of life on January 8, 2024.

Describes the status of an Elastic Graphics accelerator.

## Contents
<a name="API_ElasticGpuHealth_Contents"></a>

 ** status **   
The health status.  
Type: String  
Valid Values: `OK | IMPAIRED`   
Required: No

## See Also
<a name="API_ElasticGpuHealth_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ElasticGpuHealth) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ElasticGpuHealth) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ElasticGpuHealth) 

# ElasticGpus
<a name="API_ElasticGpus"></a>

**Note**  
Amazon Elastic Graphics reached end of life on January 8, 2024.

Describes an Elastic Graphics accelerator.

## Contents
<a name="API_ElasticGpus_Contents"></a>

 ** availabilityZone **   
The Availability Zone in the which the Elastic Graphics accelerator resides.  
Type: String  
Required: No

 ** elasticGpuHealth **   
The status of the Elastic Graphics accelerator.  
Type: [ElasticGpuHealth](API_ElasticGpuHealth.md) object  
Required: No

 ** elasticGpuId **   
The ID of the Elastic Graphics accelerator.  
Type: String  
Required: No

 ** elasticGpuState **   
The state of the Elastic Graphics accelerator.  
Type: String  
Valid Values: `ATTACHED`   
Required: No

 ** elasticGpuType **   
The type of Elastic Graphics accelerator.  
Type: String  
Required: No

 ** instanceId **   
The ID of the instance to which the Elastic Graphics accelerator is attached.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the Elastic Graphics accelerator.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ElasticGpus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ElasticGpus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ElasticGpus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ElasticGpus) 

# ElasticGpuSpecification
<a name="API_ElasticGpuSpecification"></a>

**Note**  
Amazon Elastic Graphics reached end of life on January 8, 2024.

A specification for an Elastic Graphics accelerator.

## Contents
<a name="API_ElasticGpuSpecification_Contents"></a>

 ** Type **   
The type of Elastic Graphics accelerator.  
Type: String  
Required: Yes

## See Also
<a name="API_ElasticGpuSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ElasticGpuSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ElasticGpuSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ElasticGpuSpecification) 

# ElasticGpuSpecificationResponse
<a name="API_ElasticGpuSpecificationResponse"></a>

Deprecated.

**Note**  
Amazon Elastic Graphics reached end of life on January 8, 2024.

## Contents
<a name="API_ElasticGpuSpecificationResponse_Contents"></a>

 ** type **   
Deprecated.  
Amazon Elastic Graphics reached end of life on January 8, 2024.
Type: String  
Required: No

## See Also
<a name="API_ElasticGpuSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ElasticGpuSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ElasticGpuSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ElasticGpuSpecificationResponse) 

# ElasticInferenceAccelerator
<a name="API_ElasticInferenceAccelerator"></a>

**Note**  
Amazon Elastic Inference is no longer available.

 Describes an elastic inference accelerator. 

## Contents
<a name="API_ElasticInferenceAccelerator_Contents"></a>

 ** Type **   
 The type of elastic inference accelerator. The possible values are `eia1.medium`, `eia1.large`, `eia1.xlarge`, `eia2.medium`, `eia2.large`, and `eia2.xlarge`.   
Type: String  
Required: Yes

 ** Count **   
 The number of elastic inference accelerators to attach to the instance.   
Default: 1  
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_ElasticInferenceAccelerator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ElasticInferenceAccelerator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ElasticInferenceAccelerator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ElasticInferenceAccelerator) 

# ElasticInferenceAcceleratorAssociation
<a name="API_ElasticInferenceAcceleratorAssociation"></a>

**Note**  
Amazon Elastic Inference is no longer available.

 Describes the association between an instance and an elastic inference accelerator. 

## Contents
<a name="API_ElasticInferenceAcceleratorAssociation_Contents"></a>

 ** elasticInferenceAcceleratorArn **   
 The Amazon Resource Name (ARN) of the elastic inference accelerator.   
Type: String  
Required: No

 ** elasticInferenceAcceleratorAssociationId **   
 The ID of the association.   
Type: String  
Required: No

 ** elasticInferenceAcceleratorAssociationState **   
 The state of the elastic inference accelerator.   
Type: String  
Required: No

 ** elasticInferenceAcceleratorAssociationTime **   
 The time at which the elastic inference accelerator is associated with an instance.   
Type: Timestamp  
Required: No

## See Also
<a name="API_ElasticInferenceAcceleratorAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ElasticInferenceAcceleratorAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ElasticInferenceAcceleratorAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ElasticInferenceAcceleratorAssociation) 

# EnableFastSnapshotRestoreErrorItem
<a name="API_EnableFastSnapshotRestoreErrorItem"></a>

Contains information about the errors that occurred when enabling fast snapshot restores.

## Contents
<a name="API_EnableFastSnapshotRestoreErrorItem_Contents"></a>

 ** FastSnapshotRestoreStateErrorSet.N **   
The errors.  
Type: Array of [EnableFastSnapshotRestoreStateErrorItem](API_EnableFastSnapshotRestoreStateErrorItem.md) objects  
Required: No

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

## See Also
<a name="API_EnableFastSnapshotRestoreErrorItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableFastSnapshotRestoreErrorItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableFastSnapshotRestoreErrorItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableFastSnapshotRestoreErrorItem) 

# EnableFastSnapshotRestoreStateError
<a name="API_EnableFastSnapshotRestoreStateError"></a>

Describes an error that occurred when enabling fast snapshot restores.

## Contents
<a name="API_EnableFastSnapshotRestoreStateError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Required: No

 ** message **   
The error message.  
Type: String  
Required: No

## See Also
<a name="API_EnableFastSnapshotRestoreStateError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableFastSnapshotRestoreStateError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableFastSnapshotRestoreStateError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableFastSnapshotRestoreStateError) 

# EnableFastSnapshotRestoreStateErrorItem
<a name="API_EnableFastSnapshotRestoreStateErrorItem"></a>

Contains information about an error that occurred when enabling fast snapshot restores.

## Contents
<a name="API_EnableFastSnapshotRestoreStateErrorItem_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** error **   
The error.  
Type: [EnableFastSnapshotRestoreStateError](API_EnableFastSnapshotRestoreStateError.md) object  
Required: No

## See Also
<a name="API_EnableFastSnapshotRestoreStateErrorItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableFastSnapshotRestoreStateErrorItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableFastSnapshotRestoreStateErrorItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableFastSnapshotRestoreStateErrorItem) 

# EnableFastSnapshotRestoreSuccessItem
<a name="API_EnableFastSnapshotRestoreSuccessItem"></a>

Describes fast snapshot restores that were successfully enabled.

## Contents
<a name="API_EnableFastSnapshotRestoreSuccessItem_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** disabledTime **   
The time at which fast snapshot restores entered the `disabled` state.  
Type: Timestamp  
Required: No

 ** disablingTime **   
The time at which fast snapshot restores entered the `disabling` state.  
Type: Timestamp  
Required: No

 ** enabledTime **   
The time at which fast snapshot restores entered the `enabled` state.  
Type: Timestamp  
Required: No

 ** enablingTime **   
The time at which fast snapshot restores entered the `enabling` state.  
Type: Timestamp  
Required: No

 ** optimizingTime **   
The time at which fast snapshot restores entered the `optimizing` state.  
Type: Timestamp  
Required: No

 ** ownerAlias **   
The AWS owner alias that enabled fast snapshot restores on the snapshot. This is intended for future use.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that enabled fast snapshot restores on the snapshot.  
Type: String  
Required: No

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

 ** state **   
The state of fast snapshot restores.  
Type: String  
Valid Values: `enabling | optimizing | enabled | disabling | disabled`   
Required: No

 ** stateTransitionReason **   
The reason for the state transition. The possible values are as follows:  
+  `Client.UserInitiated` - The state successfully transitioned to `enabling` or `disabling`.
+  `Client.UserInitiated - Lifecycle state transition` - The state successfully transitioned to `optimizing`, `enabled`, or `disabled`.
Type: String  
Required: No

## See Also
<a name="API_EnableFastSnapshotRestoreSuccessItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnableFastSnapshotRestoreSuccessItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnableFastSnapshotRestoreSuccessItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnableFastSnapshotRestoreSuccessItem) 

# EnaSrdSpecification
<a name="API_EnaSrdSpecification"></a>

ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.

## Contents
<a name="API_EnaSrdSpecification_Contents"></a>

 ** EnaSrdEnabled **   
Indicates whether ENA Express is enabled for the network interface.  
Type: Boolean  
Required: No

 ** EnaSrdUdpSpecification **   
Configures ENA Express for UDP network traffic.  
Type: [EnaSrdUdpSpecification](API_EnaSrdUdpSpecification.md) object  
Required: No

## See Also
<a name="API_EnaSrdSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnaSrdSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnaSrdSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnaSrdSpecification) 

# EnaSrdSpecificationRequest
<a name="API_EnaSrdSpecificationRequest"></a>

Launch instances with ENA Express settings configured from your launch template.

## Contents
<a name="API_EnaSrdSpecificationRequest_Contents"></a>

 ** EnaSrdEnabled ** (request), ** EnaSrdEnabled ** (response)  
Specifies whether ENA Express is enabled for the network interface when you launch an instance.  
Type: Boolean  
Required: No

 ** EnaSrdUdpSpecification ** (request), ** EnaSrdUdpSpecification ** (response)  
Contains ENA Express settings for UDP network traffic for the network interface attached to the instance.  
Type: [EnaSrdUdpSpecificationRequest](API_EnaSrdUdpSpecificationRequest.md) object  
Required: No

## See Also
<a name="API_EnaSrdSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnaSrdSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnaSrdSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnaSrdSpecificationRequest) 

# EnaSrdUdpSpecification
<a name="API_EnaSrdUdpSpecification"></a>

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.

## Contents
<a name="API_EnaSrdUdpSpecification_Contents"></a>

 ** EnaSrdUdpEnabled **   
Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.  
Type: Boolean  
Required: No

## See Also
<a name="API_EnaSrdUdpSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnaSrdUdpSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnaSrdUdpSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnaSrdUdpSpecification) 

# EnaSrdUdpSpecificationRequest
<a name="API_EnaSrdUdpSpecificationRequest"></a>

Configures ENA Express for UDP network traffic from your launch template.

## Contents
<a name="API_EnaSrdUdpSpecificationRequest_Contents"></a>

 ** EnaSrdUdpEnabled ** (request), ** EnaSrdUdpEnabled ** (response)  
Indicates whether UDP traffic uses ENA Express for your instance. To ensure that UDP traffic can use ENA Express when you launch an instance, you must also set **EnaSrdEnabled** in the **EnaSrdSpecificationRequest** to `true`.  
Type: Boolean  
Required: No

## See Also
<a name="API_EnaSrdUdpSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnaSrdUdpSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnaSrdUdpSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnaSrdUdpSpecificationRequest) 

# EnclaveOptions
<a name="API_EnclaveOptions"></a>

Indicates whether the instance is enabled for AWS Nitro Enclaves.

## Contents
<a name="API_EnclaveOptions_Contents"></a>

 ** enabled **   
If this parameter is set to `true`, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.  
Type: Boolean  
Required: No

## See Also
<a name="API_EnclaveOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnclaveOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnclaveOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnclaveOptions) 

# EnclaveOptionsRequest
<a name="API_EnclaveOptionsRequest"></a>

Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [ What is AWS Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the * AWS Nitro Enclaves User Guide*.

## Contents
<a name="API_EnclaveOptionsRequest_Contents"></a>

 ** Enabled **   
To enable the instance for AWS Nitro Enclaves, set this parameter to `true`.  
Type: Boolean  
Required: No

## See Also
<a name="API_EnclaveOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EnclaveOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EnclaveOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EnclaveOptionsRequest) 

# EncryptionSupport
<a name="API_EncryptionSupport"></a>

Describes the encryption support status for a transit gateway.

## Contents
<a name="API_EncryptionSupport_Contents"></a>

 ** encryptionState **   
The current encryption state of the resource.  
Type: String  
Valid Values: `enabling | enabled | disabling | disabled`   
Required: No

 ** stateMessage **   
A message describing the encryption state.  
Type: String  
Required: No

## See Also
<a name="API_EncryptionSupport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EncryptionSupport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EncryptionSupport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EncryptionSupport) 

# EventInformation
<a name="API_EventInformation"></a>

Describes an EC2 Fleet or Spot Fleet event.

## Contents
<a name="API_EventInformation_Contents"></a>

 ** eventDescription **   
The description of the event.  
Type: String  
Required: No

 ** eventSubType **   
The event.  
 `error` events:  
+  `iamFleetRoleInvalid` - The EC2 Fleet or Spot Fleet does not have the required permissions either to launch or terminate an instance.
+  `allLaunchSpecsTemporarilyBlacklisted` - None of the configurations are valid, and several attempts to launch instances have failed. For more information, see the description of the event.
+  `spotInstanceCountLimitExceeded` - You've reached the limit on the number of Spot Instances that you can launch.
+  `spotFleetRequestConfigurationInvalid` - The configuration is not valid. For more information, see the description of the event.
 `fleetRequestChange` events:  
+  `active` - The EC2 Fleet or Spot Fleet request has been validated and Amazon EC2 is attempting to maintain the target number of running instances.
+  `deleted` (EC2 Fleet) / `cancelled` (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and has no running instances. The EC2 Fleet or Spot Fleet will be deleted two days after its instances are terminated.
+  `deleted_running` (EC2 Fleet) / `cancelled_running` (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and does not launch additional instances. Its existing instances continue to run until they are interrupted or terminated. The request remains in this state until all instances are interrupted or terminated.
+  `deleted_terminating` (EC2 Fleet) / `cancelled_terminating` (Spot Fleet) - The EC2 Fleet is deleted or the Spot Fleet request is canceled and its instances are terminating. The request remains in this state until all instances are terminated.
+  `expired` - The EC2 Fleet or Spot Fleet request has expired. If the request was created with `TerminateInstancesWithExpiration` set, a subsequent `terminated` event indicates that the instances are terminated.
+  `modify_in_progress` - The EC2 Fleet or Spot Fleet request is being modified. The request remains in this state until the modification is fully processed.
+  `modify_succeeded` - The EC2 Fleet or Spot Fleet request was modified.
+  `submitted` - The EC2 Fleet or Spot Fleet request is being evaluated and Amazon EC2 is preparing to launch the target number of instances.
+  `progress` - The EC2 Fleet or Spot Fleet request is in the process of being fulfilled.
 `instanceChange` events:  
+  `launched` - A new instance was launched.
+  `terminated` - An instance was terminated by the user.
+  `termination_notified` - An instance termination notification was sent when a Spot Instance was terminated by Amazon EC2 during scale-down, when the target capacity of the fleet was modified down, for example, from a target capacity of 4 to a target capacity of 3.
 `Information` events:  
+  `fleetProgressHalted` - The price in every launch specification is not valid because it is below the Spot price (all the launch specifications have produced `launchSpecUnusable` events). A launch specification might become valid if the Spot price changes.
+  `launchSpecTemporarilyBlacklisted` - The configuration is not valid and several attempts to launch instances have failed. For more information, see the description of the event.
+  `launchSpecUnusable` - The price specified in a launch specification is not valid because it is below the Spot price for the requested Spot pools.

  Note: Even if a fleet with the `maintain` request type is in the process of being canceled, it may still publish a `launchSpecUnusable` event. This does not mean that the canceled fleet is attempting to launch a new instance.
+  `registerWithLoadBalancersFailed` - An attempt to register instances with load balancers failed. For more information, see the description of the event.
Type: String  
Required: No

 ** instanceId **   
The ID of the instance. This information is available only for `instanceChange` events.  
Type: String  
Required: No

## See Also
<a name="API_EventInformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/EventInformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/EventInformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/EventInformation) 

# Explanation
<a name="API_Explanation"></a>

Describes an explanation code for an unreachable path. For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html).

## Contents
<a name="API_Explanation_Contents"></a>

 ** acl **   
The network ACL.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** aclRule **   
The network ACL rule.  
Type: [AnalysisAclRule](API_AnalysisAclRule.md) object  
Required: No

 ** address **   
The IPv4 address, in CIDR notation.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** AddressSet.N **   
The IPv4 addresses, in CIDR notation.  
Type: Array of strings  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** attachedTo **   
The resource to which the component is attached.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** AvailabilityZoneIdSet.N **   
The IDs of the Availability Zones.  
Type: Array of strings  
Required: No

 ** AvailabilityZoneSet.N **   
The Availability Zones.  
Type: Array of strings  
Required: No

 ** CidrSet.N **   
The CIDR ranges.  
Type: Array of strings  
Required: No

 ** classicLoadBalancerListener **   
The listener for a Classic Load Balancer.  
Type: [AnalysisLoadBalancerListener](API_AnalysisLoadBalancerListener.md) object  
Required: No

 ** component **   
The component.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** componentAccount **   
The AWS account for the component.  
Type: String  
Pattern: `\d{12}`   
Required: No

 ** componentRegion **   
The Region for the component.  
Type: String  
Pattern: `[a-z]{2}-[a-z]+-[1-9]+`   
Required: No

 ** customerGateway **   
The customer gateway.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** destination **   
The destination.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** destinationVpc **   
The destination VPC.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** direction **   
The direction. The following are the possible values:  
+ egress
+ ingress
Type: String  
Required: No

 ** elasticLoadBalancerListener **   
The load balancer listener.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** explanationCode **   
The explanation code.  
Type: String  
Required: No

 ** firewallStatefulRule **   
The Network Firewall stateful rule.  
Type: [FirewallStatefulRule](API_FirewallStatefulRule.md) object  
Required: No

 ** firewallStatelessRule **   
The Network Firewall stateless rule.  
Type: [FirewallStatelessRule](API_FirewallStatelessRule.md) object  
Required: No

 ** ingressRouteTable **   
The route table.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** internetGateway **   
The internet gateway.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** loadBalancerArn **   
The Amazon Resource Name (ARN) of the load balancer.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** loadBalancerListenerPort **   
The listener port of the load balancer.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

 ** loadBalancerTarget **   
The target.  
Type: [AnalysisLoadBalancerTarget](API_AnalysisLoadBalancerTarget.md) object  
Required: No

 ** loadBalancerTargetGroup **   
The target group.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** LoadBalancerTargetGroupSet.N **   
The target groups.  
Type: Array of [AnalysisComponent](API_AnalysisComponent.md) objects  
Required: No

 ** loadBalancerTargetPort **   
The target port.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

 ** missingComponent **   
The missing component.  
Type: String  
Required: No

 ** natGateway **   
The NAT gateway.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** networkInterface **   
The network interface.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** packetField **   
The packet field.  
Type: String  
Required: No

 ** port **   
The port.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

 ** PortRangeSet.N **   
The port ranges.  
Type: Array of [PortRange](API_PortRange.md) objects  
Required: No

 ** prefixList **   
The prefix list.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** ProtocolSet.N **   
The protocols.  
Type: Array of strings  
Required: No

 ** routeTable **   
The route table.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** routeTableRoute **   
The route table route.  
Type: [AnalysisRouteTableRoute](API_AnalysisRouteTableRoute.md) object  
Required: No

 ** securityGroup **   
The security group.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** securityGroupRule **   
The security group rule.  
Type: [AnalysisSecurityGroupRule](API_AnalysisSecurityGroupRule.md) object  
Required: No

 ** SecurityGroupSet.N **   
The security groups.  
Type: Array of [AnalysisComponent](API_AnalysisComponent.md) objects  
Required: No

 ** sourceVpc **   
The source VPC.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** state **   
The state.  
Type: String  
Required: No

 ** subnet **   
The subnet.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** subnetRouteTable **   
The route table for the subnet.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** transitGateway **   
The transit gateway.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** transitGatewayAttachment **   
The transit gateway attachment.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** transitGatewayRouteTable **   
The transit gateway route table.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** transitGatewayRouteTableRoute **   
The transit gateway route table route.  
Type: [TransitGatewayRouteTableRoute](API_TransitGatewayRouteTableRoute.md) object  
Required: No

 ** vpc **   
The component VPC.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** vpcEndpoint **   
The VPC endpoint.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** vpcPeeringConnection **   
The VPC peering connection.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** vpnConnection **   
The VPN connection.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** vpnGateway **   
The VPN gateway.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

## See Also
<a name="API_Explanation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Explanation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Explanation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Explanation) 

# ExportImageTask
<a name="API_ExportImageTask"></a>

Describes an export image task.

## Contents
<a name="API_ExportImageTask_Contents"></a>

 ** description **   
A description of the image being exported.  
Type: String  
Required: No

 ** exportImageTaskId **   
The ID of the export image task.  
Type: String  
Required: No

 ** imageId **   
The ID of the image.  
Type: String  
Required: No

 ** progress **   
The percent complete of the export image task.  
Type: String  
Required: No

 ** s3ExportLocation **   
Information about the destination Amazon S3 bucket.  
Type: [ExportTaskS3Location](API_ExportTaskS3Location.md) object  
Required: No

 ** status **   
The status of the export image task. The possible values are `active`, `completed`, `deleting`, and `deleted`.  
Type: String  
Required: No

 ** statusMessage **   
The status message for the export image task.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the export image task.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ExportImageTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportImageTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportImageTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportImageTask) 

# ExportTask
<a name="API_ExportTask"></a>

Describes an export instance task.

## Contents
<a name="API_ExportTask_Contents"></a>

 ** description **   
A description of the resource being exported.  
Type: String  
Required: No

 ** exportTaskId **   
The ID of the export task.  
Type: String  
Required: No

 ** exportToS3 **   
Information about the export task.  
Type: [ExportToS3Task](API_ExportToS3Task.md) object  
Required: No

 ** instanceExport **   
Information about the instance to export.  
Type: [InstanceExportDetails](API_InstanceExportDetails.md) object  
Required: No

 ** state **   
The state of the export task.  
Type: String  
Valid Values: `active | cancelling | cancelled | completed`   
Required: No

 ** statusMessage **   
The status message related to the export task.  
Type: String  
Required: No

 ** TagSet.N **   
The tags for the export task.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ExportTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportTask) 

# ExportTaskS3Location
<a name="API_ExportTaskS3Location"></a>

Describes the destination for an export image task.

## Contents
<a name="API_ExportTaskS3Location_Contents"></a>

 ** s3Bucket **   
The destination Amazon S3 bucket.  
Type: String  
Required: No

 ** s3Prefix **   
The prefix (logical hierarchy) in the bucket.  
Type: String  
Required: No

## See Also
<a name="API_ExportTaskS3Location_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportTaskS3Location) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportTaskS3Location) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportTaskS3Location) 

# ExportTaskS3LocationRequest
<a name="API_ExportTaskS3LocationRequest"></a>

Describes the destination for an export image task.

## Contents
<a name="API_ExportTaskS3LocationRequest_Contents"></a>

 ** S3Bucket **   
The destination Amazon S3 bucket.  
Type: String  
Required: Yes

 ** S3Prefix **   
The prefix (logical hierarchy) in the bucket.  
Type: String  
Required: No

## See Also
<a name="API_ExportTaskS3LocationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportTaskS3LocationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportTaskS3LocationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportTaskS3LocationRequest) 

# ExportToS3Task
<a name="API_ExportToS3Task"></a>

Describes the format and location for the export task.

## Contents
<a name="API_ExportToS3Task_Contents"></a>

 ** containerFormat **   
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.  
Type: String  
Valid Values: `ova`   
Required: No

 ** diskImageFormat **   
The format for the exported image.  
Type: String  
Valid Values: `VMDK | RAW | VHD`   
Required: No

 ** s3Bucket **   
The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the `Grantee`. For more information about the ACL to your S3 bucket, see [Prerequisites](https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites) in the VM Import/Export User Guide.  
Type: String  
Required: No

 ** s3Key **   
The encryption key for your S3 bucket.  
Type: String  
Required: No

## See Also
<a name="API_ExportToS3Task_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportToS3Task) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportToS3Task) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportToS3Task) 

# ExportToS3TaskSpecification
<a name="API_ExportToS3TaskSpecification"></a>

Describes an export instance task.

## Contents
<a name="API_ExportToS3TaskSpecification_Contents"></a>

 ** ContainerFormat **   
The container format used to combine disk images with metadata (such as OVF). If absent, only the disk image is exported.  
Type: String  
Valid Values: `ova`   
Required: No

 ** DiskImageFormat **   
The format for the exported image.  
Type: String  
Valid Values: `VMDK | RAW | VHD`   
Required: No

 ** S3Bucket **   
The Amazon S3 bucket for the destination image. The destination bucket must exist and have an access control list (ACL) attached that specifies the Region-specific canonical account ID for the `Grantee`. For more information about the ACL to your S3 bucket, see [Prerequisites](https://docs.aws.amazon.com/vm-import/latest/userguide/vmexport.html#vmexport-prerequisites) in the VM Import/Export User Guide.  
Type: String  
Required: No

 ** S3Prefix **   
The image is written to a single object in the Amazon S3 bucket at the S3 key s3prefix \$1 exportTaskId \$1 '.' \$1 diskImageFormat.  
Type: String  
Required: No

## See Also
<a name="API_ExportToS3TaskSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExportToS3TaskSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExportToS3TaskSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExportToS3TaskSpecification) 

# ExternalAuthorityConfiguration
<a name="API_ExternalAuthorityConfiguration"></a>

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.

For more information, see [Integrate VPC IPAM with Infoblox infrastructure](https://docs.aws.amazon.com/vpc/latest/ipam/integrate-infoblox-ipam.html) in the *Amazon VPC IPAM User Guide*.

## Contents
<a name="API_ExternalAuthorityConfiguration_Contents"></a>

 ** ExternalResourceIdentifier **   
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format `<version>.identity.account.<entity_realm>.<entity_id>`.  
Type: String  
Required: No

 ** Type **   
The type of external authority.  
Type: String  
Valid Values: `infoblox`   
Required: No

## See Also
<a name="API_ExternalAuthorityConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ExternalAuthorityConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ExternalAuthorityConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ExternalAuthorityConfiguration) 

# FailedCapacityReservationFleetCancellationResult
<a name="API_FailedCapacityReservationFleetCancellationResult"></a>

Describes a Capacity Reservation Fleet that could not be cancelled.

## Contents
<a name="API_FailedCapacityReservationFleetCancellationResult_Contents"></a>

 ** cancelCapacityReservationFleetError **   
Information about the Capacity Reservation Fleet cancellation error.  
Type: [CancelCapacityReservationFleetError](API_CancelCapacityReservationFleetError.md) object  
Required: No

 ** capacityReservationFleetId **   
The ID of the Capacity Reservation Fleet that could not be cancelled.  
Type: String  
Required: No

## See Also
<a name="API_FailedCapacityReservationFleetCancellationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FailedCapacityReservationFleetCancellationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FailedCapacityReservationFleetCancellationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FailedCapacityReservationFleetCancellationResult) 

# FailedQueuedPurchaseDeletion
<a name="API_FailedQueuedPurchaseDeletion"></a>

Describes a Reserved Instance whose queued purchase was not deleted.

## Contents
<a name="API_FailedQueuedPurchaseDeletion_Contents"></a>

 ** error **   
The error.  
Type: [DeleteQueuedReservedInstancesError](API_DeleteQueuedReservedInstancesError.md) object  
Required: No

 ** reservedInstancesId **   
The ID of the Reserved Instance.  
Type: String  
Required: No

## See Also
<a name="API_FailedQueuedPurchaseDeletion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FailedQueuedPurchaseDeletion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FailedQueuedPurchaseDeletion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FailedQueuedPurchaseDeletion) 

# FastLaunchLaunchTemplateSpecificationRequest
<a name="API_FastLaunchLaunchTemplateSpecificationRequest"></a>

Request to create a launch template for a Windows fast launch enabled AMI.

**Note**  
Note - You can specify either the `LaunchTemplateName` or the `LaunchTemplateId`, but not both.

## Contents
<a name="API_FastLaunchLaunchTemplateSpecificationRequest_Contents"></a>

 ** Version **   
Specify the version of the launch template that the AMI should use for Windows fast launch.  
Type: String  
Required: Yes

 ** LaunchTemplateId **   
Specify the ID of the launch template that the AMI should use for Windows fast launch.  
Type: String  
Required: No

 ** LaunchTemplateName **   
Specify the name of the launch template that the AMI should use for Windows fast launch.  
Type: String  
Required: No

## See Also
<a name="API_FastLaunchLaunchTemplateSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FastLaunchLaunchTemplateSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FastLaunchLaunchTemplateSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FastLaunchLaunchTemplateSpecificationRequest) 

# FastLaunchLaunchTemplateSpecificationResponse
<a name="API_FastLaunchLaunchTemplateSpecificationResponse"></a>

Identifies the launch template that the AMI uses for Windows fast launch.

## Contents
<a name="API_FastLaunchLaunchTemplateSpecificationResponse_Contents"></a>

 ** launchTemplateId **   
The ID of the launch template that the AMI uses for Windows fast launch.  
Type: String  
Required: No

 ** launchTemplateName **   
The name of the launch template that the AMI uses for Windows fast launch.  
Type: String  
Required: No

 ** version **   
The version of the launch template that the AMI uses for Windows fast launch.  
Type: String  
Required: No

## See Also
<a name="API_FastLaunchLaunchTemplateSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FastLaunchLaunchTemplateSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FastLaunchLaunchTemplateSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FastLaunchLaunchTemplateSpecificationResponse) 

# FastLaunchSnapshotConfigurationRequest
<a name="API_FastLaunchSnapshotConfigurationRequest"></a>

Configuration settings for creating and managing pre-provisioned snapshots for a Windows fast launch enabled AMI.

## Contents
<a name="API_FastLaunchSnapshotConfigurationRequest_Contents"></a>

 ** TargetResourceCount **   
The number of pre-provisioned snapshots to keep on hand for a Windows fast launch enabled AMI.  
Type: Integer  
Required: No

## See Also
<a name="API_FastLaunchSnapshotConfigurationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FastLaunchSnapshotConfigurationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FastLaunchSnapshotConfigurationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FastLaunchSnapshotConfigurationRequest) 

# FastLaunchSnapshotConfigurationResponse
<a name="API_FastLaunchSnapshotConfigurationResponse"></a>

Configuration settings for creating and managing pre-provisioned snapshots for a Windows fast launch enabled Windows AMI.

## Contents
<a name="API_FastLaunchSnapshotConfigurationResponse_Contents"></a>

 ** targetResourceCount **   
The number of pre-provisioned snapshots requested to keep on hand for a Windows fast launch enabled AMI.  
Type: Integer  
Required: No

## See Also
<a name="API_FastLaunchSnapshotConfigurationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FastLaunchSnapshotConfigurationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FastLaunchSnapshotConfigurationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FastLaunchSnapshotConfigurationResponse) 

# FederatedAuthentication
<a name="API_FederatedAuthentication"></a>

Describes the IAM SAML identity providers used for federated authentication.

## Contents
<a name="API_FederatedAuthentication_Contents"></a>

 ** samlProviderArn **   
The Amazon Resource Name (ARN) of the IAM SAML identity provider.  
Type: String  
Required: No

 ** selfServiceSamlProviderArn **   
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.  
Type: String  
Required: No

## See Also
<a name="API_FederatedAuthentication_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FederatedAuthentication) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FederatedAuthentication) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FederatedAuthentication) 

# FederatedAuthenticationRequest
<a name="API_FederatedAuthenticationRequest"></a>

The IAM SAML identity provider used for federated authentication.

## Contents
<a name="API_FederatedAuthenticationRequest_Contents"></a>

 ** SAMLProviderArn **   
The Amazon Resource Name (ARN) of the IAM SAML identity provider.  
Type: String  
Required: No

 ** SelfServiceSAMLProviderArn **   
The Amazon Resource Name (ARN) of the IAM SAML identity provider for the self-service portal.  
Type: String  
Required: No

## See Also
<a name="API_FederatedAuthenticationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FederatedAuthenticationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FederatedAuthenticationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FederatedAuthenticationRequest) 

# Filter
<a name="API_Filter"></a>

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

If you specify multiple filters, the filters are joined with an `AND`, and the request returns only results that match all of the specified filters.

The filters supported by a describe operation are documented with the describe operation. For example:
+  [DescribeAvailabilityZones](API_DescribeAvailabilityZones.md) 
+  [DescribeImages](API_DescribeImages.md) 
+  [DescribeInstances](API_DescribeInstances.md) 
+  [DescribeKeyPairs](API_DescribeKeyPairs.md) 
+  [DescribeSecurityGroups](API_DescribeSecurityGroups.md) 
+  [DescribeSnapshots](API_DescribeSnapshots.md) 
+  [DescribeSubnets](API_DescribeSubnets.md) 
+  [DescribeTags](API_DescribeTags.md) 
+  [DescribeVolumes](API_DescribeVolumes.md) 
+  [DescribeVpcs](API_DescribeVpcs.md) 

For more information, see [List and filter using the CLI and API](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_Filter_Contents"></a>

 ** Name **   
The name of the filter. Filter names are case-sensitive.  
Type: String  
Required: No

 ** Value.N **   
The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an `OR`, and the request returns all results that match any of the specified values.  
Type: Array of strings  
Required: No

## See Also
<a name="API_Filter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Filter) 

# FilterPortRange
<a name="API_FilterPortRange"></a>

Describes a port range.

## Contents
<a name="API_FilterPortRange_Contents"></a>

 ** fromPort **   
The first port in the range.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

 ** toPort **   
The last port in the range.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

## See Also
<a name="API_FilterPortRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FilterPortRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FilterPortRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FilterPortRange) 

# FirewallStatefulRule
<a name="API_FirewallStatefulRule"></a>

Describes a stateful rule.

## Contents
<a name="API_FirewallStatefulRule_Contents"></a>

 ** DestinationPortSet.N **   
The destination ports.  
Type: Array of [PortRange](API_PortRange.md) objects  
Required: No

 ** DestinationSet.N **   
The destination IP addresses, in CIDR notation.  
Type: Array of strings  
Required: No

 ** direction **   
The direction. The possible values are `FORWARD` and `ANY`.  
Type: String  
Required: No

 ** protocol **   
The protocol.  
Type: String  
Required: No

 ** ruleAction **   
The rule action. The possible values are `pass`, `drop`, and `alert`.  
Type: String  
Required: No

 ** ruleGroupArn **   
The ARN of the stateful rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** SourcePortSet.N **   
The source ports.  
Type: Array of [PortRange](API_PortRange.md) objects  
Required: No

 ** SourceSet.N **   
The source IP addresses, in CIDR notation.  
Type: Array of strings  
Required: No

## See Also
<a name="API_FirewallStatefulRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FirewallStatefulRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FirewallStatefulRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FirewallStatefulRule) 

# FirewallStatelessRule
<a name="API_FirewallStatelessRule"></a>

Describes a stateless rule.

## Contents
<a name="API_FirewallStatelessRule_Contents"></a>

 ** DestinationPortSet.N **   
The destination ports.  
Type: Array of [PortRange](API_PortRange.md) objects  
Required: No

 ** DestinationSet.N **   
The destination IP addresses, in CIDR notation.  
Type: Array of strings  
Required: No

 ** priority **   
The rule priority.  
Type: Integer  
Valid Range: Minimum value of -1. Maximum value of 65535.  
Required: No

 ** ProtocolSet.N **   
The protocols.  
Type: Array of integers  
Valid Range: Minimum value of 0. Maximum value of 255.  
Required: No

 ** ruleAction **   
The rule action. The possible values are `pass`, `drop`, and `forward_to_site`.  
Type: String  
Required: No

 ** ruleGroupArn **   
The ARN of the stateless rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** SourcePortSet.N **   
The source ports.  
Type: Array of [PortRange](API_PortRange.md) objects  
Required: No

 ** SourceSet.N **   
The source IP addresses, in CIDR notation.  
Type: Array of strings  
Required: No

## See Also
<a name="API_FirewallStatelessRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FirewallStatelessRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FirewallStatelessRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FirewallStatelessRule) 

# FleetBlockDeviceMappingRequest
<a name="API_FleetBlockDeviceMappingRequest"></a>

Describes a block device mapping, which defines the EBS volumes and instance store volumes to attach to an instance at launch.

To override a block device mapping specified in the launch template:
+ Specify the exact same `DeviceName` here as specified in the launch template.
+ Only specify the parameters you want to change.
+ Any parameters you don't specify here will keep their original launch template values.

To add a new block device mapping:
+ Specify a `DeviceName` that doesn't exist in the launch template.
+ Specify all desired parameters here.

## Contents
<a name="API_FleetBlockDeviceMappingRequest_Contents"></a>

 ** DeviceName **   
The device name (for example, `/dev/sdh` or `xvdh`).  
Type: String  
Required: No

 ** Ebs **   
Parameters used to automatically set up EBS volumes when the instance is launched.  
Type: [FleetEbsBlockDeviceRequest](API_FleetEbsBlockDeviceRequest.md) object  
Required: No

 ** NoDevice **   
To omit the device from the block device mapping, specify an empty string. When this property is specified, the device is removed from the block device mapping regardless of the assigned value.  
Type: String  
Required: No

 ** VirtualName **   
The virtual device name (`ephemeralN`). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1`. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.  
NVMe instance store volumes are automatically enumerated and assigned a device name. Including them in your block device mapping has no effect.  
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.  
Type: String  
Required: No

## See Also
<a name="API_FleetBlockDeviceMappingRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetBlockDeviceMappingRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetBlockDeviceMappingRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetBlockDeviceMappingRequest) 

# FleetCapacityReservation
<a name="API_FleetCapacityReservation"></a>

Information about a Capacity Reservation in a Capacity Reservation Fleet.

## Contents
<a name="API_FleetCapacityReservation_Contents"></a>

 ** availabilityZone **   
The Availability Zone in which the Capacity Reservation reserves capacity.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone in which the Capacity Reservation reserves capacity.  
Type: String  
Required: No

 ** capacityReservationId **   
The ID of the Capacity Reservation.  
Type: String  
Required: No

 ** createDate **   
The date and time at which the Capacity Reservation was created.  
Type: Timestamp  
Required: No

 ** ebsOptimized **   
Indicates whether the Capacity Reservation reserves capacity for EBS-optimized instance types.  
Type: Boolean  
Required: No

 ** fulfilledCapacity **   
The number of capacity units fulfilled by the Capacity Reservation. 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: Double  
Required: No

 ** instancePlatform **   
The type of operating system for which the Capacity Reservation reserves 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: No

 ** instanceType **   
The instance type for which the Capacity Reservation reserves capacity.  
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

 ** priority **   
The priority of the instance type in the Capacity Reservation Fleet. For more information, see [Instance type priority](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) in the *Amazon EC2 User Guide*.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** totalInstanceCount **   
The total number of instances for which the Capacity Reservation reserves capacity.  
Type: Integer  
Required: No

 ** weight **   
The weight of the instance type in the Capacity Reservation Fleet. For more information, see [Instance type weight](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-weight) in the *Amazon EC2 User Guide*.  
Type: Double  
Valid Range: Minimum value of 0.001. Maximum value of 99.999.  
Required: No

## See Also
<a name="API_FleetCapacityReservation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetCapacityReservation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetCapacityReservation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetCapacityReservation) 

# FleetData
<a name="API_FleetData"></a>

Describes an EC2 Fleet.

## Contents
<a name="API_FleetData_Contents"></a>

 ** activityStatus **   
The progress of the EC2 Fleet.  
For fleets of type `instant`, the status is `fulfilled` after all requests are placed, regardless of whether target capacity is met (this is the only possible status for `instant` fleets).  
For fleets of type `request` or `maintain`, the status is `pending_fulfillment` after all requests are placed, `fulfilled` when the fleet size meets or exceeds target capacity, `pending_termination` while instances are terminating when fleet size is decreased, and `error` if there's an error.  
Type: String  
Valid Values: `error | pending_fulfillment | pending_termination | fulfilled`   
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).  
Constraints: Maximum 64 ASCII characters  
Type: String  
Required: No

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

 ** createTime **   
The creation date and time of the EC2 Fleet.  
Type: Timestamp  
Required: No

 ** ErrorSet.N **   
Information about the instances that could not be launched by the fleet. Valid only when **Type** is set to `instant`.  
Type: Array of [DescribeFleetError](API_DescribeFleetError.md) objects  
Required: No

 ** excessCapacityTerminationPolicy **   
Indicates whether running instances should be terminated if the 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: No

 ** FleetInstanceSet.N **   
Information about the instances that were launched by the fleet. Valid only when **Type** is set to `instant`.  
Type: Array of [DescribeFleetsInstances](API_DescribeFleetsInstances.md) objects  
Required: No

 ** fleetState **   
The state of the EC2 Fleet.  
Type: String  
Valid Values: `submitted | active | deleted | failed | deleted_running | deleted_terminating | modifying`   
Required: No

 ** fulfilledCapacity **   
The number of units fulfilled by this request compared to the set target capacity.  
Type: Double  
Required: No

 ** fulfilledOnDemandCapacity **   
The number of units fulfilled by this request compared to the set target On-Demand capacity.  
Type: Double  
Required: No

 ** LaunchTemplateConfigs.N **   
The launch template and overrides.  
Type: Array of [FleetLaunchTemplateConfig](API_FleetLaunchTemplateConfig.md) objects  
Required: No

 ** onDemandOptions **   
The allocation strategy of On-Demand Instances in an EC2 Fleet.  
Type: [OnDemandOptions](API_OnDemandOptions.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`.  
Type: [ReservedCapacityOptions](API_ReservedCapacityOptions.md) object  
Required: No

 ** spotOptions **   
The configuration of Spot Instances in an EC2 Fleet.  
Type: [SpotOptions](API_SpotOptions.md) object  
Required: No

 ** TagSet.N **   
The tags for an EC2 Fleet resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** targetCapacitySpecification **   
The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain`, you can specify a target capacity of 0 and add capacity later.  
Type: [TargetCapacitySpecification](API_TargetCapacitySpecification.md) object  
Required: No

 ** terminateInstancesWithExpiration **   
Indicates whether running instances should be terminated when the EC2 Fleet expires.   
Type: Boolean  
Required: No

 ** type **   
The type of request. Indicates whether the EC2 Fleet only `requests` the target capacity, or also attempts to `maintain` it. If you request a certain target capacity, EC2 Fleet only places the required requests; it does not attempt to replenish instances if capacity is diminished, and it does not submit requests in alternative capacity pools if capacity is unavailable. To maintain a certain target capacity, EC2 Fleet places the required requests to meet this target capacity. It also automatically replenishes any interrupted Spot Instances. Default: `maintain`.  
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 instance requests are placed or able to fulfill the request. The default end date is 7 days from the current date.   
Type: Timestamp  
Required: No

## See Also
<a name="API_FleetData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetData) 

# FleetEbsBlockDeviceRequest
<a name="API_FleetEbsBlockDeviceRequest"></a>

Describes a block device for an EBS volume.

## Contents
<a name="API_FleetEbsBlockDeviceRequest_Contents"></a>

 ** DeleteOnTermination **   
Indicates whether the EBS volume is deleted on instance termination. For more information, see [Preserve data when an instance is terminated](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/preserving-volumes-on-termination.html) in the *Amazon EC2 User Guide*.  
Type: Boolean  
Required: No

 ** Encrypted **   
Indicates whether the encryption state of an EBS volume is changed while being restored from a backing snapshot. 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 [Amazon EBS encryption](https://docs.aws.amazon.com/ebs/latest/userguide/ebs-encryption.html) in the *Amazon EBS User Guide*.  
In no case can you remove encryption from an encrypted volume.  
Encrypted volumes can only 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).  
This parameter is not returned by [DescribeImageAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImageAttribute).  
For [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage) and [RegisterImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RegisterImage), whether you can include this parameter, and the allowed values differ depending on the type of block device mapping you are creating.  
+ If you are creating a block device mapping for a **new (empty) volume**, you can include this parameter, and specify either `true` for an encrypted volume, or `false` for an unencrypted volume. If you omit this parameter, it defaults to `false` (unencrypted).
+ If you are creating a block device mapping from an **existing encrypted or unencrypted snapshot**, you must omit this parameter. If you include this parameter, the request will fail, regardless of the value that you specify.
+ If you are creating a block device mapping from an **existing unencrypted volume**, you can include this parameter, but you must specify `false`. If you specify `true`, the request will fail. In this case, we recommend that you omit the parameter.
+ If you are creating a block device mapping from an **existing encrypted volume**, you can include this parameter, and specify either `true` or `false`. However, if you specify `false`, the parameter is ignored and the block device mapping is always encrypted. In this case, we recommend that you omit the parameter.
Type: Boolean  
Required: No

 ** 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.  
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
For `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html#ec2-nitro-instances). On other instances, you can achieve performance up to 32,000 IOPS.  
This parameter is required for `io1` and `io2` volumes. The default for `gp3` volumes is 3,000 IOPS.  
Type: Integer  
Required: No

 ** KmsKeyId **   
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.  
This parameter is only supported on `BlockDeviceMapping` objects called by [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet.html), [RequestSpotInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html), and [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: String  
Required: No

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

 ** Throughput **   
The throughput that the volume supports, in MiB/s.  
This parameter is valid only for `gp3` volumes.  
Valid Range: Minimum value of 125. Maximum value of 2,000.  
Type: Integer  
Required: No

 ** VolumeSize **   
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. You can specify a volume size that is equal to or larger than the snapshot size.  
The following are the supported 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
Type: Integer  
Required: No

 ** VolumeType **   
The volume type. 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*.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

## See Also
<a name="API_FleetEbsBlockDeviceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetEbsBlockDeviceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetEbsBlockDeviceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetEbsBlockDeviceRequest) 

# FleetLaunchTemplateConfig
<a name="API_FleetLaunchTemplateConfig"></a>

Describes a launch template and overrides.

## Contents
<a name="API_FleetLaunchTemplateConfig_Contents"></a>

 ** launchTemplateSpecification **   
The launch template.  
Type: [FleetLaunchTemplateSpecification](API_FleetLaunchTemplateSpecification.md) object  
Required: No

 ** Overrides.N **   
Any parameters that you specify override the same parameters in the launch template.  
Type: Array of [FleetLaunchTemplateOverrides](API_FleetLaunchTemplateOverrides.md) objects  
Required: No

## See Also
<a name="API_FleetLaunchTemplateConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetLaunchTemplateConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetLaunchTemplateConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetLaunchTemplateConfig) 

# FleetLaunchTemplateConfigRequest
<a name="API_FleetLaunchTemplateConfigRequest"></a>

Describes a launch template and overrides.

## Contents
<a name="API_FleetLaunchTemplateConfigRequest_Contents"></a>

 ** LaunchTemplateSpecification **   
The launch template to use. You must specify either the launch template ID or launch template name in the request.   
Type: [FleetLaunchTemplateSpecificationRequest](API_FleetLaunchTemplateSpecificationRequest.md) object  
Required: No

 ** Overrides.N **   
Any parameters that you specify override the same parameters in the launch template.  
For fleets of type `request` and `maintain`, a maximum of 300 items is allowed across all launch templates.  
Type: Array of [FleetLaunchTemplateOverridesRequest](API_FleetLaunchTemplateOverridesRequest.md) objects  
Required: No

## See Also
<a name="API_FleetLaunchTemplateConfigRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetLaunchTemplateConfigRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetLaunchTemplateConfigRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetLaunchTemplateConfigRequest) 

# FleetLaunchTemplateOverrides
<a name="API_FleetLaunchTemplateOverrides"></a>

Describes overrides for a launch template.

## Contents
<a name="API_FleetLaunchTemplateOverrides_Contents"></a>

 ** availabilityZone **   
The Availability Zone in which to launch the instances. For example, `us-east-2a`.  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone in which to launch the instances. For example, `use2-az1`.  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** BlockDeviceMappingSet.N **   
The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch.  
Supported only for fleets of type `instant`.  
For more information, see [Block device mappings for volumes on Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User Guide*.  
Type: Array of [BlockDeviceMappingResponse](API_BlockDeviceMappingResponse.md) objects  
Required: No

 ** imageId **   
The ID of the AMI in the format `ami-17characters00000`.  
Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.  
To reference a public parameter:  
+  `resolve:ssm:public-parameter ` 
To reference a parameter stored in the same account:  
+  `resolve:ssm:parameter-name ` 
+  `resolve:ssm:parameter-name:version-number ` 
+  `resolve:ssm:parameter-name:label ` 
To reference a parameter shared from another AWS account:  
+  `resolve:ssm:parameter-ARN ` 
+  `resolve:ssm:parameter-ARN:version-number ` 
+  `resolve:ssm:parameter-ARN:label ` 
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*.  
This parameter is only available for fleets of type `instant`. For fleets of type `maintain` and `request`, you must specify the AMI ID in the launch template.
Type: String  
Required: No

 ** instanceRequirements **   
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.  
If you specify `InstanceRequirements`, you can't specify `InstanceType`.
Type: [InstanceRequirements](API_InstanceRequirements.md) object  
Required: No

 ** instanceType **   
The instance type.  
 `mac1.metal` is not supported as a launch template override.  
If you specify `InstanceType`, you can't specify `InstanceRequirements`.
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

 ** maxPrice **   
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.  
If you specify a maximum price, it must be more than USD \$10.001. Specifying a value below USD \$10.001 will result in an `InvalidParameterValue` error message.
Type: String  
Required: No

 ** placement **   
The location where the instance launched, if applicable.  
Type: [PlacementResponse](API_PlacementResponse.md) object  
Required: No

 ** priority **   
The priority for the launch template override. The highest priority is launched first.  
If the On-Demand `AllocationStrategy` is set to `prioritized`, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.  
If the Spot `AllocationStrategy` is set to `capacity-optimized-prioritized`, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.  
Valid values are whole numbers starting at `0`. The lower the number, the higher the priority. If no number is set, the override has the lowest priority. You can set the same priority for different launch template overrides.  
Type: Double  
Required: No

 ** subnetId **   
The ID of the subnet in which to launch the instances.  
Type: String  
Required: No

 ** weightedCapacity **   
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.  
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.  
When specifying weights, the price used in the `lowest-price` and `price-capacity-optimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity`, resulting in only 1 instance being launched, the price used is per *instance* hour.
Type: Double  
Required: No

## See Also
<a name="API_FleetLaunchTemplateOverrides_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetLaunchTemplateOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetLaunchTemplateOverrides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetLaunchTemplateOverrides) 

# FleetLaunchTemplateOverridesRequest
<a name="API_FleetLaunchTemplateOverridesRequest"></a>

Describes overrides for a launch template.

## Contents
<a name="API_FleetLaunchTemplateOverridesRequest_Contents"></a>

 ** AvailabilityZone **   
The Availability Zone in which to launch the instances. For example, `us-east-2a`.  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** AvailabilityZoneId **   
The ID of the Availability Zone in which to launch the instances. For example, `use2-az1`.  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** BlockDeviceMapping.N **   
The block device mappings, which define the EBS volumes and instance store volumes to attach to the instance at launch.  
Supported only for fleets of type `instant`.  
For more information, see [Block device mappings for volumes on Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html) in the *Amazon EC2 User Guide*.  
Type: Array of [FleetBlockDeviceMappingRequest](API_FleetBlockDeviceMappingRequest.md) objects  
Required: No

 ** ImageId **   
The ID of the AMI in the format `ami-17characters00000`.  
Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.  
To reference a public parameter:  
+  `resolve:ssm:public-parameter ` 
To reference a parameter stored in the same account:  
+  `resolve:ssm:parameter-name ` 
+  `resolve:ssm:parameter-name:version-number ` 
+  `resolve:ssm:parameter-name:label ` 
To reference a parameter shared from another AWS account:  
+  `resolve:ssm:parameter-ARN ` 
+  `resolve:ssm:parameter-ARN:version-number ` 
+  `resolve:ssm:parameter-ARN:label ` 
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*.  
This parameter is only available for fleets of type `instant`. For fleets of type `maintain` and `request`, you must specify the AMI ID in the launch template.
Type: String  
Required: No

 ** InstanceRequirements **   
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.  
If you specify `InstanceRequirements`, you can't specify `InstanceType`.
Type: [InstanceRequirementsRequest](API_InstanceRequirementsRequest.md) object  
Required: No

 ** InstanceType **   
The instance type.  
 `mac1.metal` is not supported as a launch template override.  
If you specify `InstanceType`, you can't specify `InstanceRequirements`.
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

 ** MaxPrice **   
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.  
If you specify a maximum price, it must be more than USD \$10.001. Specifying a value below USD \$10.001 will result in an `InvalidParameterValue` error message.
Type: String  
Required: No

 ** Placement **   
The location where the instance launched, if applicable.  
Type: [Placement](API_Placement.md) object  
Required: No

 ** Priority **   
The priority for the launch template override. The highest priority is launched first.  
If the On-Demand `AllocationStrategy` is set to `prioritized`, EC2 Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.  
If the Spot `AllocationStrategy` is set to `capacity-optimized-prioritized`, EC2 Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.  
Valid values are whole numbers starting at `0`. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.  
Type: Double  
Required: No

 ** SubnetId **   
The IDs of the subnets in which to launch the instances. Separate multiple subnet IDs using commas (for example, `subnet-1234abcdeexample1, subnet-0987cdef6example2`). A request of type `instant` can have only one subnet ID.  
Type: String  
Required: No

 ** WeightedCapacity **   
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.  
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.  
When specifying weights, the price used in the `lowest-price` and `price-capacity-optimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity`, resulting in only 1 instance being launched, the price used is per *instance* hour.
Type: Double  
Required: No

## See Also
<a name="API_FleetLaunchTemplateOverridesRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetLaunchTemplateOverridesRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetLaunchTemplateOverridesRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetLaunchTemplateOverridesRequest) 

# FleetLaunchTemplateSpecification
<a name="API_FleetLaunchTemplateSpecification"></a>

The Amazon EC2 launch template that can be used by a Spot Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

For information about launch templates, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_FleetLaunchTemplateSpecification_Contents"></a>

 ** LaunchTemplateId ** (request), ** launchTemplateId ** (response)  
The ID of the launch template.  
You must specify the `LaunchTemplateId` or the `LaunchTemplateName`, but not both.  
Type: String  
Required: No

 ** LaunchTemplateName ** (request), ** launchTemplateName ** (response)  
The name of the launch template.  
You must specify the `LaunchTemplateName` or the `LaunchTemplateId`, but not both.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\(\)\.\-/_]+`   
Required: No

 ** Version ** (request), ** version ** (response)  
The launch template version number, `$Latest`, or `$Default`. You must specify a value, otherwise the request fails.  
If the value is `$Latest`, Amazon EC2 uses the latest version of the launch template.  
If the value is `$Default`, Amazon EC2 uses the default version of the launch template.  
Type: String  
Required: No

## See Also
<a name="API_FleetLaunchTemplateSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetLaunchTemplateSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetLaunchTemplateSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetLaunchTemplateSpecification) 

# FleetLaunchTemplateSpecificationRequest
<a name="API_FleetLaunchTemplateSpecificationRequest"></a>

The Amazon EC2 launch template that can be used by an EC2 Fleet to configure Amazon EC2 instances. You must specify either the ID or name of the launch template in the request, but not both.

For information about launch templates, see [Launch an instance from a launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_FleetLaunchTemplateSpecificationRequest_Contents"></a>

 ** LaunchTemplateId **   
The ID of the launch template.  
You must specify the `LaunchTemplateId` or the `LaunchTemplateName`, but not both.  
Type: String  
Required: No

 ** LaunchTemplateName **   
The name of the launch template.  
You must specify the `LaunchTemplateName` or the `LaunchTemplateId`, but not both.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\(\)\.\-/_]+`   
Required: No

 ** Version **   
The launch template version number, `$Latest`, or `$Default`. You must specify a value, otherwise the request fails.  
If the value is `$Latest`, Amazon EC2 uses the latest version of the launch template.  
If the value is `$Default`, Amazon EC2 uses the default version of the launch template.  
Type: String  
Required: No

## See Also
<a name="API_FleetLaunchTemplateSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetLaunchTemplateSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetLaunchTemplateSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetLaunchTemplateSpecificationRequest) 

# FleetSpotCapacityRebalance
<a name="API_FleetSpotCapacityRebalance"></a>

The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.

## Contents
<a name="API_FleetSpotCapacityRebalance_Contents"></a>

 ** replacementStrategy **   
The replacement strategy to use. Only available for fleets of type `maintain`.  
 `launch` - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.   
 `launch-before-terminate` - EC2 Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay`), terminates the instances that received a rebalance notification.  
Type: String  
Valid Values: `launch | launch-before-terminate`   
Required: No

 ** terminationDelay **   
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.  
Required when `ReplacementStrategy` is set to `launch-before-terminate`.  
Not valid when `ReplacementStrategy` is set to `launch`.  
Valid values: Minimum value of `120` seconds. Maximum value of `7200` seconds.  
Type: Integer  
Required: No

## See Also
<a name="API_FleetSpotCapacityRebalance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetSpotCapacityRebalance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetSpotCapacityRebalance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetSpotCapacityRebalance) 

# FleetSpotCapacityRebalanceRequest
<a name="API_FleetSpotCapacityRebalanceRequest"></a>

The Spot Instance replacement strategy to use when Amazon EC2 emits a rebalance notification signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_FleetSpotCapacityRebalanceRequest_Contents"></a>

 ** ReplacementStrategy **   
The replacement strategy to use. Only available for fleets of type `maintain`.  
 `launch` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. EC2 Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.   
 `launch-before-terminate` - EC2 Fleet launches a replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay`), terminates the instances that received a rebalance notification.  
Type: String  
Valid Values: `launch | launch-before-terminate`   
Required: No

 ** TerminationDelay **   
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.  
Required when `ReplacementStrategy` is set to `launch-before-terminate`.  
Not valid when `ReplacementStrategy` is set to `launch`.  
Valid values: Minimum value of `120` seconds. Maximum value of `7200` seconds.  
Type: Integer  
Required: No

## See Also
<a name="API_FleetSpotCapacityRebalanceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetSpotCapacityRebalanceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetSpotCapacityRebalanceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetSpotCapacityRebalanceRequest) 

# FleetSpotMaintenanceStrategies
<a name="API_FleetSpotMaintenanceStrategies"></a>

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

## Contents
<a name="API_FleetSpotMaintenanceStrategies_Contents"></a>

 ** capacityRebalance **   
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.  
Type: [FleetSpotCapacityRebalance](API_FleetSpotCapacityRebalance.md) object  
Required: No

## See Also
<a name="API_FleetSpotMaintenanceStrategies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetSpotMaintenanceStrategies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetSpotMaintenanceStrategies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetSpotMaintenanceStrategies) 

# FleetSpotMaintenanceStrategiesRequest
<a name="API_FleetSpotMaintenanceStrategiesRequest"></a>

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

## Contents
<a name="API_FleetSpotMaintenanceStrategiesRequest_Contents"></a>

 ** CapacityRebalance **   
The strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted.  
Type: [FleetSpotCapacityRebalanceRequest](API_FleetSpotCapacityRebalanceRequest.md) object  
Required: No

## See Also
<a name="API_FleetSpotMaintenanceStrategiesRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FleetSpotMaintenanceStrategiesRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FleetSpotMaintenanceStrategiesRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FleetSpotMaintenanceStrategiesRequest) 

# FlowLog
<a name="API_FlowLog"></a>

Describes a flow log.

## Contents
<a name="API_FlowLog_Contents"></a>

 ** creationTime **   
The date and time the flow log was created.  
Type: Timestamp  
Required: No

 ** deliverCrossAccountRole **   
The ARN of the IAM role that allows the service to publish flow logs across accounts.  
Type: String  
Required: No

 ** deliverLogsErrorMessage **   
Information about the error that occurred. `Rate limited` indicates that CloudWatch Logs throttling has been applied for one or more network interfaces, or that you've reached the limit on the number of log groups that you can create. `Access error` indicates that the IAM role associated with the flow log does not have sufficient permissions to publish to CloudWatch Logs. `Unknown error` indicates an internal error.  
Type: String  
Required: No

 ** deliverLogsPermissionArn **   
The ARN of the IAM role allows the service to publish logs to CloudWatch Logs.  
Type: String  
Required: No

 ** deliverLogsStatus **   
The status of the logs delivery (`SUCCESS` \$1 `FAILED`).  
Type: String  
Required: No

 ** destinationOptions **   
The destination options.  
Type: [DestinationOptionsResponse](API_DestinationOptionsResponse.md) object  
Required: No

 ** flowLogId **   
The ID of the flow log.  
Type: String  
Required: No

 ** flowLogStatus **   
The status of the flow log (`ACTIVE`).  
Type: String  
Required: No

 ** logDestination **   
The Amazon Resource Name (ARN) of the destination for the flow log data.  
Type: String  
Required: No

 ** logDestinationType **   
The type of destination for the flow log data.  
Type: String  
Valid Values: `cloud-watch-logs | s3 | kinesis-data-firehose`   
Required: No

 ** logFormat **   
The format of the flow log record.  
Type: String  
Required: No

 ** logGroupName **   
The name of the flow log group.  
Type: String  
Required: No

 ** maxAggregationInterval **   
The maximum interval of time, in seconds, during which a flow of packets is captured and aggregated into a flow log record.  
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 (1 minute) or less, regardless of the specified value.  
Valid Values: `60` \$1 `600`   
Type: Integer  
Required: No

 ** resourceId **   
The ID of the resource being monitored.  
Type: String  
Required: No

 ** TagSet.N **   
The tags for the flow log.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trafficType **   
The type of traffic captured for the flow log.  
Type: String  
Valid Values: `ACCEPT | REJECT | ALL`   
Required: No

## See Also
<a name="API_FlowLog_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FlowLog) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FlowLog) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FlowLog) 

# FpgaDeviceInfo
<a name="API_FpgaDeviceInfo"></a>

Describes the FPGA accelerator for the instance type.

## Contents
<a name="API_FpgaDeviceInfo_Contents"></a>

 ** count **   
The count of FPGA accelerators for the instance type.  
Type: Integer  
Required: No

 ** manufacturer **   
The manufacturer of the FPGA accelerator.  
Type: String  
Required: No

 ** memoryInfo **   
Describes the memory for the FPGA accelerator for the instance type.  
Type: [FpgaDeviceMemoryInfo](API_FpgaDeviceMemoryInfo.md) object  
Required: No

 ** name **   
The name of the FPGA accelerator.  
Type: String  
Required: No

## See Also
<a name="API_FpgaDeviceInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FpgaDeviceInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FpgaDeviceInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FpgaDeviceInfo) 

# FpgaDeviceMemoryInfo
<a name="API_FpgaDeviceMemoryInfo"></a>

Describes the memory for the FPGA accelerator for the instance type.

## Contents
<a name="API_FpgaDeviceMemoryInfo_Contents"></a>

 ** sizeInMiB **   
The size of the memory available to the FPGA accelerator, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_FpgaDeviceMemoryInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FpgaDeviceMemoryInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FpgaDeviceMemoryInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FpgaDeviceMemoryInfo) 

# FpgaImage
<a name="API_FpgaImage"></a>

Describes an Amazon FPGA image (AFI).

## Contents
<a name="API_FpgaImage_Contents"></a>

 ** createTime **   
The date and time the AFI was created.  
Type: Timestamp  
Required: No

 ** dataRetentionSupport **   
Indicates whether data retention support is enabled for the AFI.  
Type: Boolean  
Required: No

 ** description **   
The description of the AFI.  
Type: String  
Required: No

 ** fpgaImageGlobalId **   
The global FPGA image identifier (AGFI ID).  
Type: String  
Required: No

 ** fpgaImageId **   
The FPGA image identifier (AFI ID).  
Type: String  
Required: No

 ** InstanceTypes.N **   
The instance types supported by the AFI.  
Type: Array of strings  
Required: No

 ** name **   
The name of the AFI.  
Type: String  
Required: No

 ** ownerAlias **   
The alias of the AFI owner. Possible values include `self`, `amazon`, and `aws-marketplace`.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the AFI.  
Type: String  
Required: No

 ** pciId **   
Information about the PCI bus.  
Type: [PciId](API_PciId.md) object  
Required: No

 ** ProductCodes.N **   
The product codes for the AFI.  
Type: Array of [ProductCode](API_ProductCode.md) objects  
Required: No

 ** public **   
Indicates whether the AFI is public.  
Type: Boolean  
Required: No

 ** shellVersion **   
The version of the AWS Shell that was used to create the bitstream.  
Type: String  
Required: No

 ** state **   
Information about the state of the AFI.  
Type: [FpgaImageState](API_FpgaImageState.md) object  
Required: No

 ** Tags.N **   
Any tags assigned to the AFI.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** updateTime **   
The time of the most recent update to the AFI.  
Type: Timestamp  
Required: No

## See Also
<a name="API_FpgaImage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FpgaImage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FpgaImage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FpgaImage) 

# FpgaImageAttribute
<a name="API_FpgaImageAttribute"></a>

Describes an Amazon FPGA image (AFI) attribute.

## Contents
<a name="API_FpgaImageAttribute_Contents"></a>

 ** description **   
The description of the AFI.  
Type: String  
Required: No

 ** fpgaImageId **   
The ID of the AFI.  
Type: String  
Required: No

 ** LoadPermissions.N **   
The load permissions.  
Type: Array of [LoadPermission](API_LoadPermission.md) objects  
Required: No

 ** name **   
The name of the AFI.  
Type: String  
Required: No

 ** ProductCodes.N **   
The product codes.  
Type: Array of [ProductCode](API_ProductCode.md) objects  
Required: No

## See Also
<a name="API_FpgaImageAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FpgaImageAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FpgaImageAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FpgaImageAttribute) 

# FpgaImageState
<a name="API_FpgaImageState"></a>

Describes the state of the bitstream generation process for an Amazon FPGA image (AFI).

## Contents
<a name="API_FpgaImageState_Contents"></a>

 ** code **   
The state. The following are the possible values:  
+  `pending` - AFI bitstream generation is in progress.
+  `available` - The AFI is available for use.
+  `failed` - AFI bitstream generation failed.
+  `unavailable` - The AFI is no longer available for use.
Type: String  
Valid Values: `pending | failed | available | unavailable`   
Required: No

 ** message **   
If the state is `failed`, this is the error message.  
Type: String  
Required: No

## See Also
<a name="API_FpgaImageState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FpgaImageState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FpgaImageState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FpgaImageState) 

# FpgaInfo
<a name="API_FpgaInfo"></a>

Describes the FPGAs for the instance type.

## Contents
<a name="API_FpgaInfo_Contents"></a>

 ** Fpgas.N **   
Describes the FPGAs for the instance type.  
Type: Array of [FpgaDeviceInfo](API_FpgaDeviceInfo.md) objects  
Required: No

 ** totalFpgaMemoryInMiB **   
The total memory of all FPGA accelerators for the instance type.  
Type: Integer  
Required: No

## See Also
<a name="API_FpgaInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/FpgaInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/FpgaInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/FpgaInfo) 

# GpuDeviceInfo
<a name="API_GpuDeviceInfo"></a>

Describes the GPU accelerators for the instance type.

## Contents
<a name="API_GpuDeviceInfo_Contents"></a>

 ** count **   
The number of GPUs for the instance type.  
Type: Integer  
Required: No

 ** gpuPartitionSize **   
The size of each GPU as a fraction of a full GPU, between 0 (excluded) and 1 (included).  
Type: Double  
Required: No

 ** logicalGpuCount **   
Total number of GPU devices of this type.  
Type: Integer  
Required: No

 ** manufacturer **   
The manufacturer of the GPU accelerator.  
Type: String  
Required: No

 ** memoryInfo **   
Describes the memory available to the GPU accelerator.  
Type: [GpuDeviceMemoryInfo](API_GpuDeviceMemoryInfo.md) object  
Required: No

 ** name **   
The name of the GPU accelerator.  
Type: String  
Required: No

 ** WorkloadSet.N **   
A list of workload types this GPU supports.  
Type: Array of strings  
Required: No

## See Also
<a name="API_GpuDeviceInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GpuDeviceInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GpuDeviceInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GpuDeviceInfo) 

# GpuDeviceMemoryInfo
<a name="API_GpuDeviceMemoryInfo"></a>

Describes the memory available to the GPU accelerator.

## Contents
<a name="API_GpuDeviceMemoryInfo_Contents"></a>

 ** sizeInMiB **   
The size of the memory available to the GPU accelerator, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_GpuDeviceMemoryInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GpuDeviceMemoryInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GpuDeviceMemoryInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GpuDeviceMemoryInfo) 

# GpuInfo
<a name="API_GpuInfo"></a>

Describes the GPU accelerators for the instance type.

## Contents
<a name="API_GpuInfo_Contents"></a>

 ** Gpus.N **   
Describes the GPU accelerators for the instance type.  
Type: Array of [GpuDeviceInfo](API_GpuDeviceInfo.md) objects  
Required: No

 ** totalGpuMemoryInMiB **   
The total size of the memory for the GPU accelerators for the instance type, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_GpuInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GpuInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GpuInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GpuInfo) 

# GroupIdentifier
<a name="API_GroupIdentifier"></a>

Describes a security group.

## Contents
<a name="API_GroupIdentifier_Contents"></a>

 ** GroupId ** (request), ** groupId ** (response)  
The ID of the security group.  
Type: String  
Required: No

 ** GroupName ** (request), ** groupName ** (response)  
The name of the security group.  
Type: String  
Required: No

## See Also
<a name="API_GroupIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/GroupIdentifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/GroupIdentifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/GroupIdentifier) 

# HibernationOptions
<a name="API_HibernationOptions"></a>

Indicates whether your instance is configured 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*.

## Contents
<a name="API_HibernationOptions_Contents"></a>

 ** configured **   
If `true`, your instance is enabled for hibernation; otherwise, it is not enabled for hibernation.  
Type: Boolean  
Required: No

## See Also
<a name="API_HibernationOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HibernationOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HibernationOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HibernationOptions) 

# HibernationOptionsRequest
<a name="API_HibernationOptionsRequest"></a>

Indicates whether your instance is configured 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*.

## Contents
<a name="API_HibernationOptionsRequest_Contents"></a>

 ** Configured **   
Set to `true` to enable your instance for hibernation.  
For Spot Instances, if you set `Configured` to `true`, either omit the `InstanceInterruptionBehavior` parameter (for [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotMarketOptions.html)), or set it to `hibernate`. When `Configured` is true:  
+ If you omit `InstanceInterruptionBehavior`, it defaults to `hibernate`.
+ If you set `InstanceInterruptionBehavior` to a value other than `hibernate`, you'll get an error.
Default: `false`   
Type: Boolean  
Required: No

## See Also
<a name="API_HibernationOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HibernationOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HibernationOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HibernationOptionsRequest) 

# HistoryRecord
<a name="API_HistoryRecord"></a>

Describes an event in the history of the Spot Fleet request.

## Contents
<a name="API_HistoryRecord_Contents"></a>

 ** eventInformation **   
Information about the event.  
Type: [EventInformation](API_EventInformation.md) object  
Required: No

 ** eventType **   
The event type.  
+  `error` - An error with the Spot Fleet request.
+  `fleetRequestChange` - A change in the status or configuration of the Spot Fleet request.
+  `instanceChange` - An instance was launched or terminated.
+  `Information` - An informational event.
Type: String  
Valid Values: `instanceChange | fleetRequestChange | error | information`   
Required: No

 ** timestamp **   
The date and time of the event, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).  
Type: Timestamp  
Required: No

## See Also
<a name="API_HistoryRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HistoryRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HistoryRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HistoryRecord) 

# HistoryRecordEntry
<a name="API_HistoryRecordEntry"></a>

Describes an event in the history of an EC2 Fleet.

## Contents
<a name="API_HistoryRecordEntry_Contents"></a>

 ** eventInformation **   
Information about the event.  
Type: [EventInformation](API_EventInformation.md) object  
Required: No

 ** eventType **   
The event type.  
Type: String  
Valid Values: `instance-change | fleet-change | service-error`   
Required: No

 ** timestamp **   
The date and time of the event, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).  
Type: Timestamp  
Required: No

## See Also
<a name="API_HistoryRecordEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HistoryRecordEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HistoryRecordEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HistoryRecordEntry) 

# Host
<a name="API_Host"></a>

Describes the properties of the Dedicated Host.

## Contents
<a name="API_Host_Contents"></a>

 ** allocationTime **   
The time that the Dedicated Host was allocated.  
Type: Timestamp  
Required: No

 ** allowsMultipleInstanceTypes **   
Indicates whether the Dedicated Host supports multiple instance types of the same instance family. If the value is `on`, the Dedicated Host supports multiple instance types in the instance family. If the value is `off`, the Dedicated Host supports a single instance type only.  
Type: String  
Valid Values: `on | off`   
Required: No

 ** assetId **   
The ID of the Outpost hardware asset on which the Dedicated Host is allocated.  
Type: String  
Required: No

 ** autoPlacement **   
Whether auto-placement is on or off.  
Type: String  
Valid Values: `on | off`   
Required: No

 ** availabilityZone **   
The Availability Zone of the Dedicated Host.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone in which the Dedicated Host is allocated.  
Type: String  
Required: No

 ** availableCapacity **   
Information about the instances running on the Dedicated Host.  
Type: [AvailableCapacity](API_AvailableCapacity.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/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).  
Type: String  
Required: No

 ** hostId **   
The ID of the Dedicated Host.  
Type: String  
Required: No

 ** hostMaintenance **   
Indicates whether host maintenance is enabled or disabled for the Dedicated Host.  
Type: String  
Valid Values: `on | off`   
Required: No

 ** hostProperties **   
The hardware specifications of the Dedicated Host.  
Type: [HostProperties](API_HostProperties.md) object  
Required: No

 ** hostRecovery **   
Indicates whether host recovery is enabled or disabled for the Dedicated Host.  
Type: String  
Valid Values: `on | off`   
Required: No

 ** hostReservationId **   
The reservation ID of the Dedicated Host. This returns a `null` response if the Dedicated Host doesn't have an associated reservation.  
Type: String  
Required: No

 ** Instances.N **   
The IDs and instance type that are currently running on the Dedicated Host.  
Type: Array of [HostInstance](API_HostInstance.md) objects  
Required: No

 ** memberOfServiceLinkedResourceGroup **   
Indicates whether the Dedicated Host is in a host resource group. If **memberOfServiceLinkedResourceGroup** is `true`, the host is in a host resource group; otherwise, it is not.  
Type: Boolean  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the AWS Outpost on which the Dedicated Host is allocated.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the Dedicated Host.  
Type: String  
Required: No

 ** releaseTime **   
The time that the Dedicated Host was released.  
Type: Timestamp  
Required: No

 ** state **   
The Dedicated Host's state.  
Type: String  
Valid Values: `available | under-assessment | permanent-failure | released | released-permanent-failure | pending`   
Required: No

 ** TagSet.N **   
Any tags assigned to the Dedicated Host.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_Host_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Host) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Host) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Host) 

# HostInstance
<a name="API_HostInstance"></a>

Describes an instance running on a Dedicated Host.

## Contents
<a name="API_HostInstance_Contents"></a>

 ** instanceId **   
The ID of instance that is running on the Dedicated Host.  
Type: String  
Required: No

 ** instanceType **   
The instance type (for example, `m3.medium`) of the running instance.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the instance.  
Type: String  
Required: No

## See Also
<a name="API_HostInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HostInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HostInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HostInstance) 

# HostOffering
<a name="API_HostOffering"></a>

Details about the Dedicated Host Reservation offering.

## Contents
<a name="API_HostOffering_Contents"></a>

 ** currencyCode **   
The currency of the offering.  
Type: String  
Valid Values: `USD`   
Required: No

 ** duration **   
The duration of the offering (in seconds).  
Type: Integer  
Required: No

 ** hourlyPrice **   
The hourly price of the offering.  
Type: String  
Required: No

 ** instanceFamily **   
The instance family of the offering.  
Type: String  
Required: No

 ** offeringId **   
The ID of the offering.  
Type: String  
Required: No

 ** paymentOption **   
The available payment option.  
Type: String  
Valid Values: `AllUpfront | PartialUpfront | NoUpfront`   
Required: No

 ** upfrontPrice **   
The upfront price of the offering. Does not apply to No Upfront offerings.  
Type: String  
Required: No

## See Also
<a name="API_HostOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HostOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HostOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HostOffering) 

# HostProperties
<a name="API_HostProperties"></a>

Describes the properties of a Dedicated Host.

## Contents
<a name="API_HostProperties_Contents"></a>

 ** cores **   
The number of cores on the Dedicated Host.  
Type: Integer  
Required: No

 ** instanceFamily **   
The instance family supported by the Dedicated Host. For example, `m5`.  
Type: String  
Required: No

 ** instanceType **   
The instance type supported by the Dedicated Host. For example, `m5.large`. If the host supports multiple instance types, no **instanceType** is returned.  
Type: String  
Required: No

 ** sockets **   
The number of sockets on the Dedicated Host.  
Type: Integer  
Required: No

 ** totalVCpus **   
The total number of vCPUs on the Dedicated Host.  
Type: Integer  
Required: No

## See Also
<a name="API_HostProperties_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HostProperties) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HostProperties) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HostProperties) 

# HostReservation
<a name="API_HostReservation"></a>

Details about the Dedicated Host Reservation and associated Dedicated Hosts.

## Contents
<a name="API_HostReservation_Contents"></a>

 ** count **   
The number of Dedicated Hosts the reservation is associated with.  
Type: Integer  
Required: No

 ** currencyCode **   
The currency in which the `upfrontPrice` and `hourlyPrice` amounts are specified. At this time, the only supported currency is `USD`.  
Type: String  
Valid Values: `USD`   
Required: No

 ** duration **   
The length of the reservation's term, specified in seconds. Can be `31536000 (1 year)` \$1 `94608000 (3 years)`.  
Type: Integer  
Required: No

 ** end **   
The date and time that the reservation ends.  
Type: Timestamp  
Required: No

 ** HostIdSet.N **   
The IDs of the Dedicated Hosts associated with the reservation.  
Type: Array of strings  
Required: No

 ** hostReservationId **   
The ID of the reservation that specifies the associated Dedicated Hosts.  
Type: String  
Required: No

 ** hourlyPrice **   
The hourly price of the reservation.  
Type: String  
Required: No

 ** instanceFamily **   
The instance family of the Dedicated Host Reservation. The instance family on the Dedicated Host must be the same in order for it to benefit from the reservation.  
Type: String  
Required: No

 ** offeringId **   
The ID of the reservation. This remains the same regardless of which Dedicated Hosts are associated with it.  
Type: String  
Required: No

 ** paymentOption **   
The payment option selected for this reservation.  
Type: String  
Valid Values: `AllUpfront | PartialUpfront | NoUpfront`   
Required: No

 ** start **   
The date and time that the reservation started.  
Type: Timestamp  
Required: No

 ** state **   
The state of the reservation.  
Type: String  
Valid Values: `active | expired | cancelled | scheduled | pending | failed | delayed | unsupported | payment-pending | payment-failed | retired`   
Required: No

 ** TagSet.N **   
Any tags assigned to the Dedicated Host Reservation.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** upfrontPrice **   
The upfront price of the reservation.  
Type: String  
Required: No

## See Also
<a name="API_HostReservation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/HostReservation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/HostReservation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/HostReservation) 

# IamInstanceProfile
<a name="API_IamInstanceProfile"></a>

Describes an IAM instance profile.

## Contents
<a name="API_IamInstanceProfile_Contents"></a>

 ** arn **   
The Amazon Resource Name (ARN) of the instance profile.  
Type: String  
Required: No

 ** id **   
The ID of the instance profile.  
Type: String  
Required: No

## See Also
<a name="API_IamInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IamInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IamInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IamInstanceProfile) 

# IamInstanceProfileAssociation
<a name="API_IamInstanceProfileAssociation"></a>

Describes an association between an IAM instance profile and an instance.

## Contents
<a name="API_IamInstanceProfileAssociation_Contents"></a>

 ** associationId **   
The ID of the association.  
Type: String  
Required: No

 ** iamInstanceProfile **   
The IAM instance profile.  
Type: [IamInstanceProfile](API_IamInstanceProfile.md) object  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** state **   
The state of the association.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated`   
Required: No

 ** timestamp **   
The time the IAM instance profile was associated with the instance.  
Type: Timestamp  
Required: No

## See Also
<a name="API_IamInstanceProfileAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IamInstanceProfileAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IamInstanceProfileAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IamInstanceProfileAssociation) 

# IamInstanceProfileSpecification
<a name="API_IamInstanceProfileSpecification"></a>

Describes an IAM instance profile.

## Contents
<a name="API_IamInstanceProfileSpecification_Contents"></a>

 ** Arn ** (request), ** arn ** (response)  
The Amazon Resource Name (ARN) of the instance profile.  
Type: String  
Required: No

 ** Name ** (request), ** name ** (response)  
The name of the instance profile.  
Type: String  
Required: No

## See Also
<a name="API_IamInstanceProfileSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IamInstanceProfileSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IamInstanceProfileSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IamInstanceProfileSpecification) 

# IcmpTypeCode
<a name="API_IcmpTypeCode"></a>

Describes the ICMP type and code.

## Contents
<a name="API_IcmpTypeCode_Contents"></a>

 ** Code ** (request), ** code ** (response)  
The ICMP code. A value of -1 means all codes for the specified ICMP type.  
Type: Integer  
Required: No

 ** Type ** (request), ** type ** (response)  
The ICMP type. A value of -1 means all types.  
Type: Integer  
Required: No

## See Also
<a name="API_IcmpTypeCode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IcmpTypeCode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IcmpTypeCode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IcmpTypeCode) 

# IdFormat
<a name="API_IdFormat"></a>

Describes the ID format for a resource.

## Contents
<a name="API_IdFormat_Contents"></a>

 ** deadline **   
The date in UTC at which you are permanently switched over to using longer IDs. If a deadline is not yet available for this resource type, this field is not returned.  
Type: Timestamp  
Required: No

 ** resource **   
The type of resource.  
Type: String  
Required: No

 ** useLongIds **   
Indicates whether longer IDs (17-character IDs) are enabled for the resource.  
Type: Boolean  
Required: No

## See Also
<a name="API_IdFormat_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IdFormat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IdFormat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IdFormat) 

# IKEVersionsListValue
<a name="API_IKEVersionsListValue"></a>

The internet key exchange (IKE) version permitted for the VPN tunnel.

## Contents
<a name="API_IKEVersionsListValue_Contents"></a>

 ** value **   
The IKE version.  
Type: String  
Required: No

## See Also
<a name="API_IKEVersionsListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IKEVersionsListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IKEVersionsListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IKEVersionsListValue) 

# IKEVersionsRequestListValue
<a name="API_IKEVersionsRequestListValue"></a>

The IKE version that is permitted for the VPN tunnel.

## Contents
<a name="API_IKEVersionsRequestListValue_Contents"></a>

 ** Value **   
The IKE version.  
Type: String  
Required: No

## See Also
<a name="API_IKEVersionsRequestListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IKEVersionsRequestListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IKEVersionsRequestListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IKEVersionsRequestListValue) 

# Image
<a name="API_Image"></a>

Describes an image.

## Contents
<a name="API_Image_Contents"></a>

 ** architecture **   
The architecture of the image.  
Type: String  
Valid Values: `i386 | x86_64 | arm64 | x86_64_mac | arm64_mac`   
Required: No

 ** BlockDeviceMapping.N **   
Any block device mapping entries.  
Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects  
Required: No

 ** bootMode **   
The boot mode of the image. 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

 ** creationDate **   
The date and time the image was created.  
Type: String  
Required: No

 ** deprecationTime **   
The date and time to deprecate the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z. If you specified a value for seconds, Amazon EC2 rounds the seconds to the nearest minute.  
Type: String  
Required: No

 ** deregistrationProtection **   
Indicates whether deregistration protection is enabled for the AMI.  
Type: String  
Required: No

 ** description **   
The description of the AMI that was provided during image creation.  
Type: String  
Required: No

 ** enaSupport **   
Specifies whether enhanced networking with ENA is enabled.  
Type: Boolean  
Required: No

 ** freeTierEligible **   
Indicates whether the image is eligible for AWS Free Tier.  
+ If `true`, the AMI is eligible for Free Tier and can be used to launch instances under the Free Tier limits.
+ If `false`, the AMI is not eligible for Free Tier.
Type: Boolean  
Required: No

 ** hypervisor **   
The hypervisor type of the image. Only `xen` is supported. `ovm` is not supported.  
Type: String  
Valid Values: `ovm | xen`   
Required: No

 ** imageAllowed **   
If `true`, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If `false` and Allowed AMIs is set to `enabled`, the AMI can't be discovered or used in the account. If `false` and Allowed AMIs is set to `audit-mode`, the AMI can be discovered and used in the 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*.  
Type: Boolean  
Required: No

 ** imageId **   
The ID of the AMI.  
Type: String  
Required: No

 ** imageLocation **   
The location of the AMI.  
Type: String  
Required: No

 ** imageOwnerAlias **   
The owner alias (`amazon` \$1 `aws-backup-vault` \$1 `aws-marketplace`).  
Type: String  
Required: No

 ** imageOwnerId **   
The ID of the AWS account that owns the image.  
Type: String  
Required: No

 ** imageState **   
The current state of the AMI. If the state is `available`, the image is successfully registered and can be used to launch an instance.  
Type: String  
Valid Values: `pending | available | invalid | deregistered | transient | failed | error | disabled`   
Required: No

 ** imageType **   
The type of image.  
Type: String  
Valid Values: `machine | kernel | ramdisk`   
Required: No

 ** 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: String  
Valid Values: `v2.0`   
Required: No

 ** isPublic **   
Indicates whether the image has public launch permissions. The value is `true` if this image has public launch permissions or `false` if it has only implicit and explicit launch permissions.  
Type: Boolean  
Required: No

 ** kernelId **   
The kernel associated with the image, if any. Only applicable for machine images.  
Type: String  
Required: No

 ** 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: String  
Required: No

 ** name **   
The name of the AMI that was provided during image creation.  
Type: String  
Required: No

 ** platform **   
This value is set to `windows` for Windows AMIs; otherwise, it is blank.  
Type: String  
Valid Values: `Windows`   
Required: No

 ** platformDetails **   
The platform details associated with the billing code of 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*.  
Type: String  
Required: No

 ** ProductCodes.N **   
Any product codes associated with the AMI.  
Type: Array of [ProductCode](API_ProductCode.md) objects  
Required: No

 ** ramdiskId **   
The RAM disk associated with the image, if any. Only applicable for machine images.  
Type: String  
Required: No

 ** rootDeviceName **   
The device name of the root device volume (for example, `/dev/sda1`).  
Type: String  
Required: No

 ** rootDeviceType **   
The type of root device used by the AMI. The AMI can use an Amazon EBS volume or an instance store volume.  
Type: String  
Valid Values: `ebs | instance-store`   
Required: No

 ** sourceImageId **   
The ID of the source AMI from which the AMI was created.  
The ID only appears if the AMI was created using [CreateImage](API_CreateImage.md), [CopyImage](API_CopyImage.md), or [CreateRestoreImageTask](API_CreateRestoreImageTask.md). The ID does not appear if the AMI was created using any other API. For some older AMIs, the ID might not be available. For more information, see [Identify the source AMI used to create a new Amazon EC2 AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify-source-ami-used-to-create-new-ami.html) in the *Amazon EC2 User Guide*.  
Type: String  
Required: No

 ** sourceImageRegion **   
The Region of the source AMI.  
The Region only appears if the AMI was created using [CreateImage](API_CreateImage.md), [CopyImage](API_CopyImage.md), or [CreateRestoreImageTask](API_CreateRestoreImageTask.md). The Region does not appear if the AMI was created using any other API. For some older AMIs, the Region might not be available. For more information, see [Identify the source AMI used to create a new Amazon EC2 AMI](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/identify-source-ami-used-to-create-new-ami.html) in the *Amazon EC2 User Guide*.  
Type: String  
Required: No

 ** sourceInstanceId **   
The ID of the instance that the AMI was created from if the AMI was created using [CreateImage](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateImage.html). This field only appears if the AMI was created using CreateImage.  
Type: String  
Required: No

 ** sriovNetSupport **   
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.  
Type: String  
Required: No

 ** stateReason **   
The reason for the state change.  
Type: [StateReason](API_StateReason.md) object  
Required: No

 ** TagSet.N **   
Any tags assigned to the image.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** tpmSupport **   
If the image is configured for NitroTPM support, the value is `v2.0`. 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

 ** usageOperation **   
The operation of the Amazon EC2 instance and the billing code that is associated with the AMI. `usageOperation` corresponds to the [lineitem/Operation](https://docs.aws.amazon.com/cur/latest/userguide/Lineitem-columns.html#Lineitem-details-O-Operation) column on your AWS Cost and Usage Report and in the [AWS Price List API](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/price-changes.html). You can view these fields on the **Instances** or **AMIs** pages in the Amazon EC2 console, or in the responses that are returned by the [DescribeImages](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html) command in the Amazon EC2 API, or the [describe-images](https://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html) command in the AWS CLI.  
Type: String  
Required: No

 ** virtualizationType **   
The type of virtualization of the AMI.  
Type: String  
Valid Values: `hvm | paravirtual`   
Required: No

## See Also
<a name="API_Image_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Image) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Image) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Image) 

# ImageAncestryEntry
<a name="API_ImageAncestryEntry"></a>

Information about a single AMI in the ancestry chain and its source (parent) AMI.

## Contents
<a name="API_ImageAncestryEntry_Contents"></a>

 ** creationDate **   
The date and time when this AMI was created.  
Type: Timestamp  
Required: No

 ** imageId **   
The ID of this AMI.  
Type: String  
Required: No

 ** imageOwnerAlias **   
The owner alias (`amazon` \$1 `aws-backup-vault` \$1 `aws-marketplace` ) of this AMI, if one is assigned. Otherwise, the value is `null`.  
Type: String  
Required: No

 ** sourceImageId **   
The ID of the parent AMI.  
Type: String  
Required: No

 ** sourceImageRegion **   
The AWS Region of the parent AMI.  
Type: String  
Required: No

## See Also
<a name="API_ImageAncestryEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageAncestryEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageAncestryEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageAncestryEntry) 

# ImageCriterion
<a name="API_ImageCriterion"></a>

The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified AWS Region.

For more information, see [How Allowed AMIs works](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html#how-allowed-amis-works) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_ImageCriterion_Contents"></a>

 ** creationDateCondition **   
The maximum age for allowed images.  
Type: [CreationDateCondition](API_CreationDateCondition.md) object  
Required: No

 ** deprecationTimeCondition **   
The maximum period since deprecation for allowed images.  
Type: [DeprecationTimeCondition](API_DeprecationTimeCondition.md) object  
Required: No

 ** ImageNameSet.N **   
The names of allowed images. Names can include wildcards (`?` and `*`).  
Length: 1–128 characters. With `?`, the minimum is 3 characters.  
Valid characters:  
+ Letters: `A–Z, a–z` 
+ Numbers: `0–9` 
+ Special characters: `( ) [ ] . / - ' @ _ * ?` 
+ Spaces
Maximum: 50 values  
Type: Array of strings  
Required: No

 ** ImageProviderSet.N **   
The image providers whose images are allowed.  
Possible values:  
+  `amazon`: Allow AMIs created by Amazon or verified providers.
+  `aws-marketplace`: Allow AMIs created by verified providers in the AWS Marketplace.
+  `aws-backup-vault`: Allow AMIs created by AWS Backup. 
+ 12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified.
+  `none`: Allow AMIs created by your own account only.
Maximum: 200 values  
Type: Array of strings  
Required: No

 ** MarketplaceProductCodeSet.N **   
The AWS Marketplace product codes for allowed images.  
Length: 1-25 characters  
Valid characters: Letters (`A–Z, a–z`) and numbers (`0–9`)  
Maximum: 50 values  
Type: Array of strings  
Required: No

## See Also
<a name="API_ImageCriterion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageCriterion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageCriterion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageCriterion) 

# ImageCriterionRequest
<a name="API_ImageCriterionRequest"></a>

The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified AWS Region.

The `ImageCriteria` can include up to:
+ 10 `ImageCriterion` 

Each `ImageCriterion` can include up to:
+ 200 values for `ImageProviders` 
+ 50 values for `ImageNames` 
+ 50 values for `MarketplaceProductCodes` 

For more information, see [How Allowed AMIs works](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html#how-allowed-amis-works) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_ImageCriterionRequest_Contents"></a>

 ** CreationDateCondition **   
The maximum age for allowed images.  
Type: [CreationDateConditionRequest](API_CreationDateConditionRequest.md) object  
Required: No

 ** DeprecationTimeCondition **   
The maximum period since deprecation for allowed images.  
Type: [DeprecationTimeConditionRequest](API_DeprecationTimeConditionRequest.md) object  
Required: No

 ** ImageName.N **   
The names of allowed images. Names can include wildcards (`?` and `*`).  
Length: 1–128 characters. With `?`, the minimum is 3 characters.  
Valid characters:  
+ Letters: `A–Z, a–z` 
+ Numbers: `0–9` 
+ Special characters: `( ) [ ] . / - ' @ _ * ?` 
+ Spaces
Maximum: 50 values  
Type: Array of strings  
Required: No

 ** ImageProvider.N **   
The image providers whose images are allowed.  
Possible values:  
+  `amazon`: Allow AMIs created by Amazon or verified providers.
+  `aws-marketplace`: Allow AMIs created by verified providers in the AWS Marketplace.
+  `aws-backup-vault`: Allow AMIs created by AWS Backup. 
+ 12-digit account ID: Allow AMIs created by the specified accounts. One or more account IDs can be specified.
+  `none`: Allow AMIs created by your own account only. When `none` is specified, no other values can be specified.
Maximum: 200 values  
Type: Array of strings  
Required: No

 ** MarketplaceProductCode.N **   
The AWS Marketplace product codes for allowed images.  
Length: 1-25 characters  
Valid characters: Letters (`A–Z, a–z`) and numbers (`0–9`)  
Maximum: 50 values  
Type: Array of strings  
Required: No

## See Also
<a name="API_ImageCriterionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageCriterionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageCriterionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageCriterionRequest) 

# ImageDiskContainer
<a name="API_ImageDiskContainer"></a>

Describes the disk container object for an import image task.

## Contents
<a name="API_ImageDiskContainer_Contents"></a>

 ** Description **   
The description of the disk image.  
Type: String  
Required: No

 ** DeviceName **   
The block device mapping for the disk.  
Type: String  
Required: No

 ** Format **   
The format of the disk image being imported.  
Valid values: `OVA` \$1 `VHD` \$1 `VHDX` \$1 `VMDK` \$1 `RAW`   
Type: String  
Required: No

 ** SnapshotId **   
The ID of the EBS snapshot to be used for importing the snapshot.  
Type: String  
Required: No

 ** Url **   
The URL to the Amazon S3-based disk image being imported. The URL can either be a https URL (https://..) or an Amazon S3 URL (s3://..)  
Type: String  
Required: No

 ** UserBucket **   
The S3 bucket for the disk image.  
Type: [UserBucket](API_UserBucket.md) object  
Required: No

## See Also
<a name="API_ImageDiskContainer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageDiskContainer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageDiskContainer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageDiskContainer) 

# ImageMetadata
<a name="API_ImageMetadata"></a>

Information about the AMI.

## Contents
<a name="API_ImageMetadata_Contents"></a>

 ** creationDate **   
The date and time the AMI was created.  
Type: String  
Required: No

 ** deprecationTime **   
The deprecation date and time of the AMI, in UTC, in the following format: *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z.  
Type: String  
Required: No

 ** imageAllowed **   
If `true`, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If `false`, the AMI can't be discovered or used in the 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*.  
Type: Boolean  
Required: No

 ** imageId **   
The ID of the AMI.  
Type: String  
Required: No

 ** imageOwnerAlias **   
The alias of the AMI owner.  
Valid values: `amazon` \$1 `aws-backup-vault` \$1 `aws-marketplace`   
Type: String  
Required: No

 ** imageOwnerId **   
The ID of the AWS account that owns the AMI.  
Type: String  
Required: No

 ** imageState **   
The current state of the AMI. If the state is `available`, the AMI is successfully registered and can be used to launch an instance.  
Type: String  
Valid Values: `pending | available | invalid | deregistered | transient | failed | error | disabled`   
Required: No

 ** isPublic **   
Indicates whether the AMI has public launch permissions. A value of `true` means this AMI has public launch permissions, while `false` means it has only implicit (AMI owner) or explicit (shared with your account) launch permissions.  
Type: Boolean  
Required: No

 ** name **   
The name of the AMI.  
Type: String  
Required: No

## See Also
<a name="API_ImageMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageMetadata) 

# ImageRecycleBinInfo
<a name="API_ImageRecycleBinInfo"></a>

Information about an AMI that is currently in the Recycle Bin.

## Contents
<a name="API_ImageRecycleBinInfo_Contents"></a>

 ** description **   
The description of the AMI.  
Type: String  
Required: No

 ** imageId **   
The ID of the AMI.  
Type: String  
Required: No

 ** name **   
The name of the AMI.  
Type: String  
Required: No

 ** recycleBinEnterTime **   
The date and time when the AMI entered the Recycle Bin.  
Type: Timestamp  
Required: No

 ** recycleBinExitTime **   
The date and time when the AMI is to be permanently deleted from the Recycle Bin.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ImageRecycleBinInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageRecycleBinInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageRecycleBinInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageRecycleBinInfo) 

# ImageReference
<a name="API_ImageReference"></a>

A resource that is referencing an image.

## Contents
<a name="API_ImageReference_Contents"></a>

 ** arn **   
The Amazon Resource Name (ARN) of the resource referencing the image.  
Type: String  
Required: No

 ** imageId **   
The ID of the referenced image.  
Type: String  
Required: No

 ** resourceType **   
The type of resource referencing the image.  
Type: String  
Valid Values: `ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe`   
Required: No

## See Also
<a name="API_ImageReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageReference) 

# ImageUsageReport
<a name="API_ImageUsageReport"></a>

The configuration and status of an image usage report.

## Contents
<a name="API_ImageUsageReport_Contents"></a>

 ** AccountIdSet.N **   
The IDs of the AWS accounts that were specified when the report was created.  
Type: Array of strings  
Required: No

 ** creationTime **   
The date and time when the report was created.  
Type: Timestamp  
Required: No

 ** expirationTime **   
The date and time when Amazon EC2 will delete the report (30 days after the report was created).  
Type: Timestamp  
Required: No

 ** imageId **   
The ID of the image that was specified when the report was created.  
Type: String  
Required: No

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

 ** ResourceTypeSet.N **   
The resource types that were specified when the report was created.  
Type: Array of [ImageUsageResourceType](API_ImageUsageResourceType.md) objects  
Required: No

 ** state **   
The current state of the report. Possible values:  
+  `available` - The report is available to view.
+  `pending` - The report is being created and not available to view.
+  `error` - The report could not be created.
Type: String  
Required: No

 ** stateReason **   
Provides additional details when the report is in an `error` state.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the report.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ImageUsageReport_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageUsageReport) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageUsageReport) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageUsageReport) 

# ImageUsageReportEntry
<a name="API_ImageUsageReportEntry"></a>

A single entry in an image usage report, detailing how an image is being used by a specific AWS account and resource type.

## Contents
<a name="API_ImageUsageReportEntry_Contents"></a>

 ** accountId **   
The ID of the account that uses the image.  
Type: String  
Required: No

 ** imageId **   
The ID of the image.  
Type: String  
Required: No

 ** reportCreationTime **   
The date and time the report creation was initiated.  
Type: Timestamp  
Required: No

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

 ** resourceType **   
The type of resource (`ec2:Instance` or `ec2:LaunchTemplate`).  
Type: String  
Required: No

 ** usageCount **   
The number of times resources of this type reference this image in the account.  
Type: Long  
Required: No

## See Also
<a name="API_ImageUsageReportEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageUsageReportEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageUsageReportEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageUsageReportEntry) 

# ImageUsageResourceType
<a name="API_ImageUsageResourceType"></a>

A resource type to include in the report. Associated options can also be specified if the resource type is a launch template.

## Contents
<a name="API_ImageUsageResourceType_Contents"></a>

 ** resourceType **   
The resource type.  
Valid values: `ec2:Instance` \$1 `ec2:LaunchTemplate`   
Type: String  
Required: No

 ** ResourceTypeOptionSet.N **   
The options that affect the scope of the report. Valid only when `ResourceType` is `ec2:LaunchTemplate`.  
Type: Array of [ImageUsageResourceTypeOption](API_ImageUsageResourceTypeOption.md) objects  
Required: No

## See Also
<a name="API_ImageUsageResourceType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageUsageResourceType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageUsageResourceType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageUsageResourceType) 

# ImageUsageResourceTypeOption
<a name="API_ImageUsageResourceTypeOption"></a>

The options that affect the scope of the report.

## Contents
<a name="API_ImageUsageResourceTypeOption_Contents"></a>

 ** optionName **   
The name of the option.  
Type: String  
Required: No

 ** OptionValueSet.N **   
The number of launch template versions to check.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ImageUsageResourceTypeOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageUsageResourceTypeOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageUsageResourceTypeOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageUsageResourceTypeOption) 

# ImageUsageResourceTypeOptionRequest
<a name="API_ImageUsageResourceTypeOptionRequest"></a>

The options that affect the scope of the report.

## Contents
<a name="API_ImageUsageResourceTypeOptionRequest_Contents"></a>

 ** OptionName **   
The name of the option.  
Valid value: `version-depth` - The number of launch template versions to check.  
Type: String  
Required: No

 ** OptionValue.N **   
A value for the specified option.  
Valid values: Integers between `1` and `10000`   
Default: `20`   
Type: Array of strings  
Required: No

## See Also
<a name="API_ImageUsageResourceTypeOptionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageUsageResourceTypeOptionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageUsageResourceTypeOptionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageUsageResourceTypeOptionRequest) 

# ImageUsageResourceTypeRequest
<a name="API_ImageUsageResourceTypeRequest"></a>

A resource type to include in the report. Associated options can also be specified if the resource type is a launch template.

## Contents
<a name="API_ImageUsageResourceTypeRequest_Contents"></a>

 ** ResourceType **   
The resource type.  
Valid values: `ec2:Instance` \$1 `ec2:LaunchTemplate`   
Type: String  
Required: No

 ** ResourceTypeOption.N **   
The options that affect the scope of the report. Valid only when `ResourceType` is `ec2:LaunchTemplate`.  
Type: Array of [ImageUsageResourceTypeOptionRequest](API_ImageUsageResourceTypeOptionRequest.md) objects  
Required: No

## See Also
<a name="API_ImageUsageResourceTypeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImageUsageResourceTypeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImageUsageResourceTypeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImageUsageResourceTypeRequest) 

# ImportImageLicenseConfigurationRequest
<a name="API_ImportImageLicenseConfigurationRequest"></a>

The request information of license configurations.

## Contents
<a name="API_ImportImageLicenseConfigurationRequest_Contents"></a>

 ** LicenseConfigurationArn **   
The ARN of a license configuration.  
Type: String  
Required: No

## See Also
<a name="API_ImportImageLicenseConfigurationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportImageLicenseConfigurationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportImageLicenseConfigurationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportImageLicenseConfigurationRequest) 

# ImportImageLicenseConfigurationResponse
<a name="API_ImportImageLicenseConfigurationResponse"></a>

 The response information for license configurations.

## Contents
<a name="API_ImportImageLicenseConfigurationResponse_Contents"></a>

 ** licenseConfigurationArn **   
The ARN of a license configuration.  
Type: String  
Required: No

## See Also
<a name="API_ImportImageLicenseConfigurationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportImageLicenseConfigurationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportImageLicenseConfigurationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportImageLicenseConfigurationResponse) 

# ImportImageTask
<a name="API_ImportImageTask"></a>

Describes an import image task.

## Contents
<a name="API_ImportImageTask_Contents"></a>

 ** architecture **   
The architecture of the virtual machine.  
Valid values: `i386` \$1 `x86_64` \$1 `arm64`   
Type: String  
Required: No

 ** bootMode **   
The boot mode of the virtual machine.  
Type: String  
Valid Values: `legacy-bios | uefi | uefi-preferred`   
Required: No

 ** description **   
A description of the import task.  
Type: String  
Required: No

 ** encrypted **   
Indicates whether the image is encrypted.  
Type: Boolean  
Required: No

 ** hypervisor **   
The target hypervisor for the import task.  
Valid values: `xen`   
Type: String  
Required: No

 ** imageId **   
The ID of the Amazon Machine Image (AMI) of the imported virtual machine.  
Type: String  
Required: No

 ** importTaskId **   
The ID of the import image task.  
Type: String  
Required: No

 ** kmsKeyId **   
The identifier for the KMS key that was used to create the encrypted image.  
Type: String  
Required: No

 ** LicenseSpecifications.N **   
The ARNs of the license configurations that are associated with the import image task.  
Type: Array of [ImportImageLicenseConfigurationResponse](API_ImportImageLicenseConfigurationResponse.md) objects  
Required: No

 ** licenseType **   
The license type of the virtual machine.  
Type: String  
Required: No

 ** platform **   
The description string for the import image task.  
Type: String  
Required: No

 ** progress **   
The percentage of progress of the import image task.  
Type: String  
Required: No

 ** SnapshotDetailSet.N **   
Information about the snapshots.  
Type: Array of [SnapshotDetail](API_SnapshotDetail.md) objects  
Required: No

 ** status **   
A brief status for the import image task.  
Type: String  
Required: No

 ** statusMessage **   
A descriptive status message for the import image task.  
Type: String  
Required: No

 ** TagSet.N **   
The tags for the import image task.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** usageOperation **   
The usage operation value.  
Type: String  
Required: No

## See Also
<a name="API_ImportImageTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportImageTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportImageTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportImageTask) 

# ImportInstanceLaunchSpecification
<a name="API_ImportInstanceLaunchSpecification"></a>

Describes the launch specification for VM import.

## Contents
<a name="API_ImportInstanceLaunchSpecification_Contents"></a>

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

 ** Architecture **   
The architecture of the instance.  
Type: String  
Valid Values: `i386 | x86_64 | arm64 | x86_64_mac | arm64_mac`   
Required: No

 ** GroupId.N **   
The security group IDs.  
Type: Array of strings  
Required: No

 ** GroupName.N **   
The security group names.  
Type: Array of strings  
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).  
Type: String  
Valid Values: `stop | terminate`   
Required: No

 ** InstanceType **   
The instance type. For more information about the instance types that you can import, see [Instance Types](https://docs.aws.amazon.com/vm-import/latest/userguide/vmie_prereqs.html#vmimport-instance-types) in the VM Import/Export 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

 ** Monitoring **   
Indicates whether monitoring is enabled.  
Type: Boolean  
Required: No

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

 ** PrivateIpAddress **   
[EC2-VPC] An available IP address from the IP address range of the subnet.  
Type: String  
Required: No

 ** SubnetId **   
[EC2-VPC] The ID of the subnet in which to launch the instance.  
Type: String  
Required: No

 ** UserData **   
The Base64-encoded user data to make available to the instance.  
Type: [UserData](API_UserData.md) object  
Required: No

## See Also
<a name="API_ImportInstanceLaunchSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportInstanceLaunchSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportInstanceLaunchSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportInstanceLaunchSpecification) 

# ImportInstanceTaskDetails
<a name="API_ImportInstanceTaskDetails"></a>

Describes an import instance task.

## Contents
<a name="API_ImportInstanceTaskDetails_Contents"></a>

 ** description **   
A description of the task.  
Type: String  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** platform **   
The instance operating system.  
Type: String  
Valid Values: `Windows`   
Required: No

 ** Volumes.N **   
The volumes.  
Type: Array of [ImportInstanceVolumeDetailItem](API_ImportInstanceVolumeDetailItem.md) objects  
Required: No

## See Also
<a name="API_ImportInstanceTaskDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportInstanceTaskDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportInstanceTaskDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportInstanceTaskDetails) 

# ImportInstanceVolumeDetailItem
<a name="API_ImportInstanceVolumeDetailItem"></a>

Describes an import volume task.

## Contents
<a name="API_ImportInstanceVolumeDetailItem_Contents"></a>

 ** availabilityZone **   
The Availability Zone where the resulting instance will reside.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone where the resulting instance will reside.  
Type: String  
Required: No

 ** bytesConverted **   
The number of bytes converted so far.  
Type: Long  
Required: No

 ** description **   
A description of the task.  
Type: String  
Required: No

 ** image **   
The image.  
Type: [DiskImageDescription](API_DiskImageDescription.md) object  
Required: No

 ** status **   
The status of the import of this particular disk image.  
Type: String  
Required: No

 ** statusMessage **   
The status information or errors related to the disk image.  
Type: String  
Required: No

 ** volume **   
The volume.  
Type: [DiskImageVolumeDescription](API_DiskImageVolumeDescription.md) object  
Required: No

## See Also
<a name="API_ImportInstanceVolumeDetailItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportInstanceVolumeDetailItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportInstanceVolumeDetailItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportInstanceVolumeDetailItem) 

# ImportSnapshotTask
<a name="API_ImportSnapshotTask"></a>

Describes an import snapshot task.

## Contents
<a name="API_ImportSnapshotTask_Contents"></a>

 ** description **   
A description of the import snapshot task.  
Type: String  
Required: No

 ** importTaskId **   
The ID of the import snapshot task.  
Type: String  
Required: No

 ** snapshotTaskDetail **   
Describes an import snapshot task.  
Type: [SnapshotTaskDetail](API_SnapshotTaskDetail.md) object  
Required: No

 ** TagSet.N **   
The tags for the import snapshot task.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ImportSnapshotTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportSnapshotTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportSnapshotTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportSnapshotTask) 

# ImportVolumeTaskDetails
<a name="API_ImportVolumeTaskDetails"></a>

Describes an import volume task.

## Contents
<a name="API_ImportVolumeTaskDetails_Contents"></a>

 ** availabilityZone **   
The Availability Zone where the resulting volume will reside.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone where the resulting volume will reside.  
Type: String  
Required: No

 ** bytesConverted **   
The number of bytes converted so far.  
Type: Long  
Required: No

 ** description **   
The description you provided when starting the import volume task.  
Type: String  
Required: No

 ** image **   
The image.  
Type: [DiskImageDescription](API_DiskImageDescription.md) object  
Required: No

 ** volume **   
The volume.  
Type: [DiskImageVolumeDescription](API_DiskImageVolumeDescription.md) object  
Required: No

## See Also
<a name="API_ImportVolumeTaskDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ImportVolumeTaskDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ImportVolumeTaskDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ImportVolumeTaskDetails) 

# InferenceAcceleratorInfo
<a name="API_InferenceAcceleratorInfo"></a>

**Note**  
Amazon Elastic Inference is no longer available.

Describes the Inference accelerators for the instance type.

## Contents
<a name="API_InferenceAcceleratorInfo_Contents"></a>

 ** Accelerators.N **   
Describes the Inference accelerators for the instance type.  
Type: Array of [InferenceDeviceInfo](API_InferenceDeviceInfo.md) objects  
Required: No

 ** totalInferenceMemoryInMiB **   
The total size of the memory for the inference accelerators for the instance type, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_InferenceAcceleratorInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InferenceAcceleratorInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InferenceAcceleratorInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InferenceAcceleratorInfo) 

# InferenceDeviceInfo
<a name="API_InferenceDeviceInfo"></a>

**Note**  
Amazon Elastic Inference is no longer available.

Describes the Inference accelerators for the instance type.

## Contents
<a name="API_InferenceDeviceInfo_Contents"></a>

 ** count **   
The number of Inference accelerators for the instance type.  
Type: Integer  
Required: No

 ** manufacturer **   
The manufacturer of the Inference accelerator.  
Type: String  
Required: No

 ** memoryInfo **   
Describes the memory available to the inference accelerator.  
Type: [InferenceDeviceMemoryInfo](API_InferenceDeviceMemoryInfo.md) object  
Required: No

 ** name **   
The name of the Inference accelerator.  
Type: String  
Required: No

## See Also
<a name="API_InferenceDeviceInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InferenceDeviceInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InferenceDeviceInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InferenceDeviceInfo) 

# InferenceDeviceMemoryInfo
<a name="API_InferenceDeviceMemoryInfo"></a>

**Note**  
Amazon Elastic Inference is no longer available.

Describes the memory available to the inference accelerator.

## Contents
<a name="API_InferenceDeviceMemoryInfo_Contents"></a>

 ** sizeInMiB **   
The size of the memory available to the inference accelerator, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_InferenceDeviceMemoryInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InferenceDeviceMemoryInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InferenceDeviceMemoryInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InferenceDeviceMemoryInfo) 

# InitializationStatusDetails
<a name="API_InitializationStatusDetails"></a>

Information about the volume initialization. For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html).

## Contents
<a name="API_InitializationStatusDetails_Contents"></a>

 ** estimatedTimeToCompleteInSeconds **   
The estimated remaining time, in seconds, for volume initialization to complete. Returns `0` when volume initialization has completed.  
Only available for volumes created with Amazon EBS Provisioned Rate for Volume Initialization.  
Type: Long  
Required: No

 ** initializationType **   
The method used for volume initialization. Possible values include:  
+  `default` - Volume initialized using the default volume initialization rate or fast snapshot restore.
+  `provisioned-rate` - Volume initialized using an Amazon EBS Provisioned Rate for Volume Initialization.
+  `volume-copy` - Volume copy initialized at the rate for volume copies.
Type: String  
Valid Values: `default | provisioned-rate | volume-copy`   
Required: No

 ** progress **   
The current volume initialization progress as a percentage (0-100). Returns `100` when volume initialization has completed.  
Type: Long  
Required: No

## See Also
<a name="API_InitializationStatusDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InitializationStatusDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InitializationStatusDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InitializationStatusDetails) 

# Instance
<a name="API_Instance"></a>

Describes an instance.

## Contents
<a name="API_Instance_Contents"></a>

 ** amiLaunchIndex **   
The AMI launch index, which can be used to find this instance in the launch group.  
Type: Integer  
Required: No

 ** architecture **   
The architecture of the image.  
Type: String  
Valid Values: `i386 | x86_64 | arm64 | x86_64_mac | arm64_mac`   
Required: No

 ** BlockDeviceMapping.N **   
Any block device mapping entries for the instance.  
Type: Array of [InstanceBlockDeviceMapping](API_InstanceBlockDeviceMapping.md) objects  
Required: No

 ** bootMode **   
The boot mode that was specified by the AMI. If the value is `uefi-preferred`, the AMI supports both UEFI and Legacy BIOS. The `currentInstanceBootMode` parameter is the boot mode that is used to boot the instance at launch or start.  
The operating system contained in the AMI must be configured to support the specified boot mode.
For more information, see [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

 ** capacityBlockId **   
The ID of the Capacity Block.  
For P5 instances, a Capacity Block ID refers to a group of instances. For Trn2u instances, a capacity block ID refers to an EC2 UltraServer.
Type: String  
Required: No

 ** capacityReservationId **   
The ID of the Capacity Reservation.  
Type: String  
Required: No

 ** capacityReservationSpecification **   
Information about the Capacity Reservation targeting option.  
Type: [CapacityReservationSpecificationResponse](API_CapacityReservationSpecificationResponse.md) object  
Required: No

 ** clientToken **   
The idempotency token you provided when you launched the instance, if applicable.  
Type: String  
Required: No

 ** cpuOptions **   
The CPU options for the instance.  
Type: [CpuOptions](API_CpuOptions.md) object  
Required: No

 ** currentInstanceBootMode **   
The boot mode that is used to boot the instance at launch or start. For more information, see [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`   
Required: No

 ** dnsName **   
The public DNS name assigned to the instance. This name is not available until the instance enters the `running` state. This name is only available if you've enabled DNS hostnames for your VPC. The format of this name depends on the [public hostname type](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/hostname-types.html#public-hostnames).  
Type: String  
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 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

 ** ElasticGpuAssociationSet.N **   
Deprecated.  
Amazon Elastic Graphics reached end of life on January 8, 2024.
Type: Array of [ElasticGpuAssociation](API_ElasticGpuAssociation.md) objects  
Required: No

 ** ElasticInferenceAcceleratorAssociationSet.N **   
Deprecated  
Amazon Elastic Inference is no longer available.
Type: Array of [ElasticInferenceAcceleratorAssociation](API_ElasticInferenceAcceleratorAssociation.md) objects  
Required: No

 ** enaSupport **   
Specifies whether enhanced networking with ENA is enabled.  
Type: Boolean  
Required: No

 ** enclaveOptions **   
Indicates whether the instance is enabled for AWS Nitro Enclaves.  
Type: [EnclaveOptions](API_EnclaveOptions.md) object  
Required: No

 ** GroupSet.N **   
The security groups for the instance.  
Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects  
Required: No

 ** hibernationOptions **   
Indicates whether the instance is enabled for hibernation.  
Type: [HibernationOptions](API_HibernationOptions.md) object  
Required: No

 ** hypervisor **   
The hypervisor type of the instance. The value `xen` is used for both Xen and Nitro hypervisors.  
Type: String  
Valid Values: `ovm | xen`   
Required: No

 ** iamInstanceProfile **   
The IAM instance profile associated with the instance, if applicable.  
Type: [IamInstanceProfile](API_IamInstanceProfile.md) object  
Required: No

 ** imageId **   
The ID of the AMI used to launch the instance.  
Type: String  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** instanceLifecycle **   
Indicates whether this is a Spot Instance or a Scheduled Instance.  
Type: String  
Valid Values: `spot | scheduled | capacity-block | interruptible-capacity-reservation`   
Required: No

 ** instanceState **   
The current state of the instance.  
Type: [InstanceState](API_InstanceState.md) object  
Required: No

 ** instanceType **   
The instance type.  
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

 ** ipAddress **   
The public IPv4 address, or the Carrier IP address assigned to the instance, if applicable.  
A Carrier IP address only applies to an instance launched in a subnet associated with a Wavelength Zone.  
Type: String  
Required: No

 ** ipv6Address **   
The IPv6 address assigned to the instance.  
Type: String  
Required: No

 ** kernelId **   
The kernel associated with this instance, if applicable.  
Type: String  
Required: No

 ** keyName **   
The name of the key pair, if this instance was launched with an associated key pair.  
Type: String  
Required: No

 ** launchTime **   
The time that the instance was last launched. To determine the time that instance was first launched, see the attachment time for the primary network interface.  
Type: Timestamp  
Required: No

 ** LicenseSet.N **   
The license configurations for the instance.  
Type: Array of [LicenseConfiguration](API_LicenseConfiguration.md) objects  
Required: No

 ** maintenanceOptions **   
Provides information on the recovery and maintenance options of your instance.  
Type: [InstanceMaintenanceOptions](API_InstanceMaintenanceOptions.md) object  
Required: No

 ** metadataOptions **   
The metadata options for the instance.  
Type: [InstanceMetadataOptionsResponse](API_InstanceMetadataOptionsResponse.md) object  
Required: No

 ** monitoring **   
The monitoring for the instance.  
Type: [Monitoring](API_Monitoring.md) object  
Required: No

 ** NetworkInterfaceSet.N **   
The network interfaces for the instance.  
Type: Array of [InstanceNetworkInterface](API_InstanceNetworkInterface.md) objects  
Required: No

 ** networkPerformanceOptions **   
Contains settings for the network performance options for your instance.  
Type: [InstanceNetworkPerformanceOptions](API_InstanceNetworkPerformanceOptions.md) object  
Required: No

 ** operator **   
The service provider that manages the instance.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** placement **   
The location where the instance launched, if applicable.  
Type: [Placement](API_Placement.md) object  
Required: No

 ** platform **   
The platform. This value is `windows` for Windows instances; otherwise, it is empty.  
Type: String  
Valid Values: `windows`   
Required: No

 ** platformDetails **   
The platform details value for the instance. For more information, see [AMI billing information fields](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html) in the *Amazon EC2 User Guide*.  
Type: String  
Required: No

 ** privateDnsName **   
[IPv4 only] The private DNS hostname name assigned to the instance. This DNS hostname can only be used inside the Amazon EC2 network. This name is not available until the instance enters the `running` state.   
The Amazon-provided DNS server resolves Amazon-provided private DNS hostnames if you've enabled DNS resolution and DNS hostnames in your VPC. If you are not using the Amazon-provided DNS server in your VPC, your custom domain name servers must resolve the hostname as appropriate.  
Type: String  
Required: No

 ** privateDnsNameOptions **   
The options for the instance hostname.  
Type: [PrivateDnsNameOptionsResponse](API_PrivateDnsNameOptionsResponse.md) object  
Required: No

 ** privateIpAddress **   
The private IPv4 address assigned to the instance.  
Type: String  
Required: No

 ** ProductCodes.N **   
The product codes attached to this instance, if applicable.  
Type: Array of [ProductCode](API_ProductCode.md) objects  
Required: No

 ** ramdiskId **   
The RAM disk associated with this instance, if applicable.  
Type: String  
Required: No

 ** reason **   
The reason for the most recent state transition. This might be an empty string.  
Type: String  
Required: No

 ** rootDeviceName **   
The device name of the root device volume (for example, `/dev/sda1`).  
Type: String  
Required: No

 ** rootDeviceType **   
The root device type used by the AMI. The AMI can use an EBS volume or an instance store volume.  
Type: String  
Valid Values: `ebs | instance-store`   
Required: No

 ** SecondaryInterfaceSet.N **   
The secondary interfaces for the instance.  
Type: Array of [InstanceSecondaryInterface](API_InstanceSecondaryInterface.md) objects  
Required: No

 ** sourceDestCheck **   
Indicates whether source/destination checking is enabled.  
Type: Boolean  
Required: No

 ** spotInstanceRequestId **   
If the request is a Spot Instance request, the ID of the request.  
Type: String  
Required: No

 ** sriovNetSupport **   
Specifies whether enhanced networking with the Intel 82599 Virtual Function interface is enabled.  
Type: String  
Required: No

 ** stateReason **   
The reason for the most recent state transition.  
Type: [StateReason](API_StateReason.md) object  
Required: No

 ** subnetId **   
The ID of the subnet in which the instance is running.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the instance.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** tpmSupport **   
If the instance is configured for NitroTPM support, the value is `v2.0`. For more information, see [NitroTPM](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/nitrotpm.html) in the *Amazon EC2 User Guide*.  
Type: String  
Required: No

 ** usageOperation **   
The usage operation value for the instance. For more information, see [AMI billing information fields](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/billing-info-fields.html) in the *Amazon EC2 User Guide*.  
Type: String  
Required: No

 ** usageOperationUpdateTime **   
The time that the usage operation was last updated.  
Type: Timestamp  
Required: No

 ** virtualizationType **   
The virtualization type of the instance.  
Type: String  
Valid Values: `hvm | paravirtual`   
Required: No

 ** vpcId **   
The ID of the VPC in which the instance is running.  
Type: String  
Required: No

## See Also
<a name="API_Instance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Instance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Instance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Instance) 

# InstanceAttachmentEnaSrdSpecification
<a name="API_InstanceAttachmentEnaSrdSpecification"></a>

ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.

## Contents
<a name="API_InstanceAttachmentEnaSrdSpecification_Contents"></a>

 ** enaSrdEnabled **   
Indicates whether ENA Express is enabled for the network interface.  
Type: Boolean  
Required: No

 ** enaSrdUdpSpecification **   
Configures ENA Express for UDP network traffic.  
Type: [InstanceAttachmentEnaSrdUdpSpecification](API_InstanceAttachmentEnaSrdUdpSpecification.md) object  
Required: No

## See Also
<a name="API_InstanceAttachmentEnaSrdSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceAttachmentEnaSrdSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceAttachmentEnaSrdSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceAttachmentEnaSrdSpecification) 

# InstanceAttachmentEnaSrdUdpSpecification
<a name="API_InstanceAttachmentEnaSrdUdpSpecification"></a>

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.

## Contents
<a name="API_InstanceAttachmentEnaSrdUdpSpecification_Contents"></a>

 ** enaSrdUdpEnabled **   
Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.  
Type: Boolean  
Required: No

## See Also
<a name="API_InstanceAttachmentEnaSrdUdpSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceAttachmentEnaSrdUdpSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceAttachmentEnaSrdUdpSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceAttachmentEnaSrdUdpSpecification) 

# InstanceBlockDeviceMapping
<a name="API_InstanceBlockDeviceMapping"></a>

Describes a block device mapping.

## Contents
<a name="API_InstanceBlockDeviceMapping_Contents"></a>

 ** deviceName **   
The device name.  
Type: String  
Required: No

 ** ebs **   
Parameters used to automatically set up EBS volumes when the instance is launched.  
Type: [EbsInstanceBlockDevice](API_EbsInstanceBlockDevice.md) object  
Required: No

## See Also
<a name="API_InstanceBlockDeviceMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceBlockDeviceMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceBlockDeviceMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceBlockDeviceMapping) 

# InstanceBlockDeviceMappingSpecification
<a name="API_InstanceBlockDeviceMappingSpecification"></a>

Describes a block device mapping entry.

## Contents
<a name="API_InstanceBlockDeviceMappingSpecification_Contents"></a>

 ** DeviceName **   
The device name. For available device names, see [Device names for volumes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/device_naming.html).  
Type: String  
Required: No

 ** Ebs **   
Parameters used to automatically set up EBS volumes when the instance is launched.  
Type: [EbsInstanceBlockDeviceSpecification](API_EbsInstanceBlockDeviceSpecification.md) object  
Required: No

 ** NoDevice **   
Suppresses the specified device included in the block device mapping.  
Type: String  
Required: No

 ** VirtualName **   
The virtual device name.  
Type: String  
Required: No

## See Also
<a name="API_InstanceBlockDeviceMappingSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceBlockDeviceMappingSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceBlockDeviceMappingSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceBlockDeviceMappingSpecification) 

# InstanceCapacity
<a name="API_InstanceCapacity"></a>

Information about the number of instances that can be launched onto the Dedicated Host.

## Contents
<a name="API_InstanceCapacity_Contents"></a>

 ** availableCapacity **   
The number of instances that can be launched onto the Dedicated Host based on the host's available capacity.  
Type: Integer  
Required: No

 ** instanceType **   
The instance type supported by the Dedicated Host.  
Type: String  
Required: No

 ** totalCapacity **   
The total number of instances that can be launched onto the Dedicated Host if there are no instances running on it.  
Type: Integer  
Required: No

## See Also
<a name="API_InstanceCapacity_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceCapacity) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceCapacity) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceCapacity) 

# InstanceConnectEndpointDnsNames
<a name="API_InstanceConnectEndpointDnsNames"></a>

The DNS names of the endpoint.

## Contents
<a name="API_InstanceConnectEndpointDnsNames_Contents"></a>

 ** dnsName **   
The DNS name of the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

 ** fipsDnsName **   
The Federal Information Processing Standards (FIPS) compliant DNS name of the EC2 Instance Connect Endpoint.  
Type: String  
Required: No

## See Also
<a name="API_InstanceConnectEndpointDnsNames_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceConnectEndpointDnsNames) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceConnectEndpointDnsNames) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceConnectEndpointDnsNames) 

# InstanceConnectEndpointPublicDnsNames
<a name="API_InstanceConnectEndpointPublicDnsNames"></a>

The public DNS names of the endpoint, including IPv4-only and dualstack DNS names.

## Contents
<a name="API_InstanceConnectEndpointPublicDnsNames_Contents"></a>

 ** dualstack **   
The dualstack DNS name of the EC2 Instance Connect Endpoint. A dualstack DNS name supports connections from both IPv4 and IPv6 clients.  
Type: [InstanceConnectEndpointDnsNames](API_InstanceConnectEndpointDnsNames.md) object  
Required: No

 ** ipv4 **   
The IPv4-only DNS name of the EC2 Instance Connect Endpoint.  
Type: [InstanceConnectEndpointDnsNames](API_InstanceConnectEndpointDnsNames.md) object  
Required: No

## See Also
<a name="API_InstanceConnectEndpointPublicDnsNames_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceConnectEndpointPublicDnsNames) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceConnectEndpointPublicDnsNames) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceConnectEndpointPublicDnsNames) 

# InstanceCount
<a name="API_InstanceCount"></a>

Describes a Reserved Instance listing state.

## Contents
<a name="API_InstanceCount_Contents"></a>

 ** instanceCount **   
The number of listed Reserved Instances in the state specified by the `state`.  
Type: Integer  
Required: No

 ** state **   
The states of the listed Reserved Instances.  
Type: String  
Valid Values: `available | sold | cancelled | pending`   
Required: No

## See Also
<a name="API_InstanceCount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceCount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceCount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceCount) 

# InstanceCreditSpecification
<a name="API_InstanceCreditSpecification"></a>

Describes the credit option for CPU usage of a burstable performance instance. 

## Contents
<a name="API_InstanceCreditSpecification_Contents"></a>

 ** cpuCredits **   
The credit option for CPU usage of the instance.  
Valid values: `standard` \$1 `unlimited`   
Type: String  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

## See Also
<a name="API_InstanceCreditSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceCreditSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceCreditSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceCreditSpecification) 

# InstanceCreditSpecificationRequest
<a name="API_InstanceCreditSpecificationRequest"></a>

Describes the credit option for CPU usage of a burstable performance instance.

## Contents
<a name="API_InstanceCreditSpecificationRequest_Contents"></a>

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

 ** CpuCredits **   
The credit option for CPU usage of the instance.  
Valid values: `standard` \$1 `unlimited`   
T3 instances with `host` tenancy do not support the `unlimited` CPU credit option.  
Type: String  
Required: No

## See Also
<a name="API_InstanceCreditSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceCreditSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceCreditSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceCreditSpecificationRequest) 

# InstanceEventWindow
<a name="API_InstanceEventWindow"></a>

The event window.

## Contents
<a name="API_InstanceEventWindow_Contents"></a>

 ** associationTarget **   
One or more targets associated with the event window.  
Type: [InstanceEventWindowAssociationTarget](API_InstanceEventWindowAssociationTarget.md) object  
Required: No

 ** cronExpression **   
The cron expression defined for the event window.  
Type: String  
Required: No

 ** instanceEventWindowId **   
The ID of the event window.  
Type: String  
Required: No

 ** name **   
The name of the event window.  
Type: String  
Required: No

 ** state **   
The current state of the event window.  
Type: String  
Valid Values: `creating | deleting | active | deleted`   
Required: No

 ** TagSet.N **   
The instance tags associated with the event window.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** TimeRangeSet.N **   
One or more time ranges defined for the event window.  
Type: Array of [InstanceEventWindowTimeRange](API_InstanceEventWindowTimeRange.md) objects  
Required: No

## See Also
<a name="API_InstanceEventWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceEventWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceEventWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceEventWindow) 

# InstanceEventWindowAssociationRequest
<a name="API_InstanceEventWindowAssociationRequest"></a>

One or more targets associated with the specified event window. Only one *type* of target (instance ID, instance tag, or Dedicated Host ID) can be associated with an event window.

## Contents
<a name="API_InstanceEventWindowAssociationRequest_Contents"></a>

 ** DedicatedHostId.N **   
The IDs of the Dedicated Hosts to associate with the event window.  
Type: Array of strings  
Required: No

 ** InstanceId.N **   
The IDs of the instances to associate with the event window. If the instance is on a Dedicated Host, you can't specify the Instance ID parameter; you must use the Dedicated Host ID parameter.  
Type: Array of strings  
Required: No

 ** InstanceTag.N **   
The instance tags to associate with the event window. Any instances associated with the tags will be associated with the event window.  
Note that while you can't create tag keys beginning with `aws:`, you can specify existing AWS managed tag keys (with the `aws:` prefix) when specifying them as targets to associate with the event window.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_InstanceEventWindowAssociationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceEventWindowAssociationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceEventWindowAssociationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceEventWindowAssociationRequest) 

# InstanceEventWindowAssociationTarget
<a name="API_InstanceEventWindowAssociationTarget"></a>

One or more targets associated with the event window.

## Contents
<a name="API_InstanceEventWindowAssociationTarget_Contents"></a>

 ** DedicatedHostIdSet.N **   
The IDs of the Dedicated Hosts associated with the event window.  
Type: Array of strings  
Required: No

 ** InstanceIdSet.N **   
The IDs of the instances associated with the event window.  
Type: Array of strings  
Required: No

 ** TagSet.N **   
The instance tags associated with the event window. Any instances associated with the tags will be associated with the event window.  
Note that while you can't create tag keys beginning with `aws:`, you can specify existing AWS managed tag keys (with the `aws:` prefix) when specifying them as targets to associate with the event window.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_InstanceEventWindowAssociationTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceEventWindowAssociationTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceEventWindowAssociationTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceEventWindowAssociationTarget) 

# InstanceEventWindowDisassociationRequest
<a name="API_InstanceEventWindowDisassociationRequest"></a>

The targets to disassociate from the specified event window.

## Contents
<a name="API_InstanceEventWindowDisassociationRequest_Contents"></a>

 ** DedicatedHostId.N **   
The IDs of the Dedicated Hosts to disassociate from the event window.  
Type: Array of strings  
Required: No

 ** InstanceId.N **   
The IDs of the instances to disassociate from the event window.  
Type: Array of strings  
Required: No

 ** InstanceTag.N **   
The instance tags to disassociate from the event window. Any instances associated with the tags will be disassociated from the event window.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_InstanceEventWindowDisassociationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceEventWindowDisassociationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceEventWindowDisassociationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceEventWindowDisassociationRequest) 

# InstanceEventWindowStateChange
<a name="API_InstanceEventWindowStateChange"></a>

The state of the event window.

## Contents
<a name="API_InstanceEventWindowStateChange_Contents"></a>

 ** instanceEventWindowId **   
The ID of the event window.  
Type: String  
Required: No

 ** state **   
The current state of the event window.  
Type: String  
Valid Values: `creating | deleting | active | deleted`   
Required: No

## See Also
<a name="API_InstanceEventWindowStateChange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceEventWindowStateChange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceEventWindowStateChange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceEventWindowStateChange) 

# InstanceEventWindowTimeRange
<a name="API_InstanceEventWindowTimeRange"></a>

The start day and time and the end day and time of the time range, in UTC.

## Contents
<a name="API_InstanceEventWindowTimeRange_Contents"></a>

 ** endHour **   
The hour when the time range ends.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: No

 ** endWeekDay **   
The day on which the time range ends.  
Type: String  
Valid Values: `sunday | monday | tuesday | wednesday | thursday | friday | saturday`   
Required: No

 ** startHour **   
The hour when the time range begins.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: No

 ** startWeekDay **   
The day on which the time range begins.  
Type: String  
Valid Values: `sunday | monday | tuesday | wednesday | thursday | friday | saturday`   
Required: No

## See Also
<a name="API_InstanceEventWindowTimeRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceEventWindowTimeRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceEventWindowTimeRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceEventWindowTimeRange) 

# InstanceEventWindowTimeRangeRequest
<a name="API_InstanceEventWindowTimeRangeRequest"></a>

The start day and time and the end day and time of the time range, in UTC.

## Contents
<a name="API_InstanceEventWindowTimeRangeRequest_Contents"></a>

 ** EndHour **   
The hour when the time range ends.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: No

 ** EndWeekDay **   
The day on which the time range ends.  
Type: String  
Valid Values: `sunday | monday | tuesday | wednesday | thursday | friday | saturday`   
Required: No

 ** StartHour **   
The hour when the time range begins.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 23.  
Required: No

 ** StartWeekDay **   
The day on which the time range begins.  
Type: String  
Valid Values: `sunday | monday | tuesday | wednesday | thursday | friday | saturday`   
Required: No

## See Also
<a name="API_InstanceEventWindowTimeRangeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceEventWindowTimeRangeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceEventWindowTimeRangeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceEventWindowTimeRangeRequest) 

# InstanceExportDetails
<a name="API_InstanceExportDetails"></a>

Describes an instance to export.

## Contents
<a name="API_InstanceExportDetails_Contents"></a>

 ** instanceId **   
The ID of the resource being exported.  
Type: String  
Required: No

 ** targetEnvironment **   
The target virtualization environment.  
Type: String  
Valid Values: `citrix | vmware | microsoft`   
Required: No

## See Also
<a name="API_InstanceExportDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceExportDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceExportDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceExportDetails) 

# InstanceFamilyCreditSpecification
<a name="API_InstanceFamilyCreditSpecification"></a>

Describes the default credit option for CPU usage of a burstable performance instance family.

## Contents
<a name="API_InstanceFamilyCreditSpecification_Contents"></a>

 ** cpuCredits **   
The default credit option for CPU usage of the instance family. Valid values are `standard` and `unlimited`.  
Type: String  
Required: No

 ** instanceFamily **   
The instance family.  
Type: String  
Valid Values: `t2 | t3 | t3a | t4g`   
Required: No

## See Also
<a name="API_InstanceFamilyCreditSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceFamilyCreditSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceFamilyCreditSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceFamilyCreditSpecification) 

# InstanceImageMetadata
<a name="API_InstanceImageMetadata"></a>

Information about the instance and the AMI used to launch the instance.

## Contents
<a name="API_InstanceImageMetadata_Contents"></a>

 ** availabilityZone **   
The Availability Zone or Local Zone of the instance.  
Type: String  
Required: No

 ** imageMetadata **   
Information about the AMI used to launch the instance.  
Type: [ImageMetadata](API_ImageMetadata.md) object  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** instanceOwnerId **   
The ID of the AWS account that owns the instance.  
Type: String  
Required: No

 ** instanceState **   
The current state of the instance.  
Type: [InstanceState](API_InstanceState.md) object  
Required: No

 ** instanceType **   
The instance type.  
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

 ** launchTime **   
The time the instance was launched.  
Type: Timestamp  
Required: No

 ** operator **   
The entity that manages the instance.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** TagSet.N **   
Any tags assigned to the instance.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** zoneId **   
The ID of the Availability Zone or Local Zone of the instance.  
Type: String  
Required: No

## See Also
<a name="API_InstanceImageMetadata_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceImageMetadata) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceImageMetadata) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceImageMetadata) 

# InstanceIpv4Prefix
<a name="API_InstanceIpv4Prefix"></a>

Information about an IPv4 prefix.

## Contents
<a name="API_InstanceIpv4Prefix_Contents"></a>

 ** ipv4Prefix **   
One or more IPv4 prefixes assigned to the network interface.  
Type: String  
Required: No

## See Also
<a name="API_InstanceIpv4Prefix_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceIpv4Prefix) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceIpv4Prefix) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceIpv4Prefix) 

# InstanceIpv6Address
<a name="API_InstanceIpv6Address"></a>

Describes an IPv6 address.

## Contents
<a name="API_InstanceIpv6Address_Contents"></a>

 ** Ipv6Address ** (request), ** ipv6Address ** (response)  
The IPv6 address.  
Type: String  
Required: No

 ** IsPrimaryIpv6 ** (request), ** isPrimaryIpv6 ** (response)  
Determines if an IPv6 address associated with a network interface is the primary IPv6 address. 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. For more information, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: Boolean  
Required: No

## See Also
<a name="API_InstanceIpv6Address_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceIpv6Address) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceIpv6Address) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceIpv6Address) 

# InstanceIpv6AddressRequest
<a name="API_InstanceIpv6AddressRequest"></a>

Describes an IPv6 address.

## Contents
<a name="API_InstanceIpv6AddressRequest_Contents"></a>

 ** Ipv6Address **   
The IPv6 address.  
Type: String  
Required: No

## See Also
<a name="API_InstanceIpv6AddressRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceIpv6AddressRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceIpv6AddressRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceIpv6AddressRequest) 

# InstanceIpv6Prefix
<a name="API_InstanceIpv6Prefix"></a>

Information about an IPv6 prefix.

## Contents
<a name="API_InstanceIpv6Prefix_Contents"></a>

 ** ipv6Prefix **   
One or more IPv6 prefixes assigned to the network interface.  
Type: String  
Required: No

## See Also
<a name="API_InstanceIpv6Prefix_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceIpv6Prefix) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceIpv6Prefix) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceIpv6Prefix) 

# InstanceMaintenanceOptions
<a name="API_InstanceMaintenanceOptions"></a>

The maintenance options for the instance.

## Contents
<a name="API_InstanceMaintenanceOptions_Contents"></a>

 ** autoRecovery **   
Provides information on the current automatic recovery behavior of your instance.  
Type: String  
Valid Values: `disabled | default`   
Required: No

 ** 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

## See Also
<a name="API_InstanceMaintenanceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceMaintenanceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceMaintenanceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceMaintenanceOptions) 

# InstanceMaintenanceOptionsRequest
<a name="API_InstanceMaintenanceOptionsRequest"></a>

The maintenance options for the instance.

## Contents
<a name="API_InstanceMaintenanceOptionsRequest_Contents"></a>

 ** AutoRecovery **   
Disables the automatic recovery behavior of your instance or sets it to default. For more information, see [Simplified automatic recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery).  
Type: String  
Valid Values: `disabled | default`   
Required: No

## See Also
<a name="API_InstanceMaintenanceOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceMaintenanceOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceMaintenanceOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceMaintenanceOptionsRequest) 

# InstanceMarketOptionsRequest
<a name="API_InstanceMarketOptionsRequest"></a>

Describes the market (purchasing) option for the instances.

## Contents
<a name="API_InstanceMarketOptionsRequest_Contents"></a>

 ** MarketType **   
The market type.  
Type: String  
Valid Values: `spot | capacity-block | interruptible-capacity-reservation`   
Required: No

 ** SpotOptions **   
The options for Spot Instances.  
Type: [SpotMarketOptions](API_SpotMarketOptions.md) object  
Required: No

## See Also
<a name="API_InstanceMarketOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceMarketOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceMarketOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceMarketOptionsRequest) 

# InstanceMetadataDefaultsResponse
<a name="API_InstanceMetadataDefaultsResponse"></a>

The default instance metadata service (IMDS) settings that were set at the account level in the specified AWS  Region.

## Contents
<a name="API_InstanceMetadataDefaultsResponse_Contents"></a>

 ** httpEndpoint **   
Indicates whether the IMDS endpoint for an instance is enabled or disabled. When disabled, the instance metadata can't be accessed.  
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** httpPutResponseHopLimit **   
The maximum number of hops that the metadata token can travel.  
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`   
Required: No

 ** httpTokensEnforced **   
Indicates 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`.  
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** instanceMetadataTags **   
Indicates whether access to instance tags from the instance metadata is enabled or disabled. 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`   
Required: No

 ** managedBy **   
The entity that manages the IMDS default settings. Possible values include:  
+  `account` - The IMDS default settings are managed by the account.
+  `declarative-policy` - The IMDS default settings are managed by a declarative policy and can't be modified by the account.
Type: String  
Valid Values: `account | declarative-policy`   
Required: No

 ** managedExceptionMessage **   
The customized exception message that is specified in the declarative policy.  
Type: String  
Required: No

## See Also
<a name="API_InstanceMetadataDefaultsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceMetadataDefaultsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceMetadataDefaultsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceMetadataDefaultsResponse) 

# InstanceMetadataOptionsRequest
<a name="API_InstanceMetadataOptionsRequest"></a>

The metadata options for the instance.

## Contents
<a name="API_InstanceMetadataOptionsRequest_Contents"></a>

 ** HttpEndpoint **   
Enables or disables the HTTP metadata endpoint on your instances.  
If you specify a value of `disabled`, you cannot access your instance metadata.  
Default: `enabled`   
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** HttpProtocolIpv6 **   
Enables or disables the IPv6 endpoint for the instance metadata service.  
Default: `disabled`   
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** HttpPutResponseHopLimit **   
The maximum number of hops that the metadata token can travel.  
Possible values: Integers from 1 to 64  
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.
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

 ** 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).  
Default: `disabled`   
Type: String  
Valid Values: `disabled | enabled`   
Required: No

## See Also
<a name="API_InstanceMetadataOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceMetadataOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceMetadataOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceMetadataOptionsRequest) 

# InstanceMetadataOptionsResponse
<a name="API_InstanceMetadataOptionsResponse"></a>

The metadata options for the instance.

## Contents
<a name="API_InstanceMetadataOptionsResponse_Contents"></a>

 ** httpEndpoint **   
Indicates whether the HTTP metadata endpoint on your instances is enabled or disabled.  
If the value is `disabled`, you cannot access your instance metadata.  
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** httpProtocolIpv6 **   
Indicates whether the IPv6 endpoint for the instance metadata service is enabled or disabled.  
Default: `disabled`   
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** httpPutResponseHopLimit **   
The maximum number of hops that the metadata token can travel.  
Possible values: Integers from `1` to `64`   
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`   
Required: No

 ** instanceMetadataTags **   
Indicates whether access to instance tags from the instance metadata is enabled or disabled. 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

 ** state **   
The state of the metadata option changes.  
 `pending` - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.  
 `applied` - The metadata options have been successfully applied on the instance.  
Type: String  
Valid Values: `pending | applied`   
Required: No

## See Also
<a name="API_InstanceMetadataOptionsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceMetadataOptionsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceMetadataOptionsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceMetadataOptionsResponse) 

# InstanceMonitoring
<a name="API_InstanceMonitoring"></a>

Describes the monitoring of an instance.

## Contents
<a name="API_InstanceMonitoring_Contents"></a>

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** monitoring **   
The monitoring for the instance.  
Type: [Monitoring](API_Monitoring.md) object  
Required: No

## See Also
<a name="API_InstanceMonitoring_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceMonitoring) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceMonitoring) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceMonitoring) 

# InstanceNetworkInterface
<a name="API_InstanceNetworkInterface"></a>

Describes a network interface.

## Contents
<a name="API_InstanceNetworkInterface_Contents"></a>

 ** association **   
The association information for an Elastic IPv4 associated with the network interface.  
Type: [InstanceNetworkInterfaceAssociation](API_InstanceNetworkInterfaceAssociation.md) object  
Required: No

 ** attachment **   
The network interface attachment.  
Type: [InstanceNetworkInterfaceAttachment](API_InstanceNetworkInterfaceAttachment.md) object  
Required: No

 ** connectionTrackingConfiguration **   
A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.  
Type: [ConnectionTrackingSpecificationResponse](API_ConnectionTrackingSpecificationResponse.md) object  
Required: No

 ** description **   
The description.  
Type: String  
Required: No

 ** GroupSet.N **   
The security groups.  
Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects  
Required: No

 ** interfaceType **   
The type of network interface.  
Valid values: `interface` \$1 `efa` \$1 `efa-only` \$1 `evs` \$1 `trunk`   
Type: String  
Required: No

 ** Ipv4PrefixSet.N **   
The IPv4 delegated prefixes that are assigned to the network interface.  
Type: Array of [InstanceIpv4Prefix](API_InstanceIpv4Prefix.md) objects  
Required: No

 ** Ipv6AddressesSet.N **   
The IPv6 addresses associated with the network interface.  
Type: Array of [InstanceIpv6Address](API_InstanceIpv6Address.md) objects  
Required: No

 ** Ipv6PrefixSet.N **   
The IPv6 delegated prefixes that are assigned to the network interface.  
Type: Array of [InstanceIpv6Prefix](API_InstanceIpv6Prefix.md) objects  
Required: No

 ** macAddress **   
The MAC address.  
Type: String  
Required: No

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

 ** operator **   
The service provider that manages the network interface.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** ownerId **   
The ID of the AWS account that created the network interface.  
Type: String  
Required: No

 ** privateDnsName **   
The private DNS name.  
Type: String  
Required: No

 ** privateIpAddress **   
The IPv4 address of the network interface within the subnet.  
Type: String  
Required: No

 ** PrivateIpAddressesSet.N **   
The private IPv4 addresses associated with the network interface.  
Type: Array of [InstancePrivateIpAddress](API_InstancePrivateIpAddress.md) objects  
Required: No

 ** sourceDestCheck **   
Indicates whether source/destination checking is enabled.  
Type: Boolean  
Required: No

 ** status **   
The status of the network interface.  
Type: String  
Valid Values: `available | associated | attaching | in-use | detaching`   
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_InstanceNetworkInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceNetworkInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceNetworkInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceNetworkInterface) 

# InstanceNetworkInterfaceAssociation
<a name="API_InstanceNetworkInterfaceAssociation"></a>

Describes association information for an Elastic IP address (IPv4).

## Contents
<a name="API_InstanceNetworkInterfaceAssociation_Contents"></a>

 ** carrierIp **   
The carrier IP address associated with the network interface.  
Type: String  
Required: No

 ** customerOwnedIp **   
The customer-owned IP address associated with the network interface.  
Type: String  
Required: No

 ** ipOwnerId **   
The ID of the owner of the Elastic IP address.  
Type: String  
Required: No

 ** publicDnsName **   
The public DNS name.  
Type: String  
Required: No

 ** publicIp **   
The public IP address or Elastic IP address bound to the network interface.  
Type: String  
Required: No

## See Also
<a name="API_InstanceNetworkInterfaceAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceNetworkInterfaceAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceNetworkInterfaceAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceNetworkInterfaceAssociation) 

# InstanceNetworkInterfaceAttachment
<a name="API_InstanceNetworkInterfaceAttachment"></a>

Describes a network interface attachment.

## Contents
<a name="API_InstanceNetworkInterfaceAttachment_Contents"></a>

 ** attachmentId **   
The ID of the network interface attachment.  
Type: String  
Required: No

 ** attachTime **   
The time stamp when the attachment initiated.  
Type: Timestamp  
Required: No

 ** deleteOnTermination **   
Indicates whether the network interface is deleted when the instance is terminated.  
Type: Boolean  
Required: No

 ** deviceIndex **   
The index of the device on the instance for the network interface attachment.  
Type: Integer  
Required: No

 ** enaQueueCount **   
The number of ENA queues created with the instance.  
Type: Integer  
Required: No

 ** enaSrdSpecification **   
Contains the ENA Express settings for the network interface that's attached to the instance.  
Type: [InstanceAttachmentEnaSrdSpecification](API_InstanceAttachmentEnaSrdSpecification.md) object  
Required: No

 ** networkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

 ** status **   
The attachment state.  
Type: String  
Valid Values: `attaching | attached | detaching | detached`   
Required: No

## See Also
<a name="API_InstanceNetworkInterfaceAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceNetworkInterfaceAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceNetworkInterfaceAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceNetworkInterfaceAttachment) 

# InstanceNetworkInterfaceSpecification
<a name="API_InstanceNetworkInterfaceSpecification"></a>

Describes a network interface.

## Contents
<a name="API_InstanceNetworkInterfaceSpecification_Contents"></a>

 ** AssociateCarrierIpAddress ** (request), ** AssociateCarrierIpAddress ** (response)  
Indicates whether to assign a carrier IP address to the network interface.  
You can only assign a carrier IP address to a network interface that is in a subnet in a Wavelength Zone. For more information about carrier IP addresses, see [Carrier IP address](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the * AWS Wavelength Developer Guide*.  
Type: Boolean  
Required: No

 ** AssociatePublicIpAddress ** (request), ** associatePublicIpAddress ** (response)  
Indicates whether to assign a public IPv4 address to an instance you launch in a VPC. The public IP address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is `true`.  
 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: Boolean  
Required: No

 ** ConnectionTrackingSpecification ** (request), ** ConnectionTrackingSpecification ** (response)  
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.  
Type: [ConnectionTrackingSpecificationRequest](API_ConnectionTrackingSpecificationRequest.md) object  
Required: No

 ** DeleteOnTermination ** (request), ** deleteOnTermination ** (response)  
If set to `true`, the interface is deleted when the instance is terminated. You can specify `true` only if creating a new network interface when launching an instance.  
Type: Boolean  
Required: No

 ** Description ** (request), ** description ** (response)  
The description of the network interface. Applies only if creating a network interface when launching an instance.  
Type: String  
Required: No

 ** DeviceIndex ** (request), ** deviceIndex ** (response)  
The position of the network interface in the attachment order. A primary network interface has a device index of 0.  
If you specify a network interface when launching an instance, you must specify the device index.  
Type: Integer  
Required: No

 ** EnaQueueCount ** (request), ** EnaQueueCount ** (response)  
The number of ENA queues to be created with the instance.  
Type: Integer  
Required: No

 ** EnaSrdSpecification ** (request), ** EnaSrdSpecification ** (response)  
Specifies the ENA Express settings for the network interface that's attached to the instance.  
Type: [EnaSrdSpecificationRequest](API_EnaSrdSpecificationRequest.md) object  
Required: No

 ** InterfaceType ** (request), ** InterfaceType ** (response)  
The type of network 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.  
Valid values: `interface` \$1 `efa` \$1 `efa-only`   
Type: String  
Required: No

 ** Ipv4Prefix.N **   
The IPv4 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the `Ipv4PrefixCount` option.  
Type: Array of [Ipv4PrefixSpecificationRequest](API_Ipv4PrefixSpecificationRequest.md) objects  
Required: No

 ** Ipv4PrefixCount ** (request), ** Ipv4PrefixCount ** (response)  
The number of IPv4 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the `Ipv4Prefix` option.  
Type: Integer  
Required: No

 ** Ipv6AddressCount ** (request), ** ipv6AddressCount ** (response)  
A number of IPv6 addresses to assign to the network interface. Amazon EC2 chooses the IPv6 addresses from the range of the 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.  
Type: Integer  
Required: No

 ** Ipv6Addresses.N **   
The IPv6 addresses to assign to the 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.  
Type: Array of [InstanceIpv6Address](API_InstanceIpv6Address.md) objects  
Required: No

 ** Ipv6Prefix.N **   
The IPv6 delegated prefixes to be assigned to the network interface. You cannot use this option if you use the `Ipv6PrefixCount` option.  
Type: Array of [Ipv6PrefixSpecificationRequest](API_Ipv6PrefixSpecificationRequest.md) objects  
Required: No

 ** Ipv6PrefixCount ** (request), ** Ipv6PrefixCount ** (response)  
The number of IPv6 delegated prefixes to be automatically assigned to the network interface. You cannot use this option if you use the `Ipv6Prefix` option.  
Type: Integer  
Required: No

 ** NetworkCardIndex ** (request), ** NetworkCardIndex ** (response)  
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.  
If you are using [RequestSpotInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotInstances.html) to create Spot Instances, omit this parameter because you can’t specify the network card index when using this API. To specify the network card index, use [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: Integer  
Required: No

 ** NetworkInterfaceId ** (request), ** networkInterfaceId ** (response)  
The ID of the network interface.  
If you are creating a Spot Fleet, omit this parameter because you can’t specify a network interface ID in a launch specification.  
Type: String  
Required: No

 ** PrimaryIpv6 ** (request), ** PrimaryIpv6 ** (response)  
The primary IPv6 address of the network interface. 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. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: Boolean  
Required: No

 ** PrivateIpAddress ** (request), ** privateIpAddress ** (response)  
The private IPv4 address of the network interface. Applies only if creating a network interface when launching an instance. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request.  
Type: String  
Required: No

 ** PrivateIpAddresses.N **   
The private IPv4 addresses to assign to the network interface. Only one private IPv4 address can be designated as primary. You cannot specify this option if you're launching more than one instance in a [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) request.  
Type: Array of [PrivateIpAddressSpecification](API_PrivateIpAddressSpecification.md) objects  
Required: No

 ** SecondaryPrivateIpAddressCount ** (request), ** secondaryPrivateIpAddressCount ** (response)  
The number of secondary private IPv4 addresses. You can’t specify this parameter and also specify a secondary private IP address using the `PrivateIpAddress` parameter.  
Type: Integer  
Required: No

 ** SecurityGroupId.N **   
The IDs of the security groups for the network interface. Applies only if creating a network interface when launching an instance.  
Type: Array of strings  
Required: No

 ** SubnetId ** (request), ** subnetId ** (response)  
The ID of the subnet associated with the network interface. Applies only if creating a network interface when launching an instance.  
Type: String  
Required: No

## See Also
<a name="API_InstanceNetworkInterfaceSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceNetworkInterfaceSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceNetworkInterfaceSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceNetworkInterfaceSpecification) 

# InstanceNetworkPerformanceOptions
<a name="API_InstanceNetworkPerformanceOptions"></a>

With network performance options, you can adjust your bandwidth preferences to meet the needs of the workload that runs on your instance.

## Contents
<a name="API_InstanceNetworkPerformanceOptions_Contents"></a>

 ** bandwidthWeighting **   
When you configure network bandwidth weighting, you can boost your baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type.  
Type: String  
Valid Values: `default | vpc-1 | ebs-1`   
Required: No

## See Also
<a name="API_InstanceNetworkPerformanceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceNetworkPerformanceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceNetworkPerformanceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceNetworkPerformanceOptions) 

# InstanceNetworkPerformanceOptionsRequest
<a name="API_InstanceNetworkPerformanceOptionsRequest"></a>

Configure network performance options for your instance that are geared towards performance improvements based on the workload that it runs.

## Contents
<a name="API_InstanceNetworkPerformanceOptionsRequest_Contents"></a>

 ** 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: No

## See Also
<a name="API_InstanceNetworkPerformanceOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceNetworkPerformanceOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceNetworkPerformanceOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceNetworkPerformanceOptionsRequest) 

# InstancePrivateIpAddress
<a name="API_InstancePrivateIpAddress"></a>

Describes a private IPv4 address.

## Contents
<a name="API_InstancePrivateIpAddress_Contents"></a>

 ** association **   
The association information for an Elastic IP address for the network interface.  
Type: [InstanceNetworkInterfaceAssociation](API_InstanceNetworkInterfaceAssociation.md) object  
Required: No

 ** primary **   
Indicates whether this IPv4 address is the primary private IP address of the network interface.  
Type: Boolean  
Required: No

 ** privateDnsName **   
The private IPv4 DNS name.  
Type: String  
Required: No

 ** privateIpAddress **   
The private IPv4 address of the network interface.  
Type: String  
Required: No

## See Also
<a name="API_InstancePrivateIpAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstancePrivateIpAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstancePrivateIpAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstancePrivateIpAddress) 

# InstanceRequirements
<a name="API_InstanceRequirements"></a>

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

You must specify `VCpuCount` and `MemoryMiB`. All other attributes are optional. Any unspecified optional attribute is set to its default.

When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
+  `AllowedInstanceTypes` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
+  `ExcludedInstanceTypes` - The instance types to exclude from the list, even if they match your specified attributes.

**Note**  
If you specify `InstanceRequirements`, you can't specify `InstanceType`.  
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html) or with the [RunInstances API](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html), you can't specify `InstanceRequirements`.

For more information, see [Create mixed instances group using attribute-based instance type selection](https://docs.aws.amazon.com/autoscaling/ec2/userguide/create-mixed-instances-group-attribute-based-instance-type-selection.html) in the *Amazon EC2 Auto Scaling User Guide*, and also [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*.

## Contents
<a name="API_InstanceRequirements_Contents"></a>

 ** AcceleratorCount ** (request), ** acceleratorCount ** (response)  
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.  
To exclude accelerator-enabled instance types, set `Max` to `0`.  
Default: No minimum or maximum limits  
Type: [AcceleratorCount](API_AcceleratorCount.md) object  
Required: No

 ** AcceleratorManufacturerSet.N **   
Indicates whether instance types must have accelerators by specific manufacturers.  
+ For instance types with AWS devices, specify `amazon-web-services`.
+ For instance types with AMD devices, specify `amd`.
+ For instance types with Habana devices, specify `habana`.
+ For instance types with NVIDIA devices, specify `nvidia`.
+ For instance types with Xilinx devices, specify `xilinx`.
Default: Any manufacturer  
Type: Array of strings  
Valid Values: `amazon-web-services | amd | nvidia | xilinx | habana`   
Required: No

 ** AcceleratorNameSet.N **   
The accelerators that must be on the instance type.  
+ For instance types with NVIDIA A10G GPUs, specify `a10g`.
+ For instance types with NVIDIA A100 GPUs, specify `a100`.
+ For instance types with NVIDIA H100 GPUs, specify `h100`.
+ For instance types with AWS Inferentia chips, specify `inferentia`.
+ For instance types with AWS Inferentia2 chips, specify `inferentia2`.
+ For instance types with Habana Gaudi HL-205 GPUs, specify `gaudi-hl-205`.
+ For instance types with NVIDIA GRID K520 GPUs, specify `k520`.
+ For instance types with NVIDIA K80 GPUs, specify `k80`.
+ For instance types with NVIDIA L4 GPUs, specify `l4`.
+ For instance types with NVIDIA L40S GPUs, specify `l40s`.
+ For instance types with NVIDIA M60 GPUs, specify `m60`.
+ For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520`.
+ For instance types with AWS Trainium chips, specify `trainium`.
+ For instance types with AWS Trainium2 chips, specify `trainium2`.
+ For instance types with NVIDIA T4 GPUs, specify `t4`.
+ For instance types with NVIDIA T4G GPUs, specify `t4g`.
+ For instance types with Xilinx U30 cards, specify `u30`.
+ For instance types with Xilinx VU9P FPGAs, specify `vu9p`.
+ For instance types with NVIDIA V100 GPUs, specify `v100`.
Default: Any accelerator  
Type: Array of strings  
Valid Values: `a100 | inferentia | k520 | k80 | m60 | radeon-pro-v520 | t4 | vu9p | v100 | a10g | h100 | t4g | l40s | l4 | gaudi-hl-205 | inferentia2 | trainium | trainium2 | u30`   
Required: No

 ** AcceleratorTotalMemoryMiB ** (request), ** acceleratorTotalMemoryMiB ** (response)  
The minimum and maximum amount of total accelerator memory, in MiB.  
Default: No minimum or maximum limits  
Type: [AcceleratorTotalMemoryMiB](API_AcceleratorTotalMemoryMiB.md) object  
Required: No

 ** AcceleratorTypeSet.N **   
The accelerator types that must be on the instance type.  
+ For instance types with FPGA accelerators, specify `fpga`.
+ For instance types with GPU accelerators, specify `gpu`.
+ For instance types with Inference accelerators, specify `inference`.
+ For instance types with Media accelerators, specify `media`.
Default: Any accelerator type  
Type: Array of strings  
Valid Values: `gpu | fpga | inference | media`   
Required: No

 ** AllowedInstanceTypeSet.N **   
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.  
You can use strings with one or more wild cards, represented by an asterisk (`*`), to allow an instance type, size, or generation. The following are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`, `r*`, `*3*`.  
For example, if you specify `c5*`,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*`, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.  
If you specify `AllowedInstanceTypes`, you can't specify `ExcludedInstanceTypes`.
Default: All instance types  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 400 items.  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[a-zA-Z0-9\.\*\-]+`   
Required: No

 ** BareMetal ** (request), ** bareMetal ** (response)  
Indicates whether bare metal instance types must be included, excluded, or required.  
+ To include bare metal instance types, specify `included`.
+ To require only bare metal instance types, specify `required`.
+ To exclude bare metal instance types, specify `excluded`.
Default: `excluded`   
Type: String  
Valid Values: `included | required | excluded`   
Required: No

 ** BaselineEbsBandwidthMbps ** (request), ** baselineEbsBandwidthMbps ** (response)  
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.  
Default: No minimum or maximum limits  
Type: [BaselineEbsBandwidthMbps](API_BaselineEbsBandwidthMbps.md) object  
Required: No

 ** BaselinePerformanceFactors ** (request), ** baselinePerformanceFactors ** (response)  
The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*.  
Type: [BaselinePerformanceFactors](API_BaselinePerformanceFactors.md) object  
Required: No

 ** BurstablePerformance ** (request), ** burstablePerformance ** (response)  
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).  
+ To include burstable performance instance types, specify `included`.
+ To require only burstable performance instance types, specify `required`.
+ To exclude burstable performance instance types, specify `excluded`.
Default: `excluded`   
Type: String  
Valid Values: `included | required | excluded`   
Required: No

 ** CpuManufacturerSet.N **   
The CPU manufacturers to include.  
+ For instance types with Intel CPUs, specify `intel`.
+ For instance types with AMD CPUs, specify `amd`.
+ For instance types with AWS CPUs, specify `amazon-web-services`.
+ For instance types with Apple CPUs, specify `apple`.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer  
Type: Array of strings  
Valid Values: `intel | amd | amazon-web-services | apple`   
Required: No

 ** ExcludedInstanceTypeSet.N **   
The instance types to exclude.  
You can use strings with one or more wild cards, represented by an asterisk (`*`), to exclude an instance type, size, or generation. The following are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`, `r*`, `*3*`.  
For example, if you specify `c5*`,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*`, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.  
If you specify `ExcludedInstanceTypes`, you can't specify `AllowedInstanceTypes`.
Default: No excluded instance types  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 400 items.  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[a-zA-Z0-9\.\*\-]+`   
Required: No

 ** InstanceGenerationSet.N **   
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.  
For current generation instance types, specify `current`.  
For previous generation instance types, specify `previous`.  
Default: Current and previous generation instance types  
Type: Array of strings  
Valid Values: `current | previous`   
Required: No

 ** LocalStorage ** (request), ** localStorage ** (response)  
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.  
+ To include instance types with instance store volumes, specify `included`.
+ To require only instance types with instance store volumes, specify `required`.
+ To exclude instance types with instance store volumes, specify `excluded`.
Default: `included`   
Type: String  
Valid Values: `included | required | excluded`   
Required: No

 ** LocalStorageTypeSet.N **   
The type of local storage that is required.  
+ For instance types with hard disk drive (HDD) storage, specify `hdd`.
+ For instance types with solid state drive (SSD) storage, specify `ssd`.
Default: `hdd` and `ssd`   
Type: Array of strings  
Valid Values: `hdd | ssd`   
Required: No

 ** MaxSpotPriceAsPercentageOfOptimalOnDemandPrice ** (request), ** maxSpotPriceAsPercentageOfOptimalOnDemandPrice ** (response)  
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.  
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.  
If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib`, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.  
Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999`.
Type: Integer  
Required: No

 ** MemoryGiBPerVCpu ** (request), ** memoryGiBPerVCpu ** (response)  
The minimum and maximum amount of memory per vCPU, in GiB.  
Default: No minimum or maximum limits  
Type: [MemoryGiBPerVCpu](API_MemoryGiBPerVCpu.md) object  
Required: No

 ** MemoryMiB ** (request), ** memoryMiB ** (response)  
The minimum and maximum amount of memory, in MiB.  
Type: [MemoryMiB](API_MemoryMiB.md) object  
Required: No

 ** NetworkBandwidthGbps ** (request), ** networkBandwidthGbps ** (response)  
The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).  
Default: No minimum or maximum limits  
Type: [NetworkBandwidthGbps](API_NetworkBandwidthGbps.md) object  
Required: No

 ** NetworkInterfaceCount ** (request), ** networkInterfaceCount ** (response)  
The minimum and maximum number of network interfaces.  
Default: No minimum or maximum limits  
Type: [NetworkInterfaceCount](API_NetworkInterfaceCount.md) object  
Required: No

 ** OnDemandMaxPricePercentageOverLowestPrice ** (request), ** onDemandMaxPricePercentageOverLowestPrice ** (response)  
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.  
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.  
To turn off price protection, specify a high value, such as `999999`.  
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).  
If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib`, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: `20`   
Type: Integer  
Required: No

 ** RequireEncryptionInTransit ** (request), ** requireEncryptionInTransit ** (response)  
Specifies whether instance types must support encrypting in-transit traffic between instances. For more information, including the supported instance types, see [Encryption in transit](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html#encryption-transit) in the *Amazon EC2 User Guide*.  
Default: `false`   
Type: Boolean  
Required: No

 ** RequireHibernateSupport ** (request), ** requireHibernateSupport ** (response)  
Indicates whether instance types must support hibernation for On-Demand Instances.  
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).  
Default: `false`   
Type: Boolean  
Required: No

 ** SpotMaxPricePercentageOverLowestPrice ** (request), ** spotMaxPricePercentageOverLowestPrice ** (response)  
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.  
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.  
If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib`, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.  
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).  
Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999`.
Default: `100`   
Type: Integer  
Required: No

 ** TotalLocalStorageGB ** (request), ** totalLocalStorageGB ** (response)  
The minimum and maximum amount of total local storage, in GB.  
Default: No minimum or maximum limits  
Type: [TotalLocalStorageGB](API_TotalLocalStorageGB.md) object  
Required: No

 ** VCpuCount ** (request), ** vCpuCount ** (response)  
The minimum and maximum number of vCPUs.  
Type: [VCpuCountRange](API_VCpuCountRange.md) object  
Required: No

## See Also
<a name="API_InstanceRequirements_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceRequirements) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceRequirements) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceRequirements) 

# InstanceRequirementsRequest
<a name="API_InstanceRequirementsRequest"></a>

The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.

You must specify `VCpuCount` and `MemoryMiB`. All other attributes are optional. Any unspecified optional attribute is set to its default.

When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.

To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:
+  `AllowedInstanceTypes` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
+  `ExcludedInstanceTypes` - The instance types to exclude from the list, even if they match your specified attributes.

**Note**  
If you specify `InstanceRequirements`, you can't specify `InstanceType`.  
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify `InstanceRequirements`.

For more information, see [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*.

## Contents
<a name="API_InstanceRequirementsRequest_Contents"></a>

 ** MemoryMiB **   
The minimum and maximum amount of memory, in MiB.  
Type: [MemoryMiBRequest](API_MemoryMiBRequest.md) object  
Required: Yes

 ** VCpuCount **   
The minimum and maximum number of vCPUs.  
Type: [VCpuCountRangeRequest](API_VCpuCountRangeRequest.md) object  
Required: Yes

 ** AcceleratorCount **   
The minimum and maximum number of accelerators (GPUs, FPGAs, or AWS Inferentia chips) on an instance.  
To exclude accelerator-enabled instance types, set `Max` to `0`.  
Default: No minimum or maximum limits  
Type: [AcceleratorCountRequest](API_AcceleratorCountRequest.md) object  
Required: No

 ** AcceleratorManufacturer.N **   
Indicates whether instance types must have accelerators by specific manufacturers.  
+ For instance types with AWS devices, specify `amazon-web-services`.
+ For instance types with AMD devices, specify `amd`.
+ For instance types with Habana devices, specify `habana`.
+ For instance types with NVIDIA devices, specify `nvidia`.
+ For instance types with Xilinx devices, specify `xilinx`.
Default: Any manufacturer  
Type: Array of strings  
Valid Values: `amazon-web-services | amd | nvidia | xilinx | habana`   
Required: No

 ** AcceleratorName.N **   
The accelerators that must be on the instance type.  
+ For instance types with NVIDIA A10G GPUs, specify `a10g`.
+ For instance types with NVIDIA A100 GPUs, specify `a100`.
+ For instance types with NVIDIA H100 GPUs, specify `h100`.
+ For instance types with AWS Inferentia chips, specify `inferentia`.
+ For instance types with AWS Inferentia2 chips, specify `inferentia2`.
+ For instance types with Habana Gaudi HL-205 GPUs, specify `gaudi-hl-205`.
+ For instance types with NVIDIA GRID K520 GPUs, specify `k520`.
+ For instance types with NVIDIA K80 GPUs, specify `k80`.
+ For instance types with NVIDIA L4 GPUs, specify `l4`.
+ For instance types with NVIDIA L40S GPUs, specify `l40s`.
+ For instance types with NVIDIA M60 GPUs, specify `m60`.
+ For instance types with AMD Radeon Pro V520 GPUs, specify `radeon-pro-v520`.
+ For instance types with AWS Trainium chips, specify `trainium`.
+ For instance types with AWS Trainium2 chips, specify `trainium2`.
+ For instance types with NVIDIA T4 GPUs, specify `t4`.
+ For instance types with NVIDIA T4G GPUs, specify `t4g`.
+ For instance types with Xilinx U30 cards, specify `u30`.
+ For instance types with Xilinx VU9P FPGAs, specify `vu9p`.
+ For instance types with NVIDIA V100 GPUs, specify `v100`.
Default: Any accelerator  
Type: Array of strings  
Valid Values: `a100 | inferentia | k520 | k80 | m60 | radeon-pro-v520 | t4 | vu9p | v100 | a10g | h100 | t4g | l40s | l4 | gaudi-hl-205 | inferentia2 | trainium | trainium2 | u30`   
Required: No

 ** AcceleratorTotalMemoryMiB **   
The minimum and maximum amount of total accelerator memory, in MiB.  
Default: No minimum or maximum limits  
Type: [AcceleratorTotalMemoryMiBRequest](API_AcceleratorTotalMemoryMiBRequest.md) object  
Required: No

 ** AcceleratorType.N **   
The accelerator types that must be on the instance type.  
+ For instance types with FPGA accelerators, specify `fpga`.
+ For instance types with GPU accelerators, specify `gpu`.
+ For instance types with Inference accelerators, specify `inference`.
+ For instance types with Media accelerators, specify `media`.
Default: Any accelerator type  
Type: Array of strings  
Valid Values: `gpu | fpga | inference | media`   
Required: No

 ** AllowedInstanceType.N **   
The instance types to apply your specified attributes against. All other instance types are ignored, even if they match your specified attributes.  
You can use strings with one or more wild cards, represented by an asterisk (`*`), to allow an instance type, size, or generation. The following are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`, `r*`, `*3*`.  
For example, if you specify `c5*`,Amazon EC2 will allow the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*`, Amazon EC2 will allow all the M5a instance types, but not the M5n instance types.  
If you specify `AllowedInstanceTypes`, you can't specify `ExcludedInstanceTypes`.
Default: All instance types  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 400 items.  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[a-zA-Z0-9\.\*\-]+`   
Required: No

 ** BareMetal **   
Indicates whether bare metal instance types must be included, excluded, or required.  
+ To include bare metal instance types, specify `included`.
+ To require only bare metal instance types, specify `required`.
+ To exclude bare metal instance types, specify `excluded`.
Default: `excluded`   
Type: String  
Valid Values: `included | required | excluded`   
Required: No

 ** BaselineEbsBandwidthMbps **   
The minimum and maximum baseline bandwidth to Amazon EBS, in Mbps. For more information, see [Amazon EBS–optimized instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-optimized.html) in the *Amazon EC2 User Guide*.  
Default: No minimum or maximum limits  
Type: [BaselineEbsBandwidthMbpsRequest](API_BaselineEbsBandwidthMbpsRequest.md) object  
Required: No

 ** BaselinePerformanceFactors **   
The baseline performance to consider, using an instance family as a baseline reference. The instance family establishes the lowest acceptable level of performance. Amazon EC2 uses this baseline to guide instance type selection, but there is no guarantee that the selected instance types will always exceed the baseline for every application. Currently, this parameter only supports CPU performance as a baseline performance factor. For more information, see [Performance protection](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-attribute-based-instance-type-selection.html#ec2fleet-abis-performance-protection) in the *Amazon EC2 User Guide*.  
Type: [BaselinePerformanceFactorsRequest](API_BaselinePerformanceFactorsRequest.md) object  
Required: No

 ** BurstablePerformance **   
Indicates whether burstable performance T instance types are included, excluded, or required. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).  
+ To include burstable performance instance types, specify `included`.
+ To require only burstable performance instance types, specify `required`.
+ To exclude burstable performance instance types, specify `excluded`.
Default: `excluded`   
Type: String  
Valid Values: `included | required | excluded`   
Required: No

 ** CpuManufacturer.N **   
The CPU manufacturers to include.  
+ For instance types with Intel CPUs, specify `intel`.
+ For instance types with AMD CPUs, specify `amd`.
+ For instance types with AWS CPUs, specify `amazon-web-services`.
+ For instance types with Apple CPUs, specify `apple`.
Don't confuse the CPU manufacturer with the CPU architecture. Instances will be launched with a compatible CPU architecture based on the Amazon Machine Image (AMI) that you specify in your launch template.
Default: Any manufacturer  
Type: Array of strings  
Valid Values: `intel | amd | amazon-web-services | apple`   
Required: No

 ** ExcludedInstanceType.N **   
The instance types to exclude.  
You can use strings with one or more wild cards, represented by an asterisk (`*`), to exclude an instance family, type, size, or generation. The following are examples: `m5.8xlarge`, `c5*.*`, `m5a.*`, `r*`, `*3*`.  
For example, if you specify `c5*`,Amazon EC2 will exclude the entire C5 instance family, which includes all C5a and C5n instance types. If you specify `m5a.*`, Amazon EC2 will exclude all the M5a instance types, but not the M5n instance types.  
If you specify `ExcludedInstanceTypes`, you can't specify `AllowedInstanceTypes`.
Default: No excluded instance types  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 400 items.  
Length Constraints: Minimum length of 1. Maximum length of 30.  
Pattern: `[a-zA-Z0-9\.\*\-]+`   
Required: No

 ** InstanceGeneration.N **   
Indicates whether current or previous generation instance types are included. The current generation instance types are recommended for use. Current generation instance types are typically the latest two to three generations in each instance family. For more information, see [Instance types](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html) in the *Amazon EC2 User Guide*.  
For current generation instance types, specify `current`.  
For previous generation instance types, specify `previous`.  
Default: Current and previous generation instance types  
Type: Array of strings  
Valid Values: `current | previous`   
Required: No

 ** LocalStorage **   
Indicates whether instance types with instance store volumes are included, excluded, or required. For more information, [Amazon EC2 instance store](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/InstanceStorage.html) in the *Amazon EC2 User Guide*.  
+ To include instance types with instance store volumes, specify `included`.
+ To require only instance types with instance store volumes, specify `required`.
+ To exclude instance types with instance store volumes, specify `excluded`.
Default: `included`   
Type: String  
Valid Values: `included | required | excluded`   
Required: No

 ** LocalStorageType.N **   
The type of local storage that is required.  
+ For instance types with hard disk drive (HDD) storage, specify `hdd`.
+ For instance types with solid state drive (SSD) storage, specify `ssd`.
Default: `hdd` and `ssd`   
Type: Array of strings  
Valid Values: `hdd | ssd`   
Required: No

 ** MaxSpotPriceAsPercentageOfOptimalOnDemandPrice **   
[Price protection] The price protection threshold for Spot Instances, as a percentage of an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.  
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.  
If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib`, the price protection threshold is based on the per vCPU or per memory price instead of the per instance price.  
Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999`.
Type: Integer  
Required: No

 ** MemoryGiBPerVCpu **   
The minimum and maximum amount of memory per vCPU, in GiB.  
Default: No minimum or maximum limits  
Type: [MemoryGiBPerVCpuRequest](API_MemoryGiBPerVCpuRequest.md) object  
Required: No

 ** NetworkBandwidthGbps **   
The minimum and maximum amount of baseline network bandwidth, in gigabits per second (Gbps). For more information, see [Amazon EC2 instance network bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html) in the *Amazon EC2 User Guide*.  
Default: No minimum or maximum limits  
Type: [NetworkBandwidthGbpsRequest](API_NetworkBandwidthGbpsRequest.md) object  
Required: No

 ** NetworkInterfaceCount **   
The minimum and maximum number of network interfaces.  
Default: No minimum or maximum limits  
Type: [NetworkInterfaceCountRequest](API_NetworkInterfaceCountRequest.md) object  
Required: No

 ** OnDemandMaxPricePercentageOverLowestPrice **   
[Price protection] The price protection threshold for On-Demand Instances, as a percentage higher than an identified On-Demand price. The identified On-Demand price is the price of the lowest priced current generation C, M, or R instance type with your specified attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose price exceeds your specified threshold.  
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.  
To indicate no price protection threshold, specify a high value, such as `999999`.  
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).  
If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib`, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.
Default: `20`   
Type: Integer  
Required: No

 ** RequireEncryptionInTransit **   
Specifies whether instance types must support encrypting in-transit traffic between instances. For more information, including the supported instance types, see [Encryption in transit](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data-protection.html#encryption-transit) in the *Amazon EC2 User Guide*.  
Default: `false`   
Type: Boolean  
Required: No

 ** RequireHibernateSupport **   
Indicates whether instance types must support hibernation for On-Demand Instances.  
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html).  
Default: `false`   
Type: Boolean  
Required: No

 ** SpotMaxPricePercentageOverLowestPrice **   
[Price protection] The price protection threshold for Spot Instances, as a percentage higher than an identified Spot price. The identified Spot price is the Spot price of the lowest priced current generation C, M, or R instance type with your specified attributes. If no current generation C, M, or R instance type matches your attributes, then the identified Spot price is from the lowest priced current generation instance types, and failing that, from the lowest priced previous generation instance types that match your attributes. When Amazon EC2 selects instance types with your attributes, it will exclude instance types whose Spot price exceeds your specified threshold.  
The parameter accepts an integer, which Amazon EC2 interprets as a percentage.  
If you set `TargetCapacityUnitType` to `vcpu` or `memory-mib`, the price protection threshold is applied based on the per-vCPU or per-memory price instead of the per-instance price.  
This parameter is not supported for [GetSpotPlacementScores](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetSpotPlacementScores.html) and [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements.html).  
Only one of `SpotMaxPricePercentageOverLowestPrice` or `MaxSpotPriceAsPercentageOfOptimalOnDemandPrice` can be specified. If you don't specify either, Amazon EC2 will automatically apply optimal price protection to consistently select from a wide range of instance types. To indicate no price protection threshold for Spot Instances, meaning you want to consider all instance types that match your attributes, include one of these parameters and specify a high value, such as `999999`.
Default: `100`   
Type: Integer  
Required: No

 ** TotalLocalStorageGB **   
The minimum and maximum amount of total local storage, in GB.  
Default: No minimum or maximum limits  
Type: [TotalLocalStorageGBRequest](API_TotalLocalStorageGBRequest.md) object  
Required: No

## See Also
<a name="API_InstanceRequirementsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceRequirementsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceRequirementsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceRequirementsRequest) 

# InstanceRequirementsWithMetadataRequest
<a name="API_InstanceRequirementsWithMetadataRequest"></a>

The architecture type, virtualization type, and other attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.

If you specify `InstanceRequirementsWithMetadataRequest`, you can't specify `InstanceTypes`.

## Contents
<a name="API_InstanceRequirementsWithMetadataRequest_Contents"></a>

 ** ArchitectureType.N **   
The 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: No

 ** InstanceRequirements **   
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.  
Type: [InstanceRequirementsRequest](API_InstanceRequirementsRequest.md) object  
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: No

## See Also
<a name="API_InstanceRequirementsWithMetadataRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceRequirementsWithMetadataRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceRequirementsWithMetadataRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceRequirementsWithMetadataRequest) 

# InstanceSecondaryInterface
<a name="API_InstanceSecondaryInterface"></a>

Describes a secondary interface attached to an instance.

## Contents
<a name="API_InstanceSecondaryInterface_Contents"></a>

 ** attachment **   
The attachment information for the secondary interface.  
Type: [InstanceSecondaryInterfaceAttachment](API_InstanceSecondaryInterfaceAttachment.md) object  
Required: No

 ** interfaceType **   
The type of secondary interface.  
Type: String  
Valid Values: `secondary`   
Required: No

 ** macAddress **   
The MAC address of the secondary interface.  
Type: String  
Required: No

 ** ownerId **   
The AWS account ID of the owner of the secondary interface.  
Type: String  
Required: No

 ** PrivateIpAddressSet.N **   
The private IPv4 addresses associated with the secondary interface.  
Type: Array of [InstanceSecondaryInterfacePrivateIpAddress](API_InstanceSecondaryInterfacePrivateIpAddress.md) objects  
Required: No

 ** secondaryInterfaceId **   
The ID of the secondary interface.  
Type: String  
Required: No

 ** secondaryNetworkId **   
The ID of the secondary network.  
Type: String  
Required: No

 ** secondarySubnetId **   
The ID of the secondary subnet.  
Type: String  
Required: No

 ** sourceDestCheck **   
Indicates whether source/destination checking is enabled.  
Type: Boolean  
Required: No

 ** status **   
The status of the secondary interface.  
Type: String  
Valid Values: `available | in-use`   
Required: No

## See Also
<a name="API_InstanceSecondaryInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceSecondaryInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceSecondaryInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceSecondaryInterface) 

# InstanceSecondaryInterfaceAttachment
<a name="API_InstanceSecondaryInterfaceAttachment"></a>

Describes the attachment of a secondary interface to an instance.

## Contents
<a name="API_InstanceSecondaryInterfaceAttachment_Contents"></a>

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

 ** attachTime **   
The timestamp when the attachment was created.  
Type: Timestamp  
Required: No

 ** deleteOnTermination **   
Indicates whether the secondary interface is deleted when the instance is terminated.  
The only supported value for this field is `true`.  
Type: Boolean  
Required: No

 ** deviceIndex **   
The device index of the secondary interface.  
Type: Integer  
Required: No

 ** networkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

 ** status **   
The attachment state.  
Type: String  
Valid Values: `attaching | attached | detaching | detached`   
Required: No

## See Also
<a name="API_InstanceSecondaryInterfaceAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceSecondaryInterfaceAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceSecondaryInterfaceAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceSecondaryInterfaceAttachment) 

# InstanceSecondaryInterfacePrivateIpAddress
<a name="API_InstanceSecondaryInterfacePrivateIpAddress"></a>

Describes a private IPv4 address for a secondary interface.

## Contents
<a name="API_InstanceSecondaryInterfacePrivateIpAddress_Contents"></a>

 ** privateIpAddress **   
The private IPv4 address.  
Type: String  
Required: No

## See Also
<a name="API_InstanceSecondaryInterfacePrivateIpAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceSecondaryInterfacePrivateIpAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceSecondaryInterfacePrivateIpAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceSecondaryInterfacePrivateIpAddress) 

# InstanceSecondaryInterfacePrivateIpAddressRequest
<a name="API_InstanceSecondaryInterfacePrivateIpAddressRequest"></a>

Describes a private IPv4 address for a secondary interface request.

## Contents
<a name="API_InstanceSecondaryInterfacePrivateIpAddressRequest_Contents"></a>

 ** PrivateIpAddress **   
The private IPv4 address.  
Type: String  
Required: Yes

## See Also
<a name="API_InstanceSecondaryInterfacePrivateIpAddressRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceSecondaryInterfacePrivateIpAddressRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceSecondaryInterfacePrivateIpAddressRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceSecondaryInterfacePrivateIpAddressRequest) 

# InstanceSecondaryInterfaceSpecificationRequest
<a name="API_InstanceSecondaryInterfaceSpecificationRequest"></a>

Describes a secondary interface specification for launching an instance.

## Contents
<a name="API_InstanceSecondaryInterfaceSpecificationRequest_Contents"></a>

 ** DeleteOnTermination **   
Indicates whether the secondary interface is deleted when the instance is terminated.  
The only supported value for this field is `true`.  
Type: Boolean  
Required: No

 ** DeviceIndex **   
The device index for the secondary interface attachment.  
Type: Integer  
Required: No

 ** InterfaceType **   
The type of secondary interface.  
Type: String  
Valid Values: `secondary`   
Required: No

 ** NetworkCardIndex **   
The index of the network card. The network card must support secondary interfaces.  
Type: Integer  
Required: No

 ** PrivateIpAddress.N **   
The private IPv4 addresses to assign to the secondary interface.  
Type: Array of [InstanceSecondaryInterfacePrivateIpAddressRequest](API_InstanceSecondaryInterfacePrivateIpAddressRequest.md) objects  
Required: No

 ** PrivateIpAddressCount **   
The number of private IPv4 addresses to assign to the secondary interface.  
Type: Integer  
Required: No

 ** SecondarySubnetId **   
The ID of the secondary subnet.  
Type: String  
Required: No

## See Also
<a name="API_InstanceSecondaryInterfaceSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceSecondaryInterfaceSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceSecondaryInterfaceSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceSecondaryInterfaceSpecificationRequest) 

# InstanceSpecification
<a name="API_InstanceSpecification"></a>

The instance details to specify which volumes should be snapshotted.

## Contents
<a name="API_InstanceSpecification_Contents"></a>

 ** InstanceId **   
The instance to specify which volumes should be snapshotted.  
Type: String  
Required: Yes

 ** ExcludeBootVolume **   
Excludes the root volume from being snapshotted.  
Type: Boolean  
Required: No

 ** ExcludeDataVolumeId.N **   
The IDs of the data (non-root) volumes to exclude from the multi-volume snapshot set. If you specify the ID of the root volume, the request fails. To exclude the root volume, use **ExcludeBootVolume**.  
You can specify up to 40 volume IDs per request.  
Type: Array of strings  
Required: No

## See Also
<a name="API_InstanceSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceSpecification) 

# InstanceState
<a name="API_InstanceState"></a>

Describes the current state of an instance.

## Contents
<a name="API_InstanceState_Contents"></a>

 ** code **   
The state of the instance as a 16-bit unsigned integer.   
The high byte is all of the bits between 2^8 and (2^16)-1, which equals decimal values between 256 and 65,535. These numerical values are used for internal purposes and should be ignored.  
The low byte is all of the bits between 2^0 and (2^8)-1, which equals decimal values between 0 and 255.   
The valid values for instance-state-code will all be in the range of the low byte and they are:  
+  `0` : `pending` 
+  `16` : `running` 
+  `32` : `shutting-down` 
+  `48` : `terminated` 
+  `64` : `stopping` 
+  `80` : `stopped` 
You can ignore the high byte value by zeroing out all of the bits above 2^8 or 256 in decimal.  
Type: Integer  
Required: No

 ** name **   
The current state of the instance.  
Type: String  
Valid Values: `pending | running | shutting-down | terminated | stopping | stopped`   
Required: No

## See Also
<a name="API_InstanceState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceState) 

# InstanceStateChange
<a name="API_InstanceStateChange"></a>

Describes an instance state change.

## Contents
<a name="API_InstanceStateChange_Contents"></a>

 ** currentState **   
The current state of the instance.  
Type: [InstanceState](API_InstanceState.md) object  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** previousState **   
The previous state of the instance.  
Type: [InstanceState](API_InstanceState.md) object  
Required: No

## See Also
<a name="API_InstanceStateChange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceStateChange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceStateChange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceStateChange) 

# InstanceStatus
<a name="API_InstanceStatus"></a>

Describes the status of an instance.

## Contents
<a name="API_InstanceStatus_Contents"></a>

 ** attachedEbsStatus **   
Reports impaired functionality that stems from an attached Amazon EBS volume that is unreachable and unable to complete I/O operations.  
Type: [EbsStatusSummary](API_EbsStatusSummary.md) object  
Required: No

 ** availabilityZone **   
The Availability Zone of the instance.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone of the instance.  
Type: String  
Required: No

 ** EventsSet.N **   
Any scheduled events associated with the instance.  
Type: Array of [InstanceStatusEvent](API_InstanceStatusEvent.md) objects  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** instanceState **   
The intended state of the instance. [DescribeInstanceStatus](API_DescribeInstanceStatus.md) requires that an instance be in the `running` state.  
Type: [InstanceState](API_InstanceState.md) object  
Required: No

 ** instanceStatus **   
Reports impaired functionality that stems from issues internal to the instance, such as impaired reachability.  
Type: [InstanceStatusSummary](API_InstanceStatusSummary.md) object  
Required: No

 ** operator **   
The service provider that manages the instance.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** systemStatus **   
Reports impaired functionality that stems from issues related to the systems that support an instance, such as hardware failures and network connectivity problems.  
Type: [InstanceStatusSummary](API_InstanceStatusSummary.md) object  
Required: No

## See Also
<a name="API_InstanceStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceStatus) 

# InstanceStatusDetails
<a name="API_InstanceStatusDetails"></a>

Describes the instance status.

## Contents
<a name="API_InstanceStatusDetails_Contents"></a>

 ** impairedSince **   
The time when a status check failed. For an instance that was launched and impaired, this is the time when the instance was launched.  
Type: Timestamp  
Required: No

 ** name **   
The type of instance status.  
Type: String  
Valid Values: `reachability`   
Required: No

 ** status **   
The status.  
Type: String  
Valid Values: `passed | failed | insufficient-data | initializing`   
Required: No

## See Also
<a name="API_InstanceStatusDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceStatusDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceStatusDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceStatusDetails) 

# InstanceStatusEvent
<a name="API_InstanceStatusEvent"></a>

Describes a scheduled event for an instance.

## Contents
<a name="API_InstanceStatusEvent_Contents"></a>

 ** code **   
The event code.  
Type: String  
Valid Values: `instance-reboot | system-reboot | system-maintenance | instance-retirement | instance-stop`   
Required: No

 ** description **   
A description of the event.  
After a scheduled event is completed, it can still be described for up to a week. If the event has been completed, this description starts with the following text: [Completed].  
Type: String  
Required: No

 ** instanceEventId **   
The ID of the event.  
Type: String  
Required: No

 ** notAfter **   
The latest scheduled end time for the event.  
Type: Timestamp  
Required: No

 ** notBefore **   
The earliest scheduled start time for the event.  
Type: Timestamp  
Required: No

 ** notBeforeDeadline **   
The deadline for starting the event.  
Type: Timestamp  
Required: No

## See Also
<a name="API_InstanceStatusEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceStatusEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceStatusEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceStatusEvent) 

# InstanceStatusSummary
<a name="API_InstanceStatusSummary"></a>

Describes the status of an instance.

## Contents
<a name="API_InstanceStatusSummary_Contents"></a>

 ** Details.N **   
The system instance health or application instance health.  
Type: Array of [InstanceStatusDetails](API_InstanceStatusDetails.md) objects  
Required: No

 ** status **   
The status.  
Type: String  
Valid Values: `ok | impaired | insufficient-data | not-applicable | initializing`   
Required: No

## See Also
<a name="API_InstanceStatusSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceStatusSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceStatusSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceStatusSummary) 

# InstanceStorageInfo
<a name="API_InstanceStorageInfo"></a>

Describes the instance store features that are supported by the instance type.

## Contents
<a name="API_InstanceStorageInfo_Contents"></a>

 ** Disks.N **   
Describes the disks that are available for the instance type.  
Type: Array of [DiskInfo](API_DiskInfo.md) objects  
Required: No

 ** encryptionSupport **   
Indicates whether data is encrypted at rest.  
Type: String  
Valid Values: `unsupported | required`   
Required: No

 ** nvmeSupport **   
Indicates whether non-volatile memory express (NVMe) is supported.  
Type: String  
Valid Values: `unsupported | supported | required`   
Required: No

 ** totalSizeInGB **   
The total size of the disks, in GB.  
Type: Long  
Required: No

## See Also
<a name="API_InstanceStorageInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceStorageInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceStorageInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceStorageInfo) 

# InstanceTagNotificationAttribute
<a name="API_InstanceTagNotificationAttribute"></a>

Describes the registered tag keys for the current Region.

## Contents
<a name="API_InstanceTagNotificationAttribute_Contents"></a>

 ** includeAllTagsOfInstance **   
Indicates wheter all tag keys in the current Region are registered to appear in scheduled event notifications. `true` indicates that all tag keys in the current Region are registered.  
Type: Boolean  
Required: No

 ** InstanceTagKeySet.N **   
The registered tag keys.  
Type: Array of strings  
Required: No

## See Also
<a name="API_InstanceTagNotificationAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceTagNotificationAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceTagNotificationAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceTagNotificationAttribute) 

# InstanceTopology
<a name="API_InstanceTopology"></a>

Information about the instance topology.

## Contents
<a name="API_InstanceTopology_Contents"></a>

 ** availabilityZone **   
The name of the Availability Zone or Local Zone that the instance is in.  
Type: String  
Required: No

 ** capacityBlockId **   
The ID of the Capacity Block. This parameter is only supported for UltraServer instances and identifies instances within the UltraServer domain.  
Type: String  
Required: No

 ** groupName **   
The name of the placement group that the instance is in.  
Type: String  
Required: No

 ** instanceId **   
The instance ID.  
Type: String  
Required: No

 ** instanceType **   
The instance type.  
Type: String  
Required: No

 ** NetworkNodeSet.N **   
The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings.  
The value is `null` or empty if:  
+ The instance type is not supported.
+ The instance is in a state other than `running`.
Type: Array of strings  
Required: No

 ** zoneId **   
The ID of the Availability Zone or Local Zone that the instance is in.  
Type: String  
Required: No

## See Also
<a name="API_InstanceTopology_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceTopology) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceTopology) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceTopology) 

# InstanceTypeInfo
<a name="API_InstanceTypeInfo"></a>

Describes the instance type.

## Contents
<a name="API_InstanceTypeInfo_Contents"></a>

 ** autoRecoverySupported **   
Indicates whether Amazon CloudWatch action based recovery is supported.  
Type: Boolean  
Required: No

 ** bareMetal **   
Indicates whether the instance is a bare metal instance type.  
Type: Boolean  
Required: No

 ** burstablePerformanceSupported **   
Indicates whether the instance type is a burstable performance T instance type. For more information, see [Burstable performance instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances.html).  
Type: Boolean  
Required: No

 ** currentGeneration **   
Indicates whether the instance type is current generation.  
Type: Boolean  
Required: No

 ** dedicatedHostsSupported **   
Indicates whether Dedicated Hosts are supported on the instance type.  
Type: Boolean  
Required: No

 ** ebsInfo **   
Describes the Amazon EBS settings for the instance type.  
Type: [EbsInfo](API_EbsInfo.md) object  
Required: No

 ** fpgaInfo **   
Describes the FPGA accelerator settings for the instance type.  
Type: [FpgaInfo](API_FpgaInfo.md) object  
Required: No

 ** freeTierEligible **   
Indicates whether the instance type is eligible for the free tier.  
Type: Boolean  
Required: No

 ** gpuInfo **   
Describes the GPU accelerator settings for the instance type.  
Type: [GpuInfo](API_GpuInfo.md) object  
Required: No

 ** hibernationSupported **   
Indicates whether On-Demand hibernation is supported.  
Type: Boolean  
Required: No

 ** hypervisor **   
The hypervisor for the instance type.  
Type: String  
Valid Values: `nitro | xen`   
Required: No

 ** inferenceAcceleratorInfo **   
Describes the Inference accelerator settings for the instance type.  
Type: [InferenceAcceleratorInfo](API_InferenceAcceleratorInfo.md) object  
Required: No

 ** instanceStorageInfo **   
Describes the instance storage for the instance type.  
Type: [InstanceStorageInfo](API_InstanceStorageInfo.md) object  
Required: No

 ** instanceStorageSupported **   
Indicates whether instance storage is supported.  
Type: Boolean  
Required: No

 ** instanceType **   
The instance type. 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  
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

 ** mediaAcceleratorInfo **   
Describes the media accelerator settings for the instance type.  
Type: [MediaAcceleratorInfo](API_MediaAcceleratorInfo.md) object  
Required: No

 ** memoryInfo **   
Describes the memory for the instance type.  
Type: [MemoryInfo](API_MemoryInfo.md) object  
Required: No

 ** networkInfo **   
Describes the network settings for the instance type.  
Type: [NetworkInfo](API_NetworkInfo.md) object  
Required: No

 ** neuronInfo **   
Describes the Neuron accelerator settings for the instance type.  
Type: [NeuronInfo](API_NeuronInfo.md) object  
Required: No

 ** nitroEnclavesSupport **   
Indicates whether Nitro Enclaves is supported.  
Type: String  
Valid Values: `unsupported | supported`   
Required: No

 ** nitroTpmInfo **   
Describes the supported NitroTPM versions for the instance type.  
Type: [NitroTpmInfo](API_NitroTpmInfo.md) object  
Required: No

 ** nitroTpmSupport **   
Indicates whether NitroTPM is supported.  
Type: String  
Valid Values: `unsupported | supported`   
Required: No

 ** phcSupport **   
Indicates whether a local Precision Time Protocol (PTP) hardware clock (PHC) is supported.  
Type: String  
Valid Values: `unsupported | supported`   
Required: No

 ** placementGroupInfo **   
Describes the placement group settings for the instance type.  
Type: [PlacementGroupInfo](API_PlacementGroupInfo.md) object  
Required: No

 ** processorInfo **   
Describes the processor.  
Type: [ProcessorInfo](API_ProcessorInfo.md) object  
Required: No

 ** rebootMigrationSupport **   
Indicates whether reboot migration during a user-initiated reboot is supported for instances that have a scheduled `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) in the *Amazon EC2 User Guide*.  
Type: String  
Valid Values: `unsupported | supported`   
Required: No

 ** SupportedBootModes.N **   
The supported boot modes. For more information, see [Boot modes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ami-boot.html) in the *Amazon EC2 User Guide*.  
Type: Array of strings  
Valid Values: `legacy-bios | uefi`   
Required: No

 ** SupportedRootDeviceTypes.N **   
The supported root device types.  
Type: Array of strings  
Valid Values: `ebs | instance-store`   
Required: No

 ** SupportedUsageClasses.N **   
Indicates whether the instance type is offered for spot, On-Demand, or Capacity Blocks.  
Type: Array of strings  
Valid Values: `spot | on-demand | capacity-block`   
Required: No

 ** SupportedVirtualizationTypes.N **   
The supported virtualization types.  
Type: Array of strings  
Valid Values: `hvm | paravirtual`   
Required: No

 ** vCpuInfo **   
Describes the vCPU configurations for the instance type.  
Type: [VCpuInfo](API_VCpuInfo.md) object  
Required: No

## See Also
<a name="API_InstanceTypeInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceTypeInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceTypeInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceTypeInfo) 

# InstanceTypeInfoFromInstanceRequirements
<a name="API_InstanceTypeInfoFromInstanceRequirements"></a>

The list of instance types with the specified instance attributes.

## Contents
<a name="API_InstanceTypeInfoFromInstanceRequirements_Contents"></a>

 ** instanceType **   
The matching instance type.  
Type: String  
Required: No

## See Also
<a name="API_InstanceTypeInfoFromInstanceRequirements_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceTypeInfoFromInstanceRequirements) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceTypeInfoFromInstanceRequirements) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceTypeInfoFromInstanceRequirements) 

# InstanceTypeOffering
<a name="API_InstanceTypeOffering"></a>

The instance types offered.

## Contents
<a name="API_InstanceTypeOffering_Contents"></a>

 ** instanceType **   
The instance type. 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  
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

 ** location **   
The identifier for the location. This depends on the location type. For example, if the location type is `region`, the location is the Region code (for example, `us-east-2`.)  
Type: String  
Required: No

 ** locationType **   
The location type.  
Type: String  
Valid Values: `region | availability-zone | availability-zone-id | outpost`   
Required: No

## See Also
<a name="API_InstanceTypeOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceTypeOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceTypeOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceTypeOffering) 

# InstanceUsage
<a name="API_InstanceUsage"></a>

Information about the Capacity Reservation usage.

## Contents
<a name="API_InstanceUsage_Contents"></a>

 ** accountId **   
The ID of the AWS account that is making use of the Capacity Reservation.  
Type: String  
Required: No

 ** usedInstanceCount **   
The number of instances the AWS account currently has in the Capacity Reservation.  
Type: Integer  
Required: No

## See Also
<a name="API_InstanceUsage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InstanceUsage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InstanceUsage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InstanceUsage) 

# IntegrateServices
<a name="API_IntegrateServices"></a>

Describes service integrations with VPC Flow logs.

## Contents
<a name="API_IntegrateServices_Contents"></a>

 ** AthenaIntegration.N **   
Information about the integration with Amazon Athena.  
Type: Array of [AthenaIntegration](API_AthenaIntegration.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

## See Also
<a name="API_IntegrateServices_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IntegrateServices) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IntegrateServices) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IntegrateServices) 

# InternetGateway
<a name="API_InternetGateway"></a>

Describes an internet gateway.

## Contents
<a name="API_InternetGateway_Contents"></a>

 ** AttachmentSet.N **   
Any VPCs attached to the internet gateway.  
Type: Array of [InternetGatewayAttachment](API_InternetGatewayAttachment.md) objects  
Required: No

 ** internetGatewayId **   
The ID of the internet gateway.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the internet gateway.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the internet gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_InternetGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InternetGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InternetGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InternetGateway) 

# InternetGatewayAttachment
<a name="API_InternetGatewayAttachment"></a>

Describes the attachment of a VPC to an internet gateway or an egress-only internet gateway.

## Contents
<a name="API_InternetGatewayAttachment_Contents"></a>

 ** state **   
The current state of the attachment. For an internet gateway, the state is `available` when attached to a VPC; otherwise, this value is not returned.  
Type: String  
Valid Values: `attaching | attached | detaching | detached`   
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_InternetGatewayAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InternetGatewayAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InternetGatewayAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InternetGatewayAttachment) 

# InterruptibleCapacityAllocation
<a name="API_InterruptibleCapacityAllocation"></a>

 Represents the allocation of capacity from a source reservation to an interruptible reservation, tracking current and target instance counts for allocation management. 

## Contents
<a name="API_InterruptibleCapacityAllocation_Contents"></a>

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

 ** interruptibleCapacityReservationId **   
 The ID of the interruptible Capacity Reservation created from the allocation.   
Type: String  
Required: No

 ** interruptionType **   
 The type of interruption policy applied to the interruptible reservation.   
Type: String  
Valid Values: `adhoc`   
Required: No

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

 ** targetInstanceCount **   
 After your modify request, the requested number of instances allocated to interruptible reservation.   
Type: Integer  
Required: No

## See Also
<a name="API_InterruptibleCapacityAllocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InterruptibleCapacityAllocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InterruptibleCapacityAllocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InterruptibleCapacityAllocation) 

# InterruptionInfo
<a name="API_InterruptionInfo"></a>

 Contains information about how and when instances in an interruptible reservation can be terminated when capacity is reclaimed. 

## Contents
<a name="API_InterruptionInfo_Contents"></a>

 ** interruptionType **   
 The interruption type that determines how instances are terminated when capacity is reclaimed.   
Type: String  
Valid Values: `adhoc`   
Required: No

 ** sourceCapacityReservationId **   
 The ID of the source Capacity Reservation from which the interruptible reservation was created.   
Type: String  
Required: No

## See Also
<a name="API_InterruptionInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/InterruptionInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/InterruptionInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/InterruptionInfo) 

# Ipam
<a name="API_Ipam"></a>

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*.

## Contents
<a name="API_Ipam_Contents"></a>

 ** defaultResourceDiscoveryAssociationId **   
The IPAM's default resource discovery association ID.  
Type: String  
Required: No

 ** defaultResourceDiscoveryId **   
The IPAM's default resource discovery ID.  
Type: String  
Required: No

 ** description **   
The description for the IPAM.  
Type: String  
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

 ** ipamArn **   
The Amazon Resource Name (ARN) of the IPAM.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamId **   
The ID of the IPAM.  
Type: String  
Required: No

 ** ipamRegion **   
The AWS Region of the IPAM.  
Type: String  
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

 ** OperatingRegionSet.N **   
The operating Regions for an 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 [IpamOperatingRegion](API_IpamOperatingRegion.md) objects  
Required: No

 ** ownerId **   
The AWS account ID of the owner of the IPAM.  
Type: String  
Required: No

 ** privateDefaultScopeId **   
The ID of the IPAM's default private scope.  
Type: String  
Required: No

 ** publicDefaultScopeId **   
The ID of the IPAM's default public scope.  
Type: String  
Required: No

 ** resourceDiscoveryAssociationCount **   
The IPAM's resource discovery association count.  
Type: Integer  
Required: No

 ** scopeCount **   
The number of scopes in the IPAM. The scope quota is 5. For more information on quotas, see [Quotas in IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*.   
Type: Integer  
Required: No

 ** state **   
The state of the IPAM.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** stateMessage **   
The state message.  
Type: String  
Required: No

 ** TagSet.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 [Tag](API_Tag.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

## See Also
<a name="API_Ipam_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipam) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipam) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipam) 

# IpamAddressHistoryRecord
<a name="API_IpamAddressHistoryRecord"></a>

The historical record of 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*. 

## Contents
<a name="API_IpamAddressHistoryRecord_Contents"></a>

 ** resourceCidr **   
The CIDR of the resource.  
Type: String  
Required: No

 ** resourceComplianceStatus **   
The compliance status of a resource. For more information on compliance statuses, see [Monitor CIDR usage by resource](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) in the *Amazon VPC IPAM User Guide*.  
Type: String  
Valid Values: `compliant | noncompliant | unmanaged | ignored`   
Required: No

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceName **   
The name of the resource.  
Type: String  
Required: No

 ** resourceOverlapStatus **   
The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see [Monitor CIDR usage by resource](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) in the *Amazon VPC IPAM User Guide*.  
Type: String  
Valid Values: `overlapping | nonoverlapping | ignored`   
Required: No

 ** resourceOwnerId **   
The ID of the resource owner.  
Type: String  
Required: No

 ** resourceRegion **   
The AWS Region of the resource.  
Type: String  
Required: No

 ** resourceType **   
The type of the resource.  
Type: String  
Valid Values: `eip | vpc | subnet | network-interface | instance`   
Required: No

 ** sampledEndTime **   
Sampled end time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the end time may have occurred before this specific time.  
Type: Timestamp  
Required: No

 ** sampledStartTime **   
Sampled start time of the resource-to-CIDR association within the IPAM scope. Changes are picked up in periodic snapshots, so the start time may have occurred before this specific time.  
Type: Timestamp  
Required: No

 ** vpcId **   
The VPC ID of the resource.  
Type: String  
Required: No

## See Also
<a name="API_IpamAddressHistoryRecord_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamAddressHistoryRecord) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamAddressHistoryRecord) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamAddressHistoryRecord) 

# IpamCidrAuthorizationContext
<a name="API_IpamCidrAuthorizationContext"></a>

A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.

## Contents
<a name="API_IpamCidrAuthorizationContext_Contents"></a>

 ** Message **   
The plain-text authorization message for the prefix and account.  
Type: String  
Required: No

 ** Signature **   
The signed authorization message for the prefix and account.  
Type: String  
Required: No

## See Also
<a name="API_IpamCidrAuthorizationContext_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamCidrAuthorizationContext) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamCidrAuthorizationContext) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamCidrAuthorizationContext) 

# IpamDiscoveredAccount
<a name="API_IpamDiscoveredAccount"></a>

An IPAM discovered account. 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.

## Contents
<a name="API_IpamDiscoveredAccount_Contents"></a>

 ** accountId **   
The account ID.  
Type: String  
Required: No

 ** discoveryRegion **   
The AWS Region that the account information is returned from. An account can be discovered in multiple regions and will have a separate discovered account for each Region.  
Type: String  
Required: No

 ** failureReason **   
The resource discovery failure reason.  
Type: [IpamDiscoveryFailureReason](API_IpamDiscoveryFailureReason.md) object  
Required: No

 ** lastAttemptedDiscoveryTime **   
The last attempted resource discovery time.  
Type: Timestamp  
Required: No

 ** lastSuccessfulDiscoveryTime **   
The last successful resource discovery time.  
Type: Timestamp  
Required: No

 ** organizationalUnitId **   
The ID of an Organizational Unit in AWS Organizations.  
Type: String  
Required: No

## See Also
<a name="API_IpamDiscoveredAccount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamDiscoveredAccount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamDiscoveredAccount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamDiscoveredAccount) 

# IpamDiscoveredPublicAddress
<a name="API_IpamDiscoveredPublicAddress"></a>

A public IP Address discovered by IPAM.

## Contents
<a name="API_IpamDiscoveredPublicAddress_Contents"></a>

 ** address **   
The IP address.  
Type: String  
Required: No

 ** addressAllocationId **   
The allocation ID of the resource the IP address is assigned to.  
Type: String  
Required: No

 ** addressOwnerId **   
The ID of the owner of the resource the IP address is assigned to.  
Type: String  
Required: No

 ** addressRegion **   
The Region of the resource the IP address is assigned to.  
Type: String  
Required: No

 ** addressType **   
The IP address type.  
Type: String  
Valid Values: `service-managed-ip | service-managed-byoip | amazon-owned-eip | amazon-owned-contig | byoip | ec2-public-ip | anycast-ip-list-ip`   
Required: No

 ** associationStatus **   
The association status.  
Type: String  
Valid Values: `associated | disassociated`   
Required: No

 ** instanceId **   
The instance ID of the instance the assigned IP address is assigned to.  
Type: String  
Required: No

 ** ipamResourceDiscoveryId **   
The resource discovery ID.  
Type: String  
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

 ** networkInterfaceDescription **   
The description of the network interface that IP address is assigned to.  
Type: String  
Required: No

 ** networkInterfaceId **   
The network interface ID of the resource with the assigned IP address.  
Type: String  
Required: No

 ** publicIpv4PoolId **   
The ID of the public IPv4 pool that the resource with the assigned IP address is from.  
Type: String  
Required: No

 ** sampleTime **   
The last successful resource discovery time.  
Type: Timestamp  
Required: No

 ** SecurityGroupSet.N **   
Security groups associated with the resource that the IP address is assigned to.  
Type: Array of [IpamPublicAddressSecurityGroup](API_IpamPublicAddressSecurityGroup.md) objects  
Required: No

 ** service **   
The AWS service associated with the IP address.  
Type: String  
Valid Values: `nat-gateway | database-migration-service | redshift | elastic-container-service | relational-database-service | site-to-site-vpn | load-balancer | global-accelerator | cloudfront | other`   
Required: No

 ** serviceResource **   
The resource ARN or ID.  
Type: String  
Required: No

 ** subnetId **   
The ID of the subnet that the resource with the assigned IP address is in.  
Type: String  
Required: No

 ** tags **   
Tags associated with the IP address.  
Type: [IpamPublicAddressTags](API_IpamPublicAddressTags.md) object  
Required: No

 ** vpcId **   
The ID of the VPC that the resource with the assigned IP address is in.  
Type: String  
Required: No

## See Also
<a name="API_IpamDiscoveredPublicAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamDiscoveredPublicAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamDiscoveredPublicAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamDiscoveredPublicAddress) 

# IpamDiscoveredResourceCidr
<a name="API_IpamDiscoveredResourceCidr"></a>

An IPAM discovered resource CIDR. 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. The discovered resource CIDR is the IP address range in CIDR notation that is associated with the resource.

## Contents
<a name="API_IpamDiscoveredResourceCidr_Contents"></a>

 ** availabilityZoneId **   
The Availability Zone ID.  
Type: String  
Required: No

 ** ipamResourceDiscoveryId **   
The resource discovery ID.  
Type: String  
Required: No

 ** ipSource **   
The source that allocated the IP address space. `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.  
Type: String  
Valid Values: `amazon | byoip | none`   
Required: No

 ** ipUsage **   
The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:  
+ For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. 
+ For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated. 
+ For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs). 
Type: Double  
Required: No

 ** networkInterfaceAttachmentStatus **   
For elastic network interfaces, this is the status of whether or not the elastic network interface is attached.  
Type: String  
Valid Values: `available | in-use`   
Required: No

 ** resourceCidr **   
The resource CIDR.  
Type: String  
Required: No

 ** resourceId **   
The resource ID.  
Type: String  
Required: No

 ** resourceOwnerId **   
The resource owner ID.  
Type: String  
Required: No

 ** resourceRegion **   
The resource Region.  
Type: String  
Required: No

 ** ResourceTagSet.N **   
The resource tags.  
Type: Array of [IpamResourceTag](API_IpamResourceTag.md) objects  
Required: No

 ** resourceType **   
The resource type.  
Type: String  
Valid Values: `vpc | subnet | eip | public-ipv4-pool | ipv6-pool | eni | anycast-ip-list`   
Required: No

 ** sampleTime **   
The last successful resource discovery time.  
Type: Timestamp  
Required: No

 ** subnetId **   
The subnet ID.  
Type: String  
Required: No

 ** vpcId **   
The VPC ID.  
Type: String  
Required: No

## See Also
<a name="API_IpamDiscoveredResourceCidr_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamDiscoveredResourceCidr) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamDiscoveredResourceCidr) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamDiscoveredResourceCidr) 

# IpamDiscoveryFailureReason
<a name="API_IpamDiscoveryFailureReason"></a>

The discovery failure reason.

## Contents
<a name="API_IpamDiscoveryFailureReason_Contents"></a>

 ** code **   
The discovery failure code.  
+  `assume-role-failure` - IPAM could not assume the AWS IAM service-linked role. This could be because of any of the following:
  + SLR has not been created yet and IPAM is still creating it.
  + You have opted-out of the IPAM home Region.
  + Account you are using as your IPAM account has been suspended.
+  `throttling-failure` - IPAM account is already using the allotted transactions per second and IPAM is receiving a throttling error when assuming the AWS IAM SLR.
+  `unauthorized-failure` - AWS account making the request is not authorized. For more information, see [AuthFailure](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html) in the *Amazon Elastic Compute Cloud API Reference*.
Type: String  
Valid Values: `assume-role-failure | throttling-failure | unauthorized-failure`   
Required: No

 ** message **   
The discovery failure message.  
Type: String  
Required: No

## See Also
<a name="API_IpamDiscoveryFailureReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamDiscoveryFailureReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamDiscoveryFailureReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamDiscoveryFailureReason) 

# IpamExternalResourceVerificationToken
<a name="API_IpamExternalResourceVerificationToken"></a>

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). 

## Contents
<a name="API_IpamExternalResourceVerificationToken_Contents"></a>

 ** ipamArn **   
ARN of the IPAM that created the token.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamExternalResourceVerificationTokenArn **   
Token ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamExternalResourceVerificationTokenId **   
The ID of the token.  
Type: String  
Required: No

 ** ipamId **   
The ID of the IPAM that created the token.  
Type: String  
Required: No

 ** ipamRegion **   
Region of the IPAM that created the token.  
Type: String  
Required: No

 ** notAfter **   
Token expiration.  
Type: Timestamp  
Required: No

 ** state **   
Token state.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed`   
Required: No

 ** status **   
Token status.  
Type: String  
Valid Values: `valid | expired`   
Required: No

 ** TagSet.N **   
Token tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** tokenName **   
Token name.  
Type: String  
Required: No

 ** tokenValue **   
Token value.  
Type: String  
Required: No

## See Also
<a name="API_IpamExternalResourceVerificationToken_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamExternalResourceVerificationToken) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamExternalResourceVerificationToken) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamExternalResourceVerificationToken) 

# IpamOperatingRegion
<a name="API_IpamOperatingRegion"></a>

The operating Regions for an 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*.

## Contents
<a name="API_IpamOperatingRegion_Contents"></a>

 ** regionName **   
The name of the operating Region.  
Type: String  
Required: No

## See Also
<a name="API_IpamOperatingRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamOperatingRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamOperatingRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamOperatingRegion) 

# IpamOrganizationalUnitExclusion
<a name="API_IpamOrganizationalUnitExclusion"></a>

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.

## Contents
<a name="API_IpamOrganizationalUnitExclusion_Contents"></a>

 ** organizationsEntityPath **   
An AWS Organizations entity path. For more information on the entity path, see [Understand the AWS Organizations entity path](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_last-accessed-view-data-orgs.html#access_policies_access-advisor-viewing-orgs-entity-path) in the * AWS Identity and Access Management User Guide*.  
Type: String  
Required: No

## See Also
<a name="API_IpamOrganizationalUnitExclusion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamOrganizationalUnitExclusion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamOrganizationalUnitExclusion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamOrganizationalUnitExclusion) 

# IpamPolicy
<a name="API_IpamPolicy"></a>

Information about 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.

## Contents
<a name="API_IpamPolicy_Contents"></a>

 ** ipamId **   
The ID of the IPAM this policy belongs to.  
Type: String  
Required: No

 ** ipamPolicyArn **   
The Amazon Resource Name (ARN) of the IPAM policy.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamPolicyId **   
The ID of the IPAM policy.  
Type: String  
Required: No

 ** ipamPolicyRegion **   
The Region of the IPAM policy.  
Type: String  
Required: No

 ** ownerId **   
The account ID that owns the IPAM policy.  
Type: String  
Required: No

 ** state **   
The state of the IPAM policy.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** stateMessage **   
A message about the state of the IPAM policy.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the IPAM policy.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_IpamPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPolicy) 

# IpamPolicyAllocationRule
<a name="API_IpamPolicyAllocationRule"></a>

Information about an IPAM policy allocation rule.

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.

## Contents
<a name="API_IpamPolicyAllocationRule_Contents"></a>

 ** sourceIpamPoolId **   
The ID of the source IPAM pool for the allocation rule.  
An IPAM pool is a collection of IP addresses in IPAM that can be allocated to AWS resources.  
Type: String  
Required: No

## See Also
<a name="API_IpamPolicyAllocationRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPolicyAllocationRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPolicyAllocationRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPolicyAllocationRule) 

# IpamPolicyAllocationRuleRequest
<a name="API_IpamPolicyAllocationRuleRequest"></a>

Information about a requested IPAM policy allocation rule.

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.

## Contents
<a name="API_IpamPolicyAllocationRuleRequest_Contents"></a>

 ** SourceIpamPoolId **   
The ID of the source IPAM pool for the requested allocation rule.  
An IPAM pool is a collection of IP addresses in IPAM that can be allocated to AWS resources.  
Type: String  
Required: No

## See Also
<a name="API_IpamPolicyAllocationRuleRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPolicyAllocationRuleRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPolicyAllocationRuleRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPolicyAllocationRuleRequest) 

# IpamPolicyDocument
<a name="API_IpamPolicyDocument"></a>

Information about an IPAM policy.

## Contents
<a name="API_IpamPolicyDocument_Contents"></a>

 ** AllocationRuleSet.N **   
The allocation rules in the IPAM policy document.  
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 [IpamPolicyAllocationRule](API_IpamPolicyAllocationRule.md) objects  
Required: No

 ** ipamPolicyId **   
The ID of the IPAM policy.  
Type: String  
Required: No

 ** locale **   
The locale of the IPAM policy document.  
Type: String  
Required: No

 ** resourceType **   
The resource type of the IPAM policy document.  
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

## See Also
<a name="API_IpamPolicyDocument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPolicyDocument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPolicyDocument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPolicyDocument) 

# IpamPolicyOrganizationTarget
<a name="API_IpamPolicyOrganizationTarget"></a>

The AWS Organizations target for an IPAM policy.

## Contents
<a name="API_IpamPolicyOrganizationTarget_Contents"></a>

 ** organizationTargetId **   
The ID of the AWS Organizations target.  
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

## See Also
<a name="API_IpamPolicyOrganizationTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPolicyOrganizationTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPolicyOrganizationTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPolicyOrganizationTarget) 

# IpamPool
<a name="API_IpamPool"></a>

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.

## Contents
<a name="API_IpamPool_Contents"></a>

 ** addressFamily **   
The address family of the pool.  
Type: String  
Valid Values: `ipv4 | ipv6`   
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. 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

 ** AllocationResourceTagSet.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 [IpamResourceTag](API_IpamResourceTag.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

 ** description **   
The description of the IPAM pool.  
Type: String  
Required: No

 ** ipamArn **   
The ARN of the IPAM.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamPoolArn **   
The Amazon Resource Name (ARN) of the IPAM pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamPoolId **   
The ID of the IPAM pool.  
Type: String  
Required: No

 ** ipamRegion **   
The AWS Region of the IPAM pool.  
Type: String  
Required: No

 ** ipamScopeArn **   
The ARN of the scope of the IPAM pool.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamScopeType **   
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.  
Type: String  
Valid Values: `public | private`   
Required: No

 ** locale **   
The locale of the IPAM pool.  
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.
If you choose an AWS Region for locale that has not been configured as an operating Region for the IPAM, you'll get an error.  
Type: String  
Required: No

 ** ownerId **   
The AWS account ID of the owner of the IPAM pool.  
Type: String  
Required: No

 ** poolDepth **   
The depth of pools in your IPAM pool. The pool depth quota is 10. For more information, see [Quotas in IPAM](https://docs.aws.amazon.com/vpc/latest/ipam/quotas-ipam.html) in the *Amazon VPC IPAM User Guide*.   
Type: Integer  
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. 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 a pool is publicly advertisable. This option is not available for pools with AddressFamily set to `ipv4`.  
Type: Boolean  
Required: No

 ** sourceIpamPoolId **   
The ID of the source IPAM pool. You can use this option to create an IPAM pool within an existing source pool.  
Type: String  
Required: No

 ** sourceResource **   
The resource used to provision CIDRs to a resource planning pool.  
Type: [IpamPoolSourceResource](API_IpamPoolSourceResource.md) object  
Required: No

 ** state **   
The state of the IPAM pool.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** stateMessage **   
The state message.  
Type: String  
Required: No

 ** TagSet.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 [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_IpamPool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPool) 

# IpamPoolAllocation
<a name="API_IpamPoolAllocation"></a>

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

## Contents
<a name="API_IpamPoolAllocation_Contents"></a>

 ** cidr **   
The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23`. An IPv6 CIDR example is `2001:DB8::/32`.  
Type: String  
Required: No

 ** description **   
A description of the pool allocation.  
Type: String  
Required: No

 ** ipamPoolAllocationId **   
The ID of an allocation.  
Type: String  
Required: No

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceOwner **   
The owner of the resource.  
Type: String  
Required: No

 ** resourceRegion **   
The AWS Region of the resource.  
Type: String  
Required: No

 ** resourceType **   
The type of the resource.  
Type: String  
Valid Values: `ipam-pool | vpc | ec2-public-ipv4-pool | custom | subnet | eip | anycast-ip-list`   
Required: No

## See Also
<a name="API_IpamPoolAllocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPoolAllocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPoolAllocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPoolAllocation) 

# IpamPoolCidr
<a name="API_IpamPoolCidr"></a>

A CIDR provisioned to an IPAM pool.

## Contents
<a name="API_IpamPoolCidr_Contents"></a>

 ** cidr **   
The CIDR provisioned to the IPAM pool. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is `10.24.34.0/23`. An IPv6 CIDR example is `2001:DB8::/32`.  
Type: String  
Required: No

 ** failureReason **   
Details related to why an IPAM pool CIDR failed to be provisioned.  
Type: [IpamPoolCidrFailureReason](API_IpamPoolCidrFailureReason.md) object  
Required: No

 ** ipamPoolCidrId **   
The IPAM pool CIDR ID.  
Type: String  
Required: No

 ** 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. "NetmaskLength" or "Cidr" is required.  
Type: Integer  
Required: No

 ** state **   
The state of the CIDR.  
Type: String  
Valid Values: `pending-provision | provisioned | failed-provision | pending-deprovision | deprovisioned | failed-deprovision | pending-import | failed-import`   
Required: No

## See Also
<a name="API_IpamPoolCidr_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPoolCidr) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPoolCidr) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPoolCidr) 

# IpamPoolCidrFailureReason
<a name="API_IpamPoolCidrFailureReason"></a>

Details related to why an IPAM pool CIDR failed to be provisioned.

## Contents
<a name="API_IpamPoolCidrFailureReason_Contents"></a>

 ** code **   
An error code related to why an IPAM pool CIDR failed to be provisioned.  
Type: String  
Valid Values: `cidr-not-available | limit-exceeded`   
Required: No

 ** message **   
A message related to why an IPAM pool CIDR failed to be provisioned.  
Type: String  
Required: No

## See Also
<a name="API_IpamPoolCidrFailureReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPoolCidrFailureReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPoolCidrFailureReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPoolCidrFailureReason) 

# IpamPoolSourceResource
<a name="API_IpamPoolSourceResource"></a>

The resource used to provision CIDRs to a resource planning pool.

## Contents
<a name="API_IpamPoolSourceResource_Contents"></a>

 ** resourceId **   
The source resource ID.  
Type: String  
Required: No

 ** resourceOwner **   
The source resource owner.  
Type: String  
Required: No

 ** resourceRegion **   
The source resource Region.  
Type: String  
Required: No

 ** resourceType **   
The source resource type.  
Type: String  
Valid Values: `vpc`   
Required: No

## See Also
<a name="API_IpamPoolSourceResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPoolSourceResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPoolSourceResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPoolSourceResource) 

# IpamPoolSourceResourceRequest
<a name="API_IpamPoolSourceResourceRequest"></a>

The resource used to provision CIDRs to a resource planning pool.

## Contents
<a name="API_IpamPoolSourceResourceRequest_Contents"></a>

 ** ResourceId **   
The source resource ID.  
Type: String  
Required: No

 ** ResourceOwner **   
The source resource owner.  
Type: String  
Required: No

 ** ResourceRegion **   
The source resource Region.  
Type: String  
Required: No

 ** ResourceType **   
The source resource type.  
Type: String  
Valid Values: `vpc`   
Required: No

## See Also
<a name="API_IpamPoolSourceResourceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPoolSourceResourceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPoolSourceResourceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPoolSourceResourceRequest) 

# IpamPrefixListResolver
<a name="API_IpamPrefixListResolver"></a>

Describes 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.

## Contents
<a name="API_IpamPrefixListResolver_Contents"></a>

 ** addressFamily **   
The address family (IPv4 or IPv6) for the IPAM prefix list resolver.  
Type: String  
Valid Values: `ipv4 | ipv6`   
Required: No

 ** description **   
The description of the IPAM prefix list resolver.  
Type: String  
Required: No

 ** ipamArn **   
The Amazon Resource Name (ARN) of the IPAM associated with this resolver.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamPrefixListResolverArn **   
The Amazon Resource Name (ARN) of the IPAM prefix list resolver.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamPrefixListResolverId **   
The ID of the IPAM prefix list resolver.  
Type: String  
Required: No

 ** ipamRegion **   
The AWS Region where the associated IPAM is located.  
Type: String  
Required: No

 ** lastVersionCreationStatus **   
The status for the last time a version was created.  
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.  
Type: String  
Valid Values: `pending | success | failure`   
Required: No

 ** lastVersionCreationStatusMessage **   
The status message for the last time a version was created.  
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.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the IPAM prefix list resolver.  
Type: String  
Required: No

 ** state **   
The current state of the IPAM prefix list resolver. Valid values include `create-in-progress`, `create-complete`, `create-failed`, `modify-in-progress`, `modify-complete`, `modify-failed`, `delete-in-progress`, `delete-complete`, and `delete-failed`.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** TagSet.N **   
The tags assigned to the IPAM prefix list resolver.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_IpamPrefixListResolver_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolver) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolver) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolver) 

# IpamPrefixListResolverRule
<a name="API_IpamPrefixListResolverRule"></a>

Describes a CIDR selection rule.

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.

## Contents
<a name="API_IpamPrefixListResolverRule_Contents"></a>

 ** ConditionSet.N **   
The conditions that determine which CIDRs are selected by this rule. Conditions specify criteria such as resource type, tags, account IDs, and Regions.  
Type: Array of [IpamPrefixListResolverRuleCondition](API_IpamPrefixListResolverRuleCondition.md) objects  
Required: No

 ** ipamScopeId **   
The ID of the IPAM scope from which to select CIDRs. This determines whether to select from public or private IP address space.  
Type: String  
Required: No

 ** resourceType **   
For rules of type `ipam-resource-cidr`, this is the resource type.  
Type: String  
Valid Values: `vpc | subnet | eip | public-ipv4-pool | ipv6-pool | eni | anycast-ip-list`   
Required: No

 ** ruleType **   
The type of CIDR selection rule. Valid values include `include` for selecting CIDRs that match the conditions, and `exclude` for excluding CIDRs that match the conditions.  
Type: String  
Valid Values: `static-cidr | ipam-resource-cidr | ipam-pool-cidr`   
Required: No

 ** staticCidr **   
A fixed list of CIDRs that do not change (like a manual list replicated across Regions).  
Type: String  
Required: No

## See Also
<a name="API_IpamPrefixListResolverRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolverRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolverRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolverRule) 

# IpamPrefixListResolverRuleCondition
<a name="API_IpamPrefixListResolverRuleCondition"></a>

Describes a condition within a CIDR selection rule. Conditions define the criteria for selecting CIDRs from IPAM's database based on resource attributes.

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.

There are three rule types. Only 2 of the 3 rule types support conditions - **IPAM pool CIDR** and **Scope resource CIDR**. **Static CIDR** rules cannot have conditions.
+  **Static CIDR**: A fixed list of CIDRs that do not change (like a manual list replicated across Regions)
+  **IPAM pool CIDR**: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool)

  If you choose this option, choose the following:
  +  **IPAM scope**: Select the IPAM scope to search for resources
  +  **Conditions:** 
    +  **Property** 
      +  **IPAM pool ID**: Select an IPAM pool that contains the resources
      +  **CIDR** (like 10.24.34.0/23)
    +  **Operation**: Equals/Not equals
    +  **Value**: The value on which to match the condition
+  **Scope resource CIDR**: CIDRs from AWS resources like VPCs, subnets, EIPs within an IPAM scope

  If you choose this option, choose the following:
  +  **IPAM scope**: Select the IPAM scope to search for resources
  +  **Resource type**: Select a resource, like a VPC or subnet.
  +  **Conditions**:
    +  **Property**:
      + Resource ID: The unique ID of a resource (like vpc-1234567890abcdef0)
      + Resource owner (like 111122223333)
      + Resource region (like us-east-1)
      + Resource tag (like key: name, value: dev-vpc-1)
      + CIDR (like 10.24.34.0/23)
    +  **Operation**: Equals/Not equals
    +  **Value**: The value on which to match the condition

## Contents
<a name="API_IpamPrefixListResolverRuleCondition_Contents"></a>

 ** cidr **   
A CIDR block to match against. This condition selects CIDRs that fall within or match the specified CIDR range.  
Type: String  
Required: No

 ** ipamPoolId **   
The ID of the IPAM pool to match against. This condition selects CIDRs that belong to the specified IPAM pool.  
Type: String  
Required: No

 ** operation **   
The operation to perform when evaluating this condition. Valid values include `equals`, `not-equals`, `contains`, and `not-contains`.  
Type: String  
Valid Values: `equals | not-equals | subnet-of`   
Required: No

 ** resourceId **   
The ID of the AWS resource to match against. This condition selects CIDRs associated with the specified resource.  
Type: String  
Required: No

 ** resourceOwner **   
The AWS account ID that owns the resources to match against. This condition selects CIDRs from resources owned by the specified account.  
Type: String  
Required: No

 ** resourceRegion **   
The AWS Region where the resources are located. This condition selects CIDRs from resources in the specified Region.  
Type: String  
Required: No

 ** resourceTag **   
A tag key-value pair to match against. This condition selects CIDRs from resources that have the specified tag.  
Type: [IpamResourceTag](API_IpamResourceTag.md) object  
Required: No

## See Also
<a name="API_IpamPrefixListResolverRuleCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolverRuleCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolverRuleCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolverRuleCondition) 

# IpamPrefixListResolverRuleConditionRequest
<a name="API_IpamPrefixListResolverRuleConditionRequest"></a>

Describes a condition used when creating or modifying resolver rules.

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.

There are three rule types. Only 2 of the 3 rule types support conditions - **IPAM pool CIDR** and **Scope resource CIDR**. **Static CIDR** rules cannot have conditions.
+  **Static CIDR**: A fixed list of CIDRs that do not change (like a manual list replicated across Regions)
+  **IPAM pool CIDR**: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool)

  If you choose this option, choose the following:
  +  **IPAM scope**: Select the IPAM scope to search for resources
  +  **Conditions:** 
    +  **Property** 
      +  **IPAM pool ID**: Select an IPAM pool that contains the resources
      +  **CIDR** (like 10.24.34.0/23)
    +  **Operation**: Equals/Not equals
    +  **Value**: The value on which to match the condition
+  **Scope resource CIDR**: CIDRs from AWS resources like VPCs, subnets, EIPs within an IPAM scope

  If you choose this option, choose the following:
  +  **IPAM scope**: Select the IPAM scope to search for resources
  +  **Resource type**: Select a resource, like a VPC or subnet.
  +  **Conditions**:
    +  **Property**:
      + Resource ID: The unique ID of a resource (like vpc-1234567890abcdef0)
      + Resource owner (like 111122223333)
      + Resource region (like us-east-1)
      + Resource tag (like key: name, value: dev-vpc-1)
      + CIDR (like 10.24.34.0/23)
    +  **Operation**: Equals/Not equals
    +  **Value**: The value on which to match the condition

## Contents
<a name="API_IpamPrefixListResolverRuleConditionRequest_Contents"></a>

 ** Operation **   
The operation to perform when evaluating this condition.  
Type: String  
Valid Values: `equals | not-equals | subnet-of`   
Required: Yes

 ** Cidr **   
A CIDR block to match against. This condition selects CIDRs that fall within or match the specified CIDR range.  
Type: String  
Required: No

 ** IpamPoolId **   
The ID of the IPAM pool to match against. This condition selects CIDRs that belong to the specified IPAM pool.  
Type: String  
Required: No

 ** ResourceId **   
The ID of the AWS resource to match against. This condition selects CIDRs associated with the specified resource.  
Type: String  
Required: No

 ** ResourceOwner **   
The AWS account ID that owns the resources to match against. This condition selects CIDRs from resources owned by the specified account.  
Type: String  
Required: No

 ** ResourceRegion **   
The AWS Region where the resources are located. This condition selects CIDRs from resources in the specified Region.  
Type: String  
Required: No

 ** ResourceTag **   
A tag key-value pair to match against. This condition selects CIDRs from resources that have the specified tag.  
Type: [RequestIpamResourceTag](API_RequestIpamResourceTag.md) object  
Required: No

## See Also
<a name="API_IpamPrefixListResolverRuleConditionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolverRuleConditionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolverRuleConditionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolverRuleConditionRequest) 

# IpamPrefixListResolverRuleRequest
<a name="API_IpamPrefixListResolverRuleRequest"></a>

Describes a CIDR selection rule to include in a request. This is used when creating or modifying resolver rules.

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.

There are three rule types. Only 2 of the 3 rule types support conditions - **IPAM pool CIDR** and **Scope resource CIDR**. **Static CIDR** rules cannot have conditions.
+  **Static CIDR**: A fixed list of CIDRs that do not change (like a manual list replicated across Regions)
+  **IPAM pool CIDR**: CIDRs from specific IPAM pools (like all CIDRs from your IPAM production pool)

  If you choose this option, choose the following:
  +  **IPAM scope**: Select the IPAM scope to search for resources
  +  **Conditions:** 
    +  **Property** 
      +  **IPAM pool ID**: Select an IPAM pool that contains the resources
      +  **CIDR** (like 10.24.34.0/23)
    +  **Operation**: Equals/Not equals
    +  **Value**: The value on which to match the condition
+  **Scope resource CIDR**: CIDRs from AWS resources like VPCs, subnets, EIPs within an IPAM scope

  If you choose this option, choose the following:
  +  **IPAM scope**: Select the IPAM scope to search for resources
  +  **Resource type**: Select a resource, like a VPC or subnet.
  +  **Conditions**:
    +  **Property**:
      + Resource ID: The unique ID of a resource (like vpc-1234567890abcdef0)
      + Resource owner (like 111122223333)
      + Resource region (like us-east-1)
      + Resource tag (like key: name, value: dev-vpc-1)
      + CIDR (like 10.24.34.0/23)
    +  **Operation**: Equals/Not equals
    +  **Value**: The value on which to match the condition

## Contents
<a name="API_IpamPrefixListResolverRuleRequest_Contents"></a>

 ** RuleType **   
The type of CIDR selection rule. Valid values include `include` for selecting CIDRs that match the conditions, and `exclude` for excluding CIDRs that match the conditions.  
Type: String  
Valid Values: `static-cidr | ipam-resource-cidr | ipam-pool-cidr`   
Required: Yes

 ** Condition.N **   
The conditions that determine which CIDRs are selected by this rule. Conditions specify criteria such as resource type, tags, account IDs, and Regions.  
Type: Array of [IpamPrefixListResolverRuleConditionRequest](API_IpamPrefixListResolverRuleConditionRequest.md) objects  
Required: No

 ** IpamScopeId **   
The ID of the IPAM scope from which to select CIDRs. This determines whether to select from public or private IP address space.  
Type: String  
Required: No

 ** ResourceType **   
For rules of type `ipam-resource-cidr`, this is the resource type.  
Type: String  
Valid Values: `vpc | subnet | eip | public-ipv4-pool | ipv6-pool | eni | anycast-ip-list`   
Required: No

 ** StaticCidr **   
A fixed list of CIDRs that do not change (like a manual list replicated across Regions).  
Type: String  
Required: No

## See Also
<a name="API_IpamPrefixListResolverRuleRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolverRuleRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolverRuleRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolverRuleRequest) 

# IpamPrefixListResolverTarget
<a name="API_IpamPrefixListResolverTarget"></a>

Describes 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.

## Contents
<a name="API_IpamPrefixListResolverTarget_Contents"></a>

 ** desiredVersion **   
The desired version of the prefix list that this target should synchronize with.  
Type: Long  
Required: No

 ** ipamPrefixListResolverId **   
The ID of the IPAM prefix list resolver associated with this target.  
Type: String  
Required: No

 ** ipamPrefixListResolverTargetArn **   
The Amazon Resource Name (ARN) of the IPAM prefix list resolver target.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamPrefixListResolverTargetId **   
The ID of the IPAM prefix list resolver target.  
Type: String  
Required: No

 ** lastSyncedVersion **   
The version of the prefix list that was last successfully synchronized by this target.  
Type: Long  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the IPAM prefix list resolver target.  
Type: String  
Required: No

 ** prefixListId **   
The ID of the managed prefix list associated with this target.  
Type: String  
Required: No

 ** prefixListRegion **   
The AWS Region where the prefix list associated with this target is located.  
Type: String  
Required: No

 ** state **   
The current state of the IPAM prefix list resolver target. Valid values include `create-in-progress`, `create-complete`, `create-failed`, `modify-in-progress`, `modify-complete`, `modify-failed`, `delete-in-progress`, `delete-complete`, and `delete-failed`.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | sync-in-progress | sync-complete | sync-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** stateMessage **   
A message describing the current state of the IPAM prefix list resolver target, including any error information.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the IPAM prefix list resolver target.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trackLatestVersion **   
Indicates whether this target automatically tracks the latest version of the prefix list.  
Type: Boolean  
Required: No

## See Also
<a name="API_IpamPrefixListResolverTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolverTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolverTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolverTarget) 

# IpamPrefixListResolverVersion
<a name="API_IpamPrefixListResolverVersion"></a>

Describes a version of 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

## Contents
<a name="API_IpamPrefixListResolverVersion_Contents"></a>

 ** version **   
The version number of the 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.  
Type: Long  
Required: No

## See Also
<a name="API_IpamPrefixListResolverVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolverVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolverVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolverVersion) 

# IpamPrefixListResolverVersionEntry
<a name="API_IpamPrefixListResolverVersionEntry"></a>

Describes a CIDR entry in a specific version of an IPAM prefix list resolver. This represents a CIDR that was selected and synchronized at a particular point in time.

## Contents
<a name="API_IpamPrefixListResolverVersionEntry_Contents"></a>

 ** cidr **   
The CIDR block that was selected and synchronized in this resolver version.  
Type: String  
Required: No

## See Also
<a name="API_IpamPrefixListResolverVersionEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPrefixListResolverVersionEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPrefixListResolverVersionEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPrefixListResolverVersionEntry) 

# IpamPublicAddressSecurityGroup
<a name="API_IpamPublicAddressSecurityGroup"></a>

The security group that the resource with the public IP address is in.

## Contents
<a name="API_IpamPublicAddressSecurityGroup_Contents"></a>

 ** groupId **   
The security group's ID.  
Type: String  
Required: No

 ** groupName **   
The security group's name.  
Type: String  
Required: No

## See Also
<a name="API_IpamPublicAddressSecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPublicAddressSecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPublicAddressSecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPublicAddressSecurityGroup) 

# IpamPublicAddressTag
<a name="API_IpamPublicAddressTag"></a>

A tag for a public IP address discovered by IPAM.

## Contents
<a name="API_IpamPublicAddressTag_Contents"></a>

 ** key **   
The tag's key.  
Type: String  
Required: No

 ** value **   
The tag's value.  
Type: String  
Required: No

## See Also
<a name="API_IpamPublicAddressTag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPublicAddressTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPublicAddressTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPublicAddressTag) 

# IpamPublicAddressTags
<a name="API_IpamPublicAddressTags"></a>

Tags for a public IP address discovered by IPAM.

## Contents
<a name="API_IpamPublicAddressTags_Contents"></a>

 ** EipTagSet.N **   
Tags for an Elastic IP address.  
Type: Array of [IpamPublicAddressTag](API_IpamPublicAddressTag.md) objects  
Required: No

## See Also
<a name="API_IpamPublicAddressTags_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamPublicAddressTags) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamPublicAddressTags) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamPublicAddressTags) 

# IpamResourceCidr
<a name="API_IpamResourceCidr"></a>

The CIDR for an IPAM resource.

## Contents
<a name="API_IpamResourceCidr_Contents"></a>

 ** availabilityZoneId **   
The Availability Zone ID.  
Type: String  
Required: No

 ** complianceStatus **   
The compliance status of the IPAM resource. For more information on compliance statuses, see [Monitor CIDR usage by resource](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) in the *Amazon VPC IPAM User Guide*.  
Type: String  
Valid Values: `compliant | noncompliant | unmanaged | ignored`   
Required: No

 ** ipamId **   
The IPAM ID for an IPAM resource.  
Type: String  
Required: No

 ** ipamPoolId **   
The pool ID for an IPAM resource.  
Type: String  
Required: No

 ** ipamScopeId **   
The scope ID for an IPAM resource.  
Type: String  
Required: No

 ** ipUsage **   
The percentage of IP address space in use. To convert the decimal to a percentage, multiply the decimal by 100. Note the following:  
+ For resources that are VPCs, this is the percentage of IP address space in the VPC that's taken up by subnet CIDRs. 
+ For resources that are subnets, if the subnet has an IPv4 CIDR provisioned to it, this is the percentage of IPv4 address space in the subnet that's in use. If the subnet has an IPv6 CIDR provisioned to it, the percentage of IPv6 address space in use is not represented. The percentage of IPv6 address space in use cannot currently be calculated. 
+ For resources that are public IPv4 pools, this is the percentage of IP address space in the pool that's been allocated to Elastic IP addresses (EIPs). 
Type: Double  
Required: No

 ** managementState **   
The management state of the resource. For more information about management states, see [Monitor CIDR usage by resource](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) in the *Amazon VPC IPAM User Guide*.  
Type: String  
Valid Values: `managed | unmanaged | ignored`   
Required: No

 ** overlapStatus **   
The overlap status of an IPAM resource. The overlap status tells you if the CIDR for a resource overlaps with another CIDR in the scope. For more information on overlap statuses, see [Monitor CIDR usage by resource](https://docs.aws.amazon.com/vpc/latest/ipam/monitor-cidr-compliance-ipam.html) in the *Amazon VPC IPAM User Guide*.  
Type: String  
Valid Values: `overlapping | nonoverlapping | ignored`   
Required: No

 ** resourceCidr **   
The CIDR for an IPAM resource.  
Type: String  
Required: No

 ** resourceId **   
The ID of an IPAM resource.  
Type: String  
Required: No

 ** resourceName **   
The name of an IPAM resource.  
Type: String  
Required: No

 ** resourceOwnerId **   
The AWS account number of the owner of an IPAM resource.  
Type: String  
Required: No

 ** resourceRegion **   
The AWS Region for an IPAM resource.  
Type: String  
Required: No

 ** ResourceTagSet.N **   
The tags for an IPAM resource.  
Type: Array of [IpamResourceTag](API_IpamResourceTag.md) objects  
Required: No

 ** resourceType **   
The type of IPAM resource.  
Type: String  
Valid Values: `vpc | subnet | eip | public-ipv4-pool | ipv6-pool | eni | anycast-ip-list`   
Required: No

 ** vpcId **   
The ID of a VPC.  
Type: String  
Required: No

## See Also
<a name="API_IpamResourceCidr_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamResourceCidr) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamResourceCidr) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamResourceCidr) 

# IpamResourceDiscovery
<a name="API_IpamResourceDiscovery"></a>

A resource discovery is an IPAM component that enables IPAM to manage and monitor resources that belong to the owning account.

## Contents
<a name="API_IpamResourceDiscovery_Contents"></a>

 ** description **   
The resource discovery description.  
Type: String  
Required: No

 ** ipamResourceDiscoveryArn **   
The resource discovery Amazon Resource Name (ARN).  
Type: String  
Required: No

 ** ipamResourceDiscoveryId **   
The resource discovery ID.  
Type: String  
Required: No

 ** ipamResourceDiscoveryRegion **   
The resource discovery Region.  
Type: String  
Required: No

 ** isDefault **   
Defines if the resource discovery is the default. The default resource discovery is the resource discovery automatically created when you create an IPAM.  
Type: Boolean  
Required: No

 ** OperatingRegionSet.N **   
The operating Regions for 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 [IpamOperatingRegion](API_IpamOperatingRegion.md) objects  
Required: No

 ** OrganizationalUnitExclusionSet.N **   
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.  
Type: Array of [IpamOrganizationalUnitExclusion](API_IpamOrganizationalUnitExclusion.md) objects  
Required: No

 ** ownerId **   
The ID of the owner.  
Type: String  
Required: No

 ** state **   
The lifecycle state of the resource discovery.  
+  `create-in-progress` - Resource discovery is being created.
+  `create-complete` - Resource discovery creation is complete.
+  `create-failed` - Resource discovery creation has failed.
+  `modify-in-progress` - Resource discovery is being modified.
+  `modify-complete` - Resource discovery modification is complete.
+  `modify-failed` - Resource discovery modification has failed.
+  `delete-in-progress` - Resource discovery is being deleted.
+  `delete-complete` - Resource discovery deletion is complete.
+  `delete-failed` - Resource discovery deletion has failed.
+  `isolate-in-progress` - AWS account that created the resource discovery has been removed and the resource discovery is being isolated.
+  `isolate-complete` - Resource discovery isolation is complete.
+  `restore-in-progress` - AWS account that created the resource discovery and was isolated has been restored.
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** TagSet.N **   
A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_IpamResourceDiscovery_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamResourceDiscovery) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamResourceDiscovery) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamResourceDiscovery) 

# IpamResourceDiscoveryAssociation
<a name="API_IpamResourceDiscoveryAssociation"></a>

An IPAM resource discovery association. An associated resource discovery is a resource discovery that has been associated with an IPAM. IPAM aggregates the resource CIDRs discovered by the associated resource discovery.

## Contents
<a name="API_IpamResourceDiscoveryAssociation_Contents"></a>

 ** ipamArn **   
The IPAM ARN.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamId **   
The IPAM ID.  
Type: String  
Required: No

 ** ipamRegion **   
The IPAM home Region.  
Type: String  
Required: No

 ** ipamResourceDiscoveryAssociationArn **   
The resource discovery association Amazon Resource Name (ARN).  
Type: String  
Required: No

 ** ipamResourceDiscoveryAssociationId **   
The resource discovery association ID.  
Type: String  
Required: No

 ** ipamResourceDiscoveryId **   
The resource discovery ID.  
Type: String  
Required: No

 ** isDefault **   
Defines if the resource discovery is the default. When you create an IPAM, a default resource discovery is created for your IPAM and it's associated with your IPAM.  
Type: Boolean  
Required: No

 ** ownerId **   
The AWS account ID of the resource discovery owner.  
Type: String  
Required: No

 ** resourceDiscoveryStatus **   
The resource discovery status.  
+  `active` - Connection or permissions required to read the results of the resource discovery are intact.
+  `not-found` - Connection or permissions required to read the results of the resource discovery are broken. This may happen if the owner of the resource discovery stopped sharing it or deleted the resource discovery. Verify the resource discovery still exists and the AWS RAM resource share is still intact.
Type: String  
Valid Values: `active | not-found`   
Required: No

 ** state **   
The lifecycle state of the association when you associate or disassociate a resource discovery.  
+  `associate-in-progress` - Resource discovery is being associated.
+  `associate-complete` - Resource discovery association is complete.
+  `associate-failed` - Resource discovery association has failed.
+  `disassociate-in-progress` - Resource discovery is being disassociated.
+  `disassociate-complete` - Resource discovery disassociation is complete.
+  `disassociate-failed ` - Resource discovery disassociation has failed.
+  `isolate-in-progress` - AWS account that created the resource discovery association has been removed and the resource discovery association is being isolated.
+  `isolate-complete` - Resource discovery isolation is complete.
+  `restore-in-progress` - Resource discovery is being restored.
Type: String  
Valid Values: `associate-in-progress | associate-complete | associate-failed | disassociate-in-progress | disassociate-complete | disassociate-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** TagSet.N **   
A tag is a label that you assign to an AWS resource. Each tag consists of a key and an optional value. You can use tags to search and filter your resources or track your AWS costs.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_IpamResourceDiscoveryAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamResourceDiscoveryAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamResourceDiscoveryAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamResourceDiscoveryAssociation) 

# IpamResourceTag
<a name="API_IpamResourceTag"></a>

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.

## Contents
<a name="API_IpamResourceTag_Contents"></a>

 ** 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: String  
Required: No

 ** value **   
The value of the tag.  
Type: String  
Required: No

## See Also
<a name="API_IpamResourceTag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamResourceTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamResourceTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamResourceTag) 

# IpamScope
<a name="API_IpamScope"></a>

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 [How IPAM works](https://docs.aws.amazon.com/vpc/latest/ipam/how-it-works-ipam.html) in the *Amazon VPC IPAM User Guide*.

## Contents
<a name="API_IpamScope_Contents"></a>

 ** description **   
The description of the scope.  
Type: String  
Required: No

 ** externalAuthorityConfiguration **   
The external authority configuration for this IPAM scope, if configured.  
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: [IpamScopeExternalAuthorityConfiguration](API_IpamScopeExternalAuthorityConfiguration.md) object  
Required: No

 ** ipamArn **   
The ARN of the IPAM.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamRegion **   
The AWS Region of the IPAM scope.  
Type: String  
Required: No

 ** ipamScopeArn **   
The Amazon Resource Name (ARN) of the scope.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ipamScopeId **   
The ID of the scope.  
Type: String  
Required: No

 ** ipamScopeType **   
The type of the scope.  
Type: String  
Valid Values: `public | private`   
Required: No

 ** isDefault **   
Defines if the scope is the default scope or not.  
Type: Boolean  
Required: No

 ** ownerId **   
The AWS account ID of the owner of the scope.  
Type: String  
Required: No

 ** poolCount **   
The number of pools in the scope.  
Type: Integer  
Required: No

 ** state **   
The state of the IPAM scope.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | delete-in-progress | delete-complete | delete-failed | isolate-in-progress | isolate-complete | restore-in-progress`   
Required: No

 ** TagSet.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 [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_IpamScope_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamScope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamScope) 

# IpamScopeExternalAuthorityConfiguration
<a name="API_IpamScopeExternalAuthorityConfiguration"></a>

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.

## Contents
<a name="API_IpamScopeExternalAuthorityConfiguration_Contents"></a>

 ** externalResourceIdentifier **   
The identifier for the external resource managing this scope. For Infoblox integrations, this is the Infoblox resource identifier in the format `<version>.identity.account.<entity_realm>.<entity_id>`.  
Type: String  
Required: No

 ** type **   
The type of external authority managing this scope. Currently supports `Infoblox` for integration with Infoblox Universal DDI.  
Type: String  
Valid Values: `infoblox`   
Required: No

## See Also
<a name="API_IpamScopeExternalAuthorityConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpamScopeExternalAuthorityConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpamScopeExternalAuthorityConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpamScopeExternalAuthorityConfiguration) 

# IpPermission
<a name="API_IpPermission"></a>

Describes the permissions for a security group rule.

## Contents
<a name="API_IpPermission_Contents"></a>

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

 ** Groups.N **   
The security group and AWS account ID pairs.  
Type: Array of [UserIdGroupPair](API_UserIdGroupPair.md) objects  
Required: No

 ** IpProtocol ** (request), ** ipProtocol ** (response)  
The IP protocol name (`tcp`, `udp`, `icmp`, `icmpv6`) or number (see [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml)).  
Use `-1` to specify all protocols. When authorizing security group rules, specifying `-1` or a protocol number other than `tcp`, `udp`, `icmp`, or `icmpv6` allows traffic on all ports, regardless of any port range you specify. For `tcp`, `udp`, and `icmp`, you must specify a port range. For `icmpv6`, the port range is optional; if you omit the port range, traffic for all types and codes is allowed.  
Type: String  
Required: No

 ** IpRanges.N **   
The IPv4 address ranges.  
Type: Array of [IpRange](API_IpRange.md) objects  
Required: No

 ** Ipv6Ranges.N **   
The IPv6 address ranges.  
Type: Array of [Ipv6Range](API_Ipv6Range.md) objects  
Required: No

 ** PrefixListIds.N **   
The prefix list IDs.  
Type: Array of [PrefixListId](API_PrefixListId.md) objects  
Required: No

 ** ToPort ** (request), ** toPort ** (response)  
If the protocol is TCP or UDP, this is the end of the port range. If the protocol is ICMP or ICMPv6, 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).  
Type: Integer  
Required: No

## See Also
<a name="API_IpPermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpPermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpPermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpPermission) 

# IpRange
<a name="API_IpRange"></a>

Describes an IPv4 address range.

## Contents
<a name="API_IpRange_Contents"></a>

 ** CidrIp ** (request), ** cidrIp ** (response)  
The IPv4 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv4 address, use the /32 prefix length.  
 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.
Type: String  
Required: No

 ** Description ** (request), ** description ** (response)  
A description for the security group rule that references this IPv4 address range.  
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and .\$1-:/()\$1,@[]\$1=&;\$1\$1\$1\$1\$1  
Type: String  
Required: No

## See Also
<a name="API_IpRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/IpRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/IpRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/IpRange) 

# Ipv4PrefixSpecification
<a name="API_Ipv4PrefixSpecification"></a>

Describes an IPv4 prefix.

## Contents
<a name="API_Ipv4PrefixSpecification_Contents"></a>

 ** ipv4Prefix **   
The IPv4 prefix. 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*.  
Type: String  
Required: No

## See Also
<a name="API_Ipv4PrefixSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv4PrefixSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv4PrefixSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv4PrefixSpecification) 

# Ipv4PrefixSpecificationRequest
<a name="API_Ipv4PrefixSpecificationRequest"></a>

Describes the IPv4 prefix option for a network interface.

## Contents
<a name="API_Ipv4PrefixSpecificationRequest_Contents"></a>

 ** Ipv4Prefix ** (request), ** Ipv4Prefix ** (response)  
The IPv4 prefix. 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*.  
Type: String  
Required: No

## See Also
<a name="API_Ipv4PrefixSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv4PrefixSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv4PrefixSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv4PrefixSpecificationRequest) 

# Ipv4PrefixSpecificationResponse
<a name="API_Ipv4PrefixSpecificationResponse"></a>

Information about the IPv4 delegated prefixes assigned to a network interface.

## Contents
<a name="API_Ipv4PrefixSpecificationResponse_Contents"></a>

 ** ipv4Prefix **   
The IPv4 delegated prefixes assigned to the network interface.  
Type: String  
Required: No

## See Also
<a name="API_Ipv4PrefixSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv4PrefixSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv4PrefixSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv4PrefixSpecificationResponse) 

# Ipv6CidrAssociation
<a name="API_Ipv6CidrAssociation"></a>

Describes an IPv6 CIDR block association.

## Contents
<a name="API_Ipv6CidrAssociation_Contents"></a>

 ** associatedResource **   
The resource that's associated with the IPv6 CIDR block.  
Type: String  
Required: No

 ** ipv6Cidr **   
The IPv6 CIDR block.  
Type: String  
Required: No

## See Also
<a name="API_Ipv6CidrAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv6CidrAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv6CidrAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv6CidrAssociation) 

# Ipv6CidrBlock
<a name="API_Ipv6CidrBlock"></a>

Describes an IPv6 CIDR block.

## Contents
<a name="API_Ipv6CidrBlock_Contents"></a>

 ** ipv6CidrBlock **   
The IPv6 CIDR block.  
Type: String  
Required: No

## See Also
<a name="API_Ipv6CidrBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv6CidrBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv6CidrBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv6CidrBlock) 

# Ipv6Pool
<a name="API_Ipv6Pool"></a>

Describes an IPv6 address pool.

## Contents
<a name="API_Ipv6Pool_Contents"></a>

 ** description **   
The description for the address pool.  
Type: String  
Required: No

 ** PoolCidrBlockSet.N **   
The CIDR blocks for the address pool.  
Type: Array of [PoolCidrBlock](API_PoolCidrBlock.md) objects  
Required: No

 ** poolId **   
The ID of the address pool.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags for the address pool.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_Ipv6Pool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv6Pool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv6Pool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv6Pool) 

# Ipv6PrefixSpecification
<a name="API_Ipv6PrefixSpecification"></a>

Describes the IPv6 prefix.

## Contents
<a name="API_Ipv6PrefixSpecification_Contents"></a>

 ** ipv6Prefix **   
The IPv6 prefix.  
Type: String  
Required: No

## See Also
<a name="API_Ipv6PrefixSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv6PrefixSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv6PrefixSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv6PrefixSpecification) 

# Ipv6PrefixSpecificationRequest
<a name="API_Ipv6PrefixSpecificationRequest"></a>

Describes the IPv6 prefix option for a network interface.

## Contents
<a name="API_Ipv6PrefixSpecificationRequest_Contents"></a>

 ** Ipv6Prefix ** (request), ** Ipv6Prefix ** (response)  
The IPv6 prefix.  
Type: String  
Required: No

## See Also
<a name="API_Ipv6PrefixSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv6PrefixSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv6PrefixSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv6PrefixSpecificationRequest) 

# Ipv6PrefixSpecificationResponse
<a name="API_Ipv6PrefixSpecificationResponse"></a>

Information about the IPv6 delegated prefixes assigned to a network interface.

## Contents
<a name="API_Ipv6PrefixSpecificationResponse_Contents"></a>

 ** ipv6Prefix **   
The IPv6 delegated prefixes assigned to the network interface.  
Type: String  
Required: No

## See Also
<a name="API_Ipv6PrefixSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv6PrefixSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv6PrefixSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv6PrefixSpecificationResponse) 

# Ipv6Range
<a name="API_Ipv6Range"></a>

Describes an IPv6 address range.

## Contents
<a name="API_Ipv6Range_Contents"></a>

 ** CidrIpv6 ** (request), ** cidrIpv6 ** (response)  
The IPv6 address range. You can either specify a CIDR block or a source security group, not both. To specify a single IPv6 address, use the /128 prefix length.  
 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.
Type: String  
Required: No

 ** Description ** (request), ** description ** (response)  
A description for the security group rule that references this IPv6 address range.  
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and .\$1-:/()\$1,@[]\$1=&;\$1\$1\$1\$1\$1  
Type: String  
Required: No

## See Also
<a name="API_Ipv6Range_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Ipv6Range) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Ipv6Range) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Ipv6Range) 

# KeyPairInfo
<a name="API_KeyPairInfo"></a>

Describes a key pair.

## Contents
<a name="API_KeyPairInfo_Contents"></a>

 ** createTime **   
If you used Amazon EC2 to create the key pair, this is the date and time when the key was created, in [ISO 8601 date-time format](https://www.iso.org/iso-8601-date-and-time-format.html), in the UTC time zone.  
If you imported an existing key pair to Amazon EC2, this is the date and time the key was imported, in [ISO 8601 date-time format](https://www.iso.org/iso-8601-date-and-time-format.html), in the UTC time zone.  
Type: Timestamp  
Required: No

 ** keyFingerprint **   
If you used [CreateKeyPair](API_CreateKeyPair.md) to create the key pair:  
+ 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](http://www.openssh.com/txt/release-6.8).
If you used [ImportKeyPair](API_ImportKeyPair.md) to provide AWS the public key:  
+ For RSA key pairs, the key fingerprint is the MD5 public key fingerprint as specified in section 4 of RFC4716.
+ 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  
Required: No

 ** keyName **   
The name of the key pair.  
Type: String  
Required: No

 ** keyPairId **   
The ID of the key pair.  
Type: String  
Required: No

 ** keyType **   
The type of key pair.  
Type: String  
Valid Values: `rsa | ed25519`   
Required: No

 ** publicKey **   
The public key material.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags applied to the key pair.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_KeyPairInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/KeyPairInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/KeyPairInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/KeyPairInfo) 

# LastError
<a name="API_LastError"></a>

The last error that occurred for a VPC endpoint.

## Contents
<a name="API_LastError_Contents"></a>

 ** code **   
The error code for the VPC endpoint error.  
Type: String  
Required: No

 ** message **   
The error message for the VPC endpoint error.  
Type: String  
Required: No

## See Also
<a name="API_LastError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LastError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LastError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LastError) 

# LaunchPermission
<a name="API_LaunchPermission"></a>

Describes a launch permission.

## Contents
<a name="API_LaunchPermission_Contents"></a>

 ** Group ** (request), ** group ** (response)  
The name of the group.  
Type: String  
Valid Values: `all`   
Required: No

 ** OrganizationalUnitArn ** (request), ** organizationalUnitArn ** (response)  
The Amazon Resource Name (ARN) of an organizational unit (OU).  
Type: String  
Required: No

 ** OrganizationArn ** (request), ** organizationArn ** (response)  
The Amazon Resource Name (ARN) of an organization.  
Type: String  
Required: No

 ** UserId ** (request), ** userId ** (response)  
The AWS account ID.  
Constraints: Up to 10 000 account IDs can be specified in a single request.  
Type: String  
Required: No

## See Also
<a name="API_LaunchPermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchPermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchPermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchPermission) 

# LaunchPermissionModifications
<a name="API_LaunchPermissionModifications"></a>

Describes a launch permission modification.

## Contents
<a name="API_LaunchPermissionModifications_Contents"></a>

 ** Add.N **   
The AWS account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.  
Type: Array of [LaunchPermission](API_LaunchPermission.md) objects  
Required: No

 ** Remove.N **   
The AWS account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.  
Type: Array of [LaunchPermission](API_LaunchPermission.md) objects  
Required: No

## See Also
<a name="API_LaunchPermissionModifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchPermissionModifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchPermissionModifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchPermissionModifications) 

# LaunchSpecification
<a name="API_LaunchSpecification"></a>

Describes the launch specification for an instance.

## Contents
<a name="API_LaunchSpecification_Contents"></a>

 ** addressingType **   
Deprecated.  
Type: String  
Required: No

 ** BlockDeviceMapping.N **   
The block device mapping entries.  
Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects  
Required: No

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

 ** GroupSet.N **   
The IDs of the security groups.  
Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects  
Required: No

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

 ** imageId **   
The ID of the AMI.  
Type: String  
Required: No

 ** instanceType **   
The instance type. Only one instance type can be specified.  
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

 ** kernelId **   
The ID of the kernel.  
Type: String  
Required: No

 ** keyName **   
The name of the key pair.  
Type: String  
Required: No

 ** monitoring **   
Describes the monitoring of an instance.  
Type: [RunInstancesMonitoringEnabled](API_RunInstancesMonitoringEnabled.md) object  
Required: No

 ** NetworkInterfaceSet.N **   
The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.  
Type: Array of [InstanceNetworkInterfaceSpecification](API_InstanceNetworkInterfaceSpecification.md) objects  
Required: No

 ** placement **   
The placement information for the instance.  
Type: [SpotPlacement](API_SpotPlacement.md) object  
Required: No

 ** ramdiskId **   
The ID of the RAM disk.  
Type: String  
Required: No

 ** subnetId **   
The ID of the subnet in which to launch the instance.  
Type: String  
Required: No

 ** userData **   
The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.  
Type: String  
Required: No

## See Also
<a name="API_LaunchSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchSpecification) 

# LaunchTemplate
<a name="API_LaunchTemplate"></a>

Describes a launch template.

## Contents
<a name="API_LaunchTemplate_Contents"></a>

 ** createdBy **   
The principal that created the launch template.   
Type: String  
Required: No

 ** createTime **   
The time launch template was created.  
Type: Timestamp  
Required: No

 ** defaultVersionNumber **   
The version number of the default version of the launch template.  
Type: Long  
Required: No

 ** latestVersionNumber **   
The version number of the latest version of the launch template.  
Type: Long  
Required: No

 ** launchTemplateId **   
The ID of the launch template.  
Type: String  
Required: No

 ** launchTemplateName **   
The name of the launch template.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\(\)\.\-/_]+`   
Required: No

 ** operator **   
The entity that manages the launch template.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** TagSet.N **   
The tags for the launch template.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_LaunchTemplate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplate) 

# LaunchTemplateAndOverridesResponse
<a name="API_LaunchTemplateAndOverridesResponse"></a>

Describes a launch template and overrides.

## Contents
<a name="API_LaunchTemplateAndOverridesResponse_Contents"></a>

 ** launchTemplateSpecification **   
The launch template.  
Type: [FleetLaunchTemplateSpecification](API_FleetLaunchTemplateSpecification.md) object  
Required: No

 ** overrides **   
Any parameters that you specify override the same parameters in the launch template.  
Type: [FleetLaunchTemplateOverrides](API_FleetLaunchTemplateOverrides.md) object  
Required: No

## See Also
<a name="API_LaunchTemplateAndOverridesResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateAndOverridesResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateAndOverridesResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateAndOverridesResponse) 

# LaunchTemplateBlockDeviceMapping
<a name="API_LaunchTemplateBlockDeviceMapping"></a>

Describes a block device mapping.

## Contents
<a name="API_LaunchTemplateBlockDeviceMapping_Contents"></a>

 ** deviceName **   
The device name.  
Type: String  
Required: No

 ** ebs **   
Information about the block device for an EBS volume.  
Type: [LaunchTemplateEbsBlockDevice](API_LaunchTemplateEbsBlockDevice.md) object  
Required: No

 ** noDevice **   
To omit the device from the block device mapping, specify an empty string.  
Type: String  
Required: No

 ** virtualName **   
The virtual device name (ephemeralN).  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateBlockDeviceMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateBlockDeviceMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateBlockDeviceMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateBlockDeviceMapping) 

# LaunchTemplateBlockDeviceMappingRequest
<a name="API_LaunchTemplateBlockDeviceMappingRequest"></a>

Describes a block device mapping.

## Contents
<a name="API_LaunchTemplateBlockDeviceMappingRequest_Contents"></a>

 ** DeviceName **   
The device name (for example, /dev/sdh or xvdh).  
Type: String  
Required: No

 ** Ebs **   
Parameters used to automatically set up EBS volumes when the instance is launched.  
Type: [LaunchTemplateEbsBlockDeviceRequest](API_LaunchTemplateEbsBlockDeviceRequest.md) object  
Required: No

 ** NoDevice **   
To omit the device from the block device mapping, specify an empty string.  
Type: String  
Required: No

 ** VirtualName **   
The virtual device name (ephemeralN). Instance store volumes are numbered starting from 0. An instance type with 2 available instance store volumes can specify mappings for ephemeral0 and ephemeral1. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateBlockDeviceMappingRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateBlockDeviceMappingRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateBlockDeviceMappingRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateBlockDeviceMappingRequest) 

# LaunchTemplateCapacityReservationSpecificationRequest
<a name="API_LaunchTemplateCapacityReservationSpecificationRequest"></a>

Describes an instance's Capacity Reservation targeting option. You can specify only one option at a time. Use the `CapacityReservationPreference` parameter to configure the instance to run in On-Demand capacity or to run in any `open` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone). Use the `CapacityReservationTarget` parameter to explicitly target a specific Capacity Reservation or a Capacity Reservation group.

## Contents
<a name="API_LaunchTemplateCapacityReservationSpecificationRequest_Contents"></a>

 ** CapacityReservationPreference **   
Indicates the instance's Capacity Reservation preferences. Possible preferences include:  
+  `capacity-reservations-only` - The instance will only run in a Capacity Reservation or Capacity Reservation group. If capacity isn't available, the instance will fail to launch.
+  `open` - The instance can run in any `open` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone, tenancy).
+  `none` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Type: String  
Valid Values: `capacity-reservations-only | open | none`   
Required: No

 ** CapacityReservationTarget **   
Information about the target Capacity Reservation or Capacity Reservation group.  
Type: [CapacityReservationTarget](API_CapacityReservationTarget.md) object  
Required: No

## See Also
<a name="API_LaunchTemplateCapacityReservationSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateCapacityReservationSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateCapacityReservationSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateCapacityReservationSpecificationRequest) 

# LaunchTemplateCapacityReservationSpecificationResponse
<a name="API_LaunchTemplateCapacityReservationSpecificationResponse"></a>

Information about the Capacity Reservation targeting option.

## Contents
<a name="API_LaunchTemplateCapacityReservationSpecificationResponse_Contents"></a>

 ** capacityReservationPreference **   
Indicates the instance's Capacity Reservation preferences. Possible preferences include:  
+  `open` - The instance can run in any `open` Capacity Reservation that has matching attributes (instance type, platform, Availability Zone).
+  `none` - The instance avoids running in a Capacity Reservation even if one is available. The instance runs in On-Demand capacity.
Type: String  
Valid Values: `capacity-reservations-only | open | none`   
Required: No

 ** capacityReservationTarget **   
Information about the target Capacity Reservation or Capacity Reservation group.  
Type: [CapacityReservationTargetResponse](API_CapacityReservationTargetResponse.md) object  
Required: No

## See Also
<a name="API_LaunchTemplateCapacityReservationSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateCapacityReservationSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateCapacityReservationSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateCapacityReservationSpecificationResponse) 

# LaunchTemplateConfig
<a name="API_LaunchTemplateConfig"></a>

Describes a launch template and overrides.

## Contents
<a name="API_LaunchTemplateConfig_Contents"></a>

 ** LaunchTemplateSpecification ** (request), ** launchTemplateSpecification ** (response)  
The launch template to use. Make sure that the launch template does not contain the `NetworkInterfaceId` parameter because you can't specify a network interface ID in a Spot Fleet.  
Type: [FleetLaunchTemplateSpecification](API_FleetLaunchTemplateSpecification.md) object  
Required: No

 ** Overrides.N **   
Any parameters that you specify override the same parameters in the launch template.  
Type: Array of [LaunchTemplateOverrides](API_LaunchTemplateOverrides.md) objects  
Required: No

## See Also
<a name="API_LaunchTemplateConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateConfig) 

# LaunchTemplateCpuOptions
<a name="API_LaunchTemplateCpuOptions"></a>

The CPU options for the instance.

## Contents
<a name="API_LaunchTemplateCpuOptions_Contents"></a>

 ** amdSevSnp **   
Indicates whether the instance is enabled for AMD SEV-SNP. For more information, see [AMD SEV-SNP for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** coreCount **   
The number of CPU cores for the instance.  
Type: Integer  
Required: No

 ** nestedVirtualization **   
Indicates whether the instance is enabled for nested virtualization.   
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** threadsPerCore **   
The number of threads per CPU core.  
Type: Integer  
Required: No

## See Also
<a name="API_LaunchTemplateCpuOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateCpuOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateCpuOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateCpuOptions) 

# LaunchTemplateCpuOptionsRequest
<a name="API_LaunchTemplateCpuOptionsRequest"></a>

The CPU options for the instance. Both the core count and threads per core must be specified in the request.

## Contents
<a name="API_LaunchTemplateCpuOptionsRequest_Contents"></a>

 ** AmdSevSnp **   
Indicates whether to enable the instance for AMD SEV-SNP. AMD SEV-SNP is supported with M6a, R6a, and C6a instance types only. For more information, see [AMD SEV-SNP for Amazon EC2 instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** CoreCount **   
The number of CPU cores for the instance.  
Type: Integer  
Required: No

 ** NestedVirtualization **   
Indicates whether to enable the instance for nested virtualization. Nested virtualization is supported only on 8th generation Intel-based instance types (c8i, m8i, r8i, and their flex variants). 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 per CPU core. To disable multithreading for the instance, specify a value of `1`. Otherwise, specify the default value of `2`.  
Type: Integer  
Required: No

## See Also
<a name="API_LaunchTemplateCpuOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateCpuOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateCpuOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateCpuOptionsRequest) 

# LaunchTemplateEbsBlockDevice
<a name="API_LaunchTemplateEbsBlockDevice"></a>

Describes a block device for an EBS volume.

## Contents
<a name="API_LaunchTemplateEbsBlockDevice_Contents"></a>

 ** deleteOnTermination **   
Indicates whether the EBS volume is deleted on instance termination.  
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

 ** encrypted **   
Indicates whether the EBS volume is encrypted.  
Type: Boolean  
Required: No

 ** iops **   
The number of I/O operations per second (IOPS) that the volume supports.   
Type: Integer  
Required: No

 ** kmsKeyId **   
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.  
Type: String  
Required: No

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

 ** throughput **   
The throughput that the volume supports, in MiB/s.  
Type: Integer  
Required: No

 ** volumeInitializationRate **   
The Amazon EBS Provisioned Rate for Volume Initialization (volume initialization rate) specified for the volume, in MiB/s. If no volume initialization rate was specified, the value is `null`.  
Type: Integer  
Required: No

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

 ** volumeType **   
The volume type.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

## See Also
<a name="API_LaunchTemplateEbsBlockDevice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateEbsBlockDevice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateEbsBlockDevice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateEbsBlockDevice) 

# LaunchTemplateEbsBlockDeviceRequest
<a name="API_LaunchTemplateEbsBlockDeviceRequest"></a>

The parameters for a block device for an EBS volume.

## Contents
<a name="API_LaunchTemplateEbsBlockDeviceRequest_Contents"></a>

 ** DeleteOnTermination **   
Indicates whether the EBS volume is deleted on instance termination.  
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

 ** Encrypted **   
Indicates whether the EBS volume is encrypted. Encrypted volumes can only be attached to instances that support Amazon EBS encryption. If you are creating a volume from a snapshot, you can't specify an encryption value.  
Type: Boolean  
Required: No

 ** 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.  
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
For `io2` volumes, you can achieve up to 256,000 IOPS on [instances built on the Nitro System](https://docs.aws.amazon.com/ec2/latest/instancetypes/ec2-nitro-instances.html). On other instances, you can achieve performance up to 32,000 IOPS.  
This parameter is supported for `io1`, `io2`, and `gp3` volumes only.  
Type: Integer  
Required: No

 ** KmsKeyId **   
Identifier (key ID, key alias, key ARN, or alias ARN) of the customer managed KMS key to use for EBS encryption.  
Type: String  
Required: No

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

 ** Throughput **   
The throughput to provision for a `gp3` volume, with a maximum of 2,000 MiB/s.  
Valid Range: Minimum value of 125. Maximum value of 2,000.  
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

 ** VolumeSize **   
The size of the volume, in GiBs. You must specify either a snapshot ID or a volume size. 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
Type: Integer  
Required: No

 ** VolumeType **   
The volume type. 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*.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

## See Also
<a name="API_LaunchTemplateEbsBlockDeviceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateEbsBlockDeviceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateEbsBlockDeviceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateEbsBlockDeviceRequest) 

# LaunchTemplateElasticInferenceAccelerator
<a name="API_LaunchTemplateElasticInferenceAccelerator"></a>

**Note**  
Amazon Elastic Inference is no longer available.

 Describes an elastic inference accelerator. 

## Contents
<a name="API_LaunchTemplateElasticInferenceAccelerator_Contents"></a>

 ** Type **   
 The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.   
Type: String  
Required: Yes

 ** Count **   
The number of elastic inference accelerators to attach to the instance.   
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_LaunchTemplateElasticInferenceAccelerator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateElasticInferenceAccelerator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateElasticInferenceAccelerator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateElasticInferenceAccelerator) 

# LaunchTemplateElasticInferenceAcceleratorResponse
<a name="API_LaunchTemplateElasticInferenceAcceleratorResponse"></a>

**Note**  
Amazon Elastic Inference is no longer available.

 Describes an elastic inference accelerator. 

## Contents
<a name="API_LaunchTemplateElasticInferenceAcceleratorResponse_Contents"></a>

 ** count **   
The number of elastic inference accelerators to attach to the instance.   
Type: Integer  
Required: No

 ** type **   
The type of elastic inference accelerator. The possible values are eia1.medium, eia1.large, and eia1.xlarge.   
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateElasticInferenceAcceleratorResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateElasticInferenceAcceleratorResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateElasticInferenceAcceleratorResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateElasticInferenceAcceleratorResponse) 

# LaunchTemplateEnaSrdSpecification
<a name="API_LaunchTemplateEnaSrdSpecification"></a>

ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances. With ENA Express, you can communicate between two EC2 instances in the same subnet within the same account, or in different accounts. Both sending and receiving instances must have ENA Express enabled.

To improve the reliability of network packet delivery, ENA Express reorders network packets on the receiving end by default. However, some UDP-based applications are designed to handle network packets that are out of order to reduce the overhead for packet delivery at the network layer. When ENA Express is enabled, you can specify whether UDP network traffic uses it.

## Contents
<a name="API_LaunchTemplateEnaSrdSpecification_Contents"></a>

 ** enaSrdEnabled **   
Indicates whether ENA Express is enabled for the network interface.  
Type: Boolean  
Required: No

 ** enaSrdUdpSpecification **   
Configures ENA Express for UDP network traffic.  
Type: [LaunchTemplateEnaSrdUdpSpecification](API_LaunchTemplateEnaSrdUdpSpecification.md) object  
Required: No

## See Also
<a name="API_LaunchTemplateEnaSrdSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateEnaSrdSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateEnaSrdSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateEnaSrdSpecification) 

# LaunchTemplateEnaSrdUdpSpecification
<a name="API_LaunchTemplateEnaSrdUdpSpecification"></a>

ENA Express is compatible with both TCP and UDP transport protocols. When it's enabled, TCP traffic automatically uses it. However, some UDP-based applications are designed to handle network packets that are out of order, without a need for retransmission, such as live video broadcasting or other near-real-time applications. For UDP traffic, you can specify whether to use ENA Express, based on your application environment needs.

## Contents
<a name="API_LaunchTemplateEnaSrdUdpSpecification_Contents"></a>

 ** enaSrdUdpEnabled **   
Indicates whether UDP traffic to and from the instance uses ENA Express. To specify this setting, you must first enable ENA Express.  
Type: Boolean  
Required: No

## See Also
<a name="API_LaunchTemplateEnaSrdUdpSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateEnaSrdUdpSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateEnaSrdUdpSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateEnaSrdUdpSpecification) 

# LaunchTemplateEnclaveOptions
<a name="API_LaunchTemplateEnclaveOptions"></a>

Indicates whether the instance is enabled for AWS Nitro Enclaves.

## Contents
<a name="API_LaunchTemplateEnclaveOptions_Contents"></a>

 ** enabled **   
If this parameter is set to `true`, the instance is enabled for AWS Nitro Enclaves; otherwise, it is not enabled for AWS Nitro Enclaves.  
Type: Boolean  
Required: No

## See Also
<a name="API_LaunchTemplateEnclaveOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateEnclaveOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateEnclaveOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateEnclaveOptions) 

# LaunchTemplateEnclaveOptionsRequest
<a name="API_LaunchTemplateEnclaveOptionsRequest"></a>

Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the * AWS Nitro Enclaves User Guide*.

## Contents
<a name="API_LaunchTemplateEnclaveOptionsRequest_Contents"></a>

 ** Enabled **   
To enable the instance for AWS Nitro Enclaves, set this parameter to `true`.  
Type: Boolean  
Required: No

## See Also
<a name="API_LaunchTemplateEnclaveOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateEnclaveOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateEnclaveOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateEnclaveOptionsRequest) 

# LaunchTemplateHibernationOptions
<a name="API_LaunchTemplateHibernationOptions"></a>

Indicates whether an instance is configured for hibernation.

## Contents
<a name="API_LaunchTemplateHibernationOptions_Contents"></a>

 ** configured **   
If this parameter is set to `true`, the instance is enabled for hibernation; otherwise, it is not enabled for hibernation.  
Type: Boolean  
Required: No

## See Also
<a name="API_LaunchTemplateHibernationOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateHibernationOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateHibernationOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateHibernationOptions) 

# LaunchTemplateHibernationOptionsRequest
<a name="API_LaunchTemplateHibernationOptionsRequest"></a>

Indicates whether the instance is configured 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).

## Contents
<a name="API_LaunchTemplateHibernationOptionsRequest_Contents"></a>

 ** Configured **   
If you set this parameter to `true`, the instance is enabled for hibernation.  
Default: `false`   
Type: Boolean  
Required: No

## See Also
<a name="API_LaunchTemplateHibernationOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateHibernationOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateHibernationOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateHibernationOptionsRequest) 

# LaunchTemplateIamInstanceProfileSpecification
<a name="API_LaunchTemplateIamInstanceProfileSpecification"></a>

Describes an IAM instance profile.

## Contents
<a name="API_LaunchTemplateIamInstanceProfileSpecification_Contents"></a>

 ** arn **   
The Amazon Resource Name (ARN) of the instance profile.  
Type: String  
Required: No

 ** name **   
The name of the instance profile.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateIamInstanceProfileSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateIamInstanceProfileSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateIamInstanceProfileSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateIamInstanceProfileSpecification) 

# LaunchTemplateIamInstanceProfileSpecificationRequest
<a name="API_LaunchTemplateIamInstanceProfileSpecificationRequest"></a>

An IAM instance profile.

## Contents
<a name="API_LaunchTemplateIamInstanceProfileSpecificationRequest_Contents"></a>

 ** Arn **   
The Amazon Resource Name (ARN) of the instance profile.  
Type: String  
Required: No

 ** Name **   
The name of the instance profile.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateIamInstanceProfileSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateIamInstanceProfileSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateIamInstanceProfileSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateIamInstanceProfileSpecificationRequest) 

# LaunchTemplateInstanceMaintenanceOptions
<a name="API_LaunchTemplateInstanceMaintenanceOptions"></a>

The maintenance options of your instance.

## Contents
<a name="API_LaunchTemplateInstanceMaintenanceOptions_Contents"></a>

 ** autoRecovery **   
Disables the automatic recovery behavior of your instance or sets it to default.  
Type: String  
Valid Values: `default | disabled`   
Required: No

## See Also
<a name="API_LaunchTemplateInstanceMaintenanceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceMaintenanceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceMaintenanceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceMaintenanceOptions) 

# LaunchTemplateInstanceMaintenanceOptionsRequest
<a name="API_LaunchTemplateInstanceMaintenanceOptionsRequest"></a>

The maintenance options of your instance.

## Contents
<a name="API_LaunchTemplateInstanceMaintenanceOptionsRequest_Contents"></a>

 ** AutoRecovery **   
Disables the automatic recovery behavior of your instance or sets it to default. For more information, see [Simplified automatic recovery](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-recover.html#instance-configuration-recovery).  
Type: String  
Valid Values: `default | disabled`   
Required: No

## See Also
<a name="API_LaunchTemplateInstanceMaintenanceOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceMaintenanceOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceMaintenanceOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceMaintenanceOptionsRequest) 

# LaunchTemplateInstanceMarketOptions
<a name="API_LaunchTemplateInstanceMarketOptions"></a>

The market (purchasing) option for the instances.

## Contents
<a name="API_LaunchTemplateInstanceMarketOptions_Contents"></a>

 ** marketType **   
The market type.  
Type: String  
Valid Values: `spot | capacity-block | interruptible-capacity-reservation`   
Required: No

 ** spotOptions **   
The options for Spot Instances.  
Type: [LaunchTemplateSpotMarketOptions](API_LaunchTemplateSpotMarketOptions.md) object  
Required: No

## See Also
<a name="API_LaunchTemplateInstanceMarketOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceMarketOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceMarketOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceMarketOptions) 

# LaunchTemplateInstanceMarketOptionsRequest
<a name="API_LaunchTemplateInstanceMarketOptionsRequest"></a>

The market (purchasing) option for the instances.

## Contents
<a name="API_LaunchTemplateInstanceMarketOptionsRequest_Contents"></a>

 ** MarketType **   
The market type.  
Type: String  
Valid Values: `spot | capacity-block | interruptible-capacity-reservation`   
Required: No

 ** SpotOptions **   
The options for Spot Instances.  
Type: [LaunchTemplateSpotMarketOptionsRequest](API_LaunchTemplateSpotMarketOptionsRequest.md) object  
Required: No

## See Also
<a name="API_LaunchTemplateInstanceMarketOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceMarketOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceMarketOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceMarketOptionsRequest) 

# LaunchTemplateInstanceMetadataOptions
<a name="API_LaunchTemplateInstanceMetadataOptions"></a>

The metadata options for the instance. For more information, see [Use instance metadata to manage your EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_LaunchTemplateInstanceMetadataOptions_Contents"></a>

 ** httpEndpoint **   
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is `enabled`.  
If you specify a value of `disabled`, you will not be able to access your instance metadata. 
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** httpProtocolIpv6 **   
Enables or disables the IPv6 endpoint for the instance metadata service.  
Default: `disabled`   
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.  
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.
Type: String  
Valid Values: `optional | required`   
Required: No

 ** 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).  
Default: `disabled`   
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** state **   
The state of the metadata option changes.  
 `pending` - The metadata options are being updated and the instance is not ready to process metadata traffic with the new selection.  
 `applied` - The metadata options have been successfully applied on the instance.  
Type: String  
Valid Values: `pending | applied`   
Required: No

## See Also
<a name="API_LaunchTemplateInstanceMetadataOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceMetadataOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceMetadataOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceMetadataOptions) 

# LaunchTemplateInstanceMetadataOptionsRequest
<a name="API_LaunchTemplateInstanceMetadataOptionsRequest"></a>

The metadata options for the instance. For more information, see [Use instance metadata to manage your EC2 instance](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_LaunchTemplateInstanceMetadataOptionsRequest_Contents"></a>

 ** HttpEndpoint **   
Enables or disables the HTTP metadata endpoint on your instances. If the parameter is not specified, the default state is `enabled`.  
If you specify a value of `disabled`, you will not be able to access your instance metadata. 
Type: String  
Valid Values: `disabled | enabled`   
Required: No

 ** HttpProtocolIpv6 **   
Enables or disables the IPv6 endpoint for the instance metadata service.  
Default: `disabled`   
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.  
Default: `1`   
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`, the default is `required`.  
Type: String  
Valid Values: `optional | required`   
Required: No

 ** 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).  
Default: `disabled`   
Type: String  
Valid Values: `disabled | enabled`   
Required: No

## See Also
<a name="API_LaunchTemplateInstanceMetadataOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceMetadataOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceMetadataOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceMetadataOptionsRequest) 

# LaunchTemplateInstanceNetworkInterfaceSpecification
<a name="API_LaunchTemplateInstanceNetworkInterfaceSpecification"></a>

Describes a network interface.

## Contents
<a name="API_LaunchTemplateInstanceNetworkInterfaceSpecification_Contents"></a>

 ** associateCarrierIpAddress **   
Indicates whether to associate a Carrier IP address with eth0 for a new network interface.  
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP address](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the * AWS Wavelength Developer Guide*.  
Type: Boolean  
Required: No

 ** associatePublicIpAddress **   
Indicates whether to associate a public IPv4 address with eth0 for a new network interface.  
 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: Boolean  
Required: No

 ** connectionTrackingSpecification **   
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see [Idle connection tracking timeout](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.  
Type: [ConnectionTrackingSpecification](API_ConnectionTrackingSpecification.md) object  
Required: No

 ** deleteOnTermination **   
Indicates whether the network interface is deleted when the instance is terminated.  
Type: Boolean  
Required: No

 ** description **   
A description for the network interface.  
Type: String  
Required: No

 ** deviceIndex **   
The device index for the network interface attachment.  
Type: Integer  
Required: No

 ** enaQueueCount **   
The number of ENA queues created with the instance.  
Type: Integer  
Required: No

 ** enaSrdSpecification **   
Contains the ENA Express settings for instances launched from your launch template.  
Type: [LaunchTemplateEnaSrdSpecification](API_LaunchTemplateEnaSrdSpecification.md) object  
Required: No

 ** GroupSet.N **   
The IDs of one or more security groups.  
Type: Array of strings  
Required: No

 ** interfaceType **   
The type of network interface.  
Type: String  
Required: No

 ** ipv4PrefixCount **   
The number of IPv4 prefixes that AWS automatically assigned to the network interface.  
Type: Integer  
Required: No

 ** Ipv4PrefixSet.N **   
One or more IPv4 prefixes assigned to the network interface.  
Type: Array of [Ipv4PrefixSpecificationResponse](API_Ipv4PrefixSpecificationResponse.md) objects  
Required: No

 ** ipv6AddressCount **   
The number of IPv6 addresses for the network interface.  
Type: Integer  
Required: No

 ** Ipv6AddressesSet.N **   
The IPv6 addresses for the network interface.  
Type: Array of [InstanceIpv6Address](API_InstanceIpv6Address.md) objects  
Required: No

 ** ipv6PrefixCount **   
The number of IPv6 prefixes that AWS automatically assigned to the network interface.  
Type: Integer  
Required: No

 ** Ipv6PrefixSet.N **   
One or more IPv6 prefixes assigned to the network interface.  
Type: Array of [Ipv6PrefixSpecificationResponse](API_Ipv6PrefixSpecificationResponse.md) objects  
Required: No

 ** networkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

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

 ** primaryIpv6 **   
The primary IPv6 address of the network interface. 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. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: Boolean  
Required: No

 ** privateIpAddress **   
The primary private IPv4 address of the network interface.  
Type: String  
Required: No

 ** PrivateIpAddressesSet.N **   
One or more private IPv4 addresses.  
Type: Array of [PrivateIpAddressSpecification](API_PrivateIpAddressSpecification.md) objects  
Required: No

 ** secondaryPrivateIpAddressCount **   
The number of secondary private IPv4 addresses for the network interface.  
Type: Integer  
Required: No

 ** subnetId **   
The ID of the subnet for the network interface.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateInstanceNetworkInterfaceSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceNetworkInterfaceSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceNetworkInterfaceSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceNetworkInterfaceSpecification) 

# LaunchTemplateInstanceNetworkInterfaceSpecificationRequest
<a name="API_LaunchTemplateInstanceNetworkInterfaceSpecificationRequest"></a>

The parameters for a network interface.

## Contents
<a name="API_LaunchTemplateInstanceNetworkInterfaceSpecificationRequest_Contents"></a>

 ** AssociateCarrierIpAddress **   
Associates a Carrier IP address with eth0 for a new network interface.  
Use this option when you launch an instance in a Wavelength Zone and want to associate a Carrier IP address with the network interface. For more information about Carrier IP addresses, see [Carrier IP addresses](https://docs.aws.amazon.com/wavelength/latest/developerguide/how-wavelengths-work.html#provider-owned-ip) in the * AWS Wavelength Developer Guide*.  
Type: Boolean  
Required: No

 ** AssociatePublicIpAddress **   
Associates a public IPv4 address with eth0 for a new network interface.  
 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: Boolean  
Required: No

 ** ConnectionTrackingSpecification **   
A security group connection tracking specification that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see [Idle connection tracking timeout](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.  
Type: [ConnectionTrackingSpecificationRequest](API_ConnectionTrackingSpecificationRequest.md) object  
Required: No

 ** DeleteOnTermination **   
Indicates whether the network interface is deleted when the instance is terminated.  
Type: Boolean  
Required: No

 ** Description **   
A description for the network interface.  
Type: String  
Required: No

 ** DeviceIndex **   
The device index for the network interface attachment. The primary network interface has a device index of 0. Each network interface is of type `interface`, you must specify a device index. If you create a launch template that includes secondary network interfaces but not a primary network interface, then you must add a primary network interface as a launch parameter when you launch an instance from the template.  
Type: Integer  
Required: No

 ** EnaQueueCount **   
The number of ENA queues to be created with the instance.  
Type: Integer  
Required: No

 ** EnaSrdSpecification **   
Configure ENA Express settings for your launch template.  
Type: [EnaSrdSpecificationRequest](API_EnaSrdSpecificationRequest.md) object  
Required: No

 ** InterfaceType **   
The type of network interface. To create an Elastic Fabric Adapter (EFA), specify `efa` or `efa`. For more information, see [Elastic Fabric Adapter for AI/ML and HPC workloads on Amazon EC2](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/efa.html) in the *Amazon EC2 User Guide*.  
If you are not creating an EFA, specify `interface` or omit this parameter.  
If you specify `efa-only`, do not assign any IP addresses to the network interface. EFA-only network interfaces do not support IP addresses.  
Valid values: `interface` \$1 `efa` \$1 `efa-only`   
Type: String  
Required: No

 ** Ipv4Prefix.N **   
One or more IPv4 prefixes to be assigned to the network interface. You cannot use this option if you use the `Ipv4PrefixCount` option.  
Type: Array of [Ipv4PrefixSpecificationRequest](API_Ipv4PrefixSpecificationRequest.md) objects  
Required: No

 ** Ipv4PrefixCount **   
The number of IPv4 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the `Ipv4Prefix` option.  
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 use this option if specifying specific IPv6 addresses.  
Type: Integer  
Required: No

 ** Ipv6Addresses.N **   
One or more specific IPv6 addresses from the IPv6 CIDR block range of your subnet. You can't use this option if you're specifying a number of IPv6 addresses.  
Type: Array of [InstanceIpv6AddressRequest](API_InstanceIpv6AddressRequest.md) objects  
Required: No

 ** Ipv6Prefix.N **   
One or more IPv6 prefixes to be assigned to the network interface. You cannot use this option if you use the `Ipv6PrefixCount` option.  
Type: Array of [Ipv6PrefixSpecificationRequest](API_Ipv6PrefixSpecificationRequest.md) objects  
Required: No

 ** Ipv6PrefixCount **   
The number of IPv6 prefixes to be automatically assigned to the network interface. You cannot use this option if you use the `Ipv6Prefix` option.  
Type: Integer  
Required: No

 ** 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: No

 ** PrimaryIpv6 **   
The primary IPv6 address of the network interface. 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. For more information about primary IPv6 addresses, see [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html).  
Type: Boolean  
Required: No

 ** PrivateIpAddress **   
The primary private IPv4 address of the network interface.  
Type: String  
Required: No

 ** PrivateIpAddresses.N **   
One or more private IPv4 addresses.  
Type: Array of [PrivateIpAddressSpecification](API_PrivateIpAddressSpecification.md) objects  
Required: No

 ** SecondaryPrivateIpAddressCount **   
The number of secondary private IPv4 addresses to assign to a network interface.  
Type: Integer  
Required: No

 ** SecurityGroupId.N **   
The IDs of one or more security groups.  
Type: Array of strings  
Required: No

 ** SubnetId **   
The ID of the subnet for the network interface.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateInstanceNetworkInterfaceSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceNetworkInterfaceSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceNetworkInterfaceSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceNetworkInterfaceSpecificationRequest) 

# LaunchTemplateInstanceSecondaryInterfaceSpecification
<a name="API_LaunchTemplateInstanceSecondaryInterfaceSpecification"></a>

Describes a secondary interface specification in a launch template.

## Contents
<a name="API_LaunchTemplateInstanceSecondaryInterfaceSpecification_Contents"></a>

 ** deleteOnTermination **   
Indicates whether the secondary interface is deleted when the instance is terminated.  
The only supported value for this field is `true`.  
Type: Boolean  
Required: No

 ** deviceIndex **   
The device index for the secondary interface attachment.  
Type: Integer  
Required: No

 ** interfaceType **   
The type of secondary interface.  
Type: String  
Valid Values: `secondary`   
Required: No

 ** networkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

 ** privateIpAddressCount **   
The number of private IPv4 addresses to assign to the secondary interface.  
If you specify `privateIpAddressCount` you cannot specify `privateIpAddresses`   
Type: Integer  
Required: No

 ** PrivateIpAddressesSet.N **   
The private IPv4 addresses to assign to the secondary interface.  
If you specify `privateIpAddresses` you cannot specify `privateIpAddressCount`   
Type: Array of [SecondaryInterfacePrivateIpAddressSpecification](API_SecondaryInterfacePrivateIpAddressSpecification.md) objects  
Required: No

 ** secondarySubnetId **   
The ID of the secondary subnet.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateInstanceSecondaryInterfaceSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceSecondaryInterfaceSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceSecondaryInterfaceSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceSecondaryInterfaceSpecification) 

# LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest
<a name="API_LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest"></a>

Describes a secondary interface specification for a launch template request.

## Contents
<a name="API_LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest_Contents"></a>

 ** DeleteOnTermination **   
Indicates whether the secondary interface is deleted when the instance is terminated.  
The only supported value for this field is `true`.  
Type: Boolean  
Required: No

 ** DeviceIndex **   
The device index for the secondary interface attachment.  
Type: Integer  
Required: No

 ** InterfaceType **   
The type of secondary interface.  
Type: String  
Valid Values: `secondary`   
Required: No

 ** NetworkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

 ** PrivateIpAddress.N **   
The private IPv4 addresses to assign to the secondary interface.  
Type: Array of [SecondaryInterfacePrivateIpAddressSpecificationRequest](API_SecondaryInterfacePrivateIpAddressSpecificationRequest.md) objects  
Required: No

 ** PrivateIpAddressCount **   
The number of private IPv4 addresses to assign to the secondary interface.  
Type: Integer  
Required: No

 ** SecondarySubnetId **   
The ID of the secondary subnet.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest) 

# LaunchTemplateLicenseConfiguration
<a name="API_LaunchTemplateLicenseConfiguration"></a>

Describes a license configuration.

## Contents
<a name="API_LaunchTemplateLicenseConfiguration_Contents"></a>

 ** licenseConfigurationArn **   
The Amazon Resource Name (ARN) of the license configuration.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateLicenseConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateLicenseConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateLicenseConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateLicenseConfiguration) 

# LaunchTemplateLicenseConfigurationRequest
<a name="API_LaunchTemplateLicenseConfigurationRequest"></a>

Describes a license configuration.

## Contents
<a name="API_LaunchTemplateLicenseConfigurationRequest_Contents"></a>

 ** LicenseConfigurationArn **   
The Amazon Resource Name (ARN) of the license configuration.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateLicenseConfigurationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateLicenseConfigurationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateLicenseConfigurationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateLicenseConfigurationRequest) 

# LaunchTemplateNetworkPerformanceOptions
<a name="API_LaunchTemplateNetworkPerformanceOptions"></a>

With network performance options, you can adjust your bandwidth preferences to meet the needs of the workload that runs on your instance at launch.

## Contents
<a name="API_LaunchTemplateNetworkPerformanceOptions_Contents"></a>

 ** bandwidthWeighting **   
When you configure network bandwidth weighting, you can boost baseline bandwidth for either networking or EBS by up to 25%. The total available baseline bandwidth for your instance remains the same. The default option uses the standard bandwidth configuration for your instance type.  
Type: String  
Valid Values: `default | vpc-1 | ebs-1`   
Required: No

## See Also
<a name="API_LaunchTemplateNetworkPerformanceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateNetworkPerformanceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateNetworkPerformanceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateNetworkPerformanceOptions) 

# LaunchTemplateNetworkPerformanceOptionsRequest
<a name="API_LaunchTemplateNetworkPerformanceOptionsRequest"></a>

When you configure network performance options in your launch template, your instance is geared for performance improvements based on the workload that it runs as soon as it's available.

## Contents
<a name="API_LaunchTemplateNetworkPerformanceOptionsRequest_Contents"></a>

 ** 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: No

## See Also
<a name="API_LaunchTemplateNetworkPerformanceOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateNetworkPerformanceOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateNetworkPerformanceOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateNetworkPerformanceOptionsRequest) 

# LaunchTemplateOverrides
<a name="API_LaunchTemplateOverrides"></a>

Describes overrides for a launch template.

## Contents
<a name="API_LaunchTemplateOverrides_Contents"></a>

 ** AvailabilityZone ** (request), ** availabilityZone ** (response)  
The Availability Zone in which to launch the instances. For example, `us-east-2a`.  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** AvailabilityZoneId ** (request), ** availabilityZoneId ** (response)  
The ID of the Availability Zone in which to launch the instances. For example, `use2-az1`.  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** InstanceRequirements ** (request), ** instanceRequirements ** (response)  
The instance requirements. When you specify instance requirements, Amazon EC2 will identify instance types with the provided requirements, and then use your On-Demand and Spot allocation strategies to launch instances from these instance types, in the same way as when you specify a list of instance types.  
If you specify `InstanceRequirements`, you can't specify `InstanceType`.
Type: [InstanceRequirements](API_InstanceRequirements.md) object  
Required: No

 ** InstanceType ** (request), ** instanceType ** (response)  
The instance type.  
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

 ** Priority ** (request), ** priority ** (response)  
The priority for the launch template override. The highest priority is launched first.  
If `OnDemandAllocationStrategy` is set to `prioritized`, Spot Fleet uses priority to determine which launch template override to use first in fulfilling On-Demand capacity.  
If the Spot `AllocationStrategy` is set to `capacityOptimizedPrioritized`, Spot Fleet uses priority on a best-effort basis to determine which launch template override to use in fulfilling Spot capacity, but optimizes for capacity first.  
Valid values are whole numbers starting at `0`. The lower the number, the higher the priority. If no number is set, the launch template override has the lowest priority. You can set the same priority for different launch template overrides.  
Type: Double  
Required: No

 ** SpotPrice ** (request), ** spotPrice ** (response)  
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

 ** SubnetId ** (request), ** subnetId ** (response)  
The ID of the subnet in which to launch the instances.  
Type: String  
Required: No

 ** WeightedCapacity ** (request), ** weightedCapacity ** (response)  
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.  
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.  
When specifying weights, the price used in the `lowestPrice` and `priceCapacityOptimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity`, resulting in only 1 instance being launched, the price used is per *instance* hour.
Type: Double  
Required: No

## See Also
<a name="API_LaunchTemplateOverrides_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateOverrides) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateOverrides) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateOverrides) 

# LaunchTemplatePlacement
<a name="API_LaunchTemplatePlacement"></a>

Describes the placement of an instance.

## Contents
<a name="API_LaunchTemplatePlacement_Contents"></a>

 ** affinity **   
The affinity setting for the instance on the Dedicated Host.  
Type: String  
Required: No

 ** availabilityZone **   
The Availability Zone of the instance.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone of the instance.  
Type: String  
Required: No

 ** groupId **   
The Group ID of the 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 for the instance.  
Type: String  
Required: No

 ** hostId **   
The ID of the Dedicated Host for the instance.  
Type: String  
Required: No

 ** hostResourceGroupArn **   
The ARN of the host resource group in which to launch the instances.   
Type: String  
Required: No

 ** partitionNumber **   
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to `partition`.  
Type: Integer  
Required: No

 ** spreadDomain **   
Reserved for future use.  
Type: String  
Required: No

 ** tenancy **   
The tenancy of the instance. An instance with a tenancy of `dedicated` runs on single-tenant hardware.   
Type: String  
Valid Values: `default | dedicated | host`   
Required: No

## See Also
<a name="API_LaunchTemplatePlacement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplatePlacement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplatePlacement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplatePlacement) 

# LaunchTemplatePlacementRequest
<a name="API_LaunchTemplatePlacementRequest"></a>

Describes the placement of an instance.

## Contents
<a name="API_LaunchTemplatePlacementRequest_Contents"></a>

 ** Affinity **   
The affinity setting for an instance on a Dedicated Host.  
Type: String  
Required: No

 ** AvailabilityZone **   
The Availability Zone for the instance.  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both  
Type: String  
Required: No

 ** AvailabilityZoneId **   
The ID of the Availability Zone for the instance.  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both  
Type: String  
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 for the instance.  
Type: String  
Required: No

 ** HostId **   
The ID of the Dedicated Host for the instance.  
Type: String  
Required: No

 ** HostResourceGroupArn **   
The ARN of the host resource group in which to launch the instances. If you specify a host resource group ARN, omit the **Tenancy** parameter or set it to `host`.  
Type: String  
Required: No

 ** PartitionNumber **   
The number of the partition the instance should launch in. Valid only if the placement group strategy is set to `partition`.  
Type: Integer  
Required: No

 ** SpreadDomain **   
Reserved for future use.  
Type: String  
Required: No

 ** Tenancy **   
The tenancy of the instance. An instance with a tenancy of dedicated runs on single-tenant hardware.  
Type: String  
Valid Values: `default | dedicated | host`   
Required: No

## See Also
<a name="API_LaunchTemplatePlacementRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplatePlacementRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplatePlacementRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplatePlacementRequest) 

# LaunchTemplatePrivateDnsNameOptions
<a name="API_LaunchTemplatePrivateDnsNameOptions"></a>

Describes the options for instance hostnames.

## Contents
<a name="API_LaunchTemplatePrivateDnsNameOptions_Contents"></a>

 ** 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

 ** hostnameType **   
The type of hostname to assign to an instance.  
Type: String  
Valid Values: `ip-name | resource-name`   
Required: No

## See Also
<a name="API_LaunchTemplatePrivateDnsNameOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplatePrivateDnsNameOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplatePrivateDnsNameOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplatePrivateDnsNameOptions) 

# LaunchTemplatePrivateDnsNameOptionsRequest
<a name="API_LaunchTemplatePrivateDnsNameOptionsRequest"></a>

Describes the options for instance hostnames.

## Contents
<a name="API_LaunchTemplatePrivateDnsNameOptionsRequest_Contents"></a>

 ** 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

 ** HostnameType **   
The type of hostname for Amazon EC2 instances. For IPv4 only subnets, an instance DNS name must be based on the instance IPv4 address. For IPv6 native 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

## See Also
<a name="API_LaunchTemplatePrivateDnsNameOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplatePrivateDnsNameOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplatePrivateDnsNameOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplatePrivateDnsNameOptionsRequest) 

# LaunchTemplatesMonitoring
<a name="API_LaunchTemplatesMonitoring"></a>

Describes the monitoring for the instance.

## Contents
<a name="API_LaunchTemplatesMonitoring_Contents"></a>

 ** enabled **   
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_LaunchTemplatesMonitoring_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplatesMonitoring) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplatesMonitoring) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplatesMonitoring) 

# LaunchTemplatesMonitoringRequest
<a name="API_LaunchTemplatesMonitoringRequest"></a>

Describes the monitoring for the instance.

## Contents
<a name="API_LaunchTemplatesMonitoringRequest_Contents"></a>

 ** Enabled **   
Specify `true` to enable detailed monitoring. Otherwise, basic monitoring is enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_LaunchTemplatesMonitoringRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplatesMonitoringRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplatesMonitoringRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplatesMonitoringRequest) 

# LaunchTemplateSpecification
<a name="API_LaunchTemplateSpecification"></a>

Describes the launch template to use.

## Contents
<a name="API_LaunchTemplateSpecification_Contents"></a>

 ** 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  
Required: No

 ** Version **   
The launch template version number, `$Latest`, or `$Default`.  
A value of `$Latest` uses the latest version of the launch template.  
A value of `$Default` uses the default version of the launch template.  
Default: The default version of the launch template.  
Type: String  
Required: No

## See Also
<a name="API_LaunchTemplateSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateSpecification) 

# LaunchTemplateSpotMarketOptions
<a name="API_LaunchTemplateSpotMarketOptions"></a>

The options for Spot Instances.

## Contents
<a name="API_LaunchTemplateSpotMarketOptions_Contents"></a>

 ** blockDurationMinutes **   
The required duration for the Spot Instances (also known as Spot blocks), in minutes. This value must be a multiple of 60 (60, 120, 180, 240, 300, or 360).  
Type: Integer  
Required: No

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

 ** maxPrice **   
The maximum hourly price you're 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 do specify this parameter, it must be more than USD \$10.001. Specifying a value below USD \$10.001 will result in an `InvalidParameterValue` error message when the launch template is used to launch an instance.  
Type: String  
Required: No

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

 ** validUntil **   
The end date of the request. For a one-time request, the request remains active until all instances launch, the request is canceled, or this date is reached. If the request is persistent, it remains active until it is canceled or this date and time is reached.  
Type: Timestamp  
Required: No

## See Also
<a name="API_LaunchTemplateSpotMarketOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateSpotMarketOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateSpotMarketOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateSpotMarketOptions) 

# LaunchTemplateSpotMarketOptionsRequest
<a name="API_LaunchTemplateSpotMarketOptionsRequest"></a>

The options for Spot Instances.

## Contents
<a name="API_LaunchTemplateSpotMarketOptionsRequest_Contents"></a>

 ** BlockDurationMinutes **   
Deprecated.  
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

 ** MaxPrice **   
The maximum hourly price you're 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 do specify this parameter, it must be more than USD \$10.001. Specifying a value below USD \$10.001 will result in an `InvalidParameterValue` error message when the launch template is used to launch an instance.  
If you specify a maximum price, your Spot Instances will be interrupted more frequently than if you do not specify this parameter.
Type: String  
Required: No

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

 ** ValidUntil **   
The end date of the request, in UTC format (*YYYY-MM-DD*T*HH:MM:SS*Z). Supported only for persistent requests.  
+ 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, `ValidUntil` is not supported. The request remains active until all instances launch or you cancel the request.
Default: 7 days from the current date  
Type: Timestamp  
Required: No

## See Also
<a name="API_LaunchTemplateSpotMarketOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateSpotMarketOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateSpotMarketOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateSpotMarketOptionsRequest) 

# LaunchTemplateTagSpecification
<a name="API_LaunchTemplateTagSpecification"></a>

The tags specification for the launch template.

## Contents
<a name="API_LaunchTemplateTagSpecification_Contents"></a>

 ** resourceType **   
The type of resource to tag.  
Type: String  
Valid Values: `capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | declarative-policies-report | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | image-usage-report | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-virtual-interface | local-gateway-virtual-interface-group | local-gateway-route-table-vpc-association | local-gateway-route-table-virtual-interface-group-association | natgateway | network-acl | network-interface | network-insights-analysis | network-insights-path | network-insights-access-scope | network-insights-access-scope-analysis | outpost-lag | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | service-link-virtual-interface | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-metering-policy | transit-gateway-route-table | transit-gateway-route-table-announcement | volume | vpc | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log | capacity-reservation-fleet | traffic-mirror-filter-rule | vpc-endpoint-connection-device-type | verified-access-instance | verified-access-group | verified-access-endpoint | verified-access-policy | verified-access-trust-provider | vpn-connection-device-type | vpc-block-public-access-exclusion | vpc-encryption-control | route-server | route-server-endpoint | route-server-peer | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | verified-access-endpoint-target | ipam-external-resource-verification-token | capacity-block | mac-modification-task | ipam-prefix-list-resolver | ipam-policy | ipam-prefix-list-resolver-target | secondary-interface | secondary-network | secondary-subnet | capacity-manager-data-export | vpn-concentrator`   
Required: No

 ** TagSet.N **   
The tags for the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_LaunchTemplateTagSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateTagSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateTagSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateTagSpecification) 

# LaunchTemplateTagSpecificationRequest
<a name="API_LaunchTemplateTagSpecificationRequest"></a>

The tags specification for the resources that are created during instance launch.

## Contents
<a name="API_LaunchTemplateTagSpecificationRequest_Contents"></a>

 ** ResourceType **   
The type of resource to tag.  
Valid Values lists all resource types for Amazon EC2 that can be tagged. When you create a launch template, you can specify tags for the following resource types only: `instance` \$1 `volume` \$1 `network-interface` \$1 `spot-instances-request`. If the instance does not include the resource type that you specify, the instance launch fails. For example, not all instance types include a volume.  
To tag a resource after it has been created, see [CreateTags](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateTags.html).  
Type: String  
Valid Values: `capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | declarative-policies-report | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | image-usage-report | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-virtual-interface | local-gateway-virtual-interface-group | local-gateway-route-table-vpc-association | local-gateway-route-table-virtual-interface-group-association | natgateway | network-acl | network-interface | network-insights-analysis | network-insights-path | network-insights-access-scope | network-insights-access-scope-analysis | outpost-lag | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | service-link-virtual-interface | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-metering-policy | transit-gateway-route-table | transit-gateway-route-table-announcement | volume | vpc | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log | capacity-reservation-fleet | traffic-mirror-filter-rule | vpc-endpoint-connection-device-type | verified-access-instance | verified-access-group | verified-access-endpoint | verified-access-policy | verified-access-trust-provider | vpn-connection-device-type | vpc-block-public-access-exclusion | vpc-encryption-control | route-server | route-server-endpoint | route-server-peer | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | verified-access-endpoint-target | ipam-external-resource-verification-token | capacity-block | mac-modification-task | ipam-prefix-list-resolver | ipam-policy | ipam-prefix-list-resolver-target | secondary-interface | secondary-network | secondary-subnet | capacity-manager-data-export | vpn-concentrator`   
Required: No

 ** Tag.N **   
The tags to apply to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_LaunchTemplateTagSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateTagSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateTagSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateTagSpecificationRequest) 

# LaunchTemplateVersion
<a name="API_LaunchTemplateVersion"></a>

Describes a launch template version.

## Contents
<a name="API_LaunchTemplateVersion_Contents"></a>

 ** createdBy **   
The principal that created the version.  
Type: String  
Required: No

 ** createTime **   
The time the version was created.  
Type: Timestamp  
Required: No

 ** defaultVersion **   
Indicates whether the version is the default version.  
Type: Boolean  
Required: No

 ** launchTemplateData **   
Information about the launch template.  
Type: [ResponseLaunchTemplateData](API_ResponseLaunchTemplateData.md) object  
Required: No

 ** launchTemplateId **   
The ID of the launch template.  
Type: String  
Required: No

 ** launchTemplateName **   
The name of the launch template.  
Type: String  
Length Constraints: Minimum length of 3. Maximum length of 128.  
Pattern: `[a-zA-Z0-9\(\)\.\-/_]+`   
Required: No

 ** operator **   
The entity that manages the launch template.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** versionDescription **   
The description for the version.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 255.  
Required: No

 ** versionNumber **   
The version number.  
Type: Long  
Required: No

## See Also
<a name="API_LaunchTemplateVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LaunchTemplateVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LaunchTemplateVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LaunchTemplateVersion) 

# LicenseConfiguration
<a name="API_LicenseConfiguration"></a>

Describes a license configuration.

## Contents
<a name="API_LicenseConfiguration_Contents"></a>

 ** licenseConfigurationArn **   
The Amazon Resource Name (ARN) of the license configuration.  
Type: String  
Required: No

## See Also
<a name="API_LicenseConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LicenseConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LicenseConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LicenseConfiguration) 

# LicenseConfigurationRequest
<a name="API_LicenseConfigurationRequest"></a>

Describes a license configuration.

## Contents
<a name="API_LicenseConfigurationRequest_Contents"></a>

 ** LicenseConfigurationArn **   
The Amazon Resource Name (ARN) of the license configuration.  
Type: String  
Required: No

## See Also
<a name="API_LicenseConfigurationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LicenseConfigurationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LicenseConfigurationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LicenseConfigurationRequest) 

# LoadBalancersConfig
<a name="API_LoadBalancersConfig"></a>

Describes the Classic Load Balancers and target groups to attach to a Spot Fleet request.

## Contents
<a name="API_LoadBalancersConfig_Contents"></a>

 ** ClassicLoadBalancersConfig ** (request), ** classicLoadBalancersConfig ** (response)  
The Classic Load Balancers.  
Type: [ClassicLoadBalancersConfig](API_ClassicLoadBalancersConfig.md) object  
Required: No

 ** TargetGroupsConfig ** (request), ** targetGroupsConfig ** (response)  
The target groups.  
Type: [TargetGroupsConfig](API_TargetGroupsConfig.md) object  
Required: No

## See Also
<a name="API_LoadBalancersConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LoadBalancersConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LoadBalancersConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LoadBalancersConfig) 

# LoadPermission
<a name="API_LoadPermission"></a>

Describes a load permission.

## Contents
<a name="API_LoadPermission_Contents"></a>

 ** group **   
The name of the group.  
Type: String  
Valid Values: `all`   
Required: No

 ** userId **   
The AWS account ID.  
Type: String  
Required: No

## See Also
<a name="API_LoadPermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LoadPermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LoadPermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LoadPermission) 

# LoadPermissionModifications
<a name="API_LoadPermissionModifications"></a>

Describes modifications to the load permissions of an Amazon FPGA image (AFI).

## Contents
<a name="API_LoadPermissionModifications_Contents"></a>

 ** Add.N **   
The load permissions to add.  
Type: Array of [LoadPermissionRequest](API_LoadPermissionRequest.md) objects  
Required: No

 ** Remove.N **   
The load permissions to remove.  
Type: Array of [LoadPermissionRequest](API_LoadPermissionRequest.md) objects  
Required: No

## See Also
<a name="API_LoadPermissionModifications_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LoadPermissionModifications) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LoadPermissionModifications) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LoadPermissionModifications) 

# LoadPermissionRequest
<a name="API_LoadPermissionRequest"></a>

Describes a load permission.

## Contents
<a name="API_LoadPermissionRequest_Contents"></a>

 ** Group **   
The name of the group.  
Type: String  
Valid Values: `all`   
Required: No

 ** UserId **   
The AWS account ID.  
Type: String  
Required: No

## See Also
<a name="API_LoadPermissionRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LoadPermissionRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LoadPermissionRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LoadPermissionRequest) 

# LocalGateway
<a name="API_LocalGateway"></a>

Describes a local gateway.

## Contents
<a name="API_LocalGateway_Contents"></a>

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

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the local gateway.  
Type: String  
Required: No

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

 ** TagSet.N **   
The tags assigned to the local gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_LocalGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LocalGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LocalGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LocalGateway) 

# LocalGatewayRoute
<a name="API_LocalGatewayRoute"></a>

Describes a route for a local gateway route table.

## Contents
<a name="API_LocalGatewayRoute_Contents"></a>

 ** coipPoolId **   
The ID of the customer-owned address pool.  
Type: String  
Required: No

 ** destinationCidrBlock **   
The CIDR block used for destination matches.  
Type: String  
Required: No

 ** destinationPrefixListId **   
 The ID of the prefix list.   
Type: String  
Required: No

 ** localGatewayRouteTableArn **   
The Amazon Resource Name (ARN) of the local gateway route table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** localGatewayRouteTableId **   
The ID of the local gateway route table.  
Type: String  
Required: No

 ** localGatewayVirtualInterfaceGroupId **   
The ID of the virtual interface group.  
Type: String  
Required: No

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

 ** ownerId **   
The ID of the AWS account that owns the local gateway route.  
Type: String  
Required: No

 ** state **   
The state of the route.  
Type: String  
Valid Values: `pending | active | blackhole | deleting | deleted`   
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

 ** type **   
The route type.  
Type: String  
Valid Values: `static | propagated`   
Required: No

## See Also
<a name="API_LocalGatewayRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LocalGatewayRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LocalGatewayRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LocalGatewayRoute) 

# LocalGatewayRouteTable
<a name="API_LocalGatewayRouteTable"></a>

Describes a local gateway route table.

## Contents
<a name="API_LocalGatewayRouteTable_Contents"></a>

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

 ** localGatewayRouteTableArn **   
The Amazon Resource Name (ARN) of the local gateway route table.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** localGatewayRouteTableId **   
The ID of the local gateway route table.  
Type: String  
Required: No

 ** mode **   
The mode of the local gateway route table.  
Type: String  
Valid Values: `direct-vpc-routing | coip`   
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the local gateway route table.  
Type: String  
Required: No

 ** state **   
The state of the local gateway route table.  
Type: String  
Required: No

 ** stateReason **   
Information about the state change.  
Type: [StateReason](API_StateReason.md) object  
Required: No

 ** TagSet.N **   
The tags assigned to the local gateway route table.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_LocalGatewayRouteTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LocalGatewayRouteTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LocalGatewayRouteTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LocalGatewayRouteTable) 

# LocalGatewayRouteTableVirtualInterfaceGroupAssociation
<a name="API_LocalGatewayRouteTableVirtualInterfaceGroupAssociation"></a>

Describes an association between a local gateway route table and a virtual interface group.

## Contents
<a name="API_LocalGatewayRouteTableVirtualInterfaceGroupAssociation_Contents"></a>

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

 ** localGatewayRouteTableArn **   
The Amazon Resource Name (ARN) of the local gateway route table for the virtual interface group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** localGatewayRouteTableId **   
The ID of the local gateway route table.  
Type: String  
Required: No

 ** localGatewayRouteTableVirtualInterfaceGroupAssociationId **   
The ID of the association.  
Type: String  
Required: No

 ** localGatewayVirtualInterfaceGroupId **   
The ID of the virtual interface group.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the local gateway virtual interface group association.  
Type: String  
Required: No

 ** state **   
The state of the association.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the association.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_LocalGatewayRouteTableVirtualInterfaceGroupAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LocalGatewayRouteTableVirtualInterfaceGroupAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LocalGatewayRouteTableVirtualInterfaceGroupAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LocalGatewayRouteTableVirtualInterfaceGroupAssociation) 

# LocalGatewayRouteTableVpcAssociation
<a name="API_LocalGatewayRouteTableVpcAssociation"></a>

Describes an association between a local gateway route table and a VPC.

## Contents
<a name="API_LocalGatewayRouteTableVpcAssociation_Contents"></a>

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

 ** localGatewayRouteTableArn **   
The Amazon Resource Name (ARN) of the local gateway route table for the association.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** localGatewayRouteTableId **   
The ID of the local gateway route table.  
Type: String  
Required: No

 ** localGatewayRouteTableVpcAssociationId **   
The ID of the association.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the local gateway route table for the association.  
Type: String  
Required: No

 ** state **   
The state of the association.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the association.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_LocalGatewayRouteTableVpcAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LocalGatewayRouteTableVpcAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LocalGatewayRouteTableVpcAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LocalGatewayRouteTableVpcAssociation) 

# LocalGatewayVirtualInterface
<a name="API_LocalGatewayVirtualInterface"></a>

Describes a local gateway virtual interface.

## Contents
<a name="API_LocalGatewayVirtualInterface_Contents"></a>

 ** configurationState **   
The current state of the local gateway virtual interface.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** localAddress **   
The local address.  
Type: String  
Required: No

 ** localBgpAsn **   
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) of the local gateway.  
Type: Integer  
Required: No

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

 ** localGatewayVirtualInterfaceArn **   
The Amazon Resource Number (ARN) of the local gateway virtual interface.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** localGatewayVirtualInterfaceGroupId **   
The ID of the local gateway virtual interface group.  
Type: String  
Required: No

 ** localGatewayVirtualInterfaceId **   
The ID of the virtual interface.  
Type: String  
Required: No

 ** outpostLagId **   
The Outpost LAG ID.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the local gateway virtual interface.  
Type: String  
Required: No

 ** peerAddress **   
The peer address.  
Type: String  
Required: No

 ** peerBgpAsn **   
The peer BGP ASN.  
Type: Integer  
Required: No

 ** peerBgpAsnExtended **   
The extended 32-bit ASN of the BGP peer for use with larger ASN values.  
Type: Long  
Required: No

 ** TagSet.N **   
The tags assigned to the virtual interface.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vlan **   
The ID of the VLAN.  
Type: Integer  
Required: No

## See Also
<a name="API_LocalGatewayVirtualInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LocalGatewayVirtualInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LocalGatewayVirtualInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LocalGatewayVirtualInterface) 

# LocalGatewayVirtualInterfaceGroup
<a name="API_LocalGatewayVirtualInterfaceGroup"></a>

Describes a local gateway virtual interface group.

## Contents
<a name="API_LocalGatewayVirtualInterfaceGroup_Contents"></a>

 ** configurationState **   
The current state of the local gateway virtual interface group.  
Type: String  
Valid Values: `pending | incomplete | available | deleting | deleted`   
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: No

 ** localGatewayVirtualInterfaceGroupArn **   
The Amazon Resource Number (ARN) of the local gateway virtual interface group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** localGatewayVirtualInterfaceGroupId **   
The ID of the virtual interface group.  
Type: String  
Required: No

 ** LocalGatewayVirtualInterfaceIdSet.N **   
The IDs of the virtual interfaces.  
Type: Array of strings  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the local gateway virtual interface group.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the virtual interface group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_LocalGatewayVirtualInterfaceGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LocalGatewayVirtualInterfaceGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LocalGatewayVirtualInterfaceGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LocalGatewayVirtualInterfaceGroup) 

# LockedSnapshotsInfo
<a name="API_LockedSnapshotsInfo"></a>

Information about a locked snapshot.

## Contents
<a name="API_LockedSnapshotsInfo_Contents"></a>

 ** coolOffPeriod **   
The compliance mode cooling-off period, in hours.  
Type: Integer  
Required: No

 ** 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  
Required: No

 ** lockCreatedOn **   
The date and time at which the snapshot was locked, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`).  
Type: Timestamp  
Required: No

 ** lockDuration **   
The period of time for which the snapshot is locked, in days.  
Type: Integer  
Required: No

 ** lockDurationStartTime **   
The date and time at which the lock duration started, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`).  
If you lock a snapshot that is in the `pending` state, the lock duration starts only once the snapshot enters the `completed` state.  
Type: Timestamp  
Required: No

 ** lockExpiresOn **   
The date and time at which the lock will expire, in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`).  
Type: Timestamp  
Required: No

 ** 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`   
Required: No

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

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

## See Also
<a name="API_LockedSnapshotsInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/LockedSnapshotsInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/LockedSnapshotsInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/LockedSnapshotsInfo) 

# MacHost
<a name="API_MacHost"></a>

 Information about the EC2 Mac Dedicated Host. 

## Contents
<a name="API_MacHost_Contents"></a>

 ** hostId **   
 The EC2 Mac Dedicated Host ID.   
Type: String  
Required: No

 ** MacOSLatestSupportedVersionSet.N **   
 The latest macOS versions that the EC2 Mac Dedicated Host can launch without being upgraded.   
Type: Array of strings  
Required: No

## See Also
<a name="API_MacHost_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MacHost) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MacHost) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MacHost) 

# MacModificationTask
<a name="API_MacModificationTask"></a>

Information about a System Integrity Protection (SIP) modification task or volume ownership delegation task for an Amazon EC2 Mac instance.

## Contents
<a name="API_MacModificationTask_Contents"></a>

 ** instanceId **   
The ID of the Amazon EC2 Mac instance.  
Type: String  
Required: No

 ** macModificationTaskId **   
The ID of task.  
Type: String  
Required: No

 ** macSystemIntegrityProtectionConfig **   
[SIP modification tasks only] Information about the SIP configuration.  
Type: [MacSystemIntegrityProtectionConfiguration](API_MacSystemIntegrityProtectionConfiguration.md) object  
Required: No

 ** startTime **   
The date and time the task was created, in the UTC timezone (`YYYY-MM-DDThh:mm:ss.sssZ`).  
Type: Timestamp  
Required: No

 ** TagSet.N **   
The tags assigned to the task.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** taskState **   
The state of the task.  
Type: String  
Valid Values: `successful | failed | in-progress | pending`   
Required: No

 ** taskType **   
The type of task.  
Type: String  
Valid Values: `sip-modification | volume-ownership-delegation`   
Required: No

## See Also
<a name="API_MacModificationTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MacModificationTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MacModificationTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MacModificationTask) 

# MacSystemIntegrityProtectionConfiguration
<a name="API_MacSystemIntegrityProtectionConfiguration"></a>

Describes the configuration for a System Integrity Protection (SIP) modification task.

## Contents
<a name="API_MacSystemIntegrityProtectionConfiguration_Contents"></a>

 ** appleInternal **   
Indicates whether Apple Internal was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** baseSystem **   
Indicates whether Base System was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** debuggingRestrictions **   
Indicates whether Debugging Restrictions was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** dTraceRestrictions **   
Indicates whether Dtrace Restrictions was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** filesystemProtections **   
Indicates whether Filesystem Protections was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** kextSigning **   
Indicates whether Kext Signing was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** nvramProtections **   
Indicates whether NVRAM Protections was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** status **   
Indicates SIP was enabled or disabled by the task.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

## See Also
<a name="API_MacSystemIntegrityProtectionConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MacSystemIntegrityProtectionConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MacSystemIntegrityProtectionConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MacSystemIntegrityProtectionConfiguration) 

# MacSystemIntegrityProtectionConfigurationRequest
<a name="API_MacSystemIntegrityProtectionConfigurationRequest"></a>

Describes a custom configuration for a System Integrity Protection (SIP) modification task.

## Contents
<a name="API_MacSystemIntegrityProtectionConfigurationRequest_Contents"></a>

 ** AppleInternal **   
Enables or disables Apple Internal.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** BaseSystem **   
Enables or disables Base System.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** DebuggingRestrictions **   
Enables or disables Debugging Restrictions.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** DTraceRestrictions **   
Enables or disables Dtrace Restrictions.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** FilesystemProtections **   
Enables or disables Filesystem Protections.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** KextSigning **   
Enables or disables Kext Signing.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

 ** NvramProtections **   
Enables or disables Nvram Protections.  
Type: String  
Valid Values: `enabled | disabled`   
Required: No

## See Also
<a name="API_MacSystemIntegrityProtectionConfigurationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MacSystemIntegrityProtectionConfigurationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MacSystemIntegrityProtectionConfigurationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MacSystemIntegrityProtectionConfigurationRequest) 

# MaintenanceDetails
<a name="API_MaintenanceDetails"></a>

Details for Site-to-Site VPN tunnel endpoint maintenance events.

## Contents
<a name="API_MaintenanceDetails_Contents"></a>

 ** lastMaintenanceApplied **   
Timestamp of last applied maintenance.  
Type: Timestamp  
Required: No

 ** maintenanceAutoAppliedAfter **   
The timestamp after which AWS will automatically apply maintenance.  
Type: Timestamp  
Required: No

 ** pendingMaintenance **   
Verify existence of a pending maintenance.  
Type: String  
Required: No

## See Also
<a name="API_MaintenanceDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MaintenanceDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MaintenanceDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MaintenanceDetails) 

# ManagedPrefixList
<a name="API_ManagedPrefixList"></a>

Describes a managed prefix list.

## Contents
<a name="API_ManagedPrefixList_Contents"></a>

 ** addressFamily **   
The IP address version.  
Type: String  
Required: No

 ** ipamPrefixListResolverSyncEnabled **   
Indicates whether synchronization with an IPAM prefix list resolver is enabled for this managed prefix list. When enabled, the prefix list CIDRs are automatically updated based on the resolver's CIDR selection rules.  
Type: Boolean  
Required: No

 ** ipamPrefixListResolverTargetId **   
The ID of the IPAM prefix list resolver target associated with this managed prefix list. When set, 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: No

 ** maxEntries **   
The maximum number of entries for the prefix list.  
Type: Integer  
Required: No

 ** ownerId **   
The ID of the owner of the prefix list.  
Type: String  
Required: No

 ** prefixListArn **   
The Amazon Resource Name (ARN) for the prefix list.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** prefixListId **   
The ID of the prefix list.  
Type: String  
Required: No

 ** prefixListName **   
The name of the prefix list.  
Type: String  
Required: No

 ** state **   
The current state of the prefix list.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | modify-in-progress | modify-complete | modify-failed | restore-in-progress | restore-complete | restore-failed | delete-in-progress | delete-complete | delete-failed`   
Required: No

 ** stateMessage **   
The state message.  
Type: String  
Required: No

 ** TagSet.N **   
The tags for the prefix list.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** version **   
The version of the prefix list.  
Type: Long  
Required: No

## See Also
<a name="API_ManagedPrefixList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ManagedPrefixList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ManagedPrefixList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ManagedPrefixList) 

# MediaAcceleratorInfo
<a name="API_MediaAcceleratorInfo"></a>

Describes the media accelerators for the instance type.

## Contents
<a name="API_MediaAcceleratorInfo_Contents"></a>

 ** Accelerators.N **   
Describes the media accelerators for the instance type.  
Type: Array of [MediaDeviceInfo](API_MediaDeviceInfo.md) objects  
Required: No

 ** totalMediaMemoryInMiB **   
The total size of the memory for the media accelerators for the instance type, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_MediaAcceleratorInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MediaAcceleratorInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MediaAcceleratorInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MediaAcceleratorInfo) 

# MediaDeviceInfo
<a name="API_MediaDeviceInfo"></a>

Describes the media accelerators for the instance type.

## Contents
<a name="API_MediaDeviceInfo_Contents"></a>

 ** count **   
The number of media accelerators for the instance type.  
Type: Integer  
Required: No

 ** manufacturer **   
The manufacturer of the media accelerator.  
Type: String  
Required: No

 ** memoryInfo **   
Describes the memory available to the media accelerator.  
Type: [MediaDeviceMemoryInfo](API_MediaDeviceMemoryInfo.md) object  
Required: No

 ** name **   
The name of the media accelerator.  
Type: String  
Required: No

## See Also
<a name="API_MediaDeviceInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MediaDeviceInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MediaDeviceInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MediaDeviceInfo) 

# MediaDeviceMemoryInfo
<a name="API_MediaDeviceMemoryInfo"></a>

Describes the memory available to the media accelerator.

## Contents
<a name="API_MediaDeviceMemoryInfo_Contents"></a>

 ** sizeInMiB **   
The size of the memory available to each media accelerator, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_MediaDeviceMemoryInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MediaDeviceMemoryInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MediaDeviceMemoryInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MediaDeviceMemoryInfo) 

# MemoryGiBPerVCpu
<a name="API_MemoryGiBPerVCpu"></a>

The minimum and maximum amount of memory per vCPU, in GiB.



## Contents
<a name="API_MemoryGiBPerVCpu_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no maximum limit.  
Type: Double  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum amount of memory per vCPU, in GiB. If this parameter is not specified, there is no minimum limit.  
Type: Double  
Required: No

## See Also
<a name="API_MemoryGiBPerVCpu_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MemoryGiBPerVCpu) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MemoryGiBPerVCpu) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MemoryGiBPerVCpu) 

# MemoryGiBPerVCpuRequest
<a name="API_MemoryGiBPerVCpuRequest"></a>

The minimum and maximum amount of memory per vCPU, in GiB.

## Contents
<a name="API_MemoryGiBPerVCpuRequest_Contents"></a>

 ** Max **   
The maximum amount of memory per vCPU, in GiB. To specify no maximum limit, omit this parameter.  
Type: Double  
Required: No

 ** Min **   
The minimum amount of memory per vCPU, in GiB. To specify no minimum limit, omit this parameter.  
Type: Double  
Required: No

## See Also
<a name="API_MemoryGiBPerVCpuRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MemoryGiBPerVCpuRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MemoryGiBPerVCpuRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MemoryGiBPerVCpuRequest) 

# MemoryInfo
<a name="API_MemoryInfo"></a>

Describes the memory for the instance type.

## Contents
<a name="API_MemoryInfo_Contents"></a>

 ** sizeInMiB **   
The size of the memory, in MiB.  
Type: Long  
Required: No

## See Also
<a name="API_MemoryInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MemoryInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MemoryInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MemoryInfo) 

# MemoryMiB
<a name="API_MemoryMiB"></a>

The minimum and maximum amount of memory, in MiB.

## Contents
<a name="API_MemoryMiB_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum amount of memory, in MiB. If this parameter is not specified, there is no maximum limit.  
Type: Integer  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum amount of memory, in MiB. If this parameter is not specified, there is no minimum limit.  
Type: Integer  
Required: No

## See Also
<a name="API_MemoryMiB_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MemoryMiB) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MemoryMiB) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MemoryMiB) 

# MemoryMiBRequest
<a name="API_MemoryMiBRequest"></a>

The minimum and maximum amount of memory, in MiB.

## Contents
<a name="API_MemoryMiBRequest_Contents"></a>

 ** Min **   
The minimum amount of memory, in MiB. To specify no minimum limit, specify `0`.  
Type: Integer  
Required: Yes

 ** Max **   
The maximum amount of memory, in MiB. To specify no maximum limit, omit this parameter.  
Type: Integer  
Required: No

## See Also
<a name="API_MemoryMiBRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MemoryMiBRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MemoryMiBRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MemoryMiBRequest) 

# MetricDataResult
<a name="API_MetricDataResult"></a>

 Contains a single data point from a capacity metrics query, including the dimension values, timestamp, and metric values for that specific combination. 

## Contents
<a name="API_MetricDataResult_Contents"></a>

 ** dimension **   
 The dimension values that identify this specific data point, such as account ID, region, and instance family.   
Type: [CapacityManagerDimension](API_CapacityManagerDimension.md) object  
Required: No

 ** MetricValueSet.N **   
 The metric values and statistics for this data point, containing the actual capacity usage numbers.   
Type: Array of [MetricValue](API_MetricValue.md) objects  
Required: No

 ** timestamp **   
 The timestamp for this data point, indicating when the capacity usage occurred.   
Type: Timestamp  
Required: No

## See Also
<a name="API_MetricDataResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MetricDataResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MetricDataResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MetricDataResult) 

# MetricPoint
<a name="API_MetricPoint"></a>

Indicates whether the network was healthy or degraded at a particular point. The value is aggregated from the `startDate` to the `endDate`. Currently only `five_minutes` is supported.

## Contents
<a name="API_MetricPoint_Contents"></a>

 ** endDate **   
The end date for the metric point. The ending time must be formatted as `yyyy-mm-ddThh:mm:ss`. For example, `2022-06-12T12:00:00.000Z`.  
Type: Timestamp  
Required: No

 ** startDate **   
The start date for the metric point. The starting date for the metric point. The starting time must be formatted as `yyyy-mm-ddThh:mm:ss`. For example, `2022-06-10T12:00:00.000Z`.  
Type: Timestamp  
Required: No

 ** status **   
The status of the metric point.  
Type: String  
Required: No

 ** value **   
Type: Float  
Required: No

## See Also
<a name="API_MetricPoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MetricPoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MetricPoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MetricPoint) 

# MetricValue
<a name="API_MetricValue"></a>

 Represents a single metric value with its associated statistic, such as the sum or average of unused capacity hours. 

## Contents
<a name="API_MetricValue_Contents"></a>

 ** metric **   
 The name of the metric.   
Type: String  
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: No

 ** value **   
 The numerical value of the metric for the specified statistic and time period.   
Type: Double  
Required: No

## See Also
<a name="API_MetricValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MetricValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MetricValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MetricValue) 

# ModifyTransitGatewayOptions
<a name="API_ModifyTransitGatewayOptions"></a>

The transit gateway options.

## Contents
<a name="API_ModifyTransitGatewayOptions_Contents"></a>

 ** AddTransitGatewayCidrBlocks.N **   
Adds IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.  
Type: Array of strings  
Required: No

 ** AmazonSideAsn **   
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.  
The modify ASN operation is not allowed on a transit gateway if it has the following attachments:  
+ Dynamic VPN
+ Static VPN
+ Direct Connect Gateway
+ Connect
You must first delete all transit gateway attachments configured prior to modifying the ASN on the transit gateway.  
Type: Long  
Required: No

 ** AssociationDefaultRouteTableId **   
The ID of the default association route table.  
Type: String  
Required: No

 ** AutoAcceptSharedAttachments **   
Enable or disable automatic acceptance of attachment requests.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DefaultRouteTableAssociation **   
Enable or disable automatic association with the default association route table.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DefaultRouteTablePropagation **   
Indicates whether resource attachments automatically propagate routes to the default propagation route table. Enabled by default. If `defaultRouteTablePropagation` is set to `enable`, AWS Transit Gateway will create the default transit gateway route table.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DnsSupport **   
Enable or disable DNS support.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** EncryptionSupport **   
Enable or disable encryption support for VPC Encryption Control.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** PropagationDefaultRouteTableId **   
The ID of the default propagation route table.  
Type: String  
Required: No

 ** RemoveTransitGatewayCidrBlocks.N **   
Removes CIDR blocks for the transit gateway.  
Type: Array of strings  
Required: No

 ** SecurityGroupReferencingSupport **   
Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.   
This option is disabled by default.  
For more information about security group referencing, see [Security group referencing](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#vpc-attachment-security) in the * AWS Transit Gateways Guide*.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** VpnEcmpSupport **   
Enable or disable Equal Cost Multipath Protocol support.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_ModifyTransitGatewayOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTransitGatewayOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTransitGatewayOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTransitGatewayOptions) 

# ModifyTransitGatewayVpcAttachmentRequestOptions
<a name="API_ModifyTransitGatewayVpcAttachmentRequestOptions"></a>

Describes the options for a VPC attachment.

## Contents
<a name="API_ModifyTransitGatewayVpcAttachmentRequestOptions_Contents"></a>

 ** ApplianceModeSupport **   
Enable or disable support for appliance mode. If enabled, a traffic flow between a source and destination uses the same Availability Zone for the VPC attachment for the lifetime of that flow. The default is `disable`.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DnsSupport **   
Enable or disable DNS support. The default is `enable`.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** Ipv6Support **   
Enable or disable IPv6 support. The default is `enable`.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** SecurityGroupReferencingSupport **   
Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.   
This option is disabled by default.  
For more information about security group referencing, see [Security group referencing](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#vpc-attachment-security) in the * AWS Transit Gateways Guide*.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_ModifyTransitGatewayVpcAttachmentRequestOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyTransitGatewayVpcAttachmentRequestOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyTransitGatewayVpcAttachmentRequestOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyTransitGatewayVpcAttachmentRequestOptions) 

# ModifyVerifiedAccessEndpointCidrOptions
<a name="API_ModifyVerifiedAccessEndpointCidrOptions"></a>

The CIDR options for a Verified Access endpoint.

## Contents
<a name="API_ModifyVerifiedAccessEndpointCidrOptions_Contents"></a>

 ** PortRange.N **   
The port ranges.  
Type: Array of [ModifyVerifiedAccessEndpointPortRange](API_ModifyVerifiedAccessEndpointPortRange.md) objects  
Required: No

## See Also
<a name="API_ModifyVerifiedAccessEndpointCidrOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessEndpointCidrOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessEndpointCidrOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointCidrOptions) 

# ModifyVerifiedAccessEndpointEniOptions
<a name="API_ModifyVerifiedAccessEndpointEniOptions"></a>

Describes the options when modifying a Verified Access endpoint with the `network-interface` type.

## Contents
<a name="API_ModifyVerifiedAccessEndpointEniOptions_Contents"></a>

 ** Port **   
The IP port number.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** PortRange.N **   
The port ranges.  
Type: Array of [ModifyVerifiedAccessEndpointPortRange](API_ModifyVerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** Protocol **   
The IP protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

## See Also
<a name="API_ModifyVerifiedAccessEndpointEniOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessEndpointEniOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessEndpointEniOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointEniOptions) 

# ModifyVerifiedAccessEndpointLoadBalancerOptions
<a name="API_ModifyVerifiedAccessEndpointLoadBalancerOptions"></a>

Describes a load balancer when creating an AWS Verified Access endpoint using the `load-balancer` type.

## Contents
<a name="API_ModifyVerifiedAccessEndpointLoadBalancerOptions_Contents"></a>

 ** Port **   
The IP port number.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** PortRange.N **   
The port ranges.  
Type: Array of [ModifyVerifiedAccessEndpointPortRange](API_ModifyVerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** Protocol **   
The IP protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

 ** SubnetId.N **   
The IDs of the subnets.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ModifyVerifiedAccessEndpointLoadBalancerOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessEndpointLoadBalancerOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessEndpointLoadBalancerOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointLoadBalancerOptions) 

# ModifyVerifiedAccessEndpointPortRange
<a name="API_ModifyVerifiedAccessEndpointPortRange"></a>

Describes the port range for a Verified Access endpoint.

## Contents
<a name="API_ModifyVerifiedAccessEndpointPortRange_Contents"></a>

 ** FromPort **   
The start of the port range.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** ToPort **   
The end of the port range.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

## See Also
<a name="API_ModifyVerifiedAccessEndpointPortRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessEndpointPortRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessEndpointPortRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointPortRange) 

# ModifyVerifiedAccessEndpointRdsOptions
<a name="API_ModifyVerifiedAccessEndpointRdsOptions"></a>

The RDS options for a Verified Access endpoint.

## Contents
<a name="API_ModifyVerifiedAccessEndpointRdsOptions_Contents"></a>

 ** Port **   
The port.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** RdsEndpoint **   
The RDS endpoint.  
Type: String  
Required: No

 ** SubnetId.N **   
The IDs of the subnets.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ModifyVerifiedAccessEndpointRdsOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessEndpointRdsOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessEndpointRdsOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessEndpointRdsOptions) 

# ModifyVerifiedAccessNativeApplicationOidcOptions
<a name="API_ModifyVerifiedAccessNativeApplicationOidcOptions"></a>

Describes the OpenID Connect (OIDC) options.

## Contents
<a name="API_ModifyVerifiedAccessNativeApplicationOidcOptions_Contents"></a>

 ** AuthorizationEndpoint **   
The authorization endpoint of the IdP.  
Type: String  
Required: No

 ** ClientId **   
The OAuth 2.0 client identifier.  
Type: String  
Required: No

 ** ClientSecret **   
The OAuth 2.0 client secret.  
Type: String  
Required: No

 ** Issuer **   
The OIDC issuer identifier of the IdP.  
Type: String  
Required: No

 ** PublicSigningKeyEndpoint **   
The public signing key endpoint.  
Type: String  
Required: No

 ** Scope **   
The set of user claims to be requested from the IdP.  
Type: String  
Required: No

 ** TokenEndpoint **   
The token endpoint of the IdP.  
Type: String  
Required: No

 ** UserInfoEndpoint **   
The user info endpoint of the IdP.  
Type: String  
Required: No

## See Also
<a name="API_ModifyVerifiedAccessNativeApplicationOidcOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessNativeApplicationOidcOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessNativeApplicationOidcOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessNativeApplicationOidcOptions) 

# ModifyVerifiedAccessTrustProviderDeviceOptions
<a name="API_ModifyVerifiedAccessTrustProviderDeviceOptions"></a>

Modifies the configuration of the specified device-based AWS Verified Access trust provider.

## Contents
<a name="API_ModifyVerifiedAccessTrustProviderDeviceOptions_Contents"></a>

 ** PublicSigningKeyUrl **   
 The URL AWS Verified Access will use to verify the authenticity of the device tokens.  
Type: String  
Required: No

## See Also
<a name="API_ModifyVerifiedAccessTrustProviderDeviceOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessTrustProviderDeviceOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessTrustProviderDeviceOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessTrustProviderDeviceOptions) 

# ModifyVerifiedAccessTrustProviderOidcOptions
<a name="API_ModifyVerifiedAccessTrustProviderOidcOptions"></a>

Options for an OpenID Connect-compatible user-identity trust provider.

## Contents
<a name="API_ModifyVerifiedAccessTrustProviderOidcOptions_Contents"></a>

 ** AuthorizationEndpoint **   
The OIDC authorization endpoint.  
Type: String  
Required: No

 ** ClientId **   
The client identifier.  
Type: String  
Required: No

 ** ClientSecret **   
The client secret.  
Type: String  
Required: No

 ** Issuer **   
The OIDC issuer.  
Type: String  
Required: No

 ** Scope **   
OpenID Connect (OIDC) scopes are used by an application during authentication to authorize access to a user's details. Each scope returns a specific set of user attributes.  
Type: String  
Required: No

 ** TokenEndpoint **   
The OIDC token endpoint.  
Type: String  
Required: No

 ** UserInfoEndpoint **   
The OIDC user info endpoint.  
Type: String  
Required: No

## See Also
<a name="API_ModifyVerifiedAccessTrustProviderOidcOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVerifiedAccessTrustProviderOidcOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVerifiedAccessTrustProviderOidcOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVerifiedAccessTrustProviderOidcOptions) 

# ModifyVpnTunnelOptionsSpecification
<a name="API_ModifyVpnTunnelOptionsSpecification"></a>

The AWS Site-to-Site VPN tunnel options to modify.

## Contents
<a name="API_ModifyVpnTunnelOptionsSpecification_Contents"></a>

 ** DPDTimeoutAction **   
The action to take after DPD timeout occurs. Specify `restart` to restart the IKE initiation. Specify `clear` to end the IKE session.  
Valid Values: `clear` \$1 `none` \$1 `restart`   
Default: `clear`   
Type: String  
Required: No

 ** DPDTimeoutSeconds **   
The number of seconds after which a DPD timeout occurs. A DPD timeout of 40 seconds means that the VPN endpoint will consider the peer dead 30 seconds after the first failed keep-alive.  
Constraints: A value greater than or equal to 30.  
Default: `40`   
Type: Integer  
Required: No

 ** EnableTunnelLifecycleControl **   
Turn on or off tunnel endpoint lifecycle control feature.  
Type: Boolean  
Required: No

 ** IKEVersion.N **   
The IKE versions that are permitted for the VPN tunnel.  
Valid values: `ikev1` \$1 `ikev2`   
Type: Array of [IKEVersionsRequestListValue](API_IKEVersionsRequestListValue.md) objects  
Required: No

 ** LogOptions **   
Options for logging VPN tunnel activity.  
Type: [VpnTunnelLogOptionsSpecification](API_VpnTunnelLogOptionsSpecification.md) object  
Required: No

 ** Phase1DHGroupNumber.N **   
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.  
Valid values: `2` \$1 `14` \$1 `15` \$1 `16` \$1 `17` \$1 `18` \$1 `19` \$1 `20` \$1 `21` \$1 `22` \$1 `23` \$1 `24`   
Type: Array of [Phase1DHGroupNumbersRequestListValue](API_Phase1DHGroupNumbersRequestListValue.md) objects  
Required: No

 ** Phase1EncryptionAlgorithm.N **   
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.  
Valid values: `AES128` \$1 `AES256` \$1 `AES128-GCM-16` \$1 `AES256-GCM-16`   
Type: Array of [Phase1EncryptionAlgorithmsRequestListValue](API_Phase1EncryptionAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase1IntegrityAlgorithm.N **   
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.  
Valid values: `SHA1` \$1 `SHA2-256` \$1 `SHA2-384` \$1 `SHA2-512`   
Type: Array of [Phase1IntegrityAlgorithmsRequestListValue](API_Phase1IntegrityAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase1LifetimeSeconds **   
The lifetime for phase 1 of the IKE negotiation, in seconds.  
Constraints: A value between 900 and 28,800.  
Default: `28800`   
Type: Integer  
Required: No

 ** Phase2DHGroupNumber.N **   
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.  
Valid values: `2` \$1 `5` \$1 `14` \$1 `15` \$1 `16` \$1 `17` \$1 `18` \$1 `19` \$1 `20` \$1 `21` \$1 `22` \$1 `23` \$1 `24`   
Type: Array of [Phase2DHGroupNumbersRequestListValue](API_Phase2DHGroupNumbersRequestListValue.md) objects  
Required: No

 ** Phase2EncryptionAlgorithm.N **   
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.  
Valid values: `AES128` \$1 `AES256` \$1 `AES128-GCM-16` \$1 `AES256-GCM-16`   
Type: Array of [Phase2EncryptionAlgorithmsRequestListValue](API_Phase2EncryptionAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase2IntegrityAlgorithm.N **   
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.  
Valid values: `SHA1` \$1 `SHA2-256` \$1 `SHA2-384` \$1 `SHA2-512`   
Type: Array of [Phase2IntegrityAlgorithmsRequestListValue](API_Phase2IntegrityAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase2LifetimeSeconds **   
The lifetime for phase 2 of the IKE negotiation, in seconds.  
Constraints: A value between 900 and 3,600. The value must be less than the value for `Phase1LifetimeSeconds`.  
Default: `3600`   
Type: Integer  
Required: No

 ** PreSharedKey **   
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.  
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (\$1). Must be between 8 and 64 characters in length and cannot start with zero (0).  
Type: String  
Required: No

 ** RekeyFuzzPercentage **   
The percentage of the rekey window (determined by `RekeyMarginTimeSeconds`) during which the rekey time is randomly selected.  
Constraints: A value between 0 and 100.  
Default: `100`   
Type: Integer  
Required: No

 ** RekeyMarginTimeSeconds **   
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for `RekeyFuzzPercentage`.  
Constraints: A value between 60 and half of `Phase2LifetimeSeconds`.  
Default: `270`   
Type: Integer  
Required: No

 ** ReplayWindowSize **   
The number of packets in an IKE replay window.  
Constraints: A value between 64 and 2048.  
Default: `1024`   
Type: Integer  
Required: No

 ** StartupAction **   
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify `start` for AWS to initiate the IKE negotiation.  
Valid Values: `add` \$1 `start`   
Default: `add`   
Type: String  
Required: No

 ** TunnelInsideCidr **   
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.   
Constraints: A size /30 CIDR block from the `169.254.0.0/16` range. The following CIDR blocks are reserved and cannot be used:  
+  `169.254.0.0/30` 
+  `169.254.1.0/30` 
+  `169.254.2.0/30` 
+  `169.254.3.0/30` 
+  `169.254.4.0/30` 
+  `169.254.5.0/30` 
+  `169.254.169.252/30` 
Type: String  
Required: No

 ** TunnelInsideIpv6Cidr **   
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.  
Constraints: A size /126 CIDR block from the local `fd00::/8` range.  
Type: String  
Required: No

## See Also
<a name="API_ModifyVpnTunnelOptionsSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ModifyVpnTunnelOptionsSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ModifyVpnTunnelOptionsSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ModifyVpnTunnelOptionsSpecification) 

# Monitoring
<a name="API_Monitoring"></a>

Describes the monitoring of an instance.

## Contents
<a name="API_Monitoring_Contents"></a>

 ** state **   
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.  
Type: String  
Valid Values: `disabled | disabling | enabled | pending`   
Required: No

## See Also
<a name="API_Monitoring_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Monitoring) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Monitoring) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Monitoring) 

# MovingAddressStatus
<a name="API_MovingAddressStatus"></a>

**Note**  
This action is deprecated.

Describes the status of a moving Elastic IP address.

## Contents
<a name="API_MovingAddressStatus_Contents"></a>

 ** moveStatus **   
The status of the Elastic IP address that's being moved or restored.  
Type: String  
Valid Values: `movingToVpc | restoringToClassic`   
Required: No

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

## See Also
<a name="API_MovingAddressStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/MovingAddressStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/MovingAddressStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/MovingAddressStatus) 

# NatGateway
<a name="API_NatGateway"></a>

Describes a NAT gateway.

## Contents
<a name="API_NatGateway_Contents"></a>

 ** AttachedApplianceSet.N **   
The proxy appliances attached to the NAT Gateway for filtering and inspecting traffic to prevent data exfiltration.  
Type: Array of [NatGatewayAttachedAppliance](API_NatGatewayAttachedAppliance.md) objects  
Required: No

 ** autoProvisionZones **   
For regional NAT gateways only: Indicates whether AWS automatically manages AZ coverage. When enabled, the NAT gateway associates EIPs in all AZs where your VPC has subnets to handle outbound NAT traffic, expands to new AZs when you create subnets there, and retracts from AZs where you've removed all subnets. When disabled, you must manually manage which AZs the NAT gateway supports and their corresponding EIPs.  
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: `enabled | disabled`   
Required: No

 ** autoScalingIps **   
For regional NAT gateways only: Indicates whether AWS automatically allocates additional Elastic IP addresses (EIPs) in an AZ when the NAT gateway needs more ports due to increased concurrent connections to a single destination from that AZ.  
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: `enabled | disabled`   
Required: No

 ** availabilityMode **   
Indicates whether this is a zonal (single-AZ) or regional (multi-AZ) NAT gateway.  
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

 ** connectivityType **   
Indicates whether the NAT gateway supports public or private connectivity.  
Type: String  
Valid Values: `private | public`   
Required: No

 ** createTime **   
The date and time the NAT gateway was created.  
Type: Timestamp  
Required: No

 ** deleteTime **   
The date and time the NAT gateway was deleted, if applicable.  
Type: Timestamp  
Required: No

 ** failureCode **   
If the NAT gateway could not be created, specifies the error code for the failure. (`InsufficientFreeAddressesInSubnet` \$1 `Gateway.NotAttached` \$1 `InvalidAllocationID.NotFound` \$1 `Resource.AlreadyAssociated` \$1 `InternalError` \$1 `InvalidSubnetID.NotFound`)  
Type: String  
Required: No

 ** failureMessage **   
If the NAT gateway could not be created, specifies the error message for the failure, that corresponds to the error code.  
+ For InsufficientFreeAddressesInSubnet: "Subnet has insufficient free addresses to create this NAT gateway"
+ For Gateway.NotAttached: "Network vpc-xxxxxxxx has no Internet gateway attached"
+ For InvalidAllocationID.NotFound: "Elastic IP address eipalloc-xxxxxxxx could not be associated with this NAT gateway"
+ For Resource.AlreadyAssociated: "Elastic IP address eipalloc-xxxxxxxx is already associated"
+ For InternalError: "Network interface eni-xxxxxxxx, created and used internally by this NAT gateway is in an invalid state. Please try again."
+ For InvalidSubnetID.NotFound: "The specified subnet subnet-xxxxxxxx does not exist or could not be found."
Type: String  
Required: No

 ** NatGatewayAddressSet.N **   
Information about the IP addresses and network interface associated with the NAT gateway.  
Type: Array of [NatGatewayAddress](API_NatGatewayAddress.md) objects  
Required: No

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

 ** provisionedBandwidth **   
Reserved. If you need to sustain traffic greater than the [documented limits](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-gateways), contact AWS Support.  
Type: [ProvisionedBandwidth](API_ProvisionedBandwidth.md) object  
Required: No

 ** routeTableId **   
For regional NAT gateways only, this is the ID of the NAT gateway.  
Type: String  
Required: No

 ** state **   
The state of the NAT gateway.  
+  `pending`: The NAT gateway is being created and is not ready to process traffic.
+  `failed`: The NAT gateway could not be created. Check the `failureCode` and `failureMessage` fields for the reason.
+  `available`: The NAT gateway is able to process traffic. This status remains until you delete the NAT gateway, and does not indicate the health of the NAT gateway.
+  `deleting`: The NAT gateway is in the process of being terminated and may still be processing traffic.
+  `deleted`: The NAT gateway has been terminated and is no longer processing traffic.
Type: String  
Valid Values: `pending | failed | available | deleting | deleted`   
Required: No

 ** subnetId **   
The ID of the subnet in which the NAT gateway is located.  
Type: String  
Required: No

 ** TagSet.N **   
The tags for the NAT gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC in which the NAT gateway is located.  
Type: String  
Required: No

## See Also
<a name="API_NatGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NatGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NatGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NatGateway) 

# NatGatewayAddress
<a name="API_NatGatewayAddress"></a>

Describes the IP addresses and network interface associated with a NAT gateway.

## Contents
<a name="API_NatGatewayAddress_Contents"></a>

 ** allocationId **   
[Public NAT gateway only] The allocation ID of the Elastic IP address that's associated with the NAT gateway.  
Type: String  
Required: No

 ** associationId **   
[Public NAT gateway only] The association ID of the Elastic IP address that's associated with the NAT gateway.  
Type: String  
Required: No

 ** availabilityZone **   
The Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone where this Elastic IP address (EIP) is being used to handle outbound NAT traffic. Use this instead of AvailabilityZone for consistent identification of AZs across AWS Regions.  
Type: String  
Required: No

 ** failureMessage **   
The address failure message.  
Type: String  
Required: No

 ** isPrimary **   
Defines if the IP address is the primary address.  
Type: Boolean  
Required: No

 ** networkInterfaceId **   
The ID of the network interface associated with the NAT gateway.  
Type: String  
Required: No

 ** privateIp **   
The private IP address associated with the NAT gateway.  
Type: String  
Required: No

 ** publicIp **   
[Public NAT gateway only] The Elastic IP address associated with the NAT gateway.  
Type: String  
Required: No

 ** status **   
The address status.  
Type: String  
Valid Values: `assigning | unassigning | associating | disassociating | succeeded | failed`   
Required: No

## See Also
<a name="API_NatGatewayAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NatGatewayAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NatGatewayAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NatGatewayAddress) 

# NatGatewayAttachedAppliance
<a name="API_NatGatewayAttachedAppliance"></a>

Information about an appliance attached to a NAT Gateway, providing managed security solutions for traffic filtering and inspection.

## Contents
<a name="API_NatGatewayAttachedAppliance_Contents"></a>

 ** applianceArn **   
The Amazon Resource Name (ARN) of the attached appliance, identifying the specific proxy or security appliance resource.  
Type: String  
Required: No

 ** attachmentState **   
The current attachment state of the appliance.  
Type: String  
Valid Values: `attaching | attached | detaching | detached | attach-failed | detach-failed`   
Required: No

 ** failureCode **   
The failure code if the appliance attachment or modification operation failed.  
Type: String  
Required: No

 ** failureMessage **   
A descriptive message explaining the failure if the appliance attachment or modification operation failed.  
Type: String  
Required: No

 ** modificationState **   
The current modification state of the appliance.  
Type: String  
Valid Values: `modifying | completed | failed`   
Required: No

 ** type **   
The type of appliance attached to the NAT Gateway. For network firewall proxy functionality, this will be "network-firewall-proxy".  
Type: String  
Valid Values: `network-firewall-proxy`   
Required: No

 ** vpcEndpointId **   
The VPC endpoint ID used to route traffic from application VPCs to the proxy for inspection and filtering.  
Type: String  
Required: No

## See Also
<a name="API_NatGatewayAttachedAppliance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NatGatewayAttachedAppliance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NatGatewayAttachedAppliance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NatGatewayAttachedAppliance) 

# NativeApplicationOidcOptions
<a name="API_NativeApplicationOidcOptions"></a>

Describes the OpenID Connect (OIDC) options.

## Contents
<a name="API_NativeApplicationOidcOptions_Contents"></a>

 ** authorizationEndpoint **   
The authorization endpoint of the IdP.  
Type: String  
Required: No

 ** clientId **   
The OAuth 2.0 client identifier.  
Type: String  
Required: No

 ** issuer **   
The OIDC issuer identifier of the IdP.  
Type: String  
Required: No

 ** publicSigningKeyEndpoint **   
The public signing key endpoint.  
Type: String  
Required: No

 ** scope **   
The set of user claims to be requested from the IdP.  
Type: String  
Required: No

 ** tokenEndpoint **   
The token endpoint of the IdP.  
Type: String  
Required: No

 ** userInfoEndpoint **   
The user info endpoint of the IdP.  
Type: String  
Required: No

## See Also
<a name="API_NativeApplicationOidcOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NativeApplicationOidcOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NativeApplicationOidcOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NativeApplicationOidcOptions) 

# NetworkAcl
<a name="API_NetworkAcl"></a>

Describes a network ACL.

## Contents
<a name="API_NetworkAcl_Contents"></a>

 ** AssociationSet.N **   
Any associations between the network ACL and your subnets  
Type: Array of [NetworkAclAssociation](API_NetworkAclAssociation.md) objects  
Required: No

 ** default **   
Indicates whether this is the default network ACL for the VPC.  
Type: Boolean  
Required: No

 ** EntrySet.N **   
The entries (rules) in the network ACL.  
Type: Array of [NetworkAclEntry](API_NetworkAclEntry.md) objects  
Required: No

 ** networkAclId **   
The ID of the network ACL.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the network ACL.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the network ACL.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC for the network ACL.  
Type: String  
Required: No

## See Also
<a name="API_NetworkAcl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkAcl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkAcl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkAcl) 

# NetworkAclAssociation
<a name="API_NetworkAclAssociation"></a>

Describes an association between a network ACL and a subnet.

## Contents
<a name="API_NetworkAclAssociation_Contents"></a>

 ** networkAclAssociationId **   
The ID of the association between a network ACL and a subnet.  
Type: String  
Required: No

 ** networkAclId **   
The ID of the network ACL.  
Type: String  
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

## See Also
<a name="API_NetworkAclAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkAclAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkAclAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkAclAssociation) 

# NetworkAclEntry
<a name="API_NetworkAclEntry"></a>

Describes an entry in a network ACL.

## Contents
<a name="API_NetworkAclEntry_Contents"></a>

 ** cidrBlock **   
The IPv4 network range to allow or deny, in CIDR notation.  
Type: String  
Required: No

 ** egress **   
Indicates whether the rule is an egress rule (applied to traffic leaving the subnet).  
Type: Boolean  
Required: No

 ** icmpTypeCode **   
ICMP protocol: The ICMP type and code.  
Type: [IcmpTypeCode](API_IcmpTypeCode.md) object  
Required: No

 ** ipv6CidrBlock **   
The IPv6 network range to allow or deny, in CIDR notation.  
Type: String  
Required: No

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

 ** protocol **   
The protocol number. A value of "-1" means all protocols.  
Type: String  
Required: No

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

 ** ruleNumber **   
The rule number for the entry. ACL entries are processed in ascending order by rule number.  
Type: Integer  
Required: No

## See Also
<a name="API_NetworkAclEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkAclEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkAclEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkAclEntry) 

# NetworkBandwidthGbps
<a name="API_NetworkBandwidthGbps"></a>

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

**Note**  
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_NetworkBandwidthGbps_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no maximum limit.  
Type: Double  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum amount of network bandwidth, in Gbps. If this parameter is not specified, there is no minimum limit.  
Type: Double  
Required: No

## See Also
<a name="API_NetworkBandwidthGbps_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkBandwidthGbps) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkBandwidthGbps) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkBandwidthGbps) 

# NetworkBandwidthGbpsRequest
<a name="API_NetworkBandwidthGbpsRequest"></a>

The minimum and maximum amount of network bandwidth, in gigabits per second (Gbps).

**Note**  
Setting the minimum bandwidth does not guarantee that your instance will achieve the minimum bandwidth. Amazon EC2 will identify instance types that support the specified minimum bandwidth, but the actual bandwidth of your instance might go below the specified minimum at times. For more information, see [Available instance bandwidth](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-network-bandwidth.html#available-instance-bandwidth) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_NetworkBandwidthGbpsRequest_Contents"></a>

 ** Max **   
The maximum amount of network bandwidth, in Gbps. To specify no maximum limit, omit this parameter.  
Type: Double  
Required: No

 ** Min **   
The minimum amount of network bandwidth, in Gbps. To specify no minimum limit, omit this parameter.  
Type: Double  
Required: No

## See Also
<a name="API_NetworkBandwidthGbpsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkBandwidthGbpsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkBandwidthGbpsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkBandwidthGbpsRequest) 

# NetworkCardInfo
<a name="API_NetworkCardInfo"></a>

Describes the network card support of the instance type.

## Contents
<a name="API_NetworkCardInfo_Contents"></a>

 ** additionalFlexibleNetworkInterfaces **   
The number of additional network interfaces that can be attached to an instance when using flexible Elastic Network Adapter (ENA) queues. This number is in addition to the base number specified by `maximumNetworkInterfaces`.  
Type: Integer  
Required: No

 ** baselineBandwidthInGbps **   
The baseline network performance of the network card, in Gbps.  
Type: Double  
Required: No

 ** defaultEnaQueueCountPerInterface **   
The default number of the ENA queues for each interface.  
Type: Integer  
Required: No

 ** maximumEnaQueueCount **   
The maximum number of the ENA queues.  
Type: Integer  
Required: No

 ** maximumEnaQueueCountPerInterface **   
The maximum number of the ENA queues for each interface.  
Type: Integer  
Required: No

 ** maximumNetworkInterfaces **   
The maximum number of network interfaces for the network card.  
Type: Integer  
Required: No

 ** networkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

 ** networkPerformance **   
The network performance of the network card.  
Type: String  
Required: No

 ** peakBandwidthInGbps **   
The peak (burst) network performance of the network card, in Gbps.  
Type: Double  
Required: No

## See Also
<a name="API_NetworkCardInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkCardInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkCardInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkCardInfo) 

# NetworkInfo
<a name="API_NetworkInfo"></a>

Describes the networking features of the instance type.

## Contents
<a name="API_NetworkInfo_Contents"></a>

 ** BandwidthWeightings.N **   
A list of valid settings for configurable bandwidth weighting for the instance type, if supported.  
Type: Array of strings  
Valid Values: `default | vpc-1 | ebs-1`   
Required: No

 ** connectionTrackingConfiguration **   
Indicates conntrack information for the instance type  
Type: [DefaultConnectionTrackingConfiguration](API_DefaultConnectionTrackingConfiguration.md) object  
Required: No

 ** defaultNetworkCardIndex **   
The index of the default network card, starting at 0.  
Type: Integer  
Required: No

 ** efaInfo **   
Describes the Elastic Fabric Adapters for the instance type.  
Type: [EfaInfo](API_EfaInfo.md) object  
Required: No

 ** efaSupported **   
Indicates whether Elastic Fabric Adapter (EFA) is supported.  
Type: Boolean  
Required: No

 ** enaSrdSupported **   
Indicates whether the instance type supports ENA Express. ENA Express uses AWS Scalable Reliable Datagram (SRD) technology to increase the maximum bandwidth used per stream and minimize tail latency of network traffic between EC2 instances.  
Type: Boolean  
Required: No

 ** enaSupport **   
Indicates whether Elastic Network Adapter (ENA) is supported.  
Type: String  
Valid Values: `unsupported | supported | required`   
Required: No

 ** encryptionInTransitSupported **   
Indicates whether the instance type automatically encrypts in-transit traffic between instances.  
Type: Boolean  
Required: No

 ** flexibleEnaQueuesSupport **   
Indicates whether changing the number of ENA queues is supported.  
Type: String  
Valid Values: `unsupported | supported`   
Required: No

 ** ipv4AddressesPerInterface **   
The maximum number of IPv4 addresses per network interface.  
Type: Integer  
Required: No

 ** ipv4AddressesPerSecondaryInterface **   
The maximum number of IPv4 addresses per secondary interface.  
Type: Integer  
Required: No

 ** ipv6AddressesPerInterface **   
The maximum number of IPv6 addresses per network interface.  
Type: Integer  
Required: No

 ** ipv6Supported **   
Indicates whether IPv6 is supported.  
Type: Boolean  
Required: No

 ** maximumNetworkCards **   
The maximum number of physical network cards that can be allocated to the instance.  
Type: Integer  
Required: No

 ** maximumNetworkInterfaces **   
The maximum number of network interfaces for the instance type.  
Type: Integer  
Required: No

 ** maximumSecondaryNetworkInterfaces **   
The maximum number of secondary interfaces for the instance type.  
Type: Integer  
Required: No

 ** NetworkCards.N **   
Describes the network cards for the instance type.  
Type: Array of [NetworkCardInfo](API_NetworkCardInfo.md) objects  
Required: No

 ** networkPerformance **   
The network performance.  
Type: String  
Required: No

 ** secondaryNetworkSupported **   
Indicates whether secondary interface attachments from secondary network are supported.  
Type: Boolean  
Required: No

## See Also
<a name="API_NetworkInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInfo) 

# NetworkInsightsAccessScope
<a name="API_NetworkInsightsAccessScope"></a>

Describes a Network Access Scope.

## Contents
<a name="API_NetworkInsightsAccessScope_Contents"></a>

 ** createdDate **   
The creation date.  
Type: Timestamp  
Required: No

 ** networkInsightsAccessScopeArn **   
The Amazon Resource Name (ARN) of the Network Access Scope.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** networkInsightsAccessScopeId **   
The ID of the Network Access Scope.  
Type: String  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** updatedDate **   
The last updated date.  
Type: Timestamp  
Required: No

## See Also
<a name="API_NetworkInsightsAccessScope_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInsightsAccessScope) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInsightsAccessScope) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInsightsAccessScope) 

# NetworkInsightsAccessScopeAnalysis
<a name="API_NetworkInsightsAccessScopeAnalysis"></a>

Describes a Network Access Scope analysis.

## Contents
<a name="API_NetworkInsightsAccessScopeAnalysis_Contents"></a>

 ** analyzedEniCount **   
The number of network interfaces analyzed.  
Type: Integer  
Required: No

 ** endDate **   
The analysis end date.  
Type: Timestamp  
Required: No

 ** findingsFound **   
Indicates whether there are findings.  
Type: String  
Valid Values: `true | false | unknown`   
Required: No

 ** networkInsightsAccessScopeAnalysisArn **   
The Amazon Resource Name (ARN) of the Network Access Scope analysis.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** networkInsightsAccessScopeAnalysisId **   
The ID of the Network Access Scope analysis.  
Type: String  
Required: No

 ** networkInsightsAccessScopeId **   
The ID of the Network Access Scope.  
Type: String  
Required: No

 ** startDate **   
The analysis start date.  
Type: Timestamp  
Required: No

 ** status **   
The status.  
Type: String  
Valid Values: `running | succeeded | failed`   
Required: No

 ** statusMessage **   
The status message.  
Type: String  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** warningMessage **   
The warning message.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInsightsAccessScopeAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInsightsAccessScopeAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInsightsAccessScopeAnalysis) 

# NetworkInsightsAccessScopeContent
<a name="API_NetworkInsightsAccessScopeContent"></a>

Describes the Network Access Scope content.

## Contents
<a name="API_NetworkInsightsAccessScopeContent_Contents"></a>

 ** ExcludePathSet.N **   
The paths to exclude.  
Type: Array of [AccessScopePath](API_AccessScopePath.md) objects  
Required: No

 ** MatchPathSet.N **   
The paths to match.  
Type: Array of [AccessScopePath](API_AccessScopePath.md) objects  
Required: No

 ** networkInsightsAccessScopeId **   
The ID of the Network Access Scope.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInsightsAccessScopeContent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInsightsAccessScopeContent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInsightsAccessScopeContent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInsightsAccessScopeContent) 

# NetworkInsightsAnalysis
<a name="API_NetworkInsightsAnalysis"></a>

Describes a network insights analysis.

## Contents
<a name="API_NetworkInsightsAnalysis_Contents"></a>

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

 ** AlternatePathHintSet.N **   
Potential intermediate components.  
Type: Array of [AlternatePathHint](API_AlternatePathHint.md) objects  
Required: No

 ** ExplanationSet.N **   
The explanations. For more information, see [Reachability Analyzer explanation codes](https://docs.aws.amazon.com/vpc/latest/reachability/explanation-codes.html).  
Type: Array of [Explanation](API_Explanation.md) objects  
Required: No

 ** FilterInArnSet.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

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

 ** ForwardPathComponentSet.N **   
The components in the path from source to destination.  
Type: Array of [PathComponent](API_PathComponent.md) objects  
Required: No

 ** networkInsightsAnalysisArn **   
The Amazon Resource Name (ARN) of the network insights analysis.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** networkInsightsAnalysisId **   
The ID of the network insights analysis.  
Type: String  
Required: No

 ** networkInsightsPathId **   
The ID of the path.  
Type: String  
Required: No

 ** networkPathFound **   
Indicates whether the destination is reachable from the source.  
Type: Boolean  
Required: No

 ** ReturnPathComponentSet.N **   
The components in the path from destination to source.  
Type: Array of [PathComponent](API_PathComponent.md) objects  
Required: No

 ** startDate **   
The time the analysis started.  
Type: Timestamp  
Required: No

 ** status **   
The status of the network insights analysis.  
Type: String  
Valid Values: `running | succeeded | failed`   
Required: No

 ** statusMessage **   
The status message, if the status is `failed`.  
Type: String  
Required: No

 ** SuggestedAccountSet.N **   
Potential intermediate accounts.  
Type: Array of strings  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** warningMessage **   
The warning message.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInsightsAnalysis_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInsightsAnalysis) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInsightsAnalysis) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInsightsAnalysis) 

# NetworkInsightsPath
<a name="API_NetworkInsightsPath"></a>

Describes a path.

## Contents
<a name="API_NetworkInsightsPath_Contents"></a>

 ** createdDate **   
The time stamp when the path was created.  
Type: Timestamp  
Required: No

 ** destination **   
The ID of the destination.  
Type: String  
Required: No

 ** destinationArn **   
The Amazon Resource Name (ARN) of the destination.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
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  
Required: No

 ** filterAtDestination **   
Scopes the analysis to network paths that match specific filters at the destination.  
Type: [PathFilter](API_PathFilter.md) object  
Required: No

 ** filterAtSource **   
Scopes the analysis to network paths that match specific filters at the source.  
Type: [PathFilter](API_PathFilter.md) object  
Required: No

 ** networkInsightsPathArn **   
The Amazon Resource Name (ARN) of the path.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** networkInsightsPathId **   
The ID of the path.  
Type: String  
Required: No

 ** protocol **   
The protocol.  
Type: String  
Valid Values: `tcp | udp`   
Required: No

 ** source **   
The ID of the source.  
Type: String  
Required: No

 ** sourceArn **   
The Amazon Resource Name (ARN) of the source.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** 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

 ** TagSet.N **   
The tags associated with the path.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_NetworkInsightsPath_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInsightsPath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInsightsPath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInsightsPath) 

# NetworkInterface
<a name="API_NetworkInterface"></a>

Describes a network interface.

## Contents
<a name="API_NetworkInterface_Contents"></a>

 ** AssociatedSubnetSet.N **   
The subnets associated with this network interface.  
Type: Array of strings  
Required: No

 ** association **   
The association information for an Elastic IP address (IPv4) associated with the network interface.  
Type: [NetworkInterfaceAssociation](API_NetworkInterfaceAssociation.md) object  
Required: No

 ** attachment **   
The network interface attachment.  
Type: [NetworkInterfaceAttachment](API_NetworkInterfaceAttachment.md) object  
Required: No

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** connectionTrackingConfiguration **   
A security group connection tracking configuration that enables you to set the timeout for connection tracking on an Elastic network interface. For more information, see [Connection tracking timeouts](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/security-group-connection-tracking.html#connection-tracking-timeouts) in the *Amazon EC2 User Guide*.  
Type: [ConnectionTrackingConfiguration](API_ConnectionTrackingConfiguration.md) object  
Required: No

 ** denyAllIgwTraffic **   
Indicates whether a network interface with an IPv6 address is unreachable from the public internet. If the value is `true`, inbound traffic from the internet is dropped and you cannot assign an elastic IP address to the network interface. The network interface is reachable from peered VPCs and resources connected through a transit gateway, including on-premises networks.  
Type: Boolean  
Required: No

 ** description **   
A description.  
Type: String  
Required: No

 ** GroupSet.N **   
Any security groups for the network interface.  
Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects  
Required: No

 ** interfaceType **   
The type of network interface.  
Type: String  
Valid Values: `api_gateway_managed | aws_codestar_connections_managed | branch | ec2_instance_connect_endpoint | efa | efa-only | efs | evs | gateway_load_balancer | gateway_load_balancer_endpoint | global_accelerator_managed | interface | iot_rules_managed | lambda | load_balancer | nat_gateway | network_load_balancer | quicksight | transit_gateway | trunk | vpc_endpoint`   
Required: No

 ** Ipv4PrefixSet.N **   
The IPv4 prefixes that are assigned to the network interface.  
Type: Array of [Ipv4PrefixSpecification](API_Ipv4PrefixSpecification.md) objects  
Required: No

 ** ipv6Address **   
The IPv6 globally unique address associated with the network interface.  
Type: String  
Required: No

 ** Ipv6AddressesSet.N **   
The IPv6 addresses associated with the network interface.  
Type: Array of [NetworkInterfaceIpv6Address](API_NetworkInterfaceIpv6Address.md) objects  
Required: No

 ** ipv6Native **   
Indicates whether this is an IPv6 only network interface.  
Type: Boolean  
Required: No

 ** Ipv6PrefixSet.N **   
The IPv6 prefixes that are assigned to the network interface.  
Type: Array of [Ipv6PrefixSpecification](API_Ipv6PrefixSpecification.md) objects  
Required: No

 ** macAddress **   
The MAC address.  
Type: String  
Required: No

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

 ** operator **   
The service provider that manages the network interface.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** ownerId **   
The AWS account ID of the owner of the network interface.  
Type: String  
Required: No

 ** privateDnsName **   
The private hostname. 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*.  
Type: String  
Required: No

 ** privateIpAddress **   
The IPv4 address of the network interface within the subnet.  
Type: String  
Required: No

 ** PrivateIpAddressesSet.N **   
The private IPv4 addresses associated with the network interface.  
Type: Array of [NetworkInterfacePrivateIpAddress](API_NetworkInterfacePrivateIpAddress.md) objects  
Required: No

 ** publicDnsName **   
A public hostname. 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*.  
Type: String  
Required: No

 ** publicIpDnsNameOptions **   
Public hostname type options. 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*.  
Type: [PublicIpDnsNameOptions](API_PublicIpDnsNameOptions.md) object  
Required: No

 ** requesterId **   
The alias or AWS account ID of the principal or service that created the network interface.  
Type: String  
Required: No

 ** requesterManaged **   
Indicates whether the network interface is being managed by AWS.  
Type: Boolean  
Required: No

 ** sourceDestCheck **   
Indicates whether source/destination checking is enabled.  
Type: Boolean  
Required: No

 ** status **   
The status of the network interface.  
Type: String  
Valid Values: `available | associated | attaching | in-use | detaching`   
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the network interface.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterface) 

# NetworkInterfaceAssociation
<a name="API_NetworkInterfaceAssociation"></a>

Describes association information for an Elastic IP address (IPv4 only), or a Carrier IP address (for a network interface which resides in a subnet in a Wavelength Zone).

## Contents
<a name="API_NetworkInterfaceAssociation_Contents"></a>

 ** allocationId **   
The allocation ID.  
Type: String  
Required: No

 ** associationId **   
The association ID.  
Type: String  
Required: No

 ** carrierIp **   
The carrier IP address associated with the network interface.  
This option is only available when the network interface is in a subnet which is associated with a Wavelength Zone.  
Type: String  
Required: No

 ** customerOwnedIp **   
The customer-owned IP address associated with the network interface.  
Type: String  
Required: No

 ** ipOwnerId **   
The ID of the Elastic IP address owner.  
Type: String  
Required: No

 ** publicDnsName **   
The public DNS name.  
Type: String  
Required: No

 ** publicIp **   
The address of the Elastic IP address bound to the network interface.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInterfaceAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfaceAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfaceAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfaceAssociation) 

# NetworkInterfaceAttachment
<a name="API_NetworkInterfaceAttachment"></a>

Describes a network interface attachment.

## Contents
<a name="API_NetworkInterfaceAttachment_Contents"></a>

 ** attachmentId **   
The ID of the network interface attachment.  
Type: String  
Required: No

 ** attachTime **   
The timestamp indicating when the attachment initiated.  
Type: Timestamp  
Required: No

 ** deleteOnTermination **   
Indicates whether the network interface is deleted when the instance is terminated.  
Type: Boolean  
Required: No

 ** deviceIndex **   
The device index of the network interface attachment on the instance.  
Type: Integer  
Required: No

 ** enaQueueCount **   
The number of ENA queues created with the instance.  
Type: Integer  
Required: No

 ** enaSrdSpecification **   
Configures ENA Express for the network interface that this action attaches to the instance.  
Type: [AttachmentEnaSrdSpecification](API_AttachmentEnaSrdSpecification.md) object  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

 ** instanceOwnerId **   
The AWS account ID of the owner of the instance.  
Type: String  
Required: No

 ** networkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

 ** status **   
The attachment state.  
Type: String  
Valid Values: `attaching | attached | detaching | detached`   
Required: No

## See Also
<a name="API_NetworkInterfaceAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfaceAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfaceAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfaceAttachment) 

# NetworkInterfaceAttachmentChanges
<a name="API_NetworkInterfaceAttachmentChanges"></a>

Describes an attachment change.

## Contents
<a name="API_NetworkInterfaceAttachmentChanges_Contents"></a>

 ** AttachmentId **   
The ID of the network interface attachment.  
Type: String  
Required: No

 ** DefaultEnaQueueCount **   
The default number of the ENA queues.  
Type: Boolean  
Required: No

 ** DeleteOnTermination **   
Indicates whether the network interface is deleted when the instance is terminated.  
Type: Boolean  
Required: No

 ** EnaQueueCount **   
The number of ENA queues to be created with the instance.  
Type: Integer  
Required: No

## See Also
<a name="API_NetworkInterfaceAttachmentChanges_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfaceAttachmentChanges) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfaceAttachmentChanges) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfaceAttachmentChanges) 

# NetworkInterfaceCount
<a name="API_NetworkInterfaceCount"></a>

The minimum and maximum number of network interfaces.

## Contents
<a name="API_NetworkInterfaceCount_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum number of network interfaces. If this parameter is not specified, there is no maximum limit.  
Type: Integer  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum number of network interfaces. If this parameter is not specified, there is no minimum limit.  
Type: Integer  
Required: No

## See Also
<a name="API_NetworkInterfaceCount_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfaceCount) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfaceCount) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfaceCount) 

# NetworkInterfaceCountRequest
<a name="API_NetworkInterfaceCountRequest"></a>

The minimum and maximum number of network interfaces.

## Contents
<a name="API_NetworkInterfaceCountRequest_Contents"></a>

 ** Max **   
The maximum number of network interfaces. To specify no maximum limit, omit this parameter.  
Type: Integer  
Required: No

 ** Min **   
The minimum number of network interfaces. To specify no minimum limit, omit this parameter.  
Type: Integer  
Required: No

## See Also
<a name="API_NetworkInterfaceCountRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfaceCountRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfaceCountRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfaceCountRequest) 

# NetworkInterfaceIpv6Address
<a name="API_NetworkInterfaceIpv6Address"></a>

Describes an IPv6 address associated with a network interface.

## Contents
<a name="API_NetworkInterfaceIpv6Address_Contents"></a>

 ** ipv6Address **   
The IPv6 address.  
Type: String  
Required: No

 ** isPrimaryIpv6 **   
Determines if an IPv6 address associated with a network interface is the primary IPv6 address. 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. For more information, see [ModifyNetworkInterfaceAttribute](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyNetworkInterfaceAttribute.html).  
Type: Boolean  
Required: No

 ** publicIpv6DnsName **   
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. 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*.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInterfaceIpv6Address_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfaceIpv6Address) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfaceIpv6Address) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfaceIpv6Address) 

# NetworkInterfacePermission
<a name="API_NetworkInterfacePermission"></a>

Describes a permission for a network interface.

## Contents
<a name="API_NetworkInterfacePermission_Contents"></a>

 ** awsAccountId **   
The AWS account ID.  
Type: String  
Required: No

 ** awsService **   
The AWS service.  
Type: String  
Required: No

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

 ** networkInterfacePermissionId **   
The ID of the network interface permission.  
Type: String  
Required: No

 ** permission **   
The type of permission.  
Type: String  
Valid Values: `INSTANCE-ATTACH | EIP-ASSOCIATE`   
Required: No

 ** permissionState **   
Information about the state of the permission.  
Type: [NetworkInterfacePermissionState](API_NetworkInterfacePermissionState.md) object  
Required: No

## See Also
<a name="API_NetworkInterfacePermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfacePermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfacePermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfacePermission) 

# NetworkInterfacePermissionState
<a name="API_NetworkInterfacePermissionState"></a>

Describes the state of a network interface permission.

## Contents
<a name="API_NetworkInterfacePermissionState_Contents"></a>

 ** state **   
The state of the permission.  
Type: String  
Valid Values: `pending | granted | revoking | revoked`   
Required: No

 ** statusMessage **   
A status message, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInterfacePermissionState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfacePermissionState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfacePermissionState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfacePermissionState) 

# NetworkInterfacePrivateIpAddress
<a name="API_NetworkInterfacePrivateIpAddress"></a>

Describes the private IPv4 address of a network interface.

## Contents
<a name="API_NetworkInterfacePrivateIpAddress_Contents"></a>

 ** association **   
The association information for an Elastic IP address (IPv4) associated with the network interface.  
Type: [NetworkInterfaceAssociation](API_NetworkInterfaceAssociation.md) object  
Required: No

 ** primary **   
Indicates whether this IPv4 address is the primary private IPv4 address of the network interface.  
Type: Boolean  
Required: No

 ** privateDnsName **   
The private DNS name.  
Type: String  
Required: No

 ** privateIpAddress **   
The private IPv4 address.  
Type: String  
Required: No

## See Also
<a name="API_NetworkInterfacePrivateIpAddress_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NetworkInterfacePrivateIpAddress) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NetworkInterfacePrivateIpAddress) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NetworkInterfacePrivateIpAddress) 

# NeuronDeviceCoreInfo
<a name="API_NeuronDeviceCoreInfo"></a>

Describes the cores available to the neuron accelerator.

## Contents
<a name="API_NeuronDeviceCoreInfo_Contents"></a>

 ** count **   
The number of cores available to the neuron accelerator.  
Type: Integer  
Required: No

 ** version **   
The version of the neuron accelerator.  
Type: Integer  
Required: No

## See Also
<a name="API_NeuronDeviceCoreInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NeuronDeviceCoreInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NeuronDeviceCoreInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NeuronDeviceCoreInfo) 

# NeuronDeviceInfo
<a name="API_NeuronDeviceInfo"></a>

Describes the neuron accelerators for the instance type.

## Contents
<a name="API_NeuronDeviceInfo_Contents"></a>

 ** coreInfo **   
Describes the cores available to each neuron accelerator.  
Type: [NeuronDeviceCoreInfo](API_NeuronDeviceCoreInfo.md) object  
Required: No

 ** count **   
The number of neuron accelerators for the instance type.  
Type: Integer  
Required: No

 ** memoryInfo **   
Describes the memory available to each neuron accelerator.  
Type: [NeuronDeviceMemoryInfo](API_NeuronDeviceMemoryInfo.md) object  
Required: No

 ** name **   
The name of the neuron accelerator.  
Type: String  
Required: No

## See Also
<a name="API_NeuronDeviceInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NeuronDeviceInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NeuronDeviceInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NeuronDeviceInfo) 

# NeuronDeviceMemoryInfo
<a name="API_NeuronDeviceMemoryInfo"></a>

Describes the memory available to the neuron accelerator.

## Contents
<a name="API_NeuronDeviceMemoryInfo_Contents"></a>

 ** sizeInMiB **   
The size of the memory available to the neuron accelerator, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_NeuronDeviceMemoryInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NeuronDeviceMemoryInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NeuronDeviceMemoryInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NeuronDeviceMemoryInfo) 

# NeuronInfo
<a name="API_NeuronInfo"></a>

Describes the neuron accelerators for the instance type.

## Contents
<a name="API_NeuronInfo_Contents"></a>

 ** NeuronDevices.N **   
Describes the neuron accelerators for the instance type.  
Type: Array of [NeuronDeviceInfo](API_NeuronDeviceInfo.md) objects  
Required: No

 ** totalNeuronDeviceMemoryInMiB **   
The total size of the memory for the neuron accelerators for the instance type, in MiB.  
Type: Integer  
Required: No

## See Also
<a name="API_NeuronInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NeuronInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NeuronInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NeuronInfo) 

# NewDhcpConfiguration
<a name="API_NewDhcpConfiguration"></a>

Describes a DHCP configuration option.

## Contents
<a name="API_NewDhcpConfiguration_Contents"></a>

 ** Key **   
The name of a DHCP option.  
Type: String  
Required: No

 ** Value.N **   
The values for the DHCP option.  
Type: Array of strings  
Required: No

## See Also
<a name="API_NewDhcpConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NewDhcpConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NewDhcpConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NewDhcpConfiguration) 

# NitroTpmInfo
<a name="API_NitroTpmInfo"></a>

Describes the supported NitroTPM versions for the instance type.

## Contents
<a name="API_NitroTpmInfo_Contents"></a>

 ** SupportedVersions.N **   
Indicates the supported NitroTPM versions.  
Type: Array of strings  
Required: No

## See Also
<a name="API_NitroTpmInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/NitroTpmInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/NitroTpmInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/NitroTpmInfo) 

# OidcOptions
<a name="API_OidcOptions"></a>

Describes the options for an OpenID Connect-compatible user-identity trust provider.

## Contents
<a name="API_OidcOptions_Contents"></a>

 ** authorizationEndpoint **   
The OIDC authorization endpoint.  
Type: String  
Required: No

 ** clientId **   
The client identifier.  
Type: String  
Required: No

 ** clientSecret **   
The client secret.  
Type: String  
Required: No

 ** issuer **   
The OIDC issuer.  
Type: String  
Required: No

 ** scope **   
The OpenID Connect (OIDC) scope specified.  
Type: String  
Required: No

 ** tokenEndpoint **   
The OIDC token endpoint.  
Type: String  
Required: No

 ** userInfoEndpoint **   
The OIDC user info endpoint.  
Type: String  
Required: No

## See Also
<a name="API_OidcOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/OidcOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/OidcOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/OidcOptions) 

# OnDemandOptions
<a name="API_OnDemandOptions"></a>

Describes the configuration of On-Demand Instances in an EC2 Fleet.

## Contents
<a name="API_OnDemandOptions_Contents"></a>

 ** allocationStrategy **   
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.  
 `lowest-price` - EC2 Fleet uses price to determine the order, launching the lowest price first.  
 `prioritized` - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.  
Default: `lowest-price`   
Type: String  
Valid Values: `lowest-price | prioritized`   
Required: No

 ** capacityReservationOptions **   
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.  
Supported only for fleets of type `instant`.  
Type: [CapacityReservationOptions](API_CapacityReservationOptions.md) object  
Required: No

 ** maxTotalPrice **   
The maximum amount per hour for On-Demand Instances that you're willing to pay.  
If your fleet includes T instances that are configured as `unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `maxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `maxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 ** minTargetCapacity **   
The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.  
Constraints: Maximum value of `1000`. Supported only for fleets of type `instant`.  
At least one of the following must be specified: `SingleAvailabilityZone` \$1 `SingleInstanceType`   
Type: Integer  
Required: No

 ** singleAvailabilityZone **   
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

 ** singleInstanceType **   
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

## See Also
<a name="API_OnDemandOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/OnDemandOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/OnDemandOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/OnDemandOptions) 

# OnDemandOptionsRequest
<a name="API_OnDemandOptionsRequest"></a>

Describes the configuration of On-Demand Instances in an EC2 Fleet.

## Contents
<a name="API_OnDemandOptionsRequest_Contents"></a>

 ** AllocationStrategy **   
The strategy that determines the order of the launch template overrides to use in fulfilling On-Demand capacity.  
 `lowest-price` - EC2 Fleet uses price to determine the order, launching the lowest price first.  
 `prioritized` - EC2 Fleet uses the priority that you assigned to each launch template override, launching the highest priority first.  
Default: `lowest-price`   
Type: String  
Valid Values: `lowest-price | prioritized`   
Required: No

 ** CapacityReservationOptions **   
The strategy for using unused Capacity Reservations for fulfilling On-Demand capacity.  
Supported only for fleets of type `instant`.  
Type: [CapacityReservationOptionsRequest](API_CapacityReservationOptionsRequest.md) object  
Required: No

 ** MaxTotalPrice **   
The maximum amount per hour for On-Demand Instances that you're willing to pay.  
If your fleet includes T instances that are configured as `unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `MaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `MaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 ** MinTargetCapacity **   
The minimum target capacity for On-Demand Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.  
Constraints: Maximum value of `1000`. Supported only for fleets of type `instant`.  
At least one of the following must be specified: `SingleAvailabilityZone` \$1 `SingleInstanceType`   
Type: Integer  
Required: No

 ** SingleAvailabilityZone **   
Indicates that the fleet launches all On-Demand Instances into a single Availability Zone.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

 ** SingleInstanceType **   
Indicates that the fleet uses a single instance type to launch all On-Demand Instances in the fleet.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

## See Also
<a name="API_OnDemandOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/OnDemandOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/OnDemandOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/OnDemandOptionsRequest) 

# OperatorRequest
<a name="API_OperatorRequest"></a>

The service provider that manages the resource.

## Contents
<a name="API_OperatorRequest_Contents"></a>

 ** Principal **   
The service provider that manages the resource.  
Type: String  
Required: No

## See Also
<a name="API_OperatorRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/OperatorRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/OperatorRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/OperatorRequest) 

# OperatorResponse
<a name="API_OperatorResponse"></a>

Describes whether the resource is managed by a service provider and, if so, describes the service provider that manages it.

## Contents
<a name="API_OperatorResponse_Contents"></a>

 ** managed **   
If `true`, the resource is managed by a service provider.  
Type: Boolean  
Required: No

 ** principal **   
If `managed` is `true`, then the principal is returned. The principal is the service provider that manages the resource.  
Type: String  
Required: No

## See Also
<a name="API_OperatorResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/OperatorResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/OperatorResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/OperatorResponse) 

# OutpostLag
<a name="API_OutpostLag"></a>

Describes an Outpost link aggregation group (LAG).

## Contents
<a name="API_OutpostLag_Contents"></a>

 ** LocalGatewayVirtualInterfaceIdSet.N **   
The IDs of the local gateway virtual interfaces associated with the Outpost LAG.  
Type: Array of strings  
Required: No

 ** outpostArn **   
The Amazon Resource Number (ARN) of the Outpost LAG.  
Type: String  
Required: No

 ** outpostLagId **   
The ID of the Outpost LAG.  
Type: String  
Required: No

 ** ownerId **   
The ID of the Outpost LAG owner.  
Type: String  
Required: No

 ** ServiceLinkVirtualInterfaceIdSet.N **   
The service link virtual interface IDs associated with the Outpost LAG.  
Type: Array of strings  
Required: No

 ** state **   
The current state of the Outpost LAG.  
Type: String  
Required: No

 ** TagSet.N **   
The tags associated with the Outpost LAG.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_OutpostLag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/OutpostLag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/OutpostLag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/OutpostLag) 

# PacketHeaderStatement
<a name="API_PacketHeaderStatement"></a>

Describes a packet header statement.

## Contents
<a name="API_PacketHeaderStatement_Contents"></a>

 ** DestinationAddressSet.N **   
The destination addresses.  
Type: Array of strings  
Required: No

 ** DestinationPortSet.N **   
The destination ports.  
Type: Array of strings  
Required: No

 ** DestinationPrefixListSet.N **   
The destination prefix lists.  
Type: Array of strings  
Required: No

 ** ProtocolSet.N **   
The protocols.  
Type: Array of strings  
Valid Values: `tcp | udp`   
Required: No

 ** SourceAddressSet.N **   
The source addresses.  
Type: Array of strings  
Required: No

 ** SourcePortSet.N **   
The source ports.  
Type: Array of strings  
Required: No

 ** SourcePrefixListSet.N **   
The source prefix lists.  
Type: Array of strings  
Required: No

## See Also
<a name="API_PacketHeaderStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PacketHeaderStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PacketHeaderStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PacketHeaderStatement) 

# PacketHeaderStatementRequest
<a name="API_PacketHeaderStatementRequest"></a>

Describes a packet header statement.

## Contents
<a name="API_PacketHeaderStatementRequest_Contents"></a>

 ** DestinationAddress.N **   
The destination addresses.  
Type: Array of strings  
Required: No

 ** DestinationPort.N **   
The destination ports.  
Type: Array of strings  
Required: No

 ** DestinationPrefixList.N **   
The destination prefix lists.  
Type: Array of strings  
Required: No

 ** Protocol.N **   
The protocols.  
Type: Array of strings  
Valid Values: `tcp | udp`   
Required: No

 ** SourceAddress.N **   
The source addresses.  
Type: Array of strings  
Required: No

 ** SourcePort.N **   
The source ports.  
Type: Array of strings  
Required: No

 ** SourcePrefixList.N **   
The source prefix lists.  
Type: Array of strings  
Required: No

## See Also
<a name="API_PacketHeaderStatementRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PacketHeaderStatementRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PacketHeaderStatementRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PacketHeaderStatementRequest) 

# PathComponent
<a name="API_PathComponent"></a>

Describes a path component.

## Contents
<a name="API_PathComponent_Contents"></a>

 ** aclRule **   
The network ACL rule.  
Type: [AnalysisAclRule](API_AnalysisAclRule.md) object  
Required: No

 ** AdditionalDetailSet.N **   
The additional details.  
Type: Array of [AdditionalDetail](API_AdditionalDetail.md) objects  
Required: No

 ** attachedTo **   
The resource to which the path component is attached.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** component **   
The component.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** destinationVpc **   
The destination VPC.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** elasticLoadBalancerListener **   
The load balancer listener.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** ExplanationSet.N **   
The explanation codes.  
Type: Array of [Explanation](API_Explanation.md) objects  
Required: No

 ** firewallStatefulRule **   
The Network Firewall stateful rule.  
Type: [FirewallStatefulRule](API_FirewallStatefulRule.md) object  
Required: No

 ** firewallStatelessRule **   
The Network Firewall stateless rule.  
Type: [FirewallStatelessRule](API_FirewallStatelessRule.md) object  
Required: No

 ** inboundHeader **   
The inbound header.  
Type: [AnalysisPacketHeader](API_AnalysisPacketHeader.md) object  
Required: No

 ** outboundHeader **   
The outbound header.  
Type: [AnalysisPacketHeader](API_AnalysisPacketHeader.md) object  
Required: No

 ** routeTableRoute **   
The route table route.  
Type: [AnalysisRouteTableRoute](API_AnalysisRouteTableRoute.md) object  
Required: No

 ** securityGroupRule **   
The security group rule.  
Type: [AnalysisSecurityGroupRule](API_AnalysisSecurityGroupRule.md) object  
Required: No

 ** sequenceNumber **   
The sequence number.  
Type: Integer  
Required: No

 ** serviceName **   
The name of the VPC endpoint service.  
Type: String  
Required: No

 ** sourceVpc **   
The source VPC.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** subnet **   
The subnet.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** transitGateway **   
The transit gateway.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

 ** transitGatewayRouteTableRoute **   
The route in a transit gateway route table.  
Type: [TransitGatewayRouteTableRoute](API_TransitGatewayRouteTableRoute.md) object  
Required: No

 ** vpc **   
The component VPC.  
Type: [AnalysisComponent](API_AnalysisComponent.md) object  
Required: No

## See Also
<a name="API_PathComponent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PathComponent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PathComponent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PathComponent) 

# PathFilter
<a name="API_PathFilter"></a>

Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.

## Contents
<a name="API_PathFilter_Contents"></a>

 ** destinationAddress **   
The destination IPv4 address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** destinationPortRange **   
The destination port range.  
Type: [FilterPortRange](API_FilterPortRange.md) object  
Required: No

 ** sourceAddress **   
The source IPv4 address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** sourcePortRange **   
The source port range.  
Type: [FilterPortRange](API_FilterPortRange.md) object  
Required: No

## See Also
<a name="API_PathFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PathFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PathFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PathFilter) 

# PathRequestFilter
<a name="API_PathRequestFilter"></a>

Describes a set of filters for a path analysis. Use path filters to scope the analysis when there can be multiple resulting paths.

## Contents
<a name="API_PathRequestFilter_Contents"></a>

 ** DestinationAddress **   
The destination IPv4 address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** DestinationPortRange **   
The destination port range.  
Type: [RequestFilterPortRange](API_RequestFilterPortRange.md) object  
Required: No

 ** SourceAddress **   
The source IPv4 address.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 15.  
Pattern: `^([0-9]{1,3}.){3}[0-9]{1,3}$`   
Required: No

 ** SourcePortRange **   
The source port range.  
Type: [RequestFilterPortRange](API_RequestFilterPortRange.md) object  
Required: No

## See Also
<a name="API_PathRequestFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PathRequestFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PathRequestFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PathRequestFilter) 

# PathStatement
<a name="API_PathStatement"></a>

Describes a path statement.

## Contents
<a name="API_PathStatement_Contents"></a>

 ** packetHeaderStatement **   
The packet header statement.  
Type: [PacketHeaderStatement](API_PacketHeaderStatement.md) object  
Required: No

 ** resourceStatement **   
The resource statement.  
Type: [ResourceStatement](API_ResourceStatement.md) object  
Required: No

## See Also
<a name="API_PathStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PathStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PathStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PathStatement) 

# PathStatementRequest
<a name="API_PathStatementRequest"></a>

Describes a path statement.

## Contents
<a name="API_PathStatementRequest_Contents"></a>

 ** PacketHeaderStatement **   
The packet header statement.  
Type: [PacketHeaderStatementRequest](API_PacketHeaderStatementRequest.md) object  
Required: No

 ** ResourceStatement **   
The resource statement.  
Type: [ResourceStatementRequest](API_ResourceStatementRequest.md) object  
Required: No

## See Also
<a name="API_PathStatementRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PathStatementRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PathStatementRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PathStatementRequest) 

# PciId
<a name="API_PciId"></a>

Describes the data that identifies an Amazon FPGA image (AFI) on the PCI bus.

## Contents
<a name="API_PciId_Contents"></a>

 ** DeviceId **   
The ID of the device.  
Type: String  
Required: No

 ** SubsystemId **   
The ID of the subsystem.  
Type: String  
Required: No

 ** SubsystemVendorId **   
The ID of the vendor for the subsystem.  
Type: String  
Required: No

 ** VendorId **   
The ID of the vendor.  
Type: String  
Required: No

## See Also
<a name="API_PciId_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PciId) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PciId) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PciId) 

# PeeringAttachmentStatus
<a name="API_PeeringAttachmentStatus"></a>

The status of the transit gateway peering attachment.

## Contents
<a name="API_PeeringAttachmentStatus_Contents"></a>

 ** code **   
The status code.  
Type: String  
Required: No

 ** message **   
The status message, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_PeeringAttachmentStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PeeringAttachmentStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PeeringAttachmentStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PeeringAttachmentStatus) 

# PeeringConnectionOptions
<a name="API_PeeringConnectionOptions"></a>

Describes the VPC peering connection options.

## Contents
<a name="API_PeeringConnectionOptions_Contents"></a>

 ** allowDnsResolutionFromRemoteVpc **   
If true, the public DNS hostnames of instances in the specified VPC resolve to private IP addresses when queried from instances in the peer VPC.  
Type: Boolean  
Required: No

 ** allowEgressFromLocalClassicLinkToRemoteVpc **   
Deprecated.  
Type: Boolean  
Required: No

 ** allowEgressFromLocalVpcToRemoteClassicLink **   
Deprecated.  
Type: Boolean  
Required: No

## See Also
<a name="API_PeeringConnectionOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PeeringConnectionOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PeeringConnectionOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PeeringConnectionOptions) 

# PeeringConnectionOptionsRequest
<a name="API_PeeringConnectionOptionsRequest"></a>

The VPC peering connection options.

## Contents
<a name="API_PeeringConnectionOptionsRequest_Contents"></a>

 ** AllowDnsResolutionFromRemoteVpc **   
If true, enables a local VPC to resolve public DNS hostnames to private IP addresses when queried from instances in the peer VPC.  
Type: Boolean  
Required: No

 ** AllowEgressFromLocalClassicLinkToRemoteVpc **   
Deprecated.  
Type: Boolean  
Required: No

 ** AllowEgressFromLocalVpcToRemoteClassicLink **   
Deprecated.  
Type: Boolean  
Required: No

## See Also
<a name="API_PeeringConnectionOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PeeringConnectionOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PeeringConnectionOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PeeringConnectionOptionsRequest) 

# PeeringTgwInfo
<a name="API_PeeringTgwInfo"></a>

Information about the transit gateway in the peering attachment.

## Contents
<a name="API_PeeringTgwInfo_Contents"></a>

 ** coreNetworkId **   
The ID of the core network where the transit gateway peer is located.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the transit gateway.  
Type: String  
Required: No

 ** region **   
The Region of the transit gateway.  
Type: String  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

## See Also
<a name="API_PeeringTgwInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PeeringTgwInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PeeringTgwInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PeeringTgwInfo) 

# PerformanceFactorReference
<a name="API_PerformanceFactorReference"></a>

Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture.

**Note**  
Currently, only one instance family can be specified in the list.

## Contents
<a name="API_PerformanceFactorReference_Contents"></a>

 ** InstanceFamily ** (request), ** instanceFamily ** (response)  
The instance family to use as a baseline reference.  
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (`.`) in the instance type name. For example, in the instance type `c6i.large`, the instance family is `c6i`, not `c6`. For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types*.
The following instance families are *not supported* for performance protection:  
+  `c1` 
+  `g3` \$1 `g3s` 
+  `hpc7g` 
+  `m1` \$1 `m2` 
+  `mac1` \$1 `mac2` \$1 `mac2-m1ultra` \$1 `mac2-m2` \$1 `mac2-m2pro` 
+  `p3dn` \$1 `p4d` \$1 `p5` 
+  `t1` 
+  `u-12tb1` \$1 `u-18tb1` \$1 `u-24tb1` \$1 `u-3tb1` \$1 `u-6tb1` \$1 `u-9tb1` \$1 `u7i-12tb` \$1 `u7in-16tb` \$1 `u7in-24tb` \$1 `u7in-32tb` 
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.  
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements) and an exception for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet), [ModifyFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyFleet), and [ModifySpotFleetRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySpotFleetRequest).  
Type: String  
Required: No

## See Also
<a name="API_PerformanceFactorReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PerformanceFactorReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PerformanceFactorReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PerformanceFactorReference) 

# PerformanceFactorReferenceRequest
<a name="API_PerformanceFactorReferenceRequest"></a>

Specify an instance family to use as the baseline reference for CPU performance. All instance types that match your specified attributes will be compared against the CPU performance of the referenced instance family, regardless of CPU manufacturer or architecture.

**Note**  
Currently, only one instance family can be specified in the list.

## Contents
<a name="API_PerformanceFactorReferenceRequest_Contents"></a>

 ** InstanceFamily **   
The instance family to use as a baseline reference.  
Ensure that you specify the correct value for the instance family. The instance family is everything before the period (`.`) in the instance type name. For example, in the instance type `c6i.large`, the instance family is `c6i`, not `c6`. For more information, see [Amazon EC2 instance type naming conventions](https://docs.aws.amazon.com/ec2/latest/instancetypes/instance-type-names.html) in *Amazon EC2 Instance Types*.
The following instance families are *not supported* for performance protection:  
+  `c1` 
+  `g3` \$1 `g3s` 
+  `hpc7g` 
+  `m1` \$1 `m2` 
+  `mac1` \$1 `mac2` \$1 `mac2-m1ultra` \$1 `mac2-m2` \$1 `mac2-m2pro` 
+  `p3dn` \$1 `p4d` \$1 `p5` 
+  `t1` 
+  `u-12tb1` \$1 `u-18tb1` \$1 `u-24tb1` \$1 `u-3tb1` \$1 `u-6tb1` \$1 `u-9tb1` \$1 `u7i-12tb` \$1 `u7in-16tb` \$1 `u7in-24tb` \$1 `u7in-32tb` 
If you enable performance protection by specifying a supported instance family, the returned instance types will exclude the above unsupported instance families.  
If you specify an unsupported instance family as a value for baseline performance, the API returns an empty response for [GetInstanceTypesFromInstanceRequirements](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_GetInstanceTypesFromInstanceRequirements) and an exception for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet), [RequestSpotFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RequestSpotFleet), [ModifyFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifyFleet), and [ModifySpotFleetRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ModifySpotFleetRequest).  
Type: String  
Required: No

## See Also
<a name="API_PerformanceFactorReferenceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PerformanceFactorReferenceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PerformanceFactorReferenceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PerformanceFactorReferenceRequest) 

# Phase1DHGroupNumbersListValue
<a name="API_Phase1DHGroupNumbersListValue"></a>

The Diffie-Hellmann group number for phase 1 IKE negotiations.

## Contents
<a name="API_Phase1DHGroupNumbersListValue_Contents"></a>

 ** value **   
The Diffie-Hellmann group number.  
Type: Integer  
Required: No

## See Also
<a name="API_Phase1DHGroupNumbersListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase1DHGroupNumbersListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase1DHGroupNumbersListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase1DHGroupNumbersListValue) 

# Phase1DHGroupNumbersRequestListValue
<a name="API_Phase1DHGroupNumbersRequestListValue"></a>

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 1 IKE negotiations.

## Contents
<a name="API_Phase1DHGroupNumbersRequestListValue_Contents"></a>

 ** Value **   
The Diffie-Hellmann group number.  
Type: Integer  
Required: No

## See Also
<a name="API_Phase1DHGroupNumbersRequestListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase1DHGroupNumbersRequestListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase1DHGroupNumbersRequestListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase1DHGroupNumbersRequestListValue) 

# Phase1EncryptionAlgorithmsListValue
<a name="API_Phase1EncryptionAlgorithmsListValue"></a>

The encryption algorithm for phase 1 IKE negotiations.

## Contents
<a name="API_Phase1EncryptionAlgorithmsListValue_Contents"></a>

 ** value **   
The value for the encryption algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase1EncryptionAlgorithmsListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase1EncryptionAlgorithmsListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase1EncryptionAlgorithmsListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase1EncryptionAlgorithmsListValue) 

# Phase1EncryptionAlgorithmsRequestListValue
<a name="API_Phase1EncryptionAlgorithmsRequestListValue"></a>

Specifies the encryption algorithm for the VPN tunnel for phase 1 IKE negotiations.

## Contents
<a name="API_Phase1EncryptionAlgorithmsRequestListValue_Contents"></a>

 ** Value **   
The value for the encryption algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase1EncryptionAlgorithmsRequestListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase1EncryptionAlgorithmsRequestListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase1EncryptionAlgorithmsRequestListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase1EncryptionAlgorithmsRequestListValue) 

# Phase1IntegrityAlgorithmsListValue
<a name="API_Phase1IntegrityAlgorithmsListValue"></a>

The integrity algorithm for phase 1 IKE negotiations.

## Contents
<a name="API_Phase1IntegrityAlgorithmsListValue_Contents"></a>

 ** value **   
The value for the integrity algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase1IntegrityAlgorithmsListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase1IntegrityAlgorithmsListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase1IntegrityAlgorithmsListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase1IntegrityAlgorithmsListValue) 

# Phase1IntegrityAlgorithmsRequestListValue
<a name="API_Phase1IntegrityAlgorithmsRequestListValue"></a>

Specifies the integrity algorithm for the VPN tunnel for phase 1 IKE negotiations.

## Contents
<a name="API_Phase1IntegrityAlgorithmsRequestListValue_Contents"></a>

 ** Value **   
The value for the integrity algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase1IntegrityAlgorithmsRequestListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase1IntegrityAlgorithmsRequestListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase1IntegrityAlgorithmsRequestListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase1IntegrityAlgorithmsRequestListValue) 

# Phase2DHGroupNumbersListValue
<a name="API_Phase2DHGroupNumbersListValue"></a>

The Diffie-Hellmann group number for phase 2 IKE negotiations.

## Contents
<a name="API_Phase2DHGroupNumbersListValue_Contents"></a>

 ** value **   
The Diffie-Hellmann group number.  
Type: Integer  
Required: No

## See Also
<a name="API_Phase2DHGroupNumbersListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase2DHGroupNumbersListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase2DHGroupNumbersListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase2DHGroupNumbersListValue) 

# Phase2DHGroupNumbersRequestListValue
<a name="API_Phase2DHGroupNumbersRequestListValue"></a>

Specifies a Diffie-Hellman group number for the VPN tunnel for phase 2 IKE negotiations.

## Contents
<a name="API_Phase2DHGroupNumbersRequestListValue_Contents"></a>

 ** Value **   
The Diffie-Hellmann group number.  
Type: Integer  
Required: No

## See Also
<a name="API_Phase2DHGroupNumbersRequestListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase2DHGroupNumbersRequestListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase2DHGroupNumbersRequestListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase2DHGroupNumbersRequestListValue) 

# Phase2EncryptionAlgorithmsListValue
<a name="API_Phase2EncryptionAlgorithmsListValue"></a>

The encryption algorithm for phase 2 IKE negotiations.

## Contents
<a name="API_Phase2EncryptionAlgorithmsListValue_Contents"></a>

 ** value **   
The encryption algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase2EncryptionAlgorithmsListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase2EncryptionAlgorithmsListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase2EncryptionAlgorithmsListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase2EncryptionAlgorithmsListValue) 

# Phase2EncryptionAlgorithmsRequestListValue
<a name="API_Phase2EncryptionAlgorithmsRequestListValue"></a>

Specifies the encryption algorithm for the VPN tunnel for phase 2 IKE negotiations.

## Contents
<a name="API_Phase2EncryptionAlgorithmsRequestListValue_Contents"></a>

 ** Value **   
The encryption algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase2EncryptionAlgorithmsRequestListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase2EncryptionAlgorithmsRequestListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase2EncryptionAlgorithmsRequestListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase2EncryptionAlgorithmsRequestListValue) 

# Phase2IntegrityAlgorithmsListValue
<a name="API_Phase2IntegrityAlgorithmsListValue"></a>

The integrity algorithm for phase 2 IKE negotiations.

## Contents
<a name="API_Phase2IntegrityAlgorithmsListValue_Contents"></a>

 ** value **   
The integrity algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase2IntegrityAlgorithmsListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase2IntegrityAlgorithmsListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase2IntegrityAlgorithmsListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase2IntegrityAlgorithmsListValue) 

# Phase2IntegrityAlgorithmsRequestListValue
<a name="API_Phase2IntegrityAlgorithmsRequestListValue"></a>

Specifies the integrity algorithm for the VPN tunnel for phase 2 IKE negotiations.

## Contents
<a name="API_Phase2IntegrityAlgorithmsRequestListValue_Contents"></a>

 ** Value **   
The integrity algorithm.  
Type: String  
Required: No

## See Also
<a name="API_Phase2IntegrityAlgorithmsRequestListValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Phase2IntegrityAlgorithmsRequestListValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Phase2IntegrityAlgorithmsRequestListValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Phase2IntegrityAlgorithmsRequestListValue) 

# Placement
<a name="API_Placement"></a>

Describes the placement of an instance.

## Contents
<a name="API_Placement_Contents"></a>

 ** Affinity ** (request), ** affinity ** (response)  
The affinity setting for the instance on the Dedicated Host.  
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html).  
Type: String  
Required: No

 ** AvailabilityZone ** (request), ** availabilityZone ** (response)  
The Availability Zone of the instance.  
On input, you can specify `AvailabilityZone` or `AvailabilityZoneId`, but not both. If you specify neither one, Amazon EC2 automatically selects an Availability Zone for you.  
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet).  
Type: String  
Required: No

 ** AvailabilityZoneId ** (request), ** availabilityZoneId ** (response)  
The ID of the Availability Zone of the instance.  
On input, you can specify `AvailabilityZone` or `AvailabilityZoneId`, but not both. If you specify neither one, Amazon EC2 automatically selects an Availability Zone for you.  
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet).  
Type: String  
Required: No

 ** GroupId ** (request), ** groupId ** (response)  
The ID of the placement group that the instance is in.  
On input, you can specify `GroupId` or `GroupName`, but not both.  
Type: String  
Required: No

 ** GroupName ** (request), ** groupName ** (response)  
The name of the placement group that the instance is in.  
On input, you can specify `GroupId` or `GroupName`, but not both.  
Type: String  
Required: No

 ** HostId ** (request), ** hostId ** (response)  
The ID of the Dedicated Host on which the instance resides.  
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet) or [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html).  
Type: String  
Required: No

 ** HostResourceGroupArn ** (request), ** hostResourceGroupArn ** (response)  
The ARN of the host resource group in which to launch the instances.  
On input, if you specify this parameter, either omit the **Tenancy** parameter or set it to `host`.  
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet).  
Type: String  
Required: No

 ** PartitionNumber ** (request), ** partitionNumber ** (response)  
The number of the partition that the instance is in. Valid only if the placement group strategy is set to `partition`.  
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet).  
Type: Integer  
Required: No

 ** SpreadDomain ** (request), ** spreadDomain ** (response)  
Reserved for future use.  
Type: String  
Required: No

 ** Tenancy ** (request), ** tenancy ** (response)  
The tenancy of the instance. An instance with a tenancy of `dedicated` runs on single-tenant hardware.  
This parameter is not supported for [CreateFleet](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateFleet). The `host` tenancy is not supported for [ImportInstance](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportInstance.html) or for T3 instances that are configured for the `unlimited` CPU credit option.  
Type: String  
Valid Values: `default | dedicated | host`   
Required: No

## See Also
<a name="API_Placement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Placement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Placement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Placement) 

# PlacementGroup
<a name="API_PlacementGroup"></a>

Describes a placement group.

## Contents
<a name="API_PlacementGroup_Contents"></a>

 ** groupArn **   
The Amazon Resource Name (ARN) of the placement group.  
Type: String  
Required: No

 ** groupId **   
The ID of the placement group.  
Type: String  
Required: No

 ** groupName **   
The name of the placement group.  
Type: String  
Required: No

 ** linkedGroupId **   
Reserved for future use.  
Type: String  
Required: No

 ** operator **   
The service provider that manages the Placement Group.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** partitionCount **   
The number of partitions. Valid only if **strategy** is set to `partition`.  
Type: Integer  
Required: No

 ** spreadLevel **   
The spread level for the placement group. *Only* Outpost placement groups can be spread across hosts.  
Type: String  
Valid Values: `host | rack`   
Required: No

 ** state **   
The state of the placement group.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** strategy **   
The placement strategy.  
Type: String  
Valid Values: `cluster | spread | partition`   
Required: No

 ** TagSet.N **   
Any tags applied to the placement group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_PlacementGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PlacementGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PlacementGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PlacementGroup) 

# PlacementGroupInfo
<a name="API_PlacementGroupInfo"></a>

Describes the placement group support of the instance type.

## Contents
<a name="API_PlacementGroupInfo_Contents"></a>

 ** SupportedStrategies.N **   
The supported placement group types.  
Type: Array of strings  
Valid Values: `cluster | partition | spread`   
Required: No

## See Also
<a name="API_PlacementGroupInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PlacementGroupInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PlacementGroupInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PlacementGroupInfo) 

# PlacementResponse
<a name="API_PlacementResponse"></a>

Describes the placement of an instance.

## Contents
<a name="API_PlacementResponse_Contents"></a>

 ** groupName **   
The name of the placement group that the instance is in.  
Type: String  
Required: No

## See Also
<a name="API_PlacementResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PlacementResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PlacementResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PlacementResponse) 

# PoolCidrBlock
<a name="API_PoolCidrBlock"></a>

Describes a CIDR block for an address pool.

## Contents
<a name="API_PoolCidrBlock_Contents"></a>

 ** poolCidrBlock **   
The CIDR block.  
Type: String  
Required: No

## See Also
<a name="API_PoolCidrBlock_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PoolCidrBlock) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PoolCidrBlock) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PoolCidrBlock) 

# PortRange
<a name="API_PortRange"></a>

Describes a range of ports.

## Contents
<a name="API_PortRange_Contents"></a>

 ** From ** (request), ** from ** (response)  
The first port in the range.  
Type: Integer  
Required: No

 ** To ** (request), ** to ** (response)  
The last port in the range.  
Type: Integer  
Required: No

## See Also
<a name="API_PortRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PortRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PortRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PortRange) 

# PrefixList
<a name="API_PrefixList"></a>

Describes prefixes for AWS services.

## Contents
<a name="API_PrefixList_Contents"></a>

 ** CidrSet.N **   
The IP address range of the AWS service.  
Type: Array of strings  
Required: No

 ** prefixListId **   
The ID of the prefix.  
Type: String  
Required: No

 ** prefixListName **   
The name of the prefix.  
Type: String  
Required: No

## See Also
<a name="API_PrefixList_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrefixList) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrefixList) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrefixList) 

# PrefixListAssociation
<a name="API_PrefixListAssociation"></a>

Describes the resource with which a prefix list is associated.

## Contents
<a name="API_PrefixListAssociation_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceOwner **   
The owner of the resource.  
Type: String  
Required: No

## See Also
<a name="API_PrefixListAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrefixListAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrefixListAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrefixListAssociation) 

# PrefixListEntry
<a name="API_PrefixListEntry"></a>

Describes a prefix list entry.

## Contents
<a name="API_PrefixListEntry_Contents"></a>

 ** cidr **   
The CIDR block.  
Type: String  
Required: No

 ** description **   
The description.  
Type: String  
Required: No

## See Also
<a name="API_PrefixListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrefixListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrefixListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrefixListEntry) 

# PrefixListId
<a name="API_PrefixListId"></a>

Describes a prefix list ID.

## Contents
<a name="API_PrefixListId_Contents"></a>

 ** Description ** (request), ** description ** (response)  
A description for the security group rule that references this prefix list ID.  
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and .\$1-:/()\$1,@[]\$1=;\$1\$1\$1\$1\$1  
Type: String  
Required: No

 ** PrefixListId ** (request), ** prefixListId ** (response)  
The ID of the prefix.  
Type: String  
Required: No

## See Also
<a name="API_PrefixListId_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrefixListId) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrefixListId) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrefixListId) 

# PriceSchedule
<a name="API_PriceSchedule"></a>

Describes the price for a Reserved Instance.

## Contents
<a name="API_PriceSchedule_Contents"></a>

 ** active **   
The current price schedule, as determined by the term remaining for the Reserved Instance in the listing.  
A specific price schedule is always in effect, but only one price schedule can be active at any time. Take, for example, a Reserved Instance listing that has five months remaining in its term. When you specify price schedules for five months and two months, this means that schedule 1, covering the first three months of the remaining term, will be active during months 5, 4, and 3. Then schedule 2, covering the last two months of the term, will be active for months 2 and 1.  
Type: Boolean  
Required: No

 ** currencyCode **   
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is `USD`.  
Type: String  
Valid Values: `USD`   
Required: No

 ** price **   
The fixed price for the term.  
Type: Double  
Required: No

 ** term **   
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.  
Type: Long  
Required: No

## See Also
<a name="API_PriceSchedule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PriceSchedule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PriceSchedule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PriceSchedule) 

# PriceScheduleSpecification
<a name="API_PriceScheduleSpecification"></a>

Describes the price for a Reserved Instance.

## Contents
<a name="API_PriceScheduleSpecification_Contents"></a>

 ** CurrencyCode **   
The currency for transacting the Reserved Instance resale. At this time, the only supported currency is `USD`.  
Type: String  
Valid Values: `USD`   
Required: No

 ** Price **   
The fixed price for the term.  
Type: Double  
Required: No

 ** Term **   
The number of months remaining in the reservation. For example, 2 is the second to the last month before the capacity reservation expires.  
Type: Long  
Required: No

## See Also
<a name="API_PriceScheduleSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PriceScheduleSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PriceScheduleSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PriceScheduleSpecification) 

# PricingDetail
<a name="API_PricingDetail"></a>

Describes a Reserved Instance offering.

## Contents
<a name="API_PricingDetail_Contents"></a>

 ** count **   
The number of reservations available for the price.  
Type: Integer  
Required: No

 ** price **   
The price per instance.  
Type: Double  
Required: No

## See Also
<a name="API_PricingDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PricingDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PricingDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PricingDetail) 

# PrincipalIdFormat
<a name="API_PrincipalIdFormat"></a>

PrincipalIdFormat description

## Contents
<a name="API_PrincipalIdFormat_Contents"></a>

 ** arn **   
PrincipalIdFormatARN description  
Type: String  
Required: No

 ** StatusSet.N **   
PrincipalIdFormatStatuses description  
Type: Array of [IdFormat](API_IdFormat.md) objects  
Required: No

## See Also
<a name="API_PrincipalIdFormat_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrincipalIdFormat) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrincipalIdFormat) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrincipalIdFormat) 

# PrivateDnsDetails
<a name="API_PrivateDnsDetails"></a>

Information about the Private DNS name for interface endpoints.

## Contents
<a name="API_PrivateDnsDetails_Contents"></a>

 ** privateDnsName **   
The private DNS name assigned to the VPC endpoint service.  
Type: String  
Required: No

## See Also
<a name="API_PrivateDnsDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrivateDnsDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrivateDnsDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrivateDnsDetails) 

# PrivateDnsNameConfiguration
<a name="API_PrivateDnsNameConfiguration"></a>

Information about the private DNS name for the service endpoint.

## Contents
<a name="API_PrivateDnsNameConfiguration_Contents"></a>

 ** name **   
The name of the record subdomain the service provider needs to create. The service provider adds the `value` text to the `name`.  
Type: String  
Required: No

 ** state **   
The verification state of the VPC endpoint service.  
Consumers of the endpoint service can use the private name only when the state is `verified`.  
Type: String  
Valid Values: `pendingVerification | verified | failed`   
Required: No

 ** type **   
The endpoint service verification type, for example TXT.  
Type: String  
Required: No

 ** value **   
The value the service provider adds to the private DNS name domain record before verification.  
Type: String  
Required: No

## See Also
<a name="API_PrivateDnsNameConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrivateDnsNameConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrivateDnsNameConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrivateDnsNameConfiguration) 

# PrivateDnsNameOptionsOnLaunch
<a name="API_PrivateDnsNameOptionsOnLaunch"></a>

Describes the options for instance hostnames.

## Contents
<a name="API_PrivateDnsNameOptionsOnLaunch_Contents"></a>

 ** enableResourceNameDnsAAAARecord **   
Indicates whether to respond to DNS queries for instance hostname 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

 ** hostnameType **   
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

## See Also
<a name="API_PrivateDnsNameOptionsOnLaunch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrivateDnsNameOptionsOnLaunch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrivateDnsNameOptionsOnLaunch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrivateDnsNameOptionsOnLaunch) 

# PrivateDnsNameOptionsRequest
<a name="API_PrivateDnsNameOptionsRequest"></a>

Describes the options for instance hostnames.

## Contents
<a name="API_PrivateDnsNameOptionsRequest_Contents"></a>

 ** 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

 ** HostnameType **   
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

## See Also
<a name="API_PrivateDnsNameOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrivateDnsNameOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrivateDnsNameOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrivateDnsNameOptionsRequest) 

# PrivateDnsNameOptionsResponse
<a name="API_PrivateDnsNameOptionsResponse"></a>

Describes the options for instance hostnames.

## Contents
<a name="API_PrivateDnsNameOptionsResponse_Contents"></a>

 ** 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

 ** hostnameType **   
The type of hostname to assign to an instance.  
Type: String  
Valid Values: `ip-name | resource-name`   
Required: No

## See Also
<a name="API_PrivateDnsNameOptionsResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrivateDnsNameOptionsResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrivateDnsNameOptionsResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrivateDnsNameOptionsResponse) 

# PrivateIpAddressSpecification
<a name="API_PrivateIpAddressSpecification"></a>

Describes a secondary private IPv4 address for a network interface.

## Contents
<a name="API_PrivateIpAddressSpecification_Contents"></a>

 ** Primary ** (request), ** primary ** (response)  
Indicates whether the private IPv4 address is the primary private IPv4 address. Only one IPv4 address can be designated as primary.  
Type: Boolean  
Required: No

 ** PrivateIpAddress ** (request), ** privateIpAddress ** (response)  
The private IPv4 address.  
Type: String  
Required: No

## See Also
<a name="API_PrivateIpAddressSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PrivateIpAddressSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PrivateIpAddressSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PrivateIpAddressSpecification) 

# ProcessorInfo
<a name="API_ProcessorInfo"></a>

Describes the processor used by the instance type.

## Contents
<a name="API_ProcessorInfo_Contents"></a>

 ** manufacturer **   
The manufacturer of the processor.  
Type: String  
Required: No

 ** SupportedArchitectures.N **   
The architectures supported by the instance type.  
Type: Array of strings  
Valid Values: `i386 | x86_64 | arm64 | x86_64_mac | arm64_mac`   
Required: No

 ** SupportedFeatures.N **   
Indicates whether the instance type supports AMD SEV-SNP. If the request returns `amd-sev-snp`, AMD SEV-SNP is supported. Otherwise, it is not supported. For more information, see [ AMD SEV-SNP](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/sev-snp.html).  
Type: Array of strings  
Valid Values: `amd-sev-snp | nested-virtualization`   
Required: No

 ** sustainedClockSpeedInGhz **   
The speed of the processor, in GHz.  
Type: Double  
Required: No

## See Also
<a name="API_ProcessorInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ProcessorInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ProcessorInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ProcessorInfo) 

# ProductCode
<a name="API_ProductCode"></a>

Describes a product code.

## Contents
<a name="API_ProductCode_Contents"></a>

 ** productCode **   
The product code.  
Type: String  
Required: No

 ** type **   
The type of product code.  
Type: String  
Valid Values: `devpay | marketplace`   
Required: No

## See Also
<a name="API_ProductCode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ProductCode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ProductCode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ProductCode) 

# PropagatingVgw
<a name="API_PropagatingVgw"></a>

Describes a virtual private gateway propagating route.

## Contents
<a name="API_PropagatingVgw_Contents"></a>

 ** gatewayId **   
The ID of the virtual private gateway.  
Type: String  
Required: No

## See Also
<a name="API_PropagatingVgw_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PropagatingVgw) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PropagatingVgw) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PropagatingVgw) 

# ProvisionedBandwidth
<a name="API_ProvisionedBandwidth"></a>

Reserved. If you need to sustain traffic greater than the [documented limits](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html#vpc-limits-gateways), contact AWS Support.

## Contents
<a name="API_ProvisionedBandwidth_Contents"></a>

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

 ** provisionTime **   
Reserved.  
Type: Timestamp  
Required: No

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

 ** requestTime **   
Reserved.  
Type: Timestamp  
Required: No

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

## See Also
<a name="API_ProvisionedBandwidth_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ProvisionedBandwidth) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ProvisionedBandwidth) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ProvisionedBandwidth) 

# PtrUpdateStatus
<a name="API_PtrUpdateStatus"></a>

The status of an updated pointer (PTR) record for an Elastic IP address.

## Contents
<a name="API_PtrUpdateStatus_Contents"></a>

 ** reason **   
The reason for the PTR record update.  
Type: String  
Required: No

 ** status **   
The status of the PTR record update.  
Type: String  
Required: No

 ** value **   
The value for the PTR record update.  
Type: String  
Required: No

## See Also
<a name="API_PtrUpdateStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PtrUpdateStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PtrUpdateStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PtrUpdateStatus) 

# PublicIpDnsNameOptions
<a name="API_PublicIpDnsNameOptions"></a>

Public hostname type options. 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*.

## Contents
<a name="API_PublicIpDnsNameOptions_Contents"></a>

 ** dnsHostnameType **   
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*.  
Type: String  
Required: No

 ** publicDualStackDnsName **   
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.  
Type: String  
Required: No

 ** publicIpv4DnsName **   
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.  
Type: String  
Required: No

 ** publicIpv6DnsName **   
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  
Required: No

## See Also
<a name="API_PublicIpDnsNameOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PublicIpDnsNameOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PublicIpDnsNameOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PublicIpDnsNameOptions) 

# PublicIpv4Pool
<a name="API_PublicIpv4Pool"></a>

Describes an IPv4 address pool.

## Contents
<a name="API_PublicIpv4Pool_Contents"></a>

 ** description **   
A description of the address pool.  
Type: String  
Required: No

 ** networkBorderGroup **   
The name of the location from which the address pool is advertised. A network border group is a unique set of Availability Zones or Local Zones from where AWS advertises public IP addresses.  
Type: String  
Required: No

 ** PoolAddressRangeSet.N **   
The address ranges.  
Type: Array of [PublicIpv4PoolRange](API_PublicIpv4PoolRange.md) objects  
Required: No

 ** poolId **   
The ID of the address pool.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags for the address pool.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** totalAddressCount **   
The total number of addresses.  
Type: Integer  
Required: No

 ** totalAvailableAddressCount **   
The total number of available addresses.  
Type: Integer  
Required: No

## See Also
<a name="API_PublicIpv4Pool_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PublicIpv4Pool) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PublicIpv4Pool) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PublicIpv4Pool) 

# PublicIpv4PoolRange
<a name="API_PublicIpv4PoolRange"></a>

Describes an address range of an IPv4 address pool.

## Contents
<a name="API_PublicIpv4PoolRange_Contents"></a>

 ** addressCount **   
The number of addresses in the range.  
Type: Integer  
Required: No

 ** availableAddressCount **   
The number of available addresses in the range.  
Type: Integer  
Required: No

 ** firstAddress **   
The first IP address in the range.  
Type: String  
Required: No

 ** lastAddress **   
The last IP address in the range.  
Type: String  
Required: No

## See Also
<a name="API_PublicIpv4PoolRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PublicIpv4PoolRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PublicIpv4PoolRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PublicIpv4PoolRange) 

# Purchase
<a name="API_Purchase"></a>

Describes the result of the purchase.

## Contents
<a name="API_Purchase_Contents"></a>

 ** currencyCode **   
The currency in which the `UpfrontPrice` and `HourlyPrice` amounts are specified. At this time, the only supported currency is `USD`.  
Type: String  
Valid Values: `USD`   
Required: No

 ** duration **   
The duration of the reservation's term in seconds.  
Type: Integer  
Required: No

 ** HostIdSet.N **   
The IDs of the Dedicated Hosts associated with the reservation.  
Type: Array of strings  
Required: No

 ** hostReservationId **   
The ID of the reservation.  
Type: String  
Required: No

 ** hourlyPrice **   
The hourly price of the reservation per hour.  
Type: String  
Required: No

 ** instanceFamily **   
The instance family on the Dedicated Host that the reservation can be associated with.  
Type: String  
Required: No

 ** paymentOption **   
The payment option for the reservation.  
Type: String  
Valid Values: `AllUpfront | PartialUpfront | NoUpfront`   
Required: No

 ** upfrontPrice **   
The upfront price of the reservation.  
Type: String  
Required: No

## See Also
<a name="API_Purchase_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Purchase) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Purchase) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Purchase) 

# PurchaseRequest
<a name="API_PurchaseRequest"></a>

Describes a request to purchase Scheduled Instances.

## Contents
<a name="API_PurchaseRequest_Contents"></a>

 ** InstanceCount **   
The number of instances.  
Type: Integer  
Required: Yes

 ** PurchaseToken **   
The purchase token.  
Type: String  
Required: Yes

## See Also
<a name="API_PurchaseRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/PurchaseRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/PurchaseRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/PurchaseRequest) 

# RecurringCharge
<a name="API_RecurringCharge"></a>

Describes a recurring charge.

## Contents
<a name="API_RecurringCharge_Contents"></a>

 ** amount **   
The amount of the recurring charge.  
Type: Double  
Required: No

 ** frequency **   
The frequency of the recurring charge.  
Type: String  
Valid Values: `Hourly`   
Required: No

## See Also
<a name="API_RecurringCharge_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RecurringCharge) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RecurringCharge) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RecurringCharge) 

# ReferencedSecurityGroup
<a name="API_ReferencedSecurityGroup"></a>

 Describes the security group that is referenced in the security group rule.

## Contents
<a name="API_ReferencedSecurityGroup_Contents"></a>

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

 ** peeringStatus **   
The status of a VPC peering connection, if applicable.  
Type: String  
Required: No

 ** userId **   
The AWS account ID.  
Type: String  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

 ** vpcPeeringConnectionId **   
The ID of the VPC peering connection (if applicable).  
Type: String  
Required: No

## See Also
<a name="API_ReferencedSecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReferencedSecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReferencedSecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReferencedSecurityGroup) 

# Region
<a name="API_Region"></a>

Describes a Region.

## Contents
<a name="API_Region_Contents"></a>

 ** GeographySet.N **   
The geography information for the Region. The geography is returned as a list.  
Type: Array of [RegionGeography](API_RegionGeography.md) objects  
Required: No

 ** optInStatus **   
The Region opt-in status. The possible values are `opt-in-not-required`, `opted-in`, and `not-opted-in`.  
Type: String  
Required: No

 ** regionEndpoint **   
The Region service endpoint.  
Type: String  
Required: No

 ** regionName **   
The name of the Region.  
Type: String  
Required: No

## See Also
<a name="API_Region_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Region) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Region) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Region) 

# RegionalSummary
<a name="API_RegionalSummary"></a>

A summary report for the attribute for a Region.

## Contents
<a name="API_RegionalSummary_Contents"></a>

 ** numberOfMatchedAccounts **   
The number of accounts in the Region with the same configuration value for the attribute that is most frequently observed.  
Type: Integer  
Required: No

 ** numberOfUnmatchedAccounts **   
The number of accounts in the Region with a configuration value different from the most frequently observed value for the attribute.  
Type: Integer  
Required: No

 ** regionName **   
The AWS Region.  
Type: String  
Required: No

## See Also
<a name="API_RegionalSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegionalSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegionalSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegionalSummary) 

# RegionGeography
<a name="API_RegionGeography"></a>

Describes the geography information for a Region.

## Contents
<a name="API_RegionGeography_Contents"></a>

 ** name **   
The name of the geography, for example, `United States of America`.  
Type: String  
Required: No

## See Also
<a name="API_RegionGeography_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegionGeography) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegionGeography) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegionGeography) 

# RegisteredInstance
<a name="API_RegisteredInstance"></a>

Describes an Amazon EC2 instance that is enabled for SQL Server High Availability standby detection monitoring.

## Contents
<a name="API_RegisteredInstance_Contents"></a>

 ** haStatus **   
The SQL Server High Availability status of the instance. Valid values are:  
+  `processing` - The SQL Server High Availability status for the SQL Server High Availability instance is being updated.
+  `active` - The SQL Server High Availability instance is an active node in an SQL Server High Availability cluster.
+  `standby` - The SQL Server High Availability instance is a standby failover node in an SQL Server High Availability cluster.
+  `invalid` - An error occurred due to misconfigured permissions, or unable to dertemine SQL Server High Availability status for the SQL Server High Availability instance.
Type: String  
Valid Values: `processing | active | standby | invalid`   
Required: No

 ** instanceId **   
The ID of the SQL Server High Availability instance.  
Type: String  
Required: No

 ** lastUpdatedTime **   
The date and time when the instance's SQL Server High Availability status was last updated, in the ISO 8601 format in the UTC time zone (`YYYY-MM-DDThh:mm:ss.sssZ`).  
Type: Timestamp  
Required: No

 ** processingStatus **   
A brief description of the SQL Server High Availability status. If the instance is in the `invalid` High Availability status, this parameter includes the error message.  
Type: String  
Required: No

 ** sqlServerCredentials **   
The ARN of the AWS Secrets Manager secret containing the SQL Server access credentials for the SQL Server High Availability instance. If not specified, deafult local user credentials will be used by the AWS Systems Manager agent.  
Type: String  
Required: No

 ** sqlServerLicenseUsage **   
The license type for the SQL Server license. Valid values include:  
+  `full` - The SQL Server High Availability instance is using a full SQL Server license.
+  `waived` - The SQL Server High Availability instance is waived from the SQL Server license.
Type: String  
Valid Values: `full | waived`   
Required: No

 ** TagSet.N **   
The tags assigned to the SQL Server High Availability instance.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_RegisteredInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegisteredInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegisteredInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegisteredInstance) 

# RegisterInstanceTagAttributeRequest
<a name="API_RegisterInstanceTagAttributeRequest"></a>

Information about the tag keys to register for the current Region. You can either specify individual tag keys or register all tag keys in the current Region. You must specify either `IncludeAllTagsOfInstance` or `InstanceTagKeys` in the request

## Contents
<a name="API_RegisterInstanceTagAttributeRequest_Contents"></a>

 ** IncludeAllTagsOfInstance **   
Indicates whether to register all tag keys in the current Region. Specify `true` to register all tag keys.  
Type: Boolean  
Required: No

 ** InstanceTagKey.N **   
The tag keys to register.  
Type: Array of strings  
Required: No

## See Also
<a name="API_RegisterInstanceTagAttributeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RegisterInstanceTagAttributeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RegisterInstanceTagAttributeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RegisterInstanceTagAttributeRequest) 

# RemoveIpamOperatingRegion
<a name="API_RemoveIpamOperatingRegion"></a>

Remove an operating Region from an 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* 

## Contents
<a name="API_RemoveIpamOperatingRegion_Contents"></a>

 ** RegionName **   
The name of the operating Region you want to remove.  
Type: String  
Required: No

## See Also
<a name="API_RemoveIpamOperatingRegion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RemoveIpamOperatingRegion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RemoveIpamOperatingRegion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RemoveIpamOperatingRegion) 

# RemoveIpamOrganizationalUnitExclusion
<a name="API_RemoveIpamOrganizationalUnitExclusion"></a>

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*.

## Contents
<a name="API_RemoveIpamOrganizationalUnitExclusion_Contents"></a>

 ** OrganizationsEntityPath **   
An AWS Organizations entity path. Build the path for the OU(s) using AWS Organizations IDs separated by a `/`. Include all child OUs by ending the path with `/*`.  
+ Example 1
  + Path to a child OU: `o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/ou-jkl0-awsddddd/` 
  + In this example, `o-a1b2c3d4e5` is the organization ID, `r-f6g7h8i9j0example` is the root ID , `ou-ghi0-awsccccc` is an OU ID, and `ou-jkl0-awsddddd` is a child OU ID.
  + IPAM will not manage the IP addresses in accounts in the child OU.
+ Example 2
  + Path where all child OUs will be part of the exclusion: `o-a1b2c3d4e5/r-f6g7h8i9j0example/ou-ghi0-awsccccc/*` 
  + In this example, IPAM will not manage the IP addresses in accounts in the OU (`ou-ghi0-awsccccc`) or in accounts in any OUs that are children of the OU.
For more information on how to construct an entity path, see [Understand the AWS Organizations entity path](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_last-accessed-view-data-orgs.html#access_policies_access-advisor-viewing-orgs-entity-path) in the * AWS Identity and Access Management User Guide*.  
Type: String  
Required: No

## See Also
<a name="API_RemoveIpamOrganizationalUnitExclusion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RemoveIpamOrganizationalUnitExclusion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RemoveIpamOrganizationalUnitExclusion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RemoveIpamOrganizationalUnitExclusion) 

# RemovePrefixListEntry
<a name="API_RemovePrefixListEntry"></a>

An entry for a prefix list.

## Contents
<a name="API_RemovePrefixListEntry_Contents"></a>

 ** Cidr **   
The CIDR block.  
Type: String  
Required: Yes

## See Also
<a name="API_RemovePrefixListEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RemovePrefixListEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RemovePrefixListEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RemovePrefixListEntry) 

# ReplaceRootVolumeTask
<a name="API_ReplaceRootVolumeTask"></a>

Information about a root volume replacement task.

## Contents
<a name="API_ReplaceRootVolumeTask_Contents"></a>

 ** completeTime **   
The time the task completed.  
Type: String  
Required: No

 ** deleteReplacedRootVolume **   
Indicates whether the original root volume is to be deleted after the root volume replacement task completes.  
Type: Boolean  
Required: No

 ** imageId **   
The ID of the AMI used to create the replacement root volume.  
Type: String  
Required: No

 ** instanceId **   
The ID of the instance for which the root volume replacement task was created.  
Type: String  
Required: No

 ** replaceRootVolumeTaskId **   
The ID of the root volume replacement task.  
Type: String  
Required: No

 ** snapshotId **   
The ID of the snapshot used to create the replacement root volume.  
Type: String  
Required: No

 ** startTime **   
The time the task was started.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the task.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** taskState **   
The state of the task. The task can be in one of the following states:  
+  `pending` - the replacement volume is being created.
+  `in-progress` - the original volume is being detached and the replacement volume is being attached.
+  `succeeded` - the replacement volume has been successfully attached to the instance and the instance is available.
+  `failing` - the replacement task is in the process of failing.
+  `failed` - the replacement task has failed but the original root volume is still attached.
+  `failing-detached` - the replacement task is in the process of failing. The instance might have no root volume attached.
+  `failed-detached` - the replacement task has failed and the instance has no root volume attached.
Type: String  
Valid Values: `pending | in-progress | failing | succeeded | failed | failed-detached`   
Required: No

## See Also
<a name="API_ReplaceRootVolumeTask_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReplaceRootVolumeTask) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReplaceRootVolumeTask) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReplaceRootVolumeTask) 

# RequestFilterPortRange
<a name="API_RequestFilterPortRange"></a>

Describes a port range.

## Contents
<a name="API_RequestFilterPortRange_Contents"></a>

 ** FromPort **   
The first port in the range.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

 ** ToPort **   
The last port in the range.  
Type: Integer  
Valid Range: Minimum value of 0. Maximum value of 65535.  
Required: No

## See Also
<a name="API_RequestFilterPortRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RequestFilterPortRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RequestFilterPortRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RequestFilterPortRange) 

# RequestIpamResourceTag
<a name="API_RequestIpamResourceTag"></a>

A tag on an IPAM resource.

## Contents
<a name="API_RequestIpamResourceTag_Contents"></a>

 ** 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: String  
Required: No

 ** Value **   
The value for the tag.  
Type: String  
Required: No

## See Also
<a name="API_RequestIpamResourceTag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RequestIpamResourceTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RequestIpamResourceTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RequestIpamResourceTag) 

# RequestLaunchTemplateData
<a name="API_RequestLaunchTemplateData"></a>

The information to include in the launch template.

**Note**  
You must specify at least one parameter for the launch template data.

## Contents
<a name="API_RequestLaunchTemplateData_Contents"></a>

 ** BlockDeviceMapping.N **   
The block device mapping.  
Type: Array of [LaunchTemplateBlockDeviceMappingRequest](API_LaunchTemplateBlockDeviceMappingRequest.md) objects  
Required: No

 ** CapacityReservationSpecification **   
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).  
Type: [LaunchTemplateCapacityReservationSpecificationRequest](API_LaunchTemplateCapacityReservationSpecificationRequest.md) object  
Required: No

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

 ** CreditSpecification **   
The credit option for CPU usage of the instance. Valid only for T instances.  
Type: [CreditSpecificationRequest](API_CreditSpecificationRequest.md) object  
Required: No

 ** DisableApiStop **   
Indicates whether to enable the instance 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) in the *Amazon EC2 User Guide*.  
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

 ** 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.  
Type: Boolean  
Required: No

 ** ElasticGpuSpecification.N **   
Deprecated.  
Amazon Elastic Graphics reached end of life on January 8, 2024.
Type: Array of [ElasticGpuSpecification](API_ElasticGpuSpecification.md) objects  
Required: No

 ** ElasticInferenceAccelerator.N **   
 *This member has been deprecated.*   
Amazon Elastic Inference is no longer available.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.  
You cannot specify accelerators from different generations in the same request.  
Type: Array of [LaunchTemplateElasticInferenceAccelerator](API_LaunchTemplateElasticInferenceAccelerator.md) objects  
Required: No

 ** EnclaveOptions **   
Indicates whether the instance is enabled for AWS Nitro Enclaves. For more information, see [What is Nitro Enclaves?](https://docs.aws.amazon.com/enclaves/latest/user/nitro-enclave.html) in the * AWS Nitro Enclaves User Guide*.  
You can't enable AWS Nitro Enclaves and hibernation on the same instance.  
Type: [LaunchTemplateEnclaveOptionsRequest](API_LaunchTemplateEnclaveOptionsRequest.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*.  
Type: [LaunchTemplateHibernationOptionsRequest](API_LaunchTemplateHibernationOptionsRequest.md) object  
Required: No

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

 ** ImageId **   
The ID of the AMI in the format `ami-0ac394d6a3example`.  
Alternatively, you can specify a Systems Manager parameter, using one of the following formats. The Systems Manager parameter will resolve to an AMI ID on launch.  
To reference a public parameter:  
+  `resolve:ssm:public-parameter ` 
To reference a parameter stored in the same account:  
+  `resolve:ssm:parameter-name ` 
+  `resolve:ssm:parameter-name:version-number ` 
+  `resolve:ssm:parameter-name:label ` 
To reference a parameter shared from another AWS account:  
+  `resolve:ssm:parameter-ARN ` 
+  `resolve:ssm:parameter-ARN:version-number ` 
+  `resolve:ssm:parameter-ARN:label ` 
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*.  
If the launch template will be used for an EC2 Fleet or Spot Fleet, note the following:  
+ Only EC2 Fleets of type `instant` support specifying a Systems Manager parameter.
+ For EC2 Fleets of type `maintain` or `request`, or for Spot Fleets, you must specify the AMI ID.
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: [LaunchTemplateInstanceMarketOptionsRequest](API_LaunchTemplateInstanceMarketOptionsRequest.md) object  
Required: No

 ** InstanceRequirements **   
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.  
You must specify `VCpuCount` and `MemoryMiB`. All other attributes are optional. Any unspecified optional attribute is set to its default.  
When you specify multiple attributes, you get instance types that satisfy all of the specified attributes. If you specify multiple values for an attribute, you get instance types that satisfy any of the specified values.  
To limit the list of instance types from which Amazon EC2 can identify matching instance types, you can use one of the following parameters, but not both in the same request:  
+  `AllowedInstanceTypes` - The instance types to include in the list. All other instance types are ignored, even if they match your specified attributes.
+  `ExcludedInstanceTypes` - The instance types to exclude from the list, even if they match your specified attributes.
If you specify `InstanceRequirements`, you can't specify `InstanceType`.  
Attribute-based instance type selection is only supported when using Auto Scaling groups, EC2 Fleet, and Spot Fleet to launch instances. If you plan to use the launch template in the [launch instance wizard](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-instance-wizard.html), or with the [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances.html) API or [AWS::EC2::Instance](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ec2-instance.html) AWS CloudFormation resource, you can't specify `InstanceRequirements`.
For more information, see [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*.  
Type: [InstanceRequirementsRequest](API_InstanceRequirementsRequest.md) object  
Required: No

 ** InstanceType **   
The instance type. 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*.  
If you specify `InstanceType`, you can't specify `InstanceRequirements`.  
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

 ** KernelId **   
The ID of the kernel.  
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](https://docs.aws.amazon.com/linux/al2/ug/UserProvidedKernels.html) in the *Amazon Linux 2 User Guide*.
Type: String  
Required: No

 ** KeyName **   
The name of the key pair. You can create a key pair using [CreateKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateKeyPair.html) or [ImportKeyPair](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_ImportKeyPair.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

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

 ** MaintenanceOptions **   
The maintenance options for the instance.  
Type: [LaunchTemplateInstanceMaintenanceOptionsRequest](API_LaunchTemplateInstanceMaintenanceOptionsRequest.md) object  
Required: No

 ** 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) in the *Amazon EC2 User Guide*.  
Type: [LaunchTemplateInstanceMetadataOptionsRequest](API_LaunchTemplateInstanceMetadataOptionsRequest.md) object  
Required: No

 ** Monitoring **   
The monitoring for the instance.  
Type: [LaunchTemplatesMonitoringRequest](API_LaunchTemplatesMonitoringRequest.md) object  
Required: No

 ** NetworkInterface.N **   
The network interfaces for the instance.  
Type: Array of [LaunchTemplateInstanceNetworkInterfaceSpecificationRequest](API_LaunchTemplateInstanceNetworkInterfaceSpecificationRequest.md) objects  
Required: No

 ** NetworkPerformanceOptions **   
Contains launch template settings to boost network performance for the type of workload that runs on your instance.  
Type: [LaunchTemplateNetworkPerformanceOptionsRequest](API_LaunchTemplateNetworkPerformanceOptionsRequest.md) object  
Required: No

 ** Operator **   
The entity that manages the launch template.  
Type: [OperatorRequest](API_OperatorRequest.md) object  
Required: No

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

 ** PrivateDnsNameOptions **   
The options for the instance hostname. The default values are inherited from the subnet.  
Type: [LaunchTemplatePrivateDnsNameOptionsRequest](API_LaunchTemplatePrivateDnsNameOptionsRequest.md) object  
Required: No

 ** RamDiskId **   
The ID of the RAM disk.  
We recommend that you use PV-GRUB instead of kernels and RAM disks. For more information, see [User provided kernels](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 instances launched from the template.  
Type: Array of [LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest](API_LaunchTemplateInstanceSecondaryInterfaceSpecificationRequest.md) objects  
Required: No

 ** SecurityGroup.N **   
The names of the security groups. For a nondefault VPC, you must use security group IDs instead.  
If you specify a network interface, you must specify any security groups as part of the network interface instead of using this parameter.  
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

 ** TagSpecification.N **   
The tags to apply to the resources that are created during instance launch. These tags are not applied to the launch template.  
Type: Array of [LaunchTemplateTagSpecificationRequest](API_LaunchTemplateTagSpecificationRequest.md) objects  
Required: No

 ** UserData **   
The user data to make available to the instance. You must provide base64-encoded text. User data is limited to 16 KB. For more information, see [Run commands when you launch an EC2 instance with user data input](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/user-data.html) in the *Amazon EC2 User Guide*.  
If you are creating the launch template for use with AWS Batch, the user data must be provided in the [MIME multi-part archive format](https://cloudinit.readthedocs.io/en/latest/topics/format.html#mime-multi-part-archive). For more information, see [Amazon EC2 user data in launch templates](https://docs.aws.amazon.com/batch/latest/userguide/launch-templates.html#lt-user-data) in the * AWS Batch User Guide*.  
Type: String  
Required: No

## See Also
<a name="API_RequestLaunchTemplateData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RequestLaunchTemplateData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RequestLaunchTemplateData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RequestLaunchTemplateData) 

# RequestSpotLaunchSpecification
<a name="API_RequestSpotLaunchSpecification"></a>

Describes the launch specification for an instance.

## Contents
<a name="API_RequestSpotLaunchSpecification_Contents"></a>

 ** AddressingType **   
Deprecated.  
Type: String  
Required: No

 ** BlockDeviceMapping.N **   
The block device mapping entries. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.  
Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects  
Required: No

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

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

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

 ** InstanceType **   
The instance type. Only one instance type can be specified.  
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

 ** KernelId **   
The ID of the kernel.  
Type: String  
Required: No

 ** KeyName **   
The name of the key pair.  
Type: String  
Required: No

 ** Monitoring **   
Indicates whether basic or detailed monitoring is enabled for the instance.  
Default: Disabled  
Type: [RunInstancesMonitoringEnabled](API_RunInstancesMonitoringEnabled.md) object  
Required: No

 ** NetworkInterface.N **   
The network interfaces. If you specify a network interface, you must specify subnet IDs and security group IDs using the network interface.  
Type: Array of [InstanceNetworkInterfaceSpecification](API_InstanceNetworkInterfaceSpecification.md) objects  
Required: No

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

 ** RamdiskId **   
The ID of the RAM disk.  
Type: String  
Required: No

 ** SecurityGroup.N **   
Not supported.  
Type: Array of strings  
Required: No

 ** SecurityGroupId.N **   
The IDs of the security groups.  
Type: Array of strings  
Required: No

 ** SubnetId **   
The ID of the subnet in which to launch the instance.  
Type: String  
Required: No

 ** UserData **   
The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.  
Type: String  
Required: No

## See Also
<a name="API_RequestSpotLaunchSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RequestSpotLaunchSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RequestSpotLaunchSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RequestSpotLaunchSpecification) 

# Reservation
<a name="API_Reservation"></a>

Describes a launch request for one or more instances, and includes owner, requester, and security group information that applies to all instances in the launch request.

## Contents
<a name="API_Reservation_Contents"></a>

 ** GroupSet.N **   
Not supported.  
Type: Array of [GroupIdentifier](API_GroupIdentifier.md) objects  
Required: No

 ** InstancesSet.N **   
The instances.  
Type: Array of [Instance](API_Instance.md) objects  
Required: No

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

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

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

## See Also
<a name="API_Reservation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Reservation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Reservation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Reservation) 

# ReservationFleetInstanceSpecification
<a name="API_ReservationFleetInstanceSpecification"></a>

Information about an instance type to use in a Capacity Reservation Fleet.

## Contents
<a name="API_ReservationFleetInstanceSpecification_Contents"></a>

 ** AvailabilityZone **   
The Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.  
Type: String  
Required: No

 ** AvailabilityZoneId **   
The ID of the Availability Zone in which the Capacity Reservation Fleet reserves the capacity. A Capacity Reservation Fleet can't span Availability Zones. All instance type specifications that you specify for the Fleet must use the same Availability Zone.  
Type: String  
Required: No

 ** EbsOptimized **   
Indicates whether the Capacity Reservation Fleet supports EBS-optimized instances types. 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 EBS-optimized instance types.  
Type: Boolean  
Required: No

 ** InstancePlatform **   
The type of operating system for which the Capacity Reservation Fleet reserves 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: No

 ** InstanceType **   
The instance type for which the Capacity Reservation Fleet reserves capacity.  
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

 ** Priority **   
The priority to assign to the instance type. This value is used to determine which of the instance types specified for the Fleet should be prioritized for use. A lower value indicates a high priority. For more information, see [Instance type priority](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/crfleet-concepts.html#instance-priority) in the *Amazon EC2 User Guide*.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

 ** Weight **   
The number of capacity units provided by the specified instance type. This value, together with the total target capacity that you specify for 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: Double  
Valid Range: Minimum value of 0.001. Maximum value of 99.999.  
Required: No

## See Also
<a name="API_ReservationFleetInstanceSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservationFleetInstanceSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservationFleetInstanceSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservationFleetInstanceSpecification) 

# ReservationValue
<a name="API_ReservationValue"></a>

The cost associated with the Reserved Instance.

## Contents
<a name="API_ReservationValue_Contents"></a>

 ** hourlyPrice **   
The hourly rate of the reservation.  
Type: String  
Required: No

 ** remainingTotalValue **   
The balance of the total value (the sum of remainingUpfrontValue \$1 hourlyPrice \$1 number of hours remaining).  
Type: String  
Required: No

 ** remainingUpfrontValue **   
The remaining upfront cost of the reservation.  
Type: String  
Required: No

## See Also
<a name="API_ReservationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservationValue) 

# ReservedCapacityOptions
<a name="API_ReservedCapacityOptions"></a>

Defines EC2 Fleet preferences for utilizing reserved capacity when DefaultTargetCapacityType is set to `reserved-capacity`.

## Contents
<a name="API_ReservedCapacityOptions_Contents"></a>

 ** ReservationTypeSet.N **   
The types of Capacity Reservations used for fulfilling the EC2 Fleet request.  
Type: Array of strings  
Valid Values: `interruptible-capacity-reservation`   
Required: No

## See Also
<a name="API_ReservedCapacityOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedCapacityOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedCapacityOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedCapacityOptions) 

# ReservedCapacityOptionsRequest
<a name="API_ReservedCapacityOptionsRequest"></a>

Defines EC2 Fleet preferences for utilizing reserved capacity when DefaultTargetCapacityType is set to `reserved-capacity`.

**Note**  
This configuration can only be used if the EC2 Fleet is of type `instant`.

When you specify `ReservedCapacityOptions`, you must also set `DefaultTargetCapacityType` to `reserved-capacity` in the `TargetCapacitySpecification`.

For more information about Interruptible Capacity Reservations, see [Launch instances into an Interruptible Capacity Reservation](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-launch-instances-interruptible-cr-walkthrough.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_ReservedCapacityOptionsRequest_Contents"></a>

 ** ReservationType.N **   
The types of Capacity Reservations to use for fulfilling the EC2 Fleet request.  
Type: Array of strings  
Valid Values: `interruptible-capacity-reservation`   
Required: No

## See Also
<a name="API_ReservedCapacityOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedCapacityOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedCapacityOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedCapacityOptionsRequest) 

# ReservedInstanceLimitPrice
<a name="API_ReservedInstanceLimitPrice"></a>

Describes the limit price of a Reserved Instance offering.

## Contents
<a name="API_ReservedInstanceLimitPrice_Contents"></a>

 ** Amount **   
Used for Reserved Instance Marketplace offerings. Specifies the limit price on the total order (instanceCount \$1 price).  
Type: Double  
Required: No

 ** CurrencyCode **   
The currency in which the `limitPrice` amount is specified. At this time, the only supported currency is `USD`.  
Type: String  
Valid Values: `USD`   
Required: No

## See Also
<a name="API_ReservedInstanceLimitPrice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstanceLimitPrice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstanceLimitPrice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstanceLimitPrice) 

# ReservedInstanceReservationValue
<a name="API_ReservedInstanceReservationValue"></a>

The total value of the Convertible Reserved Instance.

## Contents
<a name="API_ReservedInstanceReservationValue_Contents"></a>

 ** reservationValue **   
The total value of the Convertible Reserved Instance that you are exchanging.  
Type: [ReservationValue](API_ReservationValue.md) object  
Required: No

 ** reservedInstanceId **   
The ID of the Convertible Reserved Instance that you are exchanging.  
Type: String  
Required: No

## See Also
<a name="API_ReservedInstanceReservationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstanceReservationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstanceReservationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstanceReservationValue) 

# ReservedInstances
<a name="API_ReservedInstances"></a>

Describes a Reserved Instance.

## Contents
<a name="API_ReservedInstances_Contents"></a>

 ** availabilityZone **   
The Availability Zone in which the Reserved Instance can be used.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** currencyCode **   
The currency of the Reserved Instance. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is `USD`.  
Type: String  
Valid Values: `USD`   
Required: No

 ** duration **   
The duration of the Reserved Instance, in seconds.  
Type: Long  
Required: No

 ** end **   
The time when the Reserved Instance expires.  
Type: Timestamp  
Required: No

 ** fixedPrice **   
The purchase price of the Reserved Instance.  
Type: Float  
Required: No

 ** instanceCount **   
The number of reservations purchased.  
Type: Integer  
Required: No

 ** instanceTenancy **   
The tenancy of the instance.  
Type: String  
Valid Values: `default | dedicated | host`   
Required: No

 ** instanceType **   
The instance type on which the Reserved Instance can be used.  
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

 ** offeringClass **   
The offering class of the Reserved Instance.  
Type: String  
Valid Values: `standard | convertible`   
Required: No

 ** offeringType **   
The 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.  
Type: String  
Valid Values: `Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)`   
Required: No

 ** RecurringCharges.N **   
The recurring charge tag assigned to the resource.  
Type: Array of [RecurringCharge](API_RecurringCharge.md) objects  
Required: No

 ** reservedInstancesId **   
The ID of the Reserved Instance.  
Type: String  
Required: No

 ** scope **   
The scope of the Reserved Instance.  
Type: String  
Valid Values: `Availability Zone | Region`   
Required: No

 ** start **   
The date and time the Reserved Instance started.  
Type: Timestamp  
Required: No

 ** state **   
The state of the Reserved Instance purchase.  
Type: String  
Valid Values: `payment-pending | active | payment-failed | retired | queued | queued-deleted`   
Required: No

 ** TagSet.N **   
Any tags assigned to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** usagePrice **   
The usage price of the Reserved Instance, per hour.  
Type: Float  
Required: No

## See Also
<a name="API_ReservedInstances_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstances) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstances) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstances) 

# ReservedInstancesConfiguration
<a name="API_ReservedInstancesConfiguration"></a>

Describes the configuration settings for the modified Reserved Instances.

## Contents
<a name="API_ReservedInstancesConfiguration_Contents"></a>

 ** AvailabilityZone ** (request), ** availabilityZone ** (response)  
The Availability Zone for the modified Reserved Instances.  
Type: String  
Required: No

 ** AvailabilityZoneId ** (request), ** availabilityZoneId ** (response)  
The ID of the Availability Zone.  
Type: String  
Required: No

 ** InstanceCount ** (request), ** instanceCount ** (response)  
The number of modified Reserved Instances.  
This is a required field for a request.
Type: Integer  
Required: No

 ** InstanceType ** (request), ** instanceType ** (response)  
The instance type for the modified Reserved Instances.  
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

 ** Platform ** (request), ** platform ** (response)  
The network platform of the modified Reserved Instances.  
Type: String  
Required: No

 ** Scope ** (request), ** scope ** (response)  
Whether the Reserved Instance is applied to instances in a Region or instances in a specific Availability Zone.  
Type: String  
Valid Values: `Availability Zone | Region`   
Required: No

## See Also
<a name="API_ReservedInstancesConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstancesConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstancesConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstancesConfiguration) 

# ReservedInstancesId
<a name="API_ReservedInstancesId"></a>

Describes the ID of a Reserved Instance.

## Contents
<a name="API_ReservedInstancesId_Contents"></a>

 ** reservedInstancesId **   
The ID of the Reserved Instance.  
Type: String  
Required: No

## See Also
<a name="API_ReservedInstancesId_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstancesId) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstancesId) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstancesId) 

# ReservedInstancesListing
<a name="API_ReservedInstancesListing"></a>

Describes a Reserved Instance listing.

## Contents
<a name="API_ReservedInstancesListing_Contents"></a>

 ** clientToken **   
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).  
Type: String  
Required: No

 ** createDate **   
The time the listing was created.  
Type: Timestamp  
Required: No

 ** InstanceCounts.N **   
The number of instances in this state.  
Type: Array of [InstanceCount](API_InstanceCount.md) objects  
Required: No

 ** PriceSchedules.N **   
The price of the Reserved Instance listing.  
Type: Array of [PriceSchedule](API_PriceSchedule.md) objects  
Required: No

 ** reservedInstancesId **   
The ID of the Reserved Instance.  
Type: String  
Required: No

 ** reservedInstancesListingId **   
The ID of the Reserved Instance listing.  
Type: String  
Required: No

 ** status **   
The status of the Reserved Instance listing.  
Type: String  
Valid Values: `active | pending | cancelled | closed`   
Required: No

 ** statusMessage **   
The reason for the current status of the Reserved Instance listing. The response can be blank.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** updateDate **   
The last modified timestamp of the listing.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ReservedInstancesListing_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstancesListing) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstancesListing) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstancesListing) 

# ReservedInstancesModification
<a name="API_ReservedInstancesModification"></a>

Describes a Reserved Instance modification.

## Contents
<a name="API_ReservedInstancesModification_Contents"></a>

 ** clientToken **   
A unique, case-sensitive key supplied by the client to ensure that the request is idempotent. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).  
Type: String  
Required: No

 ** createDate **   
The time when the modification request was created.  
Type: Timestamp  
Required: No

 ** effectiveDate **   
The time for the modification to become effective.  
Type: Timestamp  
Required: No

 ** ModificationResultSet.N **   
Contains target configurations along with their corresponding new Reserved Instance IDs.  
Type: Array of [ReservedInstancesModificationResult](API_ReservedInstancesModificationResult.md) objects  
Required: No

 ** reservedInstancesModificationId **   
A unique ID for the Reserved Instance modification.  
Type: String  
Required: No

 ** ReservedInstancesSet.N **   
The IDs of one or more Reserved Instances.  
Type: Array of [ReservedInstancesId](API_ReservedInstancesId.md) objects  
Required: No

 ** status **   
The status of the Reserved Instances modification request.  
Type: String  
Required: No

 ** statusMessage **   
The reason for the status.  
Type: String  
Required: No

 ** updateDate **   
The time when the modification request was last updated.  
Type: Timestamp  
Required: No

## See Also
<a name="API_ReservedInstancesModification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstancesModification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstancesModification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstancesModification) 

# ReservedInstancesModificationResult
<a name="API_ReservedInstancesModificationResult"></a>

Describes the modification request/s.

## Contents
<a name="API_ReservedInstancesModificationResult_Contents"></a>

 ** reservedInstancesId **   
The ID for the Reserved Instances that were created as part of the modification request. This field is only available when the modification is fulfilled.  
Type: String  
Required: No

 ** targetConfiguration **   
The target Reserved Instances configurations supplied as part of the modification request.  
Type: [ReservedInstancesConfiguration](API_ReservedInstancesConfiguration.md) object  
Required: No

## See Also
<a name="API_ReservedInstancesModificationResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstancesModificationResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstancesModificationResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstancesModificationResult) 

# ReservedInstancesOffering
<a name="API_ReservedInstancesOffering"></a>

Describes a Reserved Instance offering.

## Contents
<a name="API_ReservedInstancesOffering_Contents"></a>

 ** availabilityZone **   
The Availability Zone in which the Reserved Instance can be used.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** currencyCode **   
The currency of the Reserved Instance offering you are purchasing. It's specified using ISO 4217 standard currency codes. At this time, the only supported currency is `USD`.  
Type: String  
Valid Values: `USD`   
Required: No

 ** duration **   
The duration of the Reserved Instance, in seconds.  
Type: Long  
Required: No

 ** fixedPrice **   
The purchase price of the Reserved Instance.  
Type: Float  
Required: No

 ** instanceTenancy **   
The tenancy of the instance.  
Type: String  
Valid Values: `default | dedicated | host`   
Required: No

 ** instanceType **   
The instance type on which the Reserved Instance can be used.  
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

 ** marketplace **   
Indicates whether the offering is available through the Reserved Instance Marketplace (resale) or AWS. If it's a Reserved Instance Marketplace offering, this is `true`.  
Type: Boolean  
Required: No

 ** offeringClass **   
If `convertible` it can be exchanged for Reserved Instances of the same or higher monetary value, with different configurations. If `standard`, it is not possible to perform an exchange.  
Type: String  
Valid Values: `standard | convertible`   
Required: No

 ** offeringType **   
The Reserved Instance offering type.  
Type: String  
Valid Values: `Heavy Utilization | Medium Utilization | Light Utilization | No Upfront | Partial Upfront | All Upfront`   
Required: No

 ** PricingDetailsSet.N **   
The pricing details of the Reserved Instance offering.  
Type: Array of [PricingDetail](API_PricingDetail.md) objects  
Required: No

 ** productDescription **   
The Reserved Instance product platform description.  
Type: String  
Valid Values: `Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)`   
Required: No

 ** RecurringCharges.N **   
The recurring charge tag assigned to the resource.  
Type: Array of [RecurringCharge](API_RecurringCharge.md) objects  
Required: No

 ** reservedInstancesOfferingId **   
The ID of the Reserved Instance offering. This is the offering ID used in [GetReservedInstancesExchangeQuote](API_GetReservedInstancesExchangeQuote.md) to confirm that an exchange can be made.  
Type: String  
Required: No

 ** scope **   
Whether the Reserved Instance is applied to instances in a Region or an Availability Zone.  
Type: String  
Valid Values: `Availability Zone | Region`   
Required: No

 ** usagePrice **   
The usage price of the Reserved Instance, per hour.  
Type: Float  
Required: No

## See Also
<a name="API_ReservedInstancesOffering_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ReservedInstancesOffering) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ReservedInstancesOffering) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ReservedInstancesOffering) 

# ResourceStatement
<a name="API_ResourceStatement"></a>

Describes a resource statement.

## Contents
<a name="API_ResourceStatement_Contents"></a>

 ** ResourceSet.N **   
The resources.  
Type: Array of strings  
Required: No

 ** ResourceTypeSet.N **   
The resource types.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ResourceStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResourceStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResourceStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResourceStatement) 

# ResourceStatementRequest
<a name="API_ResourceStatementRequest"></a>

Describes a resource statement.

## Contents
<a name="API_ResourceStatementRequest_Contents"></a>

 ** Resource.N **   
The resources.  
Type: Array of strings  
Required: No

 ** ResourceType.N **   
The resource types.  
Type: Array of strings  
Required: No

## See Also
<a name="API_ResourceStatementRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResourceStatementRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResourceStatementRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResourceStatementRequest) 

# ResourceTypeOption
<a name="API_ResourceTypeOption"></a>

The options that affect the scope of the response.

## Contents
<a name="API_ResourceTypeOption_Contents"></a>

 ** OptionName **   
The name of the option.  
+ For `ec2:Instance`:

  Specify `state-name` - The current state of the EC2 instance.
+ For `ec2:LaunchTemplate`:

  Specify `version-depth` - The number of launch template versions to check, starting from the most recent version.
Type: String  
Valid Values: `state-name | version-depth`   
Required: No

 ** OptionValue.N **   
A value for the specified option.  
+ For `state-name`:
  + Valid values: `pending` \$1 `running` \$1 `shutting-down` \$1 `terminated` \$1 `stopping` \$1 `stopped` 
  + Default: All states
+ For `version-depth`:
  + Valid values: Integers between `1` and `10000` 
  + Default: `10` 
Type: Array of strings  
Required: No

## See Also
<a name="API_ResourceTypeOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResourceTypeOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResourceTypeOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResourceTypeOption) 

# ResourceTypeRequest
<a name="API_ResourceTypeRequest"></a>

A resource type to check for image references. Associated options can also be specified if the resource type is an EC2 instance or launch template.

## Contents
<a name="API_ResourceTypeRequest_Contents"></a>

 ** ResourceType **   
The resource type.  
Type: String  
Valid Values: `ec2:Instance | ec2:LaunchTemplate | ssm:Parameter | imagebuilder:ImageRecipe | imagebuilder:ContainerRecipe`   
Required: No

 ** ResourceTypeOption.N **   
The options that affect the scope of the response. Valid only when `ResourceType` is `ec2:Instance` or `ec2:LaunchTemplate`.  
Type: Array of [ResourceTypeOption](API_ResourceTypeOption.md) objects  
Required: No

## See Also
<a name="API_ResourceTypeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResourceTypeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResourceTypeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResourceTypeRequest) 

# ResponseError
<a name="API_ResponseError"></a>

Describes the error that's returned when you cannot delete a launch template version.

## Contents
<a name="API_ResponseError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Valid Values: `launchTemplateIdDoesNotExist | launchTemplateIdMalformed | launchTemplateNameDoesNotExist | launchTemplateNameMalformed | launchTemplateVersionDoesNotExist | unexpectedError`   
Required: No

 ** message **   
The error message, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_ResponseError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResponseError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResponseError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResponseError) 

# ResponseLaunchTemplateData
<a name="API_ResponseLaunchTemplateData"></a>

The information for a launch template. 

## Contents
<a name="API_ResponseLaunchTemplateData_Contents"></a>

 ** BlockDeviceMappingSet.N **   
The block device mappings.  
Type: Array of [LaunchTemplateBlockDeviceMapping](API_LaunchTemplateBlockDeviceMapping.md) objects  
Required: No

 ** capacityReservationSpecification **   
Information about the Capacity Reservation targeting option.  
Type: [LaunchTemplateCapacityReservationSpecificationResponse](API_LaunchTemplateCapacityReservationSpecificationResponse.md) object  
Required: No

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

 ** creditSpecification **   
The credit option for CPU usage of the instance.  
Type: [CreditSpecification](API_CreditSpecification.md) object  
Required: No

 ** disableApiStop **   
Indicates whether the 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) in the *Amazon EC2 User Guide*.  
Type: Boolean  
Required: No

 ** disableApiTermination **   
If set to `true`, indicates that the instance cannot be terminated using the Amazon EC2 console, command line tool, or API.  
Type: Boolean  
Required: No

 ** ebsOptimized **   
Indicates whether the instance is optimized for Amazon EBS I/O.   
Type: Boolean  
Required: No

 ** ElasticGpuSpecificationSet.N **   
Deprecated.  
Amazon Elastic Graphics reached end of life on January 8, 2024.
Type: Array of [ElasticGpuSpecificationResponse](API_ElasticGpuSpecificationResponse.md) objects  
Required: No

 ** ElasticInferenceAcceleratorSet.N **   
Amazon Elastic Inference is no longer available.
An elastic inference accelerator to associate with the instance. Elastic inference accelerators are a resource you can attach to your Amazon EC2 instances to accelerate your Deep Learning (DL) inference workloads.  
You cannot specify accelerators from different generations in the same request.  
Type: Array of [LaunchTemplateElasticInferenceAcceleratorResponse](API_LaunchTemplateElasticInferenceAcceleratorResponse.md) objects  
Required: No

 ** enclaveOptions **   
Indicates whether the instance is enabled for AWS Nitro Enclaves.  
Type: [LaunchTemplateEnclaveOptions](API_LaunchTemplateEnclaveOptions.md) object  
Required: No

 ** hibernationOptions **   
Indicates whether an instance is configured for hibernation. 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*.  
Type: [LaunchTemplateHibernationOptions](API_LaunchTemplateHibernationOptions.md) object  
Required: No

 ** iamInstanceProfile **   
The IAM instance profile.  
Type: [LaunchTemplateIamInstanceProfileSpecification](API_LaunchTemplateIamInstanceProfileSpecification.md) object  
Required: No

 ** imageId **   
The ID of the AMI or a Systems Manager parameter. The Systems Manager parameter will resolve to the ID of the AMI at instance launch.  
The value depends on what you specified in the request. The possible values are:  
+ If an AMI ID was specified in the request, then this is the AMI ID.
+ If a Systems Manager parameter was specified in the request, and `ResolveAlias` was configured as `true`, then this is the AMI ID that the parameter is mapped to in the Parameter Store.
+ If a Systems Manager parameter was specified in the request, and `ResolveAlias` was configured as `false`, then this is the parameter value.
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*.  
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).  
Type: String  
Valid Values: `stop | terminate`   
Required: No

 ** instanceMarketOptions **   
The market (purchasing) option for the instances.  
Type: [LaunchTemplateInstanceMarketOptions](API_LaunchTemplateInstanceMarketOptions.md) object  
Required: No

 ** instanceRequirements **   
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with these attributes.  
If you specify `InstanceRequirements`, you can't specify `InstanceTypes`.  
Type: [InstanceRequirements](API_InstanceRequirements.md) object  
Required: No

 ** instanceType **   
The instance type.  
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

 ** kernelId **   
The ID of the kernel, if applicable.  
Type: String  
Required: No

 ** keyName **   
The name of the key pair.  
Type: String  
Required: No

 ** LicenseSet.N **   
The license configurations.  
Type: Array of [LaunchTemplateLicenseConfiguration](API_LaunchTemplateLicenseConfiguration.md) objects  
Required: No

 ** maintenanceOptions **   
The maintenance options for your instance.  
Type: [LaunchTemplateInstanceMaintenanceOptions](API_LaunchTemplateInstanceMaintenanceOptions.md) object  
Required: No

 ** 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) in the *Amazon EC2 User Guide*.  
Type: [LaunchTemplateInstanceMetadataOptions](API_LaunchTemplateInstanceMetadataOptions.md) object  
Required: No

 ** monitoring **   
The monitoring for the instance.  
Type: [LaunchTemplatesMonitoring](API_LaunchTemplatesMonitoring.md) object  
Required: No

 ** NetworkInterfaceSet.N **   
The network interfaces.  
Type: Array of [LaunchTemplateInstanceNetworkInterfaceSpecification](API_LaunchTemplateInstanceNetworkInterfaceSpecification.md) objects  
Required: No

 ** networkPerformanceOptions **   
Contains the launch template settings for network performance options for your instance.  
Type: [LaunchTemplateNetworkPerformanceOptions](API_LaunchTemplateNetworkPerformanceOptions.md) object  
Required: No

 ** operator **   
The entity that manages the launch template.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** placement **   
The placement of the instance.  
Type: [LaunchTemplatePlacement](API_LaunchTemplatePlacement.md) object  
Required: No

 ** privateDnsNameOptions **   
The options for the instance hostname.  
Type: [LaunchTemplatePrivateDnsNameOptions](API_LaunchTemplatePrivateDnsNameOptions.md) object  
Required: No

 ** ramDiskId **   
The ID of the RAM disk, if applicable.  
Type: String  
Required: No

 ** SecondaryInterfaceSet.N **   
The secondary interfaces associated with the launch template.  
Type: Array of [LaunchTemplateInstanceSecondaryInterfaceSpecification](API_LaunchTemplateInstanceSecondaryInterfaceSpecification.md) objects  
Required: No

 ** SecurityGroupIdSet.N **   
The security group IDs.  
Type: Array of strings  
Required: No

 ** SecurityGroupSet.N **   
The security group names.  
Type: Array of strings  
Required: No

 ** TagSpecificationSet.N **   
The tags that are applied to the resources that are created during instance launch.  
Type: Array of [LaunchTemplateTagSpecification](API_LaunchTemplateTagSpecification.md) objects  
Required: No

 ** userData **   
The user data for the instance.   
Type: String  
Required: No

## See Also
<a name="API_ResponseLaunchTemplateData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ResponseLaunchTemplateData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ResponseLaunchTemplateData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ResponseLaunchTemplateData) 

# RevokedSecurityGroupRule
<a name="API_RevokedSecurityGroupRule"></a>

A security group rule removed with [RevokeSecurityGroupEgress](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RevokeSecurityGroupEgress.html) or [RevokeSecurityGroupIngress](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RevokeSecurityGroupIngress.html).

## Contents
<a name="API_RevokedSecurityGroupRule_Contents"></a>

 ** cidrIpv4 **   
The IPv4 CIDR of the traffic source.  
Type: String  
Required: No

 ** cidrIpv6 **   
The IPv6 CIDR of the traffic source.  
Type: String  
Required: No

 ** description **   
A description of the revoked security group rule.  
Type: String  
Required: No

 ** fromPort **   
The 'from' port number of the security group rule.  
Type: Integer  
Required: No

 ** groupId **   
A security group ID.  
Type: String  
Required: No

 ** ipProtocol **   
The security group rule's protocol.  
Type: String  
Required: No

 ** isEgress **   
Defines if a security group rule is an outbound rule.  
Type: Boolean  
Required: No

 ** prefixListId **   
The ID of a prefix list that's the traffic source.  
Type: String  
Required: No

 ** referencedGroupId **   
The ID of a referenced security group.  
Type: String  
Required: No

 ** securityGroupRuleId **   
A security group rule ID.  
Type: String  
Required: No

 ** toPort **   
The 'to' port number of the security group rule.  
Type: Integer  
Required: No

## See Also
<a name="API_RevokedSecurityGroupRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RevokedSecurityGroupRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RevokedSecurityGroupRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RevokedSecurityGroupRule) 

# Route
<a name="API_Route"></a>

Describes a route in a route table.

## Contents
<a name="API_Route_Contents"></a>

 ** carrierGatewayId **   
The ID of the carrier gateway.  
Type: String  
Required: No

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

 ** destinationCidrBlock **   
The IPv4 CIDR block used for the destination match.  
Type: String  
Required: No

 ** destinationIpv6CidrBlock **   
The IPv6 CIDR block used for the destination match.  
Type: String  
Required: No

 ** destinationPrefixListId **   
The prefix of the AWS service.  
Type: String  
Required: No

 ** egressOnlyInternetGatewayId **   
The ID of the egress-only internet gateway.  
Type: String  
Required: No

 ** gatewayId **   
The ID of a gateway attached to your VPC.  
Type: String  
Required: No

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

 ** instanceOwnerId **   
The ID of AWS account that owns the instance.  
Type: String  
Required: No

 ** ipAddress **   
The next hop IP address for routes propagated by VPC Route Server into VPC route tables.  
Type: String  
Required: No

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

 ** natGatewayId **   
The ID of a NAT gateway.  
Type: String  
Required: No

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

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

 ** origin **   
Describes how the route was created.  
+  `CreateRouteTable` - The route was automatically created when the route table was created.
+  `CreateRoute` - The route was manually added to the route table.
+  `EnableVgwRoutePropagation` - The route was propagated by route propagation.
+  `Advertisement` - The route was created dynamically by Amazon VPC Route Server.
Type: String  
Valid Values: `CreateRouteTable | CreateRoute | EnableVgwRoutePropagation`   
Required: No

 ** state **   
The state of the route. The `blackhole` state indicates that the route's target isn't available (for example, the specified gateway isn't attached to the VPC, or the specified NAT instance has been terminated).  
Type: String  
Valid Values: `active | blackhole`   
Required: No

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

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

## See Also
<a name="API_Route_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Route) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Route) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Route) 

# RouteServer
<a name="API_RouteServer"></a>

Describes a route server and its configuration.

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).

## Contents
<a name="API_RouteServer_Contents"></a>

 ** amazonSideAsn **   
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. 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: 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. The default value is 1. Only valid if `persistRoutesState` 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

 ** persistRoutesState **   
The current state of route persistence for the route server.  
Type: String  
Valid Values: `enabling | enabled | resetting | disabling | disabled | modifying`   
Required: No

 ** routeServerId **   
The unique identifier of the route server.  
Type: String  
Required: No

 ** snsNotificationsEnabled **   
Indicates whether SNS notifications are enabled for the route server. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS.  
Type: Boolean  
Required: No

 ** snsTopicArn **   
The ARN of the SNS topic where notifications are published.  
Type: String  
Required: No

 ** state **   
The current state of the route server.  
Type: String  
Valid Values: `pending | available | modifying | deleting | deleted`   
Required: No

 ** TagSet.N **   
Any tags assigned to the route server.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_RouteServer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServer) 

# RouteServerAssociation
<a name="API_RouteServerAssociation"></a>

Describes the association between a route server and a VPC.

A route server association is the connection established between a route server and a VPC.

## Contents
<a name="API_RouteServerAssociation_Contents"></a>

 ** routeServerId **   
The ID of the associated route server.  
Type: String  
Required: No

 ** state **   
The current state of the association.  
Type: String  
Valid Values: `associating | associated | disassociating`   
Required: No

 ** vpcId **   
The ID of the associated VPC.  
Type: String  
Required: No

## See Also
<a name="API_RouteServerAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerAssociation) 

# RouteServerBfdStatus
<a name="API_RouteServerBfdStatus"></a>

The current status of Bidirectional Forwarding Detection (BFD) for a BGP session.

## Contents
<a name="API_RouteServerBfdStatus_Contents"></a>

 ** status **   
The operational status of the BFD session.  
Type: String  
Valid Values: `up | down`   
Required: No

## See Also
<a name="API_RouteServerBfdStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerBfdStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerBfdStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerBfdStatus) 

# RouteServerBgpOptions
<a name="API_RouteServerBgpOptions"></a>

The BGP configuration options for a route server peer.

## Contents
<a name="API_RouteServerBgpOptions_Contents"></a>

 ** peerAsn **   
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. 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: No

 ** peerLivenessDetection **   
The liveness detection protocol used for the BGP peer.  
The requested liveness detection protocol for the BGP peer.  
+  `bgp-keepalive`: The standard BGP keep alive mechanism ([RFC4271](https://www.rfc-editor.org/rfc/rfc4271#page-21)) that is stable but may take longer to fail-over in cases of network impact or router failure.
+  `bfd`: An additional Bidirectional Forwarding Detection (BFD) protocol ([RFC5880](https://www.rfc-editor.org/rfc/rfc5880)) that enables fast failover by using more sensitive liveness detection.
Defaults to `bgp-keepalive`.  
Type: String  
Valid Values: `bfd | bgp-keepalive`   
Required: No

## See Also
<a name="API_RouteServerBgpOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerBgpOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerBgpOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerBgpOptions) 

# RouteServerBgpOptionsRequest
<a name="API_RouteServerBgpOptionsRequest"></a>

The BGP configuration options requested for a route server peer.

## Contents
<a name="API_RouteServerBgpOptionsRequest_Contents"></a>

 ** PeerAsn **   
The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. 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

 ** PeerLivenessDetection **   
The requested liveness detection protocol for the BGP peer.  
+  `bgp-keepalive`: The standard BGP keep alive mechanism ([RFC4271](https://www.rfc-editor.org/rfc/rfc4271#page-21)) that is stable but may take longer to fail-over in cases of network impact or router failure.
+  `bfd`: An additional Bidirectional Forwarding Detection (BFD) protocol ([RFC5880](https://www.rfc-editor.org/rfc/rfc5880)) that enables fast failover by using more sensitive liveness detection.
Defaults to `bgp-keepalive`.  
Type: String  
Valid Values: `bfd | bgp-keepalive`   
Required: No

## See Also
<a name="API_RouteServerBgpOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerBgpOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerBgpOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerBgpOptionsRequest) 

# RouteServerBgpStatus
<a name="API_RouteServerBgpStatus"></a>

The current status of a BGP session.

## Contents
<a name="API_RouteServerBgpStatus_Contents"></a>

 ** status **   
The operational status of the BGP session. The status enables you to monitor session liveness if you lack monitoring on your router/appliance.  
Type: String  
Valid Values: `up | down`   
Required: No

## See Also
<a name="API_RouteServerBgpStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerBgpStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerBgpStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerBgpStatus) 

# RouteServerEndpoint
<a name="API_RouteServerEndpoint"></a>

Describes a route server endpoint and its properties.

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.

## Contents
<a name="API_RouteServerEndpoint_Contents"></a>

 ** eniAddress **   
The IP address of the Elastic network interface for the endpoint.  
Type: String  
Required: No

 ** eniId **   
The ID of the Elastic network interface for the endpoint.  
Type: String  
Required: No

 ** failureReason **   
The reason for any failure in endpoint creation or operation.  
Type: String  
Required: No

 ** routeServerEndpointId **   
The unique identifier of the route server endpoint.  
Type: String  
Required: No

 ** routeServerId **   
The ID of the route server associated with this endpoint.  
Type: String  
Required: No

 ** state **   
The current state of the route server endpoint.  
Type: String  
Valid Values: `pending | available | deleting | deleted | failing | failed | delete-failed`   
Required: No

 ** subnetId **   
The ID of the subnet to place the route server endpoint into.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the route server endpoint.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC containing the endpoint.  
Type: String  
Required: No

## See Also
<a name="API_RouteServerEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerEndpoint) 

# RouteServerPeer
<a name="API_RouteServerPeer"></a>

Describes a BGP peer configuration for a 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

## Contents
<a name="API_RouteServerPeer_Contents"></a>

 ** bfdStatus **   
The current status of the BFD session with this peer.  
Type: [RouteServerBfdStatus](API_RouteServerBfdStatus.md) object  
Required: No

 ** bgpOptions **   
The BGP configuration options for this peer, including ASN (Autonomous System Number) and BFD (Bidrectional Forwarding Detection) settings.  
Type: [RouteServerBgpOptions](API_RouteServerBgpOptions.md) object  
Required: No

 ** bgpStatus **   
The current status of the BGP session with this peer.  
Type: [RouteServerBgpStatus](API_RouteServerBgpStatus.md) object  
Required: No

 ** endpointEniAddress **   
The IP address of the Elastic network interface for the route server endpoint.  
Type: String  
Required: No

 ** endpointEniId **   
The ID of the Elastic network interface for the route server endpoint.  
Type: String  
Required: No

 ** failureReason **   
The reason for any failure in peer creation or operation.  
Type: String  
Required: No

 ** peerAddress **   
The IPv4 address of the peer device.  
Type: String  
Required: No

 ** routeServerEndpointId **   
The ID of the route server endpoint associated with this peer.  
Type: String  
Required: No

 ** routeServerId **   
The ID of the route server associated with this peer.  
Type: String  
Required: No

 ** routeServerPeerId **   
The unique identifier of the route server peer.  
Type: String  
Required: No

 ** state **   
The current state of the route server peer.  
Type: String  
Valid Values: `pending | available | deleting | deleted | failing | failed`   
Required: No

 ** subnetId **   
The ID of the subnet containing the route server peer.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the route server peer.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC containing the route server peer.  
Type: String  
Required: No

## See Also
<a name="API_RouteServerPeer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerPeer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerPeer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerPeer) 

# RouteServerPropagation
<a name="API_RouteServerPropagation"></a>

Describes the route propagation configuration between a route server and a 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.

## Contents
<a name="API_RouteServerPropagation_Contents"></a>

 ** routeServerId **   
The ID of the route server configured for route propagation.  
Type: String  
Required: No

 ** routeTableId **   
The ID of the route table configured for route server propagation.  
Type: String  
Required: No

 ** state **   
The current state of route propagation.  
Type: String  
Valid Values: `pending | available | deleting`   
Required: No

## See Also
<a name="API_RouteServerPropagation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerPropagation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerPropagation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerPropagation) 

# RouteServerRoute
<a name="API_RouteServerRoute"></a>

Describes a route in the route server's routing database.

## Contents
<a name="API_RouteServerRoute_Contents"></a>

 ** AsPathSet.N **   
The AS path attributes of the BGP route.  
Type: Array of strings  
Required: No

 ** med **   
The Multi-Exit Discriminator (MED) value of the BGP route.  
Type: Integer  
Required: No

 ** nextHopIp **   
The IP address for the next hop.  
Type: String  
Required: No

 ** prefix **   
The destination CIDR block of the route.  
Type: String  
Required: No

 ** RouteInstallationDetailSet.N **   
Details about the installation status of this route in route tables.  
Type: Array of [RouteServerRouteInstallationDetail](API_RouteServerRouteInstallationDetail.md) objects  
Required: No

 ** routeServerEndpointId **   
The ID of the route server endpoint that received this route.  
Type: String  
Required: No

 ** routeServerPeerId **   
The ID of the route server peer that advertised this route.  
Type: String  
Required: No

 ** routeStatus **   
The current status of the route in the routing database. Values are `in-rib` or `in-fib` depending on if the routes are in the RIB or the FIB database.  
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.  
The [Forwarding Information Base (FIB)](https://en.wikipedia.org/wiki/Forwarding_information_base) serves as a forwarding table for what route server has determined are the best-path routes in the RIB after evaluating all available routing information and policies. The FIB routes are installed on the route tables. The FIB is recomputed whenever there are changes to the RIB.  
Type: String  
Valid Values: `in-rib | in-fib`   
Required: No

## See Also
<a name="API_RouteServerRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerRoute) 

# RouteServerRouteInstallationDetail
<a name="API_RouteServerRouteInstallationDetail"></a>

Describes the installation status of a route in a route table.

## Contents
<a name="API_RouteServerRouteInstallationDetail_Contents"></a>

 ** routeInstallationStatus **   
The current installation status of the route in the route table.  
Type: String  
Valid Values: `installed | rejected`   
Required: No

 ** routeInstallationStatusReason **   
The reason for the current installation status of the route.  
Type: String  
Required: No

 ** routeTableId **   
The ID of the route table where the route is being installed.  
Type: String  
Required: No

## See Also
<a name="API_RouteServerRouteInstallationDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteServerRouteInstallationDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteServerRouteInstallationDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteServerRouteInstallationDetail) 

# RouteTable
<a name="API_RouteTable"></a>

Describes a route table.

## Contents
<a name="API_RouteTable_Contents"></a>

 ** AssociationSet.N **   
The associations between the route table and your subnets or gateways.  
Type: Array of [RouteTableAssociation](API_RouteTableAssociation.md) objects  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the route table.  
Type: String  
Required: No

 ** PropagatingVgwSet.N **   
Any virtual private gateway (VGW) propagating routes.  
Type: Array of [PropagatingVgw](API_PropagatingVgw.md) objects  
Required: No

 ** RouteSet.N **   
The routes in the route table.  
Type: Array of [Route](API_Route.md) objects  
Required: No

 ** routeTableId **   
The ID of the route table.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the route table.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_RouteTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteTable) 

# RouteTableAssociation
<a name="API_RouteTableAssociation"></a>

Describes an association between a route table and a subnet or gateway.

## Contents
<a name="API_RouteTableAssociation_Contents"></a>

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

 ** gatewayId **   
The ID of the internet gateway or virtual private gateway.  
Type: String  
Required: No

 ** main **   
Indicates whether this is the main route table.  
Type: Boolean  
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

 ** routeTableAssociationId **   
The ID of the association.  
Type: String  
Required: No

 ** routeTableId **   
The ID of the route table.  
Type: String  
Required: No

 ** subnetId **   
The ID of the subnet. A subnet ID is not returned for an implicit association.  
Type: String  
Required: No

## See Also
<a name="API_RouteTableAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteTableAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteTableAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteTableAssociation) 

# RouteTableAssociationState
<a name="API_RouteTableAssociationState"></a>

Describes the state of an association between a route table and a subnet or gateway.

## Contents
<a name="API_RouteTableAssociationState_Contents"></a>

 ** state **   
The state of the association.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated | failed`   
Required: No

 ** statusMessage **   
The status message, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_RouteTableAssociationState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RouteTableAssociationState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RouteTableAssociationState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RouteTableAssociationState) 

# RuleGroupRuleOptionsPair
<a name="API_RuleGroupRuleOptionsPair"></a>

Describes the rule options for a stateful rule group.

## Contents
<a name="API_RuleGroupRuleOptionsPair_Contents"></a>

 ** ruleGroupArn **   
The ARN of the rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** RuleOptionSet.N **   
The rule options.  
Type: Array of [RuleOption](API_RuleOption.md) objects  
Required: No

## See Also
<a name="API_RuleGroupRuleOptionsPair_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RuleGroupRuleOptionsPair) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RuleGroupRuleOptionsPair) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RuleGroupRuleOptionsPair) 

# RuleGroupTypePair
<a name="API_RuleGroupTypePair"></a>

Describes the type of a stateful rule group.

## Contents
<a name="API_RuleGroupTypePair_Contents"></a>

 ** ruleGroupArn **   
The ARN of the rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** ruleGroupType **   
The rule group type. The possible values are `Domain List` and `Suricata`.  
Type: String  
Required: No

## See Also
<a name="API_RuleGroupTypePair_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RuleGroupTypePair) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RuleGroupTypePair) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RuleGroupTypePair) 

# RuleOption
<a name="API_RuleOption"></a>

Describes additional settings for a stateful rule.

## Contents
<a name="API_RuleOption_Contents"></a>

 ** keyword **   
The Suricata keyword.  
Type: String  
Required: No

 ** SettingSet.N **   
The settings for the keyword.  
Type: Array of strings  
Required: No

## See Also
<a name="API_RuleOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RuleOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RuleOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RuleOption) 

# RunInstancesMonitoringEnabled
<a name="API_RunInstancesMonitoringEnabled"></a>

Describes the monitoring of an instance.

## Contents
<a name="API_RunInstancesMonitoringEnabled_Contents"></a>

 ** Enabled ** (request), ** enabled ** (response)  
Indicates whether detailed monitoring is enabled. Otherwise, basic monitoring is enabled.  
Type: Boolean  
Required: Yes

## See Also
<a name="API_RunInstancesMonitoringEnabled_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/RunInstancesMonitoringEnabled) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/RunInstancesMonitoringEnabled) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/RunInstancesMonitoringEnabled) 

# S3ObjectTag
<a name="API_S3ObjectTag"></a>

The tags to apply to the AMI object that will be stored in the Amazon S3 bucket. For more information, see [Categorizing your storage using tags](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-tagging.html) in the *Amazon Simple Storage Service User Guide*.

## Contents
<a name="API_S3ObjectTag_Contents"></a>

 ** Key **   
The key of the tag.  
Constraints: Tag keys are case-sensitive and can be up to 128 Unicode characters in length. May not begin with `aws`:.  
Type: String  
Required: No

 ** Value **   
The value of the tag.  
Constraints: Tag values are case-sensitive and can be up to 256 Unicode characters in length.  
Type: String  
Required: No

## See Also
<a name="API_S3ObjectTag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/S3ObjectTag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/S3ObjectTag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/S3ObjectTag) 

# S3Storage
<a name="API_S3Storage"></a>

Describes the storage parameters for Amazon S3 and Amazon S3 buckets for an instance store-backed AMI.

## Contents
<a name="API_S3Storage_Contents"></a>

 ** AWSAccessKeyId ** (request), ** AWSAccessKeyId ** (response)  
The access key ID of the owner of the bucket. 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 ManagementReference Guide*.  
Type: String  
Required: No

 ** Bucket ** (request), ** bucket ** (response)  
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: String  
Required: No

 ** Prefix ** (request), ** prefix ** (response)  
The beginning of the file name of the AMI.  
Type: String  
Required: No

 ** UploadPolicy ** (request), ** uploadPolicy ** (response)  
An Amazon S3 upload policy that gives Amazon EC2 permission to upload items into Amazon S3 on your behalf.  
Type: Base64-encoded binary data object  
Required: No

 ** UploadPolicySignature ** (request), ** uploadPolicySignature ** (response)  
The signature of the JSON document.  
Type: String  
Required: No

## See Also
<a name="API_S3Storage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/S3Storage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/S3Storage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/S3Storage) 

# ScheduledInstance
<a name="API_ScheduledInstance"></a>

Describes a Scheduled Instance.

## Contents
<a name="API_ScheduledInstance_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** createDate **   
The date when the Scheduled Instance was purchased.  
Type: Timestamp  
Required: No

 ** hourlyPrice **   
The hourly price for a single instance.  
Type: String  
Required: No

 ** instanceCount **   
The number of instances.  
Type: Integer  
Required: No

 ** instanceType **   
The instance type.  
Type: String  
Required: No

 ** networkPlatform **   
The network platform.  
Type: String  
Required: No

 ** nextSlotStartTime **   
The time for the next schedule to start.  
Type: Timestamp  
Required: No

 ** platform **   
The platform (`Linux/UNIX` or `Windows`).  
Type: String  
Required: No

 ** previousSlotEndTime **   
The time that the previous schedule ended or will end.  
Type: Timestamp  
Required: No

 ** recurrence **   
The schedule recurrence.  
Type: [ScheduledInstanceRecurrence](API_ScheduledInstanceRecurrence.md) object  
Required: No

 ** scheduledInstanceId **   
The Scheduled Instance ID.  
Type: String  
Required: No

 ** slotDurationInHours **   
The number of hours in the schedule.  
Type: Integer  
Required: No

 ** termEndDate **   
The end date for the Scheduled Instance.  
Type: Timestamp  
Required: No

 ** termStartDate **   
The start date for the Scheduled Instance.  
Type: Timestamp  
Required: No

 ** totalScheduledInstanceHours **   
The total number of hours for a single instance for the entire term.  
Type: Integer  
Required: No

## See Also
<a name="API_ScheduledInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstance) 

# ScheduledInstanceAvailability
<a name="API_ScheduledInstanceAvailability"></a>

Describes a schedule that is available for your Scheduled Instances.

## Contents
<a name="API_ScheduledInstanceAvailability_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availableInstanceCount **   
The number of available instances.  
Type: Integer  
Required: No

 ** firstSlotStartTime **   
The time period for the first schedule to start.  
Type: Timestamp  
Required: No

 ** hourlyPrice **   
The hourly price for a single instance.  
Type: String  
Required: No

 ** instanceType **   
The instance type. You can specify one of the C3, C4, M4, or R3 instance types.  
Type: String  
Required: No

 ** maxTermDurationInDays **   
The maximum term. The only possible value is 365 days.  
Type: Integer  
Required: No

 ** minTermDurationInDays **   
The minimum term. The only possible value is 365 days.  
Type: Integer  
Required: No

 ** networkPlatform **   
The network platform.  
Type: String  
Required: No

 ** platform **   
The platform (`Linux/UNIX` or `Windows`).  
Type: String  
Required: No

 ** purchaseToken **   
The purchase token. This token expires in two hours.  
Type: String  
Required: No

 ** recurrence **   
The schedule recurrence.  
Type: [ScheduledInstanceRecurrence](API_ScheduledInstanceRecurrence.md) object  
Required: No

 ** slotDurationInHours **   
The number of hours in the schedule.  
Type: Integer  
Required: No

 ** totalScheduledInstanceHours **   
The total number of hours for a single instance for the entire term.  
Type: Integer  
Required: No

## See Also
<a name="API_ScheduledInstanceAvailability_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstanceAvailability) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstanceAvailability) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstanceAvailability) 

# ScheduledInstanceRecurrence
<a name="API_ScheduledInstanceRecurrence"></a>

Describes the recurring schedule for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstanceRecurrence_Contents"></a>

 ** frequency **   
The frequency (`Daily`, `Weekly`, or `Monthly`).  
Type: String  
Required: No

 ** interval **   
The interval quantity. The interval unit depends on the value of `frequency`. For example, every 2 weeks or every 2 months.  
Type: Integer  
Required: No

 ** OccurrenceDaySet.N **   
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday).  
Type: Array of integers  
Required: No

 ** occurrenceRelativeToEnd **   
Indicates whether the occurrence is relative to the end of the specified week or month.  
Type: Boolean  
Required: No

 ** occurrenceUnit **   
The unit for `occurrenceDaySet` (`DayOfWeek` or `DayOfMonth`).  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstanceRecurrence_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstanceRecurrence) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstanceRecurrence) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstanceRecurrence) 

# ScheduledInstanceRecurrenceRequest
<a name="API_ScheduledInstanceRecurrenceRequest"></a>

Describes the recurring schedule for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstanceRecurrenceRequest_Contents"></a>

 ** Frequency **   
The frequency (`Daily`, `Weekly`, or `Monthly`).  
Type: String  
Required: No

 ** Interval **   
The interval quantity. The interval unit depends on the value of `Frequency`. For example, every 2 weeks or every 2 months.  
Type: Integer  
Required: No

 ** OccurrenceDay.N **   
The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.  
Type: Array of integers  
Required: No

 ** OccurrenceRelativeToEnd **   
Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.  
Type: Boolean  
Required: No

 ** OccurrenceUnit **   
The unit for `OccurrenceDays` (`DayOfWeek` or `DayOfMonth`). This value is required for a monthly schedule. You can't specify `DayOfWeek` with a weekly schedule. You can't specify this value with a daily schedule.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstanceRecurrenceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstanceRecurrenceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstanceRecurrenceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstanceRecurrenceRequest) 

# ScheduledInstancesBlockDeviceMapping
<a name="API_ScheduledInstancesBlockDeviceMapping"></a>

Describes a block device mapping for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstancesBlockDeviceMapping_Contents"></a>

 ** DeviceName **   
The device name (for example, `/dev/sdh` or `xvdh`).  
Type: String  
Required: No

 ** Ebs **   
Parameters used to set up EBS volumes automatically when the instance is launched.  
Type: [ScheduledInstancesEbs](API_ScheduledInstancesEbs.md) object  
Required: No

 ** NoDevice **   
To omit the device from the block device mapping, specify an empty string.  
Type: String  
Required: No

 ** VirtualName **   
The virtual device name (`ephemeral`N). Instance store volumes are numbered starting from 0. An instance type with two available instance store volumes can specify mappings for `ephemeral0` and `ephemeral1`. The number of available instance store volumes depends on the instance type. After you connect to the instance, you must mount the volume.  
Constraints: For M3 instances, you must specify instance store volumes in the block device mapping for the instance. When you launch an M3 instance, we ignore any instance store volumes specified in the block device mapping for the AMI.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesBlockDeviceMapping_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesBlockDeviceMapping) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesBlockDeviceMapping) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesBlockDeviceMapping) 

# ScheduledInstancesEbs
<a name="API_ScheduledInstancesEbs"></a>

Describes an EBS volume for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstancesEbs_Contents"></a>

 ** DeleteOnTermination **   
Indicates whether the volume is deleted on instance termination.  
Type: Boolean  
Required: No

 ** Encrypted **   
Indicates whether the volume is encrypted. You can attached encrypted volumes only to instances that support them.  
Type: Boolean  
Required: No

 ** Iops **   
The number of I/O operations per second (IOPS) to provision for a `gp3`, `io1`, or `io2` volume.  
Type: Integer  
Required: No

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

 ** VolumeSize **   
The size of the volume, in GiB.  
Default: If you're creating the volume from a snapshot and don't specify a volume size, the default is the snapshot size.  
Type: Integer  
Required: No

 ** VolumeType **   
The volume type.  
Default: `gp2`   
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesEbs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesEbs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesEbs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesEbs) 

# ScheduledInstancesIamInstanceProfile
<a name="API_ScheduledInstancesIamInstanceProfile"></a>

Describes an IAM instance profile for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstancesIamInstanceProfile_Contents"></a>

 ** Arn **   
The Amazon Resource Name (ARN).  
Type: String  
Required: No

 ** Name **   
The name.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesIamInstanceProfile_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesIamInstanceProfile) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesIamInstanceProfile) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesIamInstanceProfile) 

# ScheduledInstancesIpv6Address
<a name="API_ScheduledInstancesIpv6Address"></a>

Describes an IPv6 address.

## Contents
<a name="API_ScheduledInstancesIpv6Address_Contents"></a>

 ** Ipv6Address **   
The IPv6 address.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesIpv6Address_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesIpv6Address) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesIpv6Address) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesIpv6Address) 

# ScheduledInstancesLaunchSpecification
<a name="API_ScheduledInstancesLaunchSpecification"></a>

Describes the launch specification for a Scheduled Instance.

If you are launching the Scheduled Instance in EC2-VPC, you must specify the ID of the subnet. You can specify the subnet using either `SubnetId` or `NetworkInterface`.

## Contents
<a name="API_ScheduledInstancesLaunchSpecification_Contents"></a>

 ** ImageId **   
The ID of the Amazon Machine Image (AMI).  
Type: String  
Required: Yes

 ** BlockDeviceMapping.N **   
The block device mapping entries.  
Type: Array of [ScheduledInstancesBlockDeviceMapping](API_ScheduledInstancesBlockDeviceMapping.md) objects  
Required: No

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

 ** IamInstanceProfile **   
The IAM instance profile.  
Type: [ScheduledInstancesIamInstanceProfile](API_ScheduledInstancesIamInstanceProfile.md) object  
Required: No

 ** InstanceType **   
The instance type.  
Type: String  
Required: No

 ** KernelId **   
The ID of the kernel.  
Type: String  
Required: No

 ** KeyName **   
The name of the key pair.  
Type: String  
Required: No

 ** Monitoring **   
Enable or disable monitoring for the instances.  
Type: [ScheduledInstancesMonitoring](API_ScheduledInstancesMonitoring.md) object  
Required: No

 ** NetworkInterface.N **   
The network interfaces.  
Type: Array of [ScheduledInstancesNetworkInterface](API_ScheduledInstancesNetworkInterface.md) objects  
Required: No

 ** Placement **   
The placement information.  
Type: [ScheduledInstancesPlacement](API_ScheduledInstancesPlacement.md) object  
Required: No

 ** RamdiskId **   
The ID of the RAM disk.  
Type: String  
Required: No

 ** SecurityGroupId.N **   
The IDs of the security groups.  
Type: Array of strings  
Required: No

 ** SubnetId **   
The ID of the subnet in which to launch the instances.  
Type: String  
Required: No

 ** UserData **   
The base64-encoded MIME user data.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesLaunchSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesLaunchSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesLaunchSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesLaunchSpecification) 

# ScheduledInstancesMonitoring
<a name="API_ScheduledInstancesMonitoring"></a>

Describes whether monitoring is enabled for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstancesMonitoring_Contents"></a>

 ** Enabled **   
Indicates whether monitoring is enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_ScheduledInstancesMonitoring_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesMonitoring) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesMonitoring) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesMonitoring) 

# ScheduledInstancesNetworkInterface
<a name="API_ScheduledInstancesNetworkInterface"></a>

Describes a network interface for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstancesNetworkInterface_Contents"></a>

 ** AssociatePublicIpAddress **   
Indicates whether to assign a public IPv4 address to instances launched in a VPC. The public IPv4 address can only be assigned to a network interface for eth0, and can only be assigned to a new network interface, not an existing one. You cannot specify more than one network interface in the request. If launching into a default subnet, the default value is `true`.  
 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: Boolean  
Required: No

 ** DeleteOnTermination **   
Indicates whether to delete the interface when the instance is terminated.  
Type: Boolean  
Required: No

 ** Description **   
The description.  
Type: String  
Required: No

 ** DeviceIndex **   
The index of the device for the network interface attachment.  
Type: Integer  
Required: No

 ** Group.N **   
The IDs of the security groups.  
Type: Array of strings  
Required: No

 ** Ipv6Address.N **   
The specific IPv6 addresses from the subnet range.  
Type: Array of [ScheduledInstancesIpv6Address](API_ScheduledInstancesIpv6Address.md) objects  
Required: No

 ** Ipv6AddressCount **   
The number of IPv6 addresses to assign to the network interface. The IPv6 addresses are automatically selected from the subnet range.  
Type: Integer  
Required: No

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

 ** PrivateIpAddress **   
The IPv4 address of the network interface within the subnet.  
Type: String  
Required: No

 ** PrivateIpAddressConfig.N **   
The private IPv4 addresses.  
Type: Array of [ScheduledInstancesPrivateIpAddressConfig](API_ScheduledInstancesPrivateIpAddressConfig.md) objects  
Required: No

 ** SecondaryPrivateIpAddressCount **   
The number of secondary private IPv4 addresses.  
Type: Integer  
Required: No

 ** SubnetId **   
The ID of the subnet.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesNetworkInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesNetworkInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesNetworkInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesNetworkInterface) 

# ScheduledInstancesPlacement
<a name="API_ScheduledInstancesPlacement"></a>

Describes the placement for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstancesPlacement_Contents"></a>

 ** AvailabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** GroupName **   
The name of the placement group.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesPlacement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesPlacement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesPlacement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesPlacement) 

# ScheduledInstancesPrivateIpAddressConfig
<a name="API_ScheduledInstancesPrivateIpAddressConfig"></a>

Describes a private IPv4 address for a Scheduled Instance.

## Contents
<a name="API_ScheduledInstancesPrivateIpAddressConfig_Contents"></a>

 ** Primary **   
Indicates whether this is a primary IPv4 address. Otherwise, this is a secondary IPv4 address.  
Type: Boolean  
Required: No

 ** PrivateIpAddress **   
The IPv4 address.  
Type: String  
Required: No

## See Also
<a name="API_ScheduledInstancesPrivateIpAddressConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ScheduledInstancesPrivateIpAddressConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ScheduledInstancesPrivateIpAddressConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ScheduledInstancesPrivateIpAddressConfig) 

# SecondaryInterface
<a name="API_SecondaryInterface"></a>

Describes a secondary interface.

## Contents
<a name="API_SecondaryInterface_Contents"></a>

 ** attachment **   
The attachment information for the secondary interface.  
Type: [SecondaryInterfaceAttachment](API_SecondaryInterfaceAttachment.md) object  
Required: No

 ** availabilityZone **   
The Availability Zone of the secondary interface.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone of the secondary interface.  
Type: String  
Required: No

 ** macAddress **   
The MAC address of the secondary interface.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the secondary interface.  
Type: String  
Required: No

 ** PrivateIpv4AddressSet.N **   
The private IPv4 addresses associated with the secondary interface.  
Type: Array of [SecondaryInterfaceIpv4Address](API_SecondaryInterfaceIpv4Address.md) objects  
Required: No

 ** secondaryInterfaceArn **   
The Amazon Resource Name (ARN) of the secondary interface.  
Type: String  
Required: No

 ** secondaryInterfaceId **   
The ID of the secondary interface.  
Type: String  
Required: No

 ** secondaryInterfaceType **   
The type of secondary interface.  
Type: String  
Valid Values: `secondary`   
Required: No

 ** secondaryNetworkId **   
The ID of the secondary network.  
Type: String  
Required: No

 ** secondaryNetworkType **   
The type of the secondary network.  
Type: String  
Valid Values: `rdma`   
Required: No

 ** secondarySubnetId **   
The ID of the secondary subnet.  
Type: String  
Required: No

 ** sourceDestCheck **   
Indicates whether source/destination checking is enabled.  
Type: Boolean  
Required: No

 ** status **   
The status of the secondary interface.  
Type: String  
Valid Values: `available | in-use`   
Required: No

 ** TagSet.N **   
The tags assigned to the secondary interface.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_SecondaryInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondaryInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondaryInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondaryInterface) 

# SecondaryInterfaceAttachment
<a name="API_SecondaryInterfaceAttachment"></a>

Describes the attachment of a secondary interface to an instance.

## Contents
<a name="API_SecondaryInterfaceAttachment_Contents"></a>

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

 ** attachTime **   
The timestamp when the attachment was created.  
Type: Timestamp  
Required: No

 ** deleteOnTermination **   
Indicates whether the secondary interface is deleted when the instance is terminated.  
The only supported value for this field is `true`.  
Type: Boolean  
Required: No

 ** deviceIndex **   
The device index of the secondary interface.  
Type: Integer  
Required: No

 ** instanceId **   
The ID of the instance to which the secondary interface is attached.  
Type: String  
Required: No

 ** instanceOwnerId **   
The AWS account ID of the owner of the instance.  
Type: String  
Required: No

 ** networkCardIndex **   
The index of the network card.  
Type: Integer  
Required: No

 ** status **   
The attachment state.  
Type: String  
Valid Values: `attaching | attached | detaching | detached`   
Required: No

## See Also
<a name="API_SecondaryInterfaceAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondaryInterfaceAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondaryInterfaceAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondaryInterfaceAttachment) 

# SecondaryInterfaceIpv4Address
<a name="API_SecondaryInterfaceIpv4Address"></a>

Describes a private IPv4 address for a secondary interface.

## Contents
<a name="API_SecondaryInterfaceIpv4Address_Contents"></a>

 ** privateIpAddress **   
The private IPv4 address.  
Type: String  
Required: No

## See Also
<a name="API_SecondaryInterfaceIpv4Address_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondaryInterfaceIpv4Address) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondaryInterfaceIpv4Address) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondaryInterfaceIpv4Address) 

# SecondaryInterfacePrivateIpAddressSpecification
<a name="API_SecondaryInterfacePrivateIpAddressSpecification"></a>

Describes a private IPv4 address specification for a secondary interface.

## Contents
<a name="API_SecondaryInterfacePrivateIpAddressSpecification_Contents"></a>

 ** privateIpAddress **   
The private IPv4 address.  
Type: String  
Required: No

## See Also
<a name="API_SecondaryInterfacePrivateIpAddressSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondaryInterfacePrivateIpAddressSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondaryInterfacePrivateIpAddressSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondaryInterfacePrivateIpAddressSpecification) 

# SecondaryInterfacePrivateIpAddressSpecificationRequest
<a name="API_SecondaryInterfacePrivateIpAddressSpecificationRequest"></a>

Describes a private IPv4 address specification for a secondary interface request.

## Contents
<a name="API_SecondaryInterfacePrivateIpAddressSpecificationRequest_Contents"></a>

 ** PrivateIpAddress **   
The private IPv4 address.  
Type: String  
Required: No

## See Also
<a name="API_SecondaryInterfacePrivateIpAddressSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondaryInterfacePrivateIpAddressSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondaryInterfacePrivateIpAddressSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondaryInterfacePrivateIpAddressSpecificationRequest) 

# SecondaryNetwork
<a name="API_SecondaryNetwork"></a>

Describes a secondary network.

## Contents
<a name="API_SecondaryNetwork_Contents"></a>

 ** Ipv4CidrBlockAssociationSet.N **   
Information about the IPv4 CIDR blocks associated with the secondary network.  
Type: Array of [SecondaryNetworkIpv4CidrBlockAssociation](API_SecondaryNetworkIpv4CidrBlockAssociation.md) objects  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the secondary network.  
Type: String  
Required: No

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

 ** secondaryNetworkId **   
The ID of the secondary network.  
Type: String  
Required: No

 ** state **   
The state of the secondary network.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed`   
Required: No

 ** stateReason **   
The reason for the current state of the secondary network.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the secondary network.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** type **   
The type of the secondary network.  
Type: String  
Valid Values: `rdma`   
Required: No

## See Also
<a name="API_SecondaryNetwork_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondaryNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondaryNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondaryNetwork) 

# SecondaryNetworkIpv4CidrBlockAssociation
<a name="API_SecondaryNetworkIpv4CidrBlockAssociation"></a>

Describes an IPv4 CIDR block associated with a secondary network.

## Contents
<a name="API_SecondaryNetworkIpv4CidrBlockAssociation_Contents"></a>

 ** associationId **   
The association ID for the IPv4 CIDR block.  
Type: String  
Required: No

 ** cidrBlock **   
The IPv4 CIDR block.  
Type: String  
Required: No

 ** state **   
The state of the CIDR block association.  
Type: String  
Valid Values: `associating | associated | association-failed | disassociating | disassociated | disassociation-failed`   
Required: No

 ** stateReason **   
The reason for the current state of the CIDR block association.  
Type: String  
Required: No

## See Also
<a name="API_SecondaryNetworkIpv4CidrBlockAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondaryNetworkIpv4CidrBlockAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondaryNetworkIpv4CidrBlockAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondaryNetworkIpv4CidrBlockAssociation) 

# SecondarySubnet
<a name="API_SecondarySubnet"></a>

Describes a secondary subnet.

## Contents
<a name="API_SecondarySubnet_Contents"></a>

 ** availabilityZone **   
The Availability Zone of the secondary subnet.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone of the secondary subnet.  
Type: String  
Required: No

 ** Ipv4CidrBlockAssociationSet.N **   
Information about the IPv4 CIDR blocks associated with the secondary subnet.  
Type: Array of [SecondarySubnetIpv4CidrBlockAssociation](API_SecondarySubnetIpv4CidrBlockAssociation.md) objects  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the secondary subnet.  
Type: String  
Required: No

 ** secondaryNetworkId **   
The ID of the secondary network.  
Type: String  
Required: No

 ** secondaryNetworkType **   
The type of the secondary network.  
Type: String  
Valid Values: `rdma`   
Required: No

 ** secondarySubnetArn **   
The Amazon Resource Name (ARN) of the secondary subnet.  
Type: String  
Required: No

 ** secondarySubnetId **   
The ID of the secondary subnet.  
Type: String  
Required: No

 ** state **   
The state of the secondary subnet.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | delete-in-progress | delete-complete | delete-failed`   
Required: No

 ** stateReason **   
The reason for the current state of the secondary subnet.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the secondary subnet.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_SecondarySubnet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondarySubnet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondarySubnet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondarySubnet) 

# SecondarySubnetIpv4CidrBlockAssociation
<a name="API_SecondarySubnetIpv4CidrBlockAssociation"></a>

Describes an IPv4 CIDR block associated with a secondary subnet.

## Contents
<a name="API_SecondarySubnetIpv4CidrBlockAssociation_Contents"></a>

 ** associationId **   
The association ID for the IPv4 CIDR block.  
Type: String  
Required: No

 ** cidrBlock **   
The IPv4 CIDR block.  
Type: String  
Required: No

 ** state **   
The state of the CIDR block association.  
Type: String  
Valid Values: `associating | associated | association-failed | disassociating | disassociated | disassociation-failed`   
Required: No

 ** stateReason **   
The reason for the current state of the CIDR block association.  
Type: String  
Required: No

## See Also
<a name="API_SecondarySubnetIpv4CidrBlockAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecondarySubnetIpv4CidrBlockAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecondarySubnetIpv4CidrBlockAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecondarySubnetIpv4CidrBlockAssociation) 

# SecurityGroup
<a name="API_SecurityGroup"></a>

Describes a security group.

## Contents
<a name="API_SecurityGroup_Contents"></a>

 ** groupDescription **   
A description of the security group.  
Type: String  
Required: No

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

 ** groupName **   
The name of the security group.  
Type: String  
Required: No

 ** IpPermissions.N **   
The inbound rules associated with the security group.  
Type: Array of [IpPermission](API_IpPermission.md) objects  
Required: No

 ** IpPermissionsEgress.N **   
The outbound rules associated with the security group.  
Type: Array of [IpPermission](API_IpPermission.md) objects  
Required: No

 ** ownerId **   
The AWS account ID of the owner of the security group.  
Type: String  
Required: No

 ** securityGroupArn **   
The ARN of the security group.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the security group.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC for the security group.  
Type: String  
Required: No

## See Also
<a name="API_SecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroup) 

# SecurityGroupForVpc
<a name="API_SecurityGroupForVpc"></a>

A security group that can be used by interfaces in the VPC.

## Contents
<a name="API_SecurityGroupForVpc_Contents"></a>

 ** description **   
The security group's description.  
Type: String  
Required: No

 ** groupId **   
The security group ID.  
Type: String  
Required: No

 ** groupName **   
The security group name.  
Type: String  
Required: No

 ** ownerId **   
The security group owner ID.  
Type: String  
Required: No

 ** primaryVpcId **   
The VPC ID in which the security group was created.  
Type: String  
Required: No

 ** TagSet.N **   
The security group tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_SecurityGroupForVpc_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupForVpc) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupForVpc) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupForVpc) 

# SecurityGroupIdentifier
<a name="API_SecurityGroupIdentifier"></a>

Describes a security group.

## Contents
<a name="API_SecurityGroupIdentifier_Contents"></a>

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

 ** groupName **   
The name of the security group.  
Type: String  
Required: No

## See Also
<a name="API_SecurityGroupIdentifier_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupIdentifier) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupIdentifier) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupIdentifier) 

# SecurityGroupReference
<a name="API_SecurityGroupReference"></a>

Describes a VPC with a security group that references your security group.

## Contents
<a name="API_SecurityGroupReference_Contents"></a>

 ** groupId **   
The ID of your security group.  
Type: String  
Required: No

 ** referencingVpcId **   
The ID of the VPC with the referencing security group.  
Type: String  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway (if applicable).  
Type: String  
Required: No

 ** vpcPeeringConnectionId **   
The ID of the VPC peering connection (if applicable). For more information about security group referencing for peering connections, see [Update your security groups to reference peer security groups](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-security-groups.html) in the *VPC Peering Guide*.  
Type: String  
Required: No

## See Also
<a name="API_SecurityGroupReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupReference) 

# SecurityGroupRule
<a name="API_SecurityGroupRule"></a>

Describes a security group rule.

## Contents
<a name="API_SecurityGroupRule_Contents"></a>

 ** cidrIpv4 **   
The IPv4 CIDR range.  
Type: String  
Required: No

 ** cidrIpv6 **   
The IPv6 CIDR range.  
Type: String  
Required: No

 ** description **   
The security group rule description.  
Type: String  
Required: No

 ** fromPort **   
If the protocol is TCP or UDP, this is the start of the port range. If the protocol is ICMP or ICMPv6, 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

 ** groupOwnerId **   
The ID of the AWS account that owns the security group.   
Type: String  
Required: No

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

 ** isEgress **   
Indicates whether the security group rule is an outbound rule.  
Type: Boolean  
Required: No

 ** prefixListId **   
The ID of the prefix list.  
Type: String  
Required: No

 ** referencedGroupInfo **   
Describes the security group that is referenced in the rule.  
Type: [ReferencedSecurityGroup](API_ReferencedSecurityGroup.md) object  
Required: No

 ** securityGroupRuleArn **   
The ARN of the security group rule.  
Type: String  
Required: No

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

 ** TagSet.N **   
The tags applied to the security group rule.  
Type: Array of [Tag](API_Tag.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 or ICMPv6, 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).  
Type: Integer  
Required: No

## See Also
<a name="API_SecurityGroupRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupRule) 

# SecurityGroupRuleDescription
<a name="API_SecurityGroupRuleDescription"></a>

Describes the description of a security group rule.

You can use this when you want to update the security group rule description for either an inbound or outbound rule.

## Contents
<a name="API_SecurityGroupRuleDescription_Contents"></a>

 ** Description **   
The description of the security group rule.  
Type: String  
Required: No

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

## See Also
<a name="API_SecurityGroupRuleDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupRuleDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupRuleDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupRuleDescription) 

# SecurityGroupRuleRequest
<a name="API_SecurityGroupRuleRequest"></a>

Describes a security group rule.

You must specify exactly one of the following parameters, based on the rule type:
+ CidrIpv4
+ CidrIpv6
+ PrefixListId
+ ReferencedGroupId

**Note**  
 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.

When you modify a rule, you cannot change the rule type. For example, if the rule uses an IPv4 address range, you must use `CidrIpv4` to specify a new IPv4 address range.

## Contents
<a name="API_SecurityGroupRuleRequest_Contents"></a>

 ** CidrIpv4 **   
The IPv4 CIDR range. To specify a single IPv4 address, use the /32 prefix length.   
Type: String  
Required: No

 ** CidrIpv6 **   
The IPv6 CIDR range. To specify a single IPv6 address, use the /128 prefix length.  
Type: String  
Required: No

 ** Description **   
The description of the security group rule.  
Type: String  
Required: No

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

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

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

 ** ReferencedGroupId **   
The ID of the security group that is referenced in the security group rule.  
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 or ICMPv6, 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).  
Type: Integer  
Required: No

## See Also
<a name="API_SecurityGroupRuleRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupRuleRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupRuleRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupRuleRequest) 

# SecurityGroupRuleUpdate
<a name="API_SecurityGroupRuleUpdate"></a>

Describes an update to a security group rule.

## Contents
<a name="API_SecurityGroupRuleUpdate_Contents"></a>

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

 ** SecurityGroupRule **   
Information about the security group rule.  
Type: [SecurityGroupRuleRequest](API_SecurityGroupRuleRequest.md) object  
Required: No

## See Also
<a name="API_SecurityGroupRuleUpdate_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupRuleUpdate) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupRuleUpdate) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupRuleUpdate) 

# SecurityGroupVpcAssociation
<a name="API_SecurityGroupVpcAssociation"></a>

A security group association with a VPC that you made with [AssociateSecurityGroupVpc](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_AssociateSecurityGroupVpc.html).

## Contents
<a name="API_SecurityGroupVpcAssociation_Contents"></a>

 ** groupId **   
The association's security group ID.  
Type: String  
Required: No

 ** groupOwnerId **   
The AWS account ID of the owner of the security group.  
Type: String  
Required: No

 ** state **   
The association's state.  
Type: String  
Valid Values: `associating | associated | association-failed | disassociating | disassociated | disassociation-failed`   
Required: No

 ** stateReason **   
The association's state reason.  
Type: String  
Required: No

 ** vpcId **   
The association's VPC ID.  
Type: String  
Required: No

 ** vpcOwnerId **   
The AWS account ID of the owner of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_SecurityGroupVpcAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SecurityGroupVpcAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SecurityGroupVpcAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SecurityGroupVpcAssociation) 

# ServiceConfiguration
<a name="API_ServiceConfiguration"></a>

Describes a service configuration for a VPC endpoint service.

## Contents
<a name="API_ServiceConfiguration_Contents"></a>

 ** acceptanceRequired **   
Indicates whether requests from other AWS accounts to create an endpoint to the service must first be accepted.  
Type: Boolean  
Required: No

 ** AvailabilityZoneIdSet.N **   
The IDs of the Availability Zones in which the service is available.  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both  
Type: Array of strings  
Required: No

 ** AvailabilityZoneSet.N **   
The Availability Zones in which the service is available.  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both  
Type: Array of strings  
Required: No

 ** BaseEndpointDnsNameSet.N **   
The DNS names for the service.  
Type: Array of strings  
Required: No

 ** GatewayLoadBalancerArnSet.N **   
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.  
Type: Array of strings  
Required: No

 ** managesVpcEndpoints **   
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.  
Type: Boolean  
Required: No

 ** NetworkLoadBalancerArnSet.N **   
The Amazon Resource Names (ARNs) of the Network Load Balancers for the service.  
Type: Array of strings  
Required: No

 ** payerResponsibility **   
The payer responsibility.  
Type: String  
Valid Values: `ServiceOwner`   
Required: No

 ** privateDnsName **   
The private DNS name for the service.  
Type: String  
Required: No

 ** privateDnsNameConfiguration **   
Information about the endpoint service private DNS name configuration.  
Type: [PrivateDnsNameConfiguration](API_PrivateDnsNameConfiguration.md) object  
Required: No

 ** remoteAccessEnabled **   
Indicates whether consumers can access the service from a Region other than the Region where the service is hosted.  
Type: Boolean  
Required: No

 ** serviceId **   
The ID of the service.  
Type: String  
Required: No

 ** serviceName **   
The name of the service.  
Type: String  
Required: No

 ** serviceState **   
The service state.  
Type: String  
Valid Values: `Pending | Available | Deleting | Deleted | Failed`   
Required: No

 ** ServiceType.N **   
The type of service.  
Type: Array of [ServiceTypeDetail](API_ServiceTypeDetail.md) objects  
Required: No

 ** SupportedIpAddressTypeSet.N **   
The supported IP address types.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `ipv4 | ipv6`   
Required: No

 ** SupportedRegionSet.N **   
The supported Regions.  
Type: Array of [SupportedRegionDetail](API_SupportedRegionDetail.md) objects  
Required: No

 ** TagSet.N **   
The tags assigned to the service.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_ServiceConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ServiceConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ServiceConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ServiceConfiguration) 

# ServiceDetail
<a name="API_ServiceDetail"></a>

Describes a VPC endpoint service.

## Contents
<a name="API_ServiceDetail_Contents"></a>

 ** acceptanceRequired **   
Indicates whether VPC endpoint connection requests to the service must be accepted by the service owner.  
Type: Boolean  
Required: No

 ** AvailabilityZoneIdSet.N **   
The IDs of the Availability Zones in which the service is available.  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both  
Type: Array of strings  
Required: No

 ** AvailabilityZoneSet.N **   
The Availability Zones in which the service is available.  
Either `AvailabilityZone` or `AvailabilityZoneId` can be specified, but not both  
Type: Array of strings  
Required: No

 ** BaseEndpointDnsNameSet.N **   
The DNS names for the service.  
Type: Array of strings  
Required: No

 ** managesVpcEndpoints **   
Indicates whether the service manages its VPC endpoints. Management of the service VPC endpoints using the VPC endpoint API is restricted.  
Type: Boolean  
Required: No

 ** owner **   
The AWS account ID of the service owner.  
Type: String  
Required: No

 ** payerResponsibility **   
The payer responsibility.  
Type: String  
Valid Values: `ServiceOwner`   
Required: No

 ** privateDnsName **   
The private DNS name for the service.  
Type: String  
Required: No

 ** PrivateDnsNameSet.N **   
The private DNS names assigned to the VPC endpoint service.  
Type: Array of [PrivateDnsDetails](API_PrivateDnsDetails.md) objects  
Required: No

 ** privateDnsNameVerificationState **   
The verification state of the VPC endpoint service.  
Consumers of the endpoint service cannot use the private name when the state is not `verified`.  
Type: String  
Valid Values: `pendingVerification | verified | failed`   
Required: No

 ** serviceId **   
The ID of the endpoint service.  
Type: String  
Required: No

 ** serviceName **   
The name of the service.  
Type: String  
Required: No

 ** serviceRegion **   
The Region where the service is hosted.  
Type: String  
Required: No

 ** ServiceType.N **   
The type of service.  
Type: Array of [ServiceTypeDetail](API_ServiceTypeDetail.md) objects  
Required: No

 ** SupportedIpAddressTypeSet.N **   
The supported IP address types.  
Type: Array of strings  
Array Members: Minimum number of 0 items. Maximum number of 2 items.  
Valid Values: `ipv4 | ipv6`   
Required: No

 ** TagSet.N **   
The tags assigned to the service.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcEndpointPolicySupported **   
Indicates whether the service supports endpoint policies.  
Type: Boolean  
Required: No

## See Also
<a name="API_ServiceDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ServiceDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ServiceDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ServiceDetail) 

# ServiceLinkVirtualInterface
<a name="API_ServiceLinkVirtualInterface"></a>

Describes the service link virtual interfaces that establish connectivity between AWS Outpost and on-premises networks.

## Contents
<a name="API_ServiceLinkVirtualInterface_Contents"></a>

 ** configurationState **   
The current state of the service link virtual interface.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** localAddress **   
The IPv4 address assigned to the local gateway virtual interface on the Outpost side.  
Type: String  
Required: No

 ** outpostArn **   
The Outpost Amazon Resource Number (ARN) for the service link virtual interface.  
Type: String  
Required: No

 ** outpostId **   
The Outpost ID for the service link virtual interface.  
Type: String  
Required: No

 ** outpostLagId **   
The link aggregation group (LAG) ID for the service link virtual interface.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the service link virtual interface..  
Type: String  
Required: No

 ** peerAddress **   
The IPv4 peer address for the service link virtual interface.  
Type: String  
Required: No

 ** peerBgpAsn **   
The ASN for the Border Gateway Protocol (BGP) associated with the service link virtual interface.  
Type: Long  
Required: No

 ** serviceLinkVirtualInterfaceArn **   
The Amazon Resource Number (ARN) for the service link virtual interface.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** serviceLinkVirtualInterfaceId **   
The ID of the service link virtual interface.  
Type: String  
Required: No

 ** TagSet.N **   
The tags associated with the service link virtual interface.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vlan **   
The virtual local area network for the service link virtual interface.  
Type: Integer  
Required: No

## See Also
<a name="API_ServiceLinkVirtualInterface_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ServiceLinkVirtualInterface) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ServiceLinkVirtualInterface) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ServiceLinkVirtualInterface) 

# ServiceTypeDetail
<a name="API_ServiceTypeDetail"></a>

Describes the type of service for a VPC endpoint.

## Contents
<a name="API_ServiceTypeDetail_Contents"></a>

 ** serviceType **   
The type of service.  
Type: String  
Valid Values: `Interface | Gateway | GatewayLoadBalancer`   
Required: No

## See Also
<a name="API_ServiceTypeDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ServiceTypeDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ServiceTypeDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ServiceTypeDetail) 

# SlotDateTimeRangeRequest
<a name="API_SlotDateTimeRangeRequest"></a>

Describes the time period for a Scheduled Instance to start its first schedule. The time period must span less than one day.

## Contents
<a name="API_SlotDateTimeRangeRequest_Contents"></a>

 ** EarliestTime **   
The earliest date and time, in UTC, for the Scheduled Instance to start.  
Type: Timestamp  
Required: Yes

 ** LatestTime **   
The latest date and time, in UTC, for the Scheduled Instance to start. This value must be later than or equal to the earliest date and at most three months in the future.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_SlotDateTimeRangeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SlotDateTimeRangeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SlotDateTimeRangeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SlotDateTimeRangeRequest) 

# SlotStartTimeRangeRequest
<a name="API_SlotStartTimeRangeRequest"></a>

Describes the time period for a Scheduled Instance to start its first schedule.

## Contents
<a name="API_SlotStartTimeRangeRequest_Contents"></a>

 ** EarliestTime **   
The earliest date and time, in UTC, for the Scheduled Instance to start.  
Type: Timestamp  
Required: No

 ** LatestTime **   
The latest date and time, in UTC, for the Scheduled Instance to start.  
Type: Timestamp  
Required: No

## See Also
<a name="API_SlotStartTimeRangeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SlotStartTimeRangeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SlotStartTimeRangeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SlotStartTimeRangeRequest) 

# Snapshot
<a name="API_Snapshot"></a>

Describes a snapshot.

## Contents
<a name="API_Snapshot_Contents"></a>

 ** 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  
Required: No

 ** 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  
Required: No

 ** completionTime **   
The time stamp when the snapshot was completed.  
Type: Timestamp  
Required: No

 ** 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  
Required: No

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

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

 ** 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  
Required: No

 ** 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  
Required: No

 ** 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  
Required: No

 ** 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  
Required: No

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

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

 ** 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  
Required: No

 ** snapshotId **   
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.  
Type: String  
Required: No

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

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

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

 ** 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  
Required: No

 ** 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`   
Required: No

 ** TagSet.N **   
Any tags assigned to the snapshot.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** 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`   
Required: No

 ** 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  
Required: No

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

## See Also
<a name="API_Snapshot_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Snapshot) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Snapshot) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Snapshot) 

# SnapshotDetail
<a name="API_SnapshotDetail"></a>

Describes the snapshot created from the imported disk.

## Contents
<a name="API_SnapshotDetail_Contents"></a>

 ** description **   
A description for the snapshot.  
Type: String  
Required: No

 ** deviceName **   
The block device mapping for the snapshot.  
Type: String  
Required: No

 ** diskImageSize **   
The size of the disk in the snapshot, in GiB.  
Type: Double  
Required: No

 ** format **   
The format of the disk image from which the snapshot is created.  
Type: String  
Required: No

 ** progress **   
The percentage of progress for the task.  
Type: String  
Required: No

 ** snapshotId **   
The snapshot ID of the disk being imported.  
Type: String  
Required: No

 ** status **   
A brief status of the snapshot creation.  
Type: String  
Required: No

 ** statusMessage **   
A detailed status message for the snapshot creation.  
Type: String  
Required: No

 ** url **   
The URL used to access the disk image.  
Type: String  
Required: No

 ** userBucket **   
The Amazon S3 bucket for the disk image.  
Type: [UserBucketDetails](API_UserBucketDetails.md) object  
Required: No

## See Also
<a name="API_SnapshotDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SnapshotDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SnapshotDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SnapshotDetail) 

# SnapshotDiskContainer
<a name="API_SnapshotDiskContainer"></a>

The disk container object for the import snapshot request.

## Contents
<a name="API_SnapshotDiskContainer_Contents"></a>

 ** Description **   
The description of the disk image being imported.  
Type: String  
Required: No

 ** Format **   
The format of the disk image being imported.  
Valid values: `VHD` \$1 `VMDK` \$1 `RAW`   
Type: String  
Required: No

 ** Url **   
The URL to the Amazon S3-based disk image being imported. It can either be a https URL (https://..) or an Amazon S3 URL (s3://..).  
Type: String  
Required: No

 ** UserBucket **   
The Amazon S3 bucket for the disk image.  
Type: [UserBucket](API_UserBucket.md) object  
Required: No

## See Also
<a name="API_SnapshotDiskContainer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SnapshotDiskContainer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SnapshotDiskContainer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SnapshotDiskContainer) 

# SnapshotInfo
<a name="API_SnapshotInfo"></a>

Information about a snapshot.

## Contents
<a name="API_SnapshotInfo_Contents"></a>

 ** availabilityZone **   
The Availability Zone or Local Zone of the snapshots. For example, `us-west-1a` (Availability Zone) or `us-west-2-lax-1a` (Local Zone).  
Type: String  
Required: No

 ** description **   
Description specified by the CreateSnapshotRequest that has been applied to all snapshots.  
Type: String  
Required: No

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

 ** 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  
Required: No

 ** ownerId **   
Account id used when creating this snapshot.  
Type: String  
Required: No

 ** progress **   
Progress this snapshot has made towards completing.  
Type: String  
Required: No

 ** snapshotId **   
Snapshot id that can be used to describe this snapshot.  
Type: String  
Required: No

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

 ** startTime **   
Time this snapshot was started. This is the same for all snapshots initiated by the same request.  
Type: Timestamp  
Required: No

 ** state **   
Current state of the snapshot.  
Type: String  
Valid Values: `pending | completed | error | recoverable | recovering`   
Required: No

 ** TagSet.N **   
Tags associated with this snapshot.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** volumeId **   
Source volume from which this snapshot was created.  
Type: String  
Required: No

 ** volumeSize **   
Size of the volume from which this snapshot was created.  
Type: Integer  
Required: No

## See Also
<a name="API_SnapshotInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SnapshotInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SnapshotInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SnapshotInfo) 

# SnapshotRecycleBinInfo
<a name="API_SnapshotRecycleBinInfo"></a>

Information about a snapshot that is currently in the Recycle Bin.

## Contents
<a name="API_SnapshotRecycleBinInfo_Contents"></a>

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

 ** recycleBinEnterTime **   
The date and time when the snapshot entered the Recycle Bin.  
Type: Timestamp  
Required: No

 ** recycleBinExitTime **   
The date and time when the snapshot is to be permanently deleted from the Recycle Bin.  
Type: Timestamp  
Required: No

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

 ** volumeId **   
The ID of the volume from which the snapshot was created.  
Type: String  
Required: No

## See Also
<a name="API_SnapshotRecycleBinInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SnapshotRecycleBinInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SnapshotRecycleBinInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SnapshotRecycleBinInfo) 

# SnapshotTaskDetail
<a name="API_SnapshotTaskDetail"></a>

Details about the import snapshot task.

## Contents
<a name="API_SnapshotTaskDetail_Contents"></a>

 ** description **   
The description of the disk image being imported.  
Type: String  
Required: No

 ** diskImageSize **   
The size of the disk in the snapshot, in GiB.  
Type: Double  
Required: No

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

 ** format **   
The format of the disk image from which the snapshot is created.  
Type: String  
Required: No

 ** kmsKeyId **   
The identifier for the KMS key that was used to create the encrypted snapshot.  
Type: String  
Required: No

 ** progress **   
The percentage of completion for the import snapshot task.  
Type: String  
Required: No

 ** snapshotId **   
The snapshot ID of the disk being imported.  
Type: String  
Required: No

 ** status **   
A brief status for the import snapshot task.  
Type: String  
Required: No

 ** statusMessage **   
A detailed status message for the import snapshot task.  
Type: String  
Required: No

 ** url **   
The URL of the disk image from which the snapshot is created.  
Type: String  
Required: No

 ** userBucket **   
The Amazon S3 bucket for the disk image.  
Type: [UserBucketDetails](API_UserBucketDetails.md) object  
Required: No

## See Also
<a name="API_SnapshotTaskDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SnapshotTaskDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SnapshotTaskDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SnapshotTaskDetail) 

# SnapshotTierStatus
<a name="API_SnapshotTierStatus"></a>

Provides information about a snapshot's storage tier.

## Contents
<a name="API_SnapshotTierStatus_Contents"></a>

 ** archivalCompleteTime **   
The date and time when the last archive process was completed.  
Type: Timestamp  
Required: No

 ** lastTieringOperationStatus **   
The status of the last archive or restore process.  
Type: String  
Valid Values: `archival-in-progress | archival-completed | archival-failed | temporary-restore-in-progress | temporary-restore-completed | temporary-restore-failed | permanent-restore-in-progress | permanent-restore-completed | permanent-restore-failed`   
Required: No

 ** lastTieringOperationStatusDetail **   
A message describing the status of the last archive or restore process.  
Type: String  
Required: No

 ** lastTieringProgress **   
The progress of the last archive or restore process, as a percentage.  
Type: Integer  
Required: No

 ** lastTieringStartTime **   
The date and time when the last archive or restore process was started.  
Type: Timestamp  
Required: No

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

 ** 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  
Required: No

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

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

 ** 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`   
Required: No

 ** TagSet.N **   
The tags that are assigned to the snapshot.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** volumeId **   
The ID of the volume from which the snapshot was created.  
Type: String  
Required: No

## See Also
<a name="API_SnapshotTierStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SnapshotTierStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SnapshotTierStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SnapshotTierStatus) 

# SpotCapacityRebalance
<a name="API_SpotCapacityRebalance"></a>

The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide*.

## Contents
<a name="API_SpotCapacityRebalance_Contents"></a>

 ** ReplacementStrategy ** (request), ** replacementStrategy ** (response)  
The replacement strategy to use. Only available for fleets of type `maintain`.  
 `launch` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet. Spot Fleet does not terminate the instances that receive a rebalance notification. You can terminate the old instances, or you can leave them running. You are charged for all instances while they are running.   
 `launch-before-terminate` - Spot Fleet launches a new replacement Spot Instance when a rebalance notification is emitted for an existing Spot Instance in the fleet, and then, after a delay that you specify (in `TerminationDelay`), terminates the instances that received a rebalance notification.  
Type: String  
Valid Values: `launch | launch-before-terminate`   
Required: No

 ** TerminationDelay ** (request), ** terminationDelay ** (response)  
The amount of time (in seconds) that Amazon EC2 waits before terminating the old Spot Instance after launching a new replacement Spot Instance.  
Required when `ReplacementStrategy` is set to `launch-before-terminate`.  
Not valid when `ReplacementStrategy` is set to `launch`.  
Valid values: Minimum value of `120` seconds. Maximum value of `7200` seconds.  
Type: Integer  
Required: No

## See Also
<a name="API_SpotCapacityRebalance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotCapacityRebalance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotCapacityRebalance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotCapacityRebalance) 

# SpotDatafeedSubscription
<a name="API_SpotDatafeedSubscription"></a>

Describes the data feed for a Spot Instance.

## Contents
<a name="API_SpotDatafeedSubscription_Contents"></a>

 ** bucket **   
The name of the Amazon S3 bucket where the Spot Instance data feed is located.  
Type: String  
Required: No

 ** fault **   
The fault codes for the Spot Instance request, if any.  
Type: [SpotInstanceStateFault](API_SpotInstanceStateFault.md) object  
Required: No

 ** ownerId **   
The AWS account ID of the account.  
Type: String  
Required: No

 ** prefix **   
The prefix for the data feed files.  
Type: String  
Required: No

 ** state **   
The state of the Spot Instance data feed subscription.  
Type: String  
Valid Values: `Active | Inactive`   
Required: No

## See Also
<a name="API_SpotDatafeedSubscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotDatafeedSubscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotDatafeedSubscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotDatafeedSubscription) 

# SpotFleetLaunchSpecification
<a name="API_SpotFleetLaunchSpecification"></a>

Describes the launch specification for one or more Spot Instances. If you include On-Demand capacity in your fleet request or want to specify an EFA network device, you can't use `SpotFleetLaunchSpecification`; you must use [LaunchTemplateConfig](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html).

## Contents
<a name="API_SpotFleetLaunchSpecification_Contents"></a>

 ** AddressingType ** (request), ** addressingType ** (response)  
Deprecated.  
Type: String  
Required: No

 ** BlockDeviceMapping.N **   
One or more block devices that are mapped to the Spot Instances. You can't specify both a snapshot ID and an encryption value. This is because only blank volumes can be encrypted on creation. If a snapshot is the basis for a volume, it is not blank and its encryption status is used for the volume encryption status.  
Type: Array of [BlockDeviceMapping](API_BlockDeviceMapping.md) objects  
Required: No

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

 ** GroupSet.N **   
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 [GroupIdentifier](API_GroupIdentifier.md) objects  
Required: No

 ** IamInstanceProfile ** (request), ** iamInstanceProfile ** (response)  
The IAM instance profile.  
Type: [IamInstanceProfileSpecification](API_IamInstanceProfileSpecification.md) object  
Required: No

 ** ImageId ** (request), ** imageId ** (response)  
The ID of the AMI.  
Type: String  
Required: No

 ** InstanceRequirements ** (request), ** instanceRequirements ** (response)  
The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance types with those attributes.  
If you specify `InstanceRequirements`, you can't specify `InstanceType`.
Type: [InstanceRequirements](API_InstanceRequirements.md) object  
Required: No

 ** InstanceType ** (request), ** instanceType ** (response)  
The instance type.  
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

 ** KernelId ** (request), ** kernelId ** (response)  
The ID of the kernel.  
Type: String  
Required: No

 ** KeyName ** (request), ** keyName ** (response)  
The name of the key pair.  
Type: String  
Required: No

 ** Monitoring ** (request), ** monitoring ** (response)  
Enable or disable monitoring for the instances.  
Type: [SpotFleetMonitoring](API_SpotFleetMonitoring.md) object  
Required: No

 ** NetworkInterfaceSet.N **   
The network interfaces.  
 `SpotFleetLaunchSpecification` does not support Elastic Fabric Adapter (EFA). You must use [LaunchTemplateConfig](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_LaunchTemplateConfig.html) instead.
Type: Array of [InstanceNetworkInterfaceSpecification](API_InstanceNetworkInterfaceSpecification.md) objects  
Required: No

 ** Placement ** (request), ** placement ** (response)  
The placement information.  
Type: [SpotPlacement](API_SpotPlacement.md) object  
Required: No

 ** RamdiskId ** (request), ** ramdiskId ** (response)  
The ID of the RAM disk. 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, refer to the AWS Resource Center and search for the kernel ID.  
Type: String  
Required: No

 ** SpotPrice ** (request), ** spotPrice ** (response)  
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

 ** SubnetId ** (request), ** subnetId ** (response)  
The IDs of the subnets in which to launch the instances. To specify multiple subnets, separate them using commas; for example, "subnet-1234abcdeexample1, subnet-0987cdef6example2".  
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

 ** TagSpecificationSet.N **   
The tags to apply during creation.  
Type: Array of [SpotFleetTagSpecification](API_SpotFleetTagSpecification.md) objects  
Required: No

 ** UserData ** (request), ** userData ** (response)  
The base64-encoded user data that instances use when starting up. User data is limited to 16 KB.  
Type: String  
Required: No

 ** WeightedCapacity ** (request), ** weightedCapacity ** (response)  
The number of units provided by the specified instance type. These are the same units that you chose to set the target capacity in terms of instances, or a performance characteristic such as vCPUs, memory, or I/O.  
If the target capacity divided by this value is not a whole number, Amazon EC2 rounds the number of instances to the next whole number. If this value is not specified, the default is 1.  
When specifying weights, the price used in the `lowestPrice` and `priceCapacityOptimized` allocation strategies is per *unit* hour (where the instance price is divided by the specified weight). However, if all the specified weights are above the requested `TargetCapacity`, resulting in only 1 instance being launched, the price used is per *instance* hour.
Type: Double  
Required: No

## See Also
<a name="API_SpotFleetLaunchSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotFleetLaunchSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotFleetLaunchSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotFleetLaunchSpecification) 

# SpotFleetMonitoring
<a name="API_SpotFleetMonitoring"></a>

Describes whether monitoring is enabled.

## Contents
<a name="API_SpotFleetMonitoring_Contents"></a>

 ** Enabled ** (request), ** enabled ** (response)  
Enables monitoring for the instance.  
Default: `false`   
Type: Boolean  
Required: No

## See Also
<a name="API_SpotFleetMonitoring_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotFleetMonitoring) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotFleetMonitoring) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotFleetMonitoring) 

# SpotFleetRequestConfig
<a name="API_SpotFleetRequestConfig"></a>

Describes a Spot Fleet request.

## Contents
<a name="API_SpotFleetRequestConfig_Contents"></a>

 ** activityStatus **   
The progress of the Spot Fleet request. If there is an error, the status is `error`. After all requests are placed, the status is `pending_fulfillment`. If the size of the fleet is equal to or greater than its target capacity, the status is `fulfilled`. If the size of the fleet is decreased, the status is `pending_termination` while Spot Instances are terminating.  
Type: String  
Valid Values: `error | pending_fulfillment | pending_termination | fulfilled`   
Required: No

 ** createTime **   
The creation date and time of the request.  
Type: Timestamp  
Required: No

 ** spotFleetRequestConfig **   
The configuration of the Spot Fleet request.  
Type: [SpotFleetRequestConfigData](API_SpotFleetRequestConfigData.md) object  
Required: No

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

 ** spotFleetRequestState **   
The state of the Spot Fleet request.  
Type: String  
Valid Values: `submitted | active | cancelled | failed | cancelled_running | cancelled_terminating | modifying`   
Required: No

 ** TagSet.N **   
The tags for a Spot Fleet resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_SpotFleetRequestConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotFleetRequestConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotFleetRequestConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotFleetRequestConfig) 

# SpotFleetRequestConfigData
<a name="API_SpotFleetRequestConfigData"></a>

Describes the configuration of a Spot Fleet request.

## Contents
<a name="API_SpotFleetRequestConfigData_Contents"></a>

 ** IamFleetRole ** (request), ** iamFleetRole ** (response)  
The Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that grants the Spot Fleet the permission to request, launch, terminate, and tag instances on your behalf. For more information, see [Spot Fleet prerequisites](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-requests.html#spot-fleet-prerequisites) in the *Amazon EC2 User Guide*. Spot Fleet can terminate Spot Instances on your behalf when you cancel its Spot Fleet request using [CancelSpotFleetRequests](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CancelSpotFleetRequests) or when the Spot Fleet request expires, if you set `TerminateInstancesWithExpiration`.  
Type: String  
Required: Yes

 ** TargetCapacity ** (request), ** targetCapacity ** (response)  
The number of units to request for the Spot Fleet. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain`, you can specify a target capacity of 0 and add capacity later.  
Type: Integer  
Required: Yes

 ** AllocationStrategy ** (request), ** allocationStrategy ** (response)  
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the Spot Fleet launch configuration. For more information, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide*.    
priceCapacityOptimized (recommended)  
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. Spot Fleet then requests Spot Instances from the lowest priced of these pools.  
capacityOptimized  
Spot Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use `capacityOptimizedPrioritized`. Set a priority for each instance type by using the `Priority` parameter for `LaunchTemplateOverrides`. You can assign the same priority to different `LaunchTemplateOverrides`. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. `capacityOptimizedPrioritized` is supported only if your Spot Fleet uses a launch template. Note that if the `OnDemandAllocationStrategy` is set to `prioritized`, the same priority is applied when fulfilling On-Demand capacity.  
diversified  
Spot Fleet requests instances from all of the Spot Instance pools that you specify.  
lowestPrice (not recommended)  
We don't recommend the `lowestPrice` allocation strategy because it has the highest risk of interruption for your Spot Instances.
Spot Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, Spot Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: `lowestPrice`   
Type: String  
Valid Values: `lowestPrice | diversified | capacityOptimized | capacityOptimizedPrioritized | priceCapacityOptimized`   
Required: No

 ** ClientToken ** (request), ** clientToken ** (response)  
A unique, case-sensitive identifier that you provide to ensure the idempotency of your listings. This helps to avoid duplicate listings. For more information, see [Ensuring Idempotency](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Run_Instance_Idempotency.html).  
Type: String  
Required: No

 ** Context ** (request), ** context ** (response)  
Reserved.  
Type: String  
Required: No

 ** ExcessCapacityTerminationPolicy ** (request), ** excessCapacityTerminationPolicy ** (response)  
Indicates whether running instances should be terminated if you decrease the target capacity of the Spot Fleet request below the current size of the Spot Fleet.  
Supported only for fleets of type `maintain`.  
Type: String  
Valid Values: `noTermination | default`   
Required: No

 ** FulfilledCapacity ** (request), ** fulfilledCapacity ** (response)  
The number of units fulfilled by this request compared to the set target capacity. You cannot set this value.  
Type: Double  
Required: No

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

 ** InstancePoolsToUseCount ** (request), ** instancePoolsToUseCount ** (response)  
The number of Spot pools across which to allocate your target Spot capacity. Valid only when Spot **AllocationStrategy** is set to `lowest-price`. Spot Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.  
Note that Spot Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, Spot Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.  
Type: Integer  
Required: No

 ** LaunchSpecifications.N **   
The launch specifications for the Spot Fleet request. If you specify `LaunchSpecifications`, you can't specify `LaunchTemplateConfigs`. If you include On-Demand capacity in your request, you must use `LaunchTemplateConfigs`.  
If an AMI specified in a launch specification is deregistered or disabled, no new instances can be launched from the AMI. For fleets of type `maintain`, the target capacity will not be maintained.
Type: Array of [SpotFleetLaunchSpecification](API_SpotFleetLaunchSpecification.md) objects  
Required: No

 ** LaunchTemplateConfigs.N **   
The launch template and overrides. If you specify `LaunchTemplateConfigs`, you can't specify `LaunchSpecifications`. If you include On-Demand capacity in your request, you must use `LaunchTemplateConfigs`.  
Type: Array of [LaunchTemplateConfig](API_LaunchTemplateConfig.md) objects  
Required: No

 ** LoadBalancersConfig ** (request), ** loadBalancersConfig ** (response)  
One or more Classic Load Balancers and target groups to attach to the Spot Fleet request. Spot Fleet registers the running Spot Instances with the specified Classic Load Balancers and target groups.  
With Network Load Balancers, Spot Fleet cannot register instances that have the following instance types: C1, CC1, CC2, CG1, CG2, CR1, CS1, G1, G2, HI1, HS1, M1, M2, M3, and T1.  
Type: [LoadBalancersConfig](API_LoadBalancersConfig.md) object  
Required: No

 ** OnDemandAllocationStrategy ** (request), ** onDemandAllocationStrategy ** (response)  
The order of the launch template overrides to use in fulfilling On-Demand capacity. If you specify `lowestPrice`, Spot Fleet uses price to determine the order, launching the lowest price first. If you specify `prioritized`, Spot Fleet uses the priority that you assign to each Spot Fleet launch template override, launching the highest priority first. If you do not specify a value, Spot Fleet defaults to `lowestPrice`.  
Type: String  
Valid Values: `lowestPrice | prioritized`   
Required: No

 ** OnDemandFulfilledCapacity ** (request), ** onDemandFulfilledCapacity ** (response)  
The number of On-Demand units fulfilled by this request compared to the set target On-Demand capacity.  
Type: Double  
Required: No

 ** OnDemandMaxTotalPrice ** (request), ** onDemandMaxTotalPrice ** (response)  
The maximum amount per hour for On-Demand Instances that you're willing to pay. You can use the `onDemandMaxTotalPrice` parameter, the `spotMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.  
If your fleet includes T instances that are configured as `unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `onDemandMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `onDemandMaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 ** OnDemandTargetCapacity ** (request), ** onDemandTargetCapacity ** (response)  
The number of On-Demand units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain`, you can specify a target capacity of 0 and add capacity later.  
Type: Integer  
Required: No

 ** ReplaceUnhealthyInstances ** (request), ** replaceUnhealthyInstances ** (response)  
Indicates whether Spot Fleet should replace unhealthy instances.  
Type: Boolean  
Required: No

 ** SpotMaintenanceStrategies ** (request), ** spotMaintenanceStrategies ** (response)  
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.  
Type: [SpotMaintenanceStrategies](API_SpotMaintenanceStrategies.md) object  
Required: No

 ** SpotMaxTotalPrice ** (request), ** spotMaxTotalPrice ** (response)  
The maximum amount per hour for Spot Instances that you're willing to pay. You can use the `spotMaxTotalPrice` parameter, the `onDemandMaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, Spot Fleet will launch instances until it reaches the maximum amount you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity.  
If your fleet includes T instances that are configured as `unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `spotMaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `spotMaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 ** SpotPrice ** (request), ** spotPrice ** (response)  
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 Fleet request on creation. The value for `ResourceType` must be `spot-fleet-request`, otherwise the Spot Fleet request fails. To tag instances at launch, specify the tags in the [launch template](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html#create-launch-template) (valid only if you use `LaunchTemplateConfigs`) or in the ` [SpotFleetTagSpecification](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetTagSpecification.html) ` (valid only if you use `LaunchSpecifications`). For information about tagging after launch, see [Tag your resources](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html#tag-resources).  
Type: Array of [TagSpecification](API_TagSpecification.md) objects  
Required: No

 ** TargetCapacityUnitType ** (request), ** targetCapacityUnitType ** (response)  
The unit for the target capacity. You can specify this parameter only when using attribute-based instance type selection.  
Default: `units` (the number of instances)  
Type: String  
Valid Values: `vcpu | memory-mib | units`   
Required: No

 ** TerminateInstancesWithExpiration ** (request), ** terminateInstancesWithExpiration ** (response)  
Indicates whether running Spot Instances are terminated when the Spot Fleet request expires.  
Type: Boolean  
Required: No

 ** Type ** (request), ** type ** (response)  
The type of request. Indicates whether the Spot Fleet only requests the target capacity or also attempts to maintain it. When this value is `request`, the Spot Fleet only places the required requests. It does not attempt to replenish Spot Instances if capacity is diminished, nor does it submit requests in alternative Spot pools if capacity is not available. When this value is `maintain`, the Spot Fleet maintains the target capacity. The Spot Fleet places the required requests to meet capacity and automatically replenishes any interrupted instances. Default: `maintain`. `instant` is listed but is not used by Spot Fleet.  
Type: String  
Valid Values: `request | maintain | instant`   
Required: No

 ** ValidFrom ** (request), ** validFrom ** (response)  
The start date and time of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). By default, Amazon EC2 starts fulfilling the request immediately.  
Type: Timestamp  
Required: No

 ** ValidUntil ** (request), ** validUntil ** (response)  
The end date and time of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). After the end date and time, no new Spot Instance requests are placed or able to fulfill the request. If no value is specified, the Spot Fleet request remains until you cancel it.  
Type: Timestamp  
Required: No

## See Also
<a name="API_SpotFleetRequestConfigData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotFleetRequestConfigData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotFleetRequestConfigData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotFleetRequestConfigData) 

# SpotFleetTagSpecification
<a name="API_SpotFleetTagSpecification"></a>

The tags for a Spot Fleet resource.

## Contents
<a name="API_SpotFleetTagSpecification_Contents"></a>

 ** ResourceType ** (request), ** resourceType ** (response)  
The type of resource. Currently, the only resource type that is supported is `instance`. To tag the Spot Fleet request on creation, use the `TagSpecifications` parameter in ` [SpotFleetRequestConfigData](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotFleetRequestConfigData.html) `.  
Type: String  
Valid Values: `capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | declarative-policies-report | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | image-usage-report | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-virtual-interface | local-gateway-virtual-interface-group | local-gateway-route-table-vpc-association | local-gateway-route-table-virtual-interface-group-association | natgateway | network-acl | network-interface | network-insights-analysis | network-insights-path | network-insights-access-scope | network-insights-access-scope-analysis | outpost-lag | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | service-link-virtual-interface | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-metering-policy | transit-gateway-route-table | transit-gateway-route-table-announcement | volume | vpc | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log | capacity-reservation-fleet | traffic-mirror-filter-rule | vpc-endpoint-connection-device-type | verified-access-instance | verified-access-group | verified-access-endpoint | verified-access-policy | verified-access-trust-provider | vpn-connection-device-type | vpc-block-public-access-exclusion | vpc-encryption-control | route-server | route-server-endpoint | route-server-peer | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | verified-access-endpoint-target | ipam-external-resource-verification-token | capacity-block | mac-modification-task | ipam-prefix-list-resolver | ipam-policy | ipam-prefix-list-resolver-target | secondary-interface | secondary-network | secondary-subnet | capacity-manager-data-export | vpn-concentrator`   
Required: No

 ** Tag.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_SpotFleetTagSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotFleetTagSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotFleetTagSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotFleetTagSpecification) 

# SpotInstanceRequest
<a name="API_SpotInstanceRequest"></a>

Describes a Spot Instance request.

## Contents
<a name="API_SpotInstanceRequest_Contents"></a>

 ** actualBlockHourlyPrice **   
Deprecated.  
Type: String  
Required: No

 ** availabilityZoneGroup **   
The Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.  
Type: String  
Required: No

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

 ** createTime **   
The date and time when the Spot Instance request was created, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).  
Type: Timestamp  
Required: No

 ** fault **   
The fault codes for the Spot Instance request, if any.  
Type: [SpotInstanceStateFault](API_SpotInstanceStateFault.md) object  
Required: No

 ** instanceId **   
The instance ID, if an instance has been launched to fulfill the Spot Instance request.  
Type: String  
Required: No

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

 ** launchedAvailabilityZone **   
The Availability Zone in which the request is launched.  
Either `launchedAvailabilityZone` or `launchedAvailabilityZoneId` can be specified, but not both  
Type: String  
Required: No

 ** launchedAvailabilityZoneId **   
The ID of the Availability Zone in which the request is launched.  
Either `launchedAvailabilityZone` or `launchedAvailabilityZoneId` can be specified, but not both  
Type: String  
Required: No

 ** launchGroup **   
The instance launch group. Launch groups are Spot Instances that launch together and terminate together.  
Type: String  
Required: No

 ** launchSpecification **   
Additional information for launching instances.  
Type: [LaunchSpecification](API_LaunchSpecification.md) object  
Required: No

 ** productDescription **   
The product description associated with the Spot Instance.  
Type: String  
Valid Values: `Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)`   
Required: No

 ** spotInstanceRequestId **   
The ID of the Spot Instance request.  
Type: String  
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

 ** state **   
The state of the Spot Instance request. Spot request status information helps track your 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*.  
Type: String  
Valid Values: `open | active | closed | cancelled | failed`   
Required: No

 ** status **   
The status code and status message describing the Spot Instance request.  
Type: [SpotInstanceStatus](API_SpotInstanceStatus.md) object  
Required: No

 ** TagSet.N **   
Any tags assigned to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

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

 ** validFrom **   
The start date of the request, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). The request becomes active at this 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

## See Also
<a name="API_SpotInstanceRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotInstanceRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotInstanceRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotInstanceRequest) 

# SpotInstanceStateFault
<a name="API_SpotInstanceStateFault"></a>

Describes a Spot Instance state change.

## Contents
<a name="API_SpotInstanceStateFault_Contents"></a>

 ** code **   
The reason code for the Spot Instance state change.  
Type: String  
Required: No

 ** message **   
The message for the Spot Instance state change.  
Type: String  
Required: No

## See Also
<a name="API_SpotInstanceStateFault_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotInstanceStateFault) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotInstanceStateFault) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotInstanceStateFault) 

# SpotInstanceStatus
<a name="API_SpotInstanceStatus"></a>

Describes the status of a Spot Instance request.

## Contents
<a name="API_SpotInstanceStatus_Contents"></a>

 ** code **   
The status code. For a list of status codes, see [Spot request status codes](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-request-status.html#spot-instance-request-status-understand) in the *Amazon EC2 User Guide*.  
Type: String  
Required: No

 ** message **   
The description for the status code.  
Type: String  
Required: No

 ** updateTime **   
The date and time of the most recent status update, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).  
Type: Timestamp  
Required: No

## See Also
<a name="API_SpotInstanceStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotInstanceStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotInstanceStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotInstanceStatus) 

# SpotMaintenanceStrategies
<a name="API_SpotMaintenanceStrategies"></a>

The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.

## Contents
<a name="API_SpotMaintenanceStrategies_Contents"></a>

 ** CapacityRebalance ** (request), ** capacityRebalance ** (response)  
The Spot Instance replacement strategy to use when Amazon EC2 emits a signal that your Spot Instance is at an elevated risk of being interrupted. For more information, see [Capacity rebalancing](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/spot-fleet-capacity-rebalance.html) in the *Amazon EC2 User Guide*.  
Type: [SpotCapacityRebalance](API_SpotCapacityRebalance.md) object  
Required: No

## See Also
<a name="API_SpotMaintenanceStrategies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotMaintenanceStrategies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotMaintenanceStrategies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotMaintenanceStrategies) 

# SpotMarketOptions
<a name="API_SpotMarketOptions"></a>

The options for Spot Instances.

## Contents
<a name="API_SpotMarketOptions_Contents"></a>

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

 ** InstanceInterruptionBehavior **   
The behavior when a Spot Instance is interrupted.  
If `Configured` (for [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html)) is set to `true`, the `InstanceInterruptionBehavior` parameter is automatically set to `hibernate`. If you set it to `stop` or `terminate`, you'll get an error.  
If `Configured` (for [https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_HibernationOptionsRequest.html)) is set to `false` or `null`, the `InstanceInterruptionBehavior` parameter is automatically set to `terminate`. You can also set it to `stop` or `hibernate`.  
For more information, see [Interruption behavior](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/interruption-behavior.html) in the *Amazon EC2 User Guide*.  
Type: String  
Valid Values: `hibernate | stop | terminate`   
Required: No

 ** MaxPrice **   
The maximum hourly price that you're 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 Spot Instances will be interrupted more frequently than if you do not specify this parameter.  
If you specify a maximum price, it must be more than USD \$10.001. Specifying a value below USD \$10.001 will result in an `InvalidParameterValue` error message.
Type: String  
Required: No

 ** SpotInstanceType **   
The Spot Instance request type. For [RunInstances](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_RunInstances), persistent Spot Instance requests are only supported when the instance interruption behavior is either `hibernate` or `stop`.  
Type: String  
Valid Values: `one-time | persistent`   
Required: No

 ** ValidUntil **   
The end date of the request, in UTC format (*YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z). Supported only for persistent requests.  
+ 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, `ValidUntil` is not supported. The request remains active until all instances launch or you cancel the request.
Type: Timestamp  
Required: No

## See Also
<a name="API_SpotMarketOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotMarketOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotMarketOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotMarketOptions) 

# SpotOptions
<a name="API_SpotOptions"></a>

Describes the configuration of Spot Instances in an EC2 Fleet.

## Contents
<a name="API_SpotOptions_Contents"></a>

 ** allocationStrategy **   
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide*.    
price-capacity-optimized (recommended)  
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.  
capacity-optimized  
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use `capacity-optimized-prioritized`. Set a priority for each instance type by using the `Priority` parameter for `LaunchTemplateOverrides`. You can assign the same priority to different `LaunchTemplateOverrides`. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. `capacity-optimized-prioritized` is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand `AllocationStrategy` is set to `prioritized`, the same priority is applied when fulfilling On-Demand capacity.  
diversified  
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.  
lowest-price (not recommended)  
We don't recommend the `lowest-price` allocation strategy because it has the highest risk of interruption for your Spot Instances.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: `lowest-price`   
Type: String  
Valid Values: `lowest-price | diversified | capacity-optimized | capacity-optimized-prioritized | price-capacity-optimized`   
Required: No

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

 ** instancePoolsToUseCount **   
The number of Spot pools across which to allocate your target Spot capacity. Supported only when `AllocationStrategy` is set to `lowest-price`. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.  
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.  
Type: Integer  
Required: No

 ** maintenanceStrategies **   
The strategies for managing your workloads on your Spot Instances that will be interrupted. Currently only the capacity rebalance strategy is available.  
Type: [FleetSpotMaintenanceStrategies](API_FleetSpotMaintenanceStrategies.md) object  
Required: No

 ** maxTotalPrice **   
The maximum amount per hour for Spot Instances that you're willing to pay. 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 Spot Instances will be interrupted more frequently than if you do not specify this parameter.
If your fleet includes T instances that are configured as `unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `maxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `maxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 ** minTargetCapacity **   
The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.  
Constraints: Maximum value of `1000`. Supported only for fleets of type `instant`.  
At least one of the following must be specified: `SingleAvailabilityZone` \$1 `SingleInstanceType`   
Type: Integer  
Required: No

 ** singleAvailabilityZone **   
Indicates that the fleet launches all Spot Instances into a single Availability Zone.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

 ** singleInstanceType **   
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

## See Also
<a name="API_SpotOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotOptions) 

# SpotOptionsRequest
<a name="API_SpotOptionsRequest"></a>

Describes the configuration of Spot Instances in an EC2 Fleet request.

## Contents
<a name="API_SpotOptionsRequest_Contents"></a>

 ** AllocationStrategy **   
The strategy that determines how to allocate the target Spot Instance capacity across the Spot Instance pools specified by the EC2 Fleet launch configuration. For more information, see [Allocation strategies for Spot Instances](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-fleet-allocation-strategy.html) in the *Amazon EC2 User Guide*.    
price-capacity-optimized (recommended)  
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. EC2 Fleet then requests Spot Instances from the lowest priced of these pools.  
capacity-optimized  
EC2 Fleet identifies the pools with the highest capacity availability for the number of instances that are launching. This means that we will request Spot Instances from the pools that we believe have the lowest chance of interruption in the near term. To give certain instance types a higher chance of launching first, use `capacity-optimized-prioritized`. Set a priority for each instance type by using the `Priority` parameter for `LaunchTemplateOverrides`. You can assign the same priority to different `LaunchTemplateOverrides`. EC2 implements the priorities on a best-effort basis, but optimizes for capacity first. `capacity-optimized-prioritized` is supported only if your EC2 Fleet uses a launch template. Note that if the On-Demand `AllocationStrategy` is set to `prioritized`, the same priority is applied when fulfilling On-Demand capacity.  
diversified  
EC2 Fleet requests instances from all of the Spot Instance pools that you specify.  
lowest-price (not recommended)  
We don't recommend the `lowest-price` allocation strategy because it has the highest risk of interruption for your Spot Instances.
EC2 Fleet requests instances from the lowest priced Spot Instance pool that has available capacity. If the lowest priced pool doesn't have available capacity, the Spot Instances come from the next lowest priced pool that has available capacity. If a pool runs out of capacity before fulfilling your desired capacity, EC2 Fleet will continue to fulfill your request by drawing from the next lowest priced pool. To ensure that your desired capacity is met, you might receive Spot Instances from several pools. Because this strategy only considers instance price and not capacity availability, it might lead to high interruption rates.
Default: `lowest-price`   
Type: String  
Valid Values: `lowest-price | diversified | capacity-optimized | capacity-optimized-prioritized | price-capacity-optimized`   
Required: No

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

 ** InstancePoolsToUseCount **   
The number of Spot pools across which to allocate your target Spot capacity. Supported only when Spot `AllocationStrategy` is set to `lowest-price`. EC2 Fleet selects the cheapest Spot pools and evenly allocates your target Spot capacity across the number of Spot pools that you specify.  
Note that EC2 Fleet attempts to draw Spot Instances from the number of pools that you specify on a best effort basis. If a pool runs out of Spot capacity before fulfilling your target capacity, EC2 Fleet will continue to fulfill your request by drawing from the next cheapest pool. To ensure that your target capacity is met, you might receive Spot Instances from more than the number of pools that you specified. Similarly, if most of the pools have no Spot capacity, you might receive your full target capacity from fewer than the number of pools that you specified.  
Type: Integer  
Required: No

 ** MaintenanceStrategies **   
The strategies for managing your Spot Instances that are at an elevated risk of being interrupted.  
Type: [FleetSpotMaintenanceStrategiesRequest](API_FleetSpotMaintenanceStrategiesRequest.md) object  
Required: No

 ** MaxTotalPrice **   
The maximum amount per hour for Spot Instances that you're willing to pay. 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 Spot Instances will be interrupted more frequently than if you do not specify this parameter.
If your fleet includes T instances that are configured as `unlimited`, and if their average CPU usage exceeds the baseline utilization, you will incur a charge for surplus credits. The `MaxTotalPrice` does not account for surplus credits, and, if you use surplus credits, your final cost might be higher than what you specified for `MaxTotalPrice`. For more information, see [Surplus credits can incur charges](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/burstable-performance-instances-unlimited-mode-concepts.html#unlimited-mode-surplus-credits) in the *Amazon EC2 User Guide*.
Type: String  
Required: No

 ** MinTargetCapacity **   
The minimum target capacity for Spot Instances in the fleet. If this minimum capacity isn't reached, no instances are launched.  
Constraints: Maximum value of `1000`. Supported only for fleets of type `instant`.  
At least one of the following must be specified: `SingleAvailabilityZone` \$1 `SingleInstanceType`   
Type: Integer  
Required: No

 ** SingleAvailabilityZone **   
Indicates that the fleet launches all Spot Instances into a single Availability Zone.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

 ** SingleInstanceType **   
Indicates that the fleet uses a single instance type to launch all Spot Instances in the fleet.  
Supported only for fleets of type `instant`.  
Type: Boolean  
Required: No

## See Also
<a name="API_SpotOptionsRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotOptionsRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotOptionsRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotOptionsRequest) 

# SpotPlacement
<a name="API_SpotPlacement"></a>

Describes Spot Instance placement.

## Contents
<a name="API_SpotPlacement_Contents"></a>

 ** AvailabilityZone ** (request), ** availabilityZone ** (response)  
The Availability Zone. For example, `us-east-2a`.  
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "`us-east-2a`, `us-east-2b`".  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** AvailabilityZoneId ** (request), ** availabilityZoneId ** (response)  
The ID of the Availability Zone. For example, `use2-az1`.  
[Spot Fleet only] To specify multiple Availability Zones, separate them using commas; for example, "`use2-az1`, `use2-bz1`".  
Either `AvailabilityZone` or `AvailabilityZoneId` must be specified in the request, but not both.  
Type: String  
Required: No

 ** GroupName ** (request), ** groupName ** (response)  
The name of the placement group.  
Type: String  
Required: No

 ** Tenancy ** (request), ** tenancy ** (response)  
The tenancy of the instance (if the instance is running in a VPC). An instance with a tenancy of `dedicated` runs on single-tenant hardware. The `host` tenancy is not supported for Spot Instances.  
Type: String  
Valid Values: `default | dedicated | host`   
Required: No

## See Also
<a name="API_SpotPlacement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotPlacement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotPlacement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotPlacement) 

# SpotPlacementScore
<a name="API_SpotPlacementScore"></a>

The Spot placement score for this Region or Availability Zone. The score is calculated based on the assumption that the `capacity-optimized` allocation strategy is used and that all of the Availability Zones in the Region can be used.

## Contents
<a name="API_SpotPlacementScore_Contents"></a>

 ** availabilityZoneId **   
The Availability Zone.  
Type: String  
Required: No

 ** region **   
The Region.  
Type: String  
Required: No

 ** score **   
The placement score, on a scale from `1` to `10`. A score of `10` indicates that your Spot request is highly likely to succeed in this Region or Availability Zone. A score of `1` indicates that your Spot request is not likely to succeed.   
Type: Integer  
Required: No

## See Also
<a name="API_SpotPlacementScore_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotPlacementScore) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotPlacementScore) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotPlacementScore) 

# SpotPrice
<a name="API_SpotPrice"></a>

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.

**Important**  
If you specify a maximum price, your instances will be interrupted more frequently than if you do not specify this parameter.

## Contents
<a name="API_SpotPrice_Contents"></a>

 ** availabilityZone **   
The Availability Zone.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** instanceType **   
The instance type.  
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

 ** productDescription **   
A general description of the AMI.  
Type: String  
Valid Values: `Linux/UNIX | Linux/UNIX (Amazon VPC) | Windows | Windows (Amazon VPC)`   
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

 ** timestamp **   
The date and time the request was created, in UTC format (for example, *YYYY*-*MM*-*DD*T*HH*:*MM*:*SS*Z).  
Type: Timestamp  
Required: No

## See Also
<a name="API_SpotPrice_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SpotPrice) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SpotPrice) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SpotPrice) 

# StaleIpPermission
<a name="API_StaleIpPermission"></a>

Describes a stale rule in a security group.

## Contents
<a name="API_StaleIpPermission_Contents"></a>

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

 ** Groups.N **   
The security group pairs. Returns the ID of the referenced security group and VPC, and the ID and status of the VPC peering connection.  
Type: Array of [UserIdGroupPair](API_UserIdGroupPair.md) objects  
Required: No

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

 ** IpRanges.N **   
The IP ranges. Not applicable for stale security group rules.  
Type: Array of strings  
Required: No

 ** PrefixListIds.N **   
The prefix list IDs. Not applicable for stale security group rules.  
Type: Array of strings  
Required: No

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

## See Also
<a name="API_StaleIpPermission_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StaleIpPermission) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StaleIpPermission) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StaleIpPermission) 

# StaleSecurityGroup
<a name="API_StaleSecurityGroup"></a>

Describes a stale security group (a security group that contains stale rules).

## Contents
<a name="API_StaleSecurityGroup_Contents"></a>

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

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

 ** groupName **   
The name of the security group.  
Type: String  
Required: No

 ** StaleIpPermissions.N **   
Information about the stale inbound rules in the security group.  
Type: Array of [StaleIpPermission](API_StaleIpPermission.md) objects  
Required: No

 ** StaleIpPermissionsEgress.N **   
Information about the stale outbound rules in the security group.  
Type: Array of [StaleIpPermission](API_StaleIpPermission.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC for the security group.  
Type: String  
Required: No

## See Also
<a name="API_StaleSecurityGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StaleSecurityGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StaleSecurityGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StaleSecurityGroup) 

# StateReason
<a name="API_StateReason"></a>

Describes a state change.

## Contents
<a name="API_StateReason_Contents"></a>

 ** code **   
The reason code for the state change.  
Type: String  
Required: No

 ** message **   
The message for the state change.  
+  `Server.InsufficientInstanceCapacity`: There was insufficient capacity available to satisfy the launch request.
+  `Server.InternalError`: An internal error caused the instance to terminate during launch.
+  `Server.ScheduledStop`: The instance was stopped due to a scheduled retirement.
+  `Server.SpotInstanceShutdown`: The instance was stopped because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
+  `Server.SpotInstanceTermination`: The instance was terminated because the number of Spot requests with a maximum price equal to or higher than the Spot price exceeded available capacity or because of an increase in the Spot price.
+  `Client.InstanceInitiatedShutdown`: The instance was shut down from the operating system of the instance.
+  `Client.InstanceTerminated`: The instance was terminated or rebooted during AMI creation.
+  `Client.InternalError`: A client error caused the instance to terminate during launch.
+  `Client.InvalidSnapshot.NotFound`: The specified snapshot was not found.
+  `Client.UserInitiatedHibernate`: Hibernation was initiated on the instance.
+  `Client.UserInitiatedShutdown`: The instance was shut down using the Amazon EC2 API.
+  `Client.VolumeLimitExceeded`: The limit on the number of EBS volumes or total storage was exceeded. Decrease usage or request an increase in your account limits.
Type: String  
Required: No

## See Also
<a name="API_StateReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StateReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StateReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StateReason) 

# Storage
<a name="API_Storage"></a>

Describes the storage location for an instance store-backed AMI.

## Contents
<a name="API_Storage_Contents"></a>

 ** S3 ** (request), ** S3 ** (response)  
An Amazon S3 storage location.  
Type: [S3Storage](API_S3Storage.md) object  
Required: No

## See Also
<a name="API_Storage_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Storage) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Storage) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Storage) 

# StorageLocation
<a name="API_StorageLocation"></a>

Describes a storage location in Amazon S3.

## Contents
<a name="API_StorageLocation_Contents"></a>

 ** Bucket **   
The name of the S3 bucket.  
Type: String  
Required: No

 ** Key **   
The key.  
Type: String  
Required: No

## See Also
<a name="API_StorageLocation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StorageLocation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StorageLocation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StorageLocation) 

# StoreImageTaskResult
<a name="API_StoreImageTaskResult"></a>

The information about the AMI store task, including the progress of the task.

## Contents
<a name="API_StoreImageTaskResult_Contents"></a>

 ** amiId **   
The ID of the AMI that is being stored.  
Type: String  
Required: No

 ** bucket **   
The name of the Amazon S3 bucket that contains the stored AMI object.  
Type: String  
Required: No

 ** progressPercentage **   
The progress of the task as a percentage.  
Type: Integer  
Required: No

 ** s3objectKey **   
The name of the stored AMI object in the bucket.  
Type: String  
Required: No

 ** storeTaskFailureReason **   
If the tasks fails, the reason for the failure is returned. If the task succeeds, `null` is returned.  
Type: String  
Required: No

 ** storeTaskState **   
The state of the store task (`InProgress`, `Completed`, or `Failed`).  
Type: String  
Required: No

 ** taskStartTime **   
The time the task started.  
Type: Timestamp  
Required: No

## See Also
<a name="API_StoreImageTaskResult_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/StoreImageTaskResult) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/StoreImageTaskResult) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/StoreImageTaskResult) 

# Subnet
<a name="API_Subnet"></a>

Describes a subnet.

## Contents
<a name="API_Subnet_Contents"></a>

 ** assignIpv6AddressOnCreation **   
Indicates whether a network interface created in this subnet (including a network interface created by [RunInstances](API_RunInstances.md)) receives an IPv6 address.  
Type: Boolean  
Required: No

 ** availabilityZone **   
The Availability Zone of the subnet.  
Type: String  
Required: No

 ** availabilityZoneId **   
The AZ ID of the subnet.  
Type: String  
Required: No

 ** availableIpAddressCount **   
The number of unused private IPv4 addresses in the subnet. The IPv4 addresses for any stopped instances are considered unavailable.  
Type: Integer  
Required: No

 ** blockPublicAccessStates **   
The state of VPC Block Public Access (BPA).  
Type: [BlockPublicAccessStates](API_BlockPublicAccessStates.md) object  
Required: No

 ** cidrBlock **   
The IPv4 CIDR block assigned to the subnet.  
Type: String  
Required: No

 ** customerOwnedIpv4Pool **   
The customer-owned IPv4 address pool associated with the subnet.  
Type: String  
Required: No

 ** defaultForAz **   
Indicates whether this is the default subnet for the Availability Zone.  
Type: Boolean  
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.  
Type: Boolean  
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).   
Type: Integer  
Required: No

 ** Ipv6CidrBlockAssociationSet.N **   
Information about the IPv6 CIDR blocks associated with the subnet.  
Type: Array of [SubnetIpv6CidrBlockAssociation](API_SubnetIpv6CidrBlockAssociation.md) objects  
Required: No

 ** ipv6Native **   
Indicates whether this is an IPv6 only subnet.  
Type: Boolean  
Required: No

 ** mapCustomerOwnedIpOnLaunch **   
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.  
Type: Boolean  
Required: No

 ** mapPublicIpOnLaunch **   
Indicates whether instances launched in this subnet receive 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: Boolean  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the subnet.  
Type: String  
Required: No

 ** privateDnsNameOptionsOnLaunch **   
The type of hostnames to assign to instances in the subnet at launch. An instance hostname is based on the IPv4 address or ID of the instance.  
Type: [PrivateDnsNameOptionsOnLaunch](API_PrivateDnsNameOptionsOnLaunch.md) object  
Required: No

 ** state **   
The current state of the subnet.  
+  `failed`: The underlying infrastructure to support the subnet failed to provision as expected.
+  `failed-insufficient-capacity`: The underlying infrastructure to support the subnet failed to provision due to a shortage of EC2 instance capacity.
Type: String  
Valid Values: `pending | available | unavailable | failed | failed-insufficient-capacity`   
Required: No

 ** subnetArn **   
The Amazon Resource Name (ARN) of the subnet.  
Type: String  
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the subnet.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** type **   
Indicates if this is a subnet used with Amazon Elastic VMware Service (EVS). Possible values are `Elastic VMware Service` or no value. For more information about Amazon EVS, see [https://docs.aws.amazon.com/evs/latest/APIReference/Welcome.html](https://docs.aws.amazon.com/evs/latest/APIReference/Welcome.html).  
Type: String  
Required: No

 ** vpcId **   
The ID of the VPC the subnet is in.  
Type: String  
Required: No

## See Also
<a name="API_Subnet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Subnet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Subnet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Subnet) 

# SubnetAssociation
<a name="API_SubnetAssociation"></a>

Describes the subnet association with the transit gateway multicast domain.

## Contents
<a name="API_SubnetAssociation_Contents"></a>

 ** state **   
The state of the subnet association.  
Type: String  
Valid Values: `pendingAcceptance | associating | associated | disassociating | disassociated | rejected | failed`   
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

## See Also
<a name="API_SubnetAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SubnetAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SubnetAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SubnetAssociation) 

# SubnetCidrBlockState
<a name="API_SubnetCidrBlockState"></a>

Describes the state of a CIDR block.

## Contents
<a name="API_SubnetCidrBlockState_Contents"></a>

 ** state **   
The state of a CIDR block.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated | failing | failed`   
Required: No

 ** statusMessage **   
A message about the status of the CIDR block, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_SubnetCidrBlockState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SubnetCidrBlockState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SubnetCidrBlockState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SubnetCidrBlockState) 

# SubnetCidrReservation
<a name="API_SubnetCidrReservation"></a>

Describes a subnet CIDR reservation.

## Contents
<a name="API_SubnetCidrReservation_Contents"></a>

 ** cidr **   
The CIDR that has been reserved.  
Type: String  
Required: No

 ** description **   
The description assigned to the subnet CIDR reservation.  
Type: String  
Required: No

 ** ownerId **   
The ID of the account that owns the subnet CIDR reservation.   
Type: String  
Required: No

 ** reservationType **   
The type of reservation.   
Type: String  
Valid Values: `prefix | explicit`   
Required: No

 ** subnetCidrReservationId **   
The ID of the subnet CIDR reservation.  
Type: String  
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the subnet CIDR reservation.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_SubnetCidrReservation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SubnetCidrReservation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SubnetCidrReservation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SubnetCidrReservation) 

# SubnetConfiguration
<a name="API_SubnetConfiguration"></a>

Describes the configuration of a subnet for a VPC endpoint.

## Contents
<a name="API_SubnetConfiguration_Contents"></a>

 ** Ipv4 **   
The IPv4 address to assign to the endpoint network interface in the subnet. You must provide an IPv4 address if the VPC endpoint supports IPv4.  
If you specify an IPv4 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.  
Type: String  
Required: No

 ** Ipv6 **   
The IPv6 address to assign to the endpoint network interface in the subnet. You must provide an IPv6 address if the VPC endpoint supports IPv6.  
If you specify an IPv6 address when modifying a VPC endpoint, we replace the existing endpoint network interface with a new endpoint network interface with this IP address. This process temporarily disconnects the subnet and the VPC endpoint.  
Type: String  
Required: No

 ** SubnetId **   
The ID of the subnet.  
Type: String  
Required: No

## See Also
<a name="API_SubnetConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SubnetConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SubnetConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SubnetConfiguration) 

# SubnetIpPrefixes
<a name="API_SubnetIpPrefixes"></a>

Prefixes of the subnet IP.

## Contents
<a name="API_SubnetIpPrefixes_Contents"></a>

 ** IpPrefixSet.N **   
Array of SubnetIpPrefixes objects.  
Type: Array of strings  
Required: No

 ** subnetId **   
ID of the subnet.  
Type: String  
Required: No

## See Also
<a name="API_SubnetIpPrefixes_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SubnetIpPrefixes) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SubnetIpPrefixes) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SubnetIpPrefixes) 

# SubnetIpv6CidrBlockAssociation
<a name="API_SubnetIpv6CidrBlockAssociation"></a>

Describes an association between a subnet and an IPv6 CIDR block.

## Contents
<a name="API_SubnetIpv6CidrBlockAssociation_Contents"></a>

 ** associationId **   
The ID of the association.  
Type: String  
Required: No

 ** ipSource **   
The source that allocated the IP address space. `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.  
Type: String  
Valid Values: `amazon | byoip | none`   
Required: No

 ** ipv6AddressAttribute **   
Public IPv6 addresses are those advertised on the internet from AWS. Private IP addresses are not and cannot be advertised on the internet from AWS.  
Type: String  
Valid Values: `public | private`   
Required: No

 ** ipv6CidrBlock **   
The IPv6 CIDR block.  
Type: String  
Required: No

 ** ipv6CidrBlockState **   
The state of the CIDR block.  
Type: [SubnetCidrBlockState](API_SubnetCidrBlockState.md) object  
Required: No

## See Also
<a name="API_SubnetIpv6CidrBlockAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SubnetIpv6CidrBlockAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SubnetIpv6CidrBlockAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SubnetIpv6CidrBlockAssociation) 

# Subscription
<a name="API_Subscription"></a>

Describes an Infrastructure Performance subscription.

## Contents
<a name="API_Subscription_Contents"></a>

 ** destination **   
The Region or Availability Zone that's the target for the subscription. For example, `eu-west-1`.  
Type: String  
Required: No

 ** metric **   
The metric used for the subscription.  
Type: String  
Valid Values: `aggregate-latency`   
Required: No

 ** period **   
The data aggregation time for the subscription.  
Type: String  
Valid Values: `five-minutes | fifteen-minutes | one-hour | three-hours | one-day | one-week`   
Required: No

 ** source **   
The Region or Availability Zone that's the source for the subscription. For example, `us-east-1`.  
Type: String  
Required: No

 ** statistic **   
The statistic used for the subscription.  
Type: String  
Valid Values: `p50`   
Required: No

## See Also
<a name="API_Subscription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Subscription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Subscription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Subscription) 

# SuccessfulInstanceCreditSpecificationItem
<a name="API_SuccessfulInstanceCreditSpecificationItem"></a>

Describes the burstable performance instance whose credit option for CPU usage was successfully modified.

## Contents
<a name="API_SuccessfulInstanceCreditSpecificationItem_Contents"></a>

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

## See Also
<a name="API_SuccessfulInstanceCreditSpecificationItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SuccessfulInstanceCreditSpecificationItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SuccessfulInstanceCreditSpecificationItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SuccessfulInstanceCreditSpecificationItem) 

# SuccessfulQueuedPurchaseDeletion
<a name="API_SuccessfulQueuedPurchaseDeletion"></a>

Describes a Reserved Instance whose queued purchase was successfully deleted.

## Contents
<a name="API_SuccessfulQueuedPurchaseDeletion_Contents"></a>

 ** reservedInstancesId **   
The ID of the Reserved Instance.  
Type: String  
Required: No

## See Also
<a name="API_SuccessfulQueuedPurchaseDeletion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SuccessfulQueuedPurchaseDeletion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SuccessfulQueuedPurchaseDeletion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SuccessfulQueuedPurchaseDeletion) 

# SupportedRegionDetail
<a name="API_SupportedRegionDetail"></a>

Describes a supported Region.

## Contents
<a name="API_SupportedRegionDetail_Contents"></a>

 ** region **   
The Region code.  
Type: String  
Required: No

 ** serviceState **   
The service state. The possible values are `Pending`, `Available`, `Deleting`, `Deleted`, `Failed`, and `Closed`.  
Type: String  
Required: No

## See Also
<a name="API_SupportedRegionDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/SupportedRegionDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/SupportedRegionDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/SupportedRegionDetail) 

# Tag
<a name="API_Tag"></a>

Describes a tag.

## Contents
<a name="API_Tag_Contents"></a>

 ** Key ** (request), ** key ** (response)  
The key of the tag.  
Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with `aws:`.  
Type: String  
Required: No

 ** Value ** (request), ** value ** (response)  
The value of the tag.  
Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.  
Type: String  
Required: No

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Tag) 

# TagDescription
<a name="API_TagDescription"></a>

Describes a tag.

## Contents
<a name="API_TagDescription_Contents"></a>

 ** key **   
The tag key.  
Type: String  
Required: No

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceType **   
The resource type.  
Type: String  
Valid Values: `capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | declarative-policies-report | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | image-usage-report | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-virtual-interface | local-gateway-virtual-interface-group | local-gateway-route-table-vpc-association | local-gateway-route-table-virtual-interface-group-association | natgateway | network-acl | network-interface | network-insights-analysis | network-insights-path | network-insights-access-scope | network-insights-access-scope-analysis | outpost-lag | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | service-link-virtual-interface | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-metering-policy | transit-gateway-route-table | transit-gateway-route-table-announcement | volume | vpc | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log | capacity-reservation-fleet | traffic-mirror-filter-rule | vpc-endpoint-connection-device-type | verified-access-instance | verified-access-group | verified-access-endpoint | verified-access-policy | verified-access-trust-provider | vpn-connection-device-type | vpc-block-public-access-exclusion | vpc-encryption-control | route-server | route-server-endpoint | route-server-peer | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | verified-access-endpoint-target | ipam-external-resource-verification-token | capacity-block | mac-modification-task | ipam-prefix-list-resolver | ipam-policy | ipam-prefix-list-resolver-target | secondary-interface | secondary-network | secondary-subnet | capacity-manager-data-export | vpn-concentrator`   
Required: No

 ** value **   
The tag value.  
Type: String  
Required: No

## See Also
<a name="API_TagDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TagDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TagDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TagDescription) 

# TagSpecification
<a name="API_TagSpecification"></a>

The tags to apply to a resource when the resource is being created. When you specify a tag, you must specify the resource type to tag, otherwise the request will fail.

**Note**  
The `Valid Values` lists all the resource types that can be tagged. However, the action you're using might not support tagging all of these resource types. If you try to tag a resource type that is unsupported for the action you're using, you'll get an error.

## Contents
<a name="API_TagSpecification_Contents"></a>

 ** ResourceType ** (request), ** resourceType ** (response)  
The type of resource to tag on creation.  
Type: String  
Valid Values: `capacity-reservation | client-vpn-endpoint | customer-gateway | carrier-gateway | coip-pool | declarative-policies-report | dedicated-host | dhcp-options | egress-only-internet-gateway | elastic-ip | elastic-gpu | export-image-task | export-instance-task | fleet | fpga-image | host-reservation | image | image-usage-report | import-image-task | import-snapshot-task | instance | instance-event-window | internet-gateway | ipam | ipam-pool | ipam-scope | ipv4pool-ec2 | ipv6pool-ec2 | key-pair | launch-template | local-gateway | local-gateway-route-table | local-gateway-virtual-interface | local-gateway-virtual-interface-group | local-gateway-route-table-vpc-association | local-gateway-route-table-virtual-interface-group-association | natgateway | network-acl | network-interface | network-insights-analysis | network-insights-path | network-insights-access-scope | network-insights-access-scope-analysis | outpost-lag | placement-group | prefix-list | replace-root-volume-task | reserved-instances | route-table | security-group | security-group-rule | service-link-virtual-interface | snapshot | spot-fleet-request | spot-instances-request | subnet | subnet-cidr-reservation | traffic-mirror-filter | traffic-mirror-session | traffic-mirror-target | transit-gateway | transit-gateway-attachment | transit-gateway-connect-peer | transit-gateway-multicast-domain | transit-gateway-policy-table | transit-gateway-metering-policy | transit-gateway-route-table | transit-gateway-route-table-announcement | volume | vpc | vpc-endpoint | vpc-endpoint-connection | vpc-endpoint-service | vpc-endpoint-service-permission | vpc-peering-connection | vpn-connection | vpn-gateway | vpc-flow-log | capacity-reservation-fleet | traffic-mirror-filter-rule | vpc-endpoint-connection-device-type | verified-access-instance | verified-access-group | verified-access-endpoint | verified-access-policy | verified-access-trust-provider | vpn-connection-device-type | vpc-block-public-access-exclusion | vpc-encryption-control | route-server | route-server-endpoint | route-server-peer | ipam-resource-discovery | ipam-resource-discovery-association | instance-connect-endpoint | verified-access-endpoint-target | ipam-external-resource-verification-token | capacity-block | mac-modification-task | ipam-prefix-list-resolver | ipam-policy | ipam-prefix-list-resolver-target | secondary-interface | secondary-network | secondary-subnet | capacity-manager-data-export | vpn-concentrator`   
Required: No

 ** Tag.N **   
The tags to apply to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_TagSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TagSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TagSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TagSpecification) 

# TargetCapacitySpecification
<a name="API_TargetCapacitySpecification"></a>

The number of units to request. You can choose to set the target capacity in terms of instances or a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain`, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance `MaxTotalPrice` parameter, the Spot Instance `MaxTotalPrice`, or both to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn’t met the target capacity. The `MaxTotalPrice` parameters are located in [OnDemandOptions](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptions.html) and [SpotOptions](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptions).

## Contents
<a name="API_TargetCapacitySpecification_Contents"></a>

 ** defaultTargetCapacityType **   
The default target capacity type.  
Type: String  
Valid Values: `spot | on-demand | capacity-block | reserved-capacity`   
Required: No

 ** onDemandTargetCapacity **   
The number of On-Demand units to request. If you specify a target capacity for Spot units, you cannot specify a target capacity for On-Demand units.  
Type: Integer  
Required: No

 ** spotTargetCapacity **   
The maximum number of Spot units to launch. If you specify a target capacity for On-Demand units, you cannot specify a target capacity for Spot units.  
Type: Integer  
Required: No

 ** targetCapacityUnitType **   
The unit for the target capacity.  
Type: String  
Valid Values: `vcpu | memory-mib | units`   
Required: No

 ** totalTargetCapacity **   
The number of units to request, filled the default target capacity type.  
Type: Integer  
Required: No

## See Also
<a name="API_TargetCapacitySpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetCapacitySpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetCapacitySpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetCapacitySpecification) 

# TargetCapacitySpecificationRequest
<a name="API_TargetCapacitySpecificationRequest"></a>

The number of units to request. You can choose to set the target capacity as the number of instances. Or you can set the target capacity to a performance characteristic that is important to your application workload, such as vCPUs, memory, or I/O. If the request type is `maintain`, you can specify a target capacity of 0 and add capacity later.

You can use the On-Demand Instance `MaxTotalPrice` parameter, the Spot Instance `MaxTotalPrice` parameter, or both parameters to ensure that your fleet cost does not exceed your budget. If you set a maximum price per hour for the On-Demand Instances and Spot Instances in your request, EC2 Fleet will launch instances until it reaches the maximum amount that you're willing to pay. When the maximum amount you're willing to pay is reached, the fleet stops launching instances even if it hasn't met the target capacity. The `MaxTotalPrice` parameters are located in [OnDemandOptionsRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_OnDemandOptionsRequest) and [SpotOptionsRequest](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_SpotOptionsRequest).

## Contents
<a name="API_TargetCapacitySpecificationRequest_Contents"></a>

 ** TotalTargetCapacity **   
The number of units to request, filled using the default target capacity type.  
Type: Integer  
Required: Yes

 ** DefaultTargetCapacityType **   
The default target capacity type.  
Type: String  
Valid Values: `spot | on-demand | capacity-block | reserved-capacity`   
Required: No

 ** OnDemandTargetCapacity **   
The number of On-Demand units to request.  
Type: Integer  
Required: No

 ** SpotTargetCapacity **   
The number of Spot units to request.  
Type: Integer  
Required: No

 ** TargetCapacityUnitType **   
The unit for the target capacity. You can specify this parameter only when using attributed-based instance type selection.  
Default: `units` (the number of instances)  
Type: String  
Valid Values: `vcpu | memory-mib | units`   
Required: No

## See Also
<a name="API_TargetCapacitySpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetCapacitySpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetCapacitySpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetCapacitySpecificationRequest) 

# TargetConfiguration
<a name="API_TargetConfiguration"></a>

Information about the Convertible Reserved Instance offering.

## Contents
<a name="API_TargetConfiguration_Contents"></a>

 ** instanceCount **   
The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request  
Type: Integer  
Required: No

 ** offeringId **   
The ID of the Convertible Reserved Instance offering.  
Type: String  
Required: No

## See Also
<a name="API_TargetConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetConfiguration) 

# TargetConfigurationRequest
<a name="API_TargetConfigurationRequest"></a>

Details about the target configuration.

## Contents
<a name="API_TargetConfigurationRequest_Contents"></a>

 ** OfferingId **   
The Convertible Reserved Instance offering ID.  
Type: String  
Required: Yes

 ** InstanceCount **   
The number of instances the Convertible Reserved Instance offering can be applied to. This parameter is reserved and cannot be specified in a request  
Type: Integer  
Required: No

## See Also
<a name="API_TargetConfigurationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetConfigurationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetConfigurationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetConfigurationRequest) 

# TargetGroup
<a name="API_TargetGroup"></a>

Describes a load balancer target group.

## Contents
<a name="API_TargetGroup_Contents"></a>

 ** Arn ** (request), ** arn ** (response)  
The Amazon Resource Name (ARN) of the target group.  
Type: String  
Required: No

## See Also
<a name="API_TargetGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetGroup) 

# TargetGroupsConfig
<a name="API_TargetGroupsConfig"></a>

Describes the target groups to attach to a Spot Fleet. Spot Fleet registers the running Spot Instances with these target groups.

## Contents
<a name="API_TargetGroupsConfig_Contents"></a>

 ** TargetGroups.N **   
One or more target groups.  
Type: Array of [TargetGroup](API_TargetGroup.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Required: No

## See Also
<a name="API_TargetGroupsConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetGroupsConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetGroupsConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetGroupsConfig) 

# TargetNetwork
<a name="API_TargetNetwork"></a>

Describes a target network associated with a Client VPN endpoint.

## Contents
<a name="API_TargetNetwork_Contents"></a>

 ** associationId **   
The ID of the association.  
Type: String  
Required: No

 ** clientVpnEndpointId **   
The ID of the Client VPN endpoint with which the target network is associated.  
Type: String  
Required: No

 ** SecurityGroups.N **   
The IDs of the security groups applied to the target network association.  
Type: Array of strings  
Required: No

 ** status **   
The current state of the target network association.  
Type: [AssociationStatus](API_AssociationStatus.md) object  
Required: No

 ** targetNetworkId **   
The ID of the subnet specified as the target network.  
Type: String  
Required: No

 ** vpcId **   
The ID of the VPC in which the target network (subnet) is located.  
Type: String  
Required: No

## See Also
<a name="API_TargetNetwork_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetNetwork) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetNetwork) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetNetwork) 

# TargetReservationValue
<a name="API_TargetReservationValue"></a>

The total value of the new Convertible Reserved Instances.

## Contents
<a name="API_TargetReservationValue_Contents"></a>

 ** reservationValue **   
The total value of the Convertible Reserved Instances that make up the exchange. This is the sum of the list value, remaining upfront price, and additional upfront cost of the exchange.  
Type: [ReservationValue](API_ReservationValue.md) object  
Required: No

 ** targetConfiguration **   
The configuration of the Convertible Reserved Instances that make up the exchange.  
Type: [TargetConfiguration](API_TargetConfiguration.md) object  
Required: No

## See Also
<a name="API_TargetReservationValue_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TargetReservationValue) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TargetReservationValue) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TargetReservationValue) 

# TerminateConnectionStatus
<a name="API_TerminateConnectionStatus"></a>

Information about a terminated Client VPN endpoint client connection.

## Contents
<a name="API_TerminateConnectionStatus_Contents"></a>

 ** connectionId **   
The ID of the client connection.  
Type: String  
Required: No

 ** currentStatus **   
A message about the status of the client connection, if applicable.  
Type: [ClientVpnConnectionStatus](API_ClientVpnConnectionStatus.md) object  
Required: No

 ** previousStatus **   
The state of the client connection.  
Type: [ClientVpnConnectionStatus](API_ClientVpnConnectionStatus.md) object  
Required: No

## See Also
<a name="API_TerminateConnectionStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TerminateConnectionStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TerminateConnectionStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TerminateConnectionStatus) 

# ThroughResourcesStatement
<a name="API_ThroughResourcesStatement"></a>

Describes a through resource statement.

## Contents
<a name="API_ThroughResourcesStatement_Contents"></a>

 ** resourceStatement **   
The resource statement.  
Type: [ResourceStatement](API_ResourceStatement.md) object  
Required: No

## See Also
<a name="API_ThroughResourcesStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ThroughResourcesStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ThroughResourcesStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ThroughResourcesStatement) 

# ThroughResourcesStatementRequest
<a name="API_ThroughResourcesStatementRequest"></a>

Describes a through resource statement.

## Contents
<a name="API_ThroughResourcesStatementRequest_Contents"></a>

 ** ResourceStatement **   
The resource statement.  
Type: [ResourceStatementRequest](API_ResourceStatementRequest.md) object  
Required: No

## See Also
<a name="API_ThroughResourcesStatementRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ThroughResourcesStatementRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ThroughResourcesStatementRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ThroughResourcesStatementRequest) 

# TotalLocalStorageGB
<a name="API_TotalLocalStorageGB"></a>

The minimum and maximum amount of total local storage, in GB.

## Contents
<a name="API_TotalLocalStorageGB_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum amount of total local storage, in GB. If this parameter is not specified, there is no maximum limit.  
Type: Double  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum amount of total local storage, in GB. If this parameter is not specified, there is no minimum limit.  
Type: Double  
Required: No

## See Also
<a name="API_TotalLocalStorageGB_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TotalLocalStorageGB) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TotalLocalStorageGB) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TotalLocalStorageGB) 

# TotalLocalStorageGBRequest
<a name="API_TotalLocalStorageGBRequest"></a>

The minimum and maximum amount of total local storage, in GB.

## Contents
<a name="API_TotalLocalStorageGBRequest_Contents"></a>

 ** Max **   
The maximum amount of total local storage, in GB. To specify no maximum limit, omit this parameter.  
Type: Double  
Required: No

 ** Min **   
The minimum amount of total local storage, in GB. To specify no minimum limit, omit this parameter.  
Type: Double  
Required: No

## See Also
<a name="API_TotalLocalStorageGBRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TotalLocalStorageGBRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TotalLocalStorageGBRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TotalLocalStorageGBRequest) 

# TrafficMirrorFilter
<a name="API_TrafficMirrorFilter"></a>

Describes the Traffic Mirror filter.

## Contents
<a name="API_TrafficMirrorFilter_Contents"></a>

 ** description **   
The description of the Traffic Mirror filter.  
Type: String  
Required: No

 ** EgressFilterRuleSet.N **   
Information about the egress rules that are associated with the Traffic Mirror filter.  
Type: Array of [TrafficMirrorFilterRule](API_TrafficMirrorFilterRule.md) objects  
Required: No

 ** IngressFilterRuleSet.N **   
Information about the ingress rules that are associated with the Traffic Mirror filter.  
Type: Array of [TrafficMirrorFilterRule](API_TrafficMirrorFilterRule.md) objects  
Required: No

 ** NetworkServiceSet.N **   
The network service traffic that is associated with the Traffic Mirror filter.  
Type: Array of strings  
Valid Values: `amazon-dns`   
Required: No

 ** TagSet.N **   
The tags assigned to the Traffic Mirror filter.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trafficMirrorFilterId **   
The ID of the Traffic Mirror filter.  
Type: String  
Required: No

## See Also
<a name="API_TrafficMirrorFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TrafficMirrorFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TrafficMirrorFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TrafficMirrorFilter) 

# TrafficMirrorFilterRule
<a name="API_TrafficMirrorFilterRule"></a>

Describes the Traffic Mirror rule.

## Contents
<a name="API_TrafficMirrorFilterRule_Contents"></a>

 ** description **   
The description of the Traffic Mirror rule.  
Type: String  
Required: No

 ** destinationCidrBlock **   
The destination CIDR block assigned to the Traffic Mirror rule.  
Type: String  
Required: No

 ** destinationPortRange **   
The destination port range assigned to the Traffic Mirror rule.  
Type: [TrafficMirrorPortRange](API_TrafficMirrorPortRange.md) object  
Required: No

 ** protocol **   
The protocol assigned to the Traffic Mirror rule.  
Type: Integer  
Required: No

 ** ruleAction **   
The action assigned to the Traffic Mirror rule.  
Type: String  
Valid Values: `accept | reject`   
Required: No

 ** ruleNumber **   
The rule number of the Traffic Mirror rule.  
Type: Integer  
Required: No

 ** sourceCidrBlock **   
The source CIDR block assigned to the Traffic Mirror rule.  
Type: String  
Required: No

 ** sourcePortRange **   
The source port range assigned to the Traffic Mirror rule.  
Type: [TrafficMirrorPortRange](API_TrafficMirrorPortRange.md) object  
Required: No

 ** TagSet.N **   
Tags on Traffic Mirroring filter rules.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trafficDirection **   
The traffic direction assigned to the Traffic Mirror rule.  
Type: String  
Valid Values: `ingress | egress`   
Required: No

 ** trafficMirrorFilterId **   
The ID of the Traffic Mirror filter that the rule is associated with.  
Type: String  
Required: No

 ** trafficMirrorFilterRuleId **   
The ID of the Traffic Mirror rule.  
Type: String  
Required: No

## See Also
<a name="API_TrafficMirrorFilterRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TrafficMirrorFilterRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TrafficMirrorFilterRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TrafficMirrorFilterRule) 

# TrafficMirrorPortRange
<a name="API_TrafficMirrorPortRange"></a>

Describes the Traffic Mirror port range.

## Contents
<a name="API_TrafficMirrorPortRange_Contents"></a>

 ** fromPort **   
The start of the Traffic Mirror port range. This applies to the TCP and UDP protocols.  
Type: Integer  
Required: No

 ** toPort **   
The end of the Traffic Mirror port range. This applies to the TCP and UDP protocols.  
Type: Integer  
Required: No

## See Also
<a name="API_TrafficMirrorPortRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TrafficMirrorPortRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TrafficMirrorPortRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TrafficMirrorPortRange) 

# TrafficMirrorPortRangeRequest
<a name="API_TrafficMirrorPortRangeRequest"></a>

Information about the Traffic Mirror filter rule port range.

## Contents
<a name="API_TrafficMirrorPortRangeRequest_Contents"></a>

 ** FromPort **   
The first port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.  
Type: Integer  
Required: No

 ** ToPort **   
The last port in the Traffic Mirror port range. This applies to the TCP and UDP protocols.  
Type: Integer  
Required: No

## See Also
<a name="API_TrafficMirrorPortRangeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TrafficMirrorPortRangeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TrafficMirrorPortRangeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TrafficMirrorPortRangeRequest) 

# TrafficMirrorSession
<a name="API_TrafficMirrorSession"></a>

Describes a Traffic Mirror session.

## Contents
<a name="API_TrafficMirrorSession_Contents"></a>

 ** description **   
The description of the Traffic Mirror session.  
Type: String  
Required: No

 ** networkInterfaceId **   
The ID of the Traffic Mirror session's network interface.  
Type: String  
Required: No

 ** ownerId **   
The ID of the account that owns the Traffic Mirror session.  
Type: String  
Required: No

 ** packetLength **   
The number of bytes in each packet to mirror. These are the 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  
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: No

 ** TagSet.N **   
The tags assigned to the Traffic Mirror session.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trafficMirrorFilterId **   
The ID of the Traffic Mirror filter.  
Type: String  
Required: No

 ** trafficMirrorSessionId **   
The ID for the Traffic Mirror session.  
Type: String  
Required: No

 ** trafficMirrorTargetId **   
The ID of the Traffic Mirror target.  
Type: String  
Required: No

 ** virtualNetworkId **   
The virtual network ID associated with the Traffic Mirror session.  
Type: Integer  
Required: No

## See Also
<a name="API_TrafficMirrorSession_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TrafficMirrorSession) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TrafficMirrorSession) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TrafficMirrorSession) 

# TrafficMirrorTarget
<a name="API_TrafficMirrorTarget"></a>

Describes a Traffic Mirror target.

## Contents
<a name="API_TrafficMirrorTarget_Contents"></a>

 ** description **   
Information about the Traffic Mirror target.  
Type: String  
Required: No

 ** gatewayLoadBalancerEndpointId **   
The ID of the Gateway Load Balancer endpoint.  
Type: String  
Required: No

 ** networkInterfaceId **   
The network interface ID that is attached to the target.  
Type: String  
Required: No

 ** networkLoadBalancerArn **   
The Amazon Resource Name (ARN) of the Network Load Balancer.  
Type: String  
Required: No

 ** ownerId **   
The ID of the account that owns the Traffic Mirror target.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the Traffic Mirror target.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trafficMirrorTargetId **   
The ID of the Traffic Mirror target.  
Type: String  
Required: No

 ** type **   
The type of Traffic Mirror target.  
Type: String  
Valid Values: `network-interface | network-load-balancer | gateway-load-balancer-endpoint`   
Required: No

## See Also
<a name="API_TrafficMirrorTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TrafficMirrorTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TrafficMirrorTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TrafficMirrorTarget) 

# TransitGateway
<a name="API_TransitGateway"></a>

Describes a transit gateway.

## Contents
<a name="API_TransitGateway_Contents"></a>

 ** creationTime **   
The creation time.  
Type: Timestamp  
Required: No

 ** description **   
The description of the transit gateway.  
Type: String  
Required: No

 ** options **   
The transit gateway options.  
Type: [TransitGatewayOptions](API_TransitGatewayOptions.md) object  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the transit gateway.  
Type: String  
Required: No

 ** state **   
The state of the transit gateway.  
Type: String  
Valid Values: `pending | available | modifying | deleting | deleted`   
Required: No

 ** TagSet.N **   
The tags for the transit gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayArn **   
The Amazon Resource Name (ARN) of the transit gateway.  
Type: String  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

## See Also
<a name="API_TransitGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGateway) 

# TransitGatewayAssociation
<a name="API_TransitGatewayAssociation"></a>

Describes an association between a resource attachment and a transit gateway route table.

## Contents
<a name="API_TransitGatewayAssociation_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceType **   
The resource type. Note that the `tgw-peering` resource type has been deprecated.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** state **   
The state of the association.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated`   
Required: No

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

 ** transitGatewayRouteTableId **   
The ID of the transit gateway route table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayAssociation) 

# TransitGatewayAttachment
<a name="API_TransitGatewayAttachment"></a>

Describes an attachment between a resource and a transit gateway.

## Contents
<a name="API_TransitGatewayAttachment_Contents"></a>

 ** association **   
The association.  
Type: [TransitGatewayAttachmentAssociation](API_TransitGatewayAttachmentAssociation.md) object  
Required: No

 ** creationTime **   
The creation time.  
Type: Timestamp  
Required: No

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceOwnerId **   
The ID of the AWS account that owns the resource.  
Type: String  
Required: No

 ** resourceType **   
The resource type. Note that the `tgw-peering` resource type has been deprecated.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** state **   
The attachment state. Note that the `initiating` state has been deprecated.  
Type: String  
Valid Values: `initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing`   
Required: No

 ** TagSet.N **   
The tags for the attachment.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

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

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

 ** transitGatewayOwnerId **   
The ID of the AWS account that owns the transit gateway.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayAttachment) 

# TransitGatewayAttachmentAssociation
<a name="API_TransitGatewayAttachmentAssociation"></a>

Describes an association.

## Contents
<a name="API_TransitGatewayAttachmentAssociation_Contents"></a>

 ** state **   
The state of the association.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated`   
Required: No

 ** transitGatewayRouteTableId **   
The ID of the route table for the transit gateway.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayAttachmentAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayAttachmentAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayAttachmentAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayAttachmentAssociation) 

# TransitGatewayAttachmentBgpConfiguration
<a name="API_TransitGatewayAttachmentBgpConfiguration"></a>

The BGP configuration information.

## Contents
<a name="API_TransitGatewayAttachmentBgpConfiguration_Contents"></a>

 ** bgpStatus **   
The BGP status.  
Type: String  
Valid Values: `up | down`   
Required: No

 ** peerAddress **   
The interior BGP peer IP address for the appliance.  
Type: String  
Required: No

 ** peerAsn **   
The peer Autonomous System Number (ASN).  
Type: Long  
Required: No

 ** transitGatewayAddress **   
The interior BGP peer IP address for the transit gateway.  
Type: String  
Required: No

 ** transitGatewayAsn **   
The transit gateway Autonomous System Number (ASN).  
Type: Long  
Required: No

## See Also
<a name="API_TransitGatewayAttachmentBgpConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayAttachmentBgpConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayAttachmentBgpConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayAttachmentBgpConfiguration) 

# TransitGatewayAttachmentPropagation
<a name="API_TransitGatewayAttachmentPropagation"></a>

Describes a propagation route table.

## Contents
<a name="API_TransitGatewayAttachmentPropagation_Contents"></a>

 ** state **   
The state of the propagation route table.  
Type: String  
Valid Values: `enabling | enabled | disabling | disabled`   
Required: No

 ** transitGatewayRouteTableId **   
The ID of the propagation route table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayAttachmentPropagation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayAttachmentPropagation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayAttachmentPropagation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayAttachmentPropagation) 

# TransitGatewayConnect
<a name="API_TransitGatewayConnect"></a>

Describes a transit gateway Connect attachment.

## Contents
<a name="API_TransitGatewayConnect_Contents"></a>

 ** creationTime **   
The creation time.  
Type: Timestamp  
Required: No

 ** options **   
The Connect attachment options.  
Type: [TransitGatewayConnectOptions](API_TransitGatewayConnectOptions.md) object  
Required: No

 ** state **   
The state of the attachment.  
Type: String  
Valid Values: `initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing`   
Required: No

 ** TagSet.N **   
The tags for the attachment.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

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

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

 ** transportTransitGatewayAttachmentId **   
The ID of the attachment from which the Connect attachment was created.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayConnect_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayConnect) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayConnect) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayConnect) 

# TransitGatewayConnectOptions
<a name="API_TransitGatewayConnectOptions"></a>

Describes the Connect attachment options.

## Contents
<a name="API_TransitGatewayConnectOptions_Contents"></a>

 ** protocol **   
The tunnel protocol.  
Type: String  
Valid Values: `gre`   
Required: No

## See Also
<a name="API_TransitGatewayConnectOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayConnectOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayConnectOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayConnectOptions) 

# TransitGatewayConnectPeer
<a name="API_TransitGatewayConnectPeer"></a>

Describes a transit gateway Connect peer.

## Contents
<a name="API_TransitGatewayConnectPeer_Contents"></a>

 ** connectPeerConfiguration **   
The Connect peer details.  
Type: [TransitGatewayConnectPeerConfiguration](API_TransitGatewayConnectPeerConfiguration.md) object  
Required: No

 ** creationTime **   
The creation time.  
Type: Timestamp  
Required: No

 ** state **   
The state of the Connect peer.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** TagSet.N **   
The tags for the Connect peer.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

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

 ** transitGatewayConnectPeerId **   
The ID of the Connect peer.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayConnectPeer_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayConnectPeer) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayConnectPeer) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayConnectPeer) 

# TransitGatewayConnectPeerConfiguration
<a name="API_TransitGatewayConnectPeerConfiguration"></a>

Describes the Connect peer details.

## Contents
<a name="API_TransitGatewayConnectPeerConfiguration_Contents"></a>

 ** BgpConfigurations.N **   
The BGP configuration details.  
Type: Array of [TransitGatewayAttachmentBgpConfiguration](API_TransitGatewayAttachmentBgpConfiguration.md) objects  
Required: No

 ** InsideCidrBlocks.N **   
The range of interior BGP peer IP addresses.  
Type: Array of strings  
Required: No

 ** peerAddress **   
The Connect peer IP address on the appliance side of the tunnel.  
Type: String  
Required: No

 ** protocol **   
The tunnel protocol.  
Type: String  
Valid Values: `gre`   
Required: No

 ** transitGatewayAddress **   
The Connect peer IP address on the transit gateway side of the tunnel.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayConnectPeerConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayConnectPeerConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayConnectPeerConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayConnectPeerConfiguration) 

# TransitGatewayConnectRequestBgpOptions
<a name="API_TransitGatewayConnectRequestBgpOptions"></a>

The BGP options for the Connect attachment.

## Contents
<a name="API_TransitGatewayConnectRequestBgpOptions_Contents"></a>

 ** PeerAsn **   
The peer Autonomous System Number (ASN).  
Type: Long  
Required: No

## See Also
<a name="API_TransitGatewayConnectRequestBgpOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayConnectRequestBgpOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayConnectRequestBgpOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayConnectRequestBgpOptions) 

# TransitGatewayMeteringPolicy
<a name="API_TransitGatewayMeteringPolicy"></a>

Describes a transit gateway metering policy.

## Contents
<a name="API_TransitGatewayMeteringPolicy_Contents"></a>

 ** MiddleboxAttachmentIdSet.N **   
The IDs of the middlebox attachments associated with the metering policy.  
Type: Array of strings  
Required: No

 ** state **   
The state of the transit gateway metering policy.  
Type: String  
Valid Values: `available | deleted | pending | modifying | deleting`   
Required: No

 ** TagSet.N **   
The tags assigned to the transit gateway metering policy.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway associated with the metering policy.  
Type: String  
Required: No

 ** transitGatewayMeteringPolicyId **   
The ID of the transit gateway metering policy.  
Type: String  
Required: No

 ** updateEffectiveAt **   
The date and time when the metering policy update becomes effective.  
Type: Timestamp  
Required: No

## See Also
<a name="API_TransitGatewayMeteringPolicy_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMeteringPolicy) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMeteringPolicy) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMeteringPolicy) 

# TransitGatewayMeteringPolicyEntry
<a name="API_TransitGatewayMeteringPolicyEntry"></a>

Describes an entry in a transit gateway metering policy.

## Contents
<a name="API_TransitGatewayMeteringPolicyEntry_Contents"></a>

 ** meteredAccount **   
The AWS account ID to which the metered traffic is attributed.  
Type: String  
Valid Values: `source-attachment-owner | destination-attachment-owner | transit-gateway-owner`   
Required: No

 ** meteringPolicyRule **   
The metering policy rule that defines traffic matching criteria.  
Type: [TransitGatewayMeteringPolicyRule](API_TransitGatewayMeteringPolicyRule.md) object  
Required: No

 ** policyRuleNumber **   
The rule number of the metering policy entry.  
Type: String  
Required: No

 ** state **   
The state of the metering policy entry.  
Type: String  
Valid Values: `available | deleted`   
Required: No

 ** updatedAt **   
The date and time when the metering policy entry was last updated.  
Type: Timestamp  
Required: No

 ** updateEffectiveAt **   
The date and time when the metering policy entry update becomes effective.  
Type: Timestamp  
Required: No

## See Also
<a name="API_TransitGatewayMeteringPolicyEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMeteringPolicyEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMeteringPolicyEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMeteringPolicyEntry) 

# TransitGatewayMeteringPolicyRule
<a name="API_TransitGatewayMeteringPolicyRule"></a>

Describes the traffic matching criteria for a transit gateway metering policy rule.

## Contents
<a name="API_TransitGatewayMeteringPolicyRule_Contents"></a>

 ** destinationCidrBlock **   
The destination CIDR block for the rule.  
Type: String  
Required: No

 ** destinationPortRange **   
The destination port range for the rule.  
Type: String  
Required: No

 ** destinationTransitGatewayAttachmentId **   
The ID of the destination transit gateway attachment.  
Type: String  
Required: No

 ** destinationTransitGatewayAttachmentType **   
The type of the destination transit gateway attachment. 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

 ** protocol **   
The protocol for the rule (1, 6, 17, etc.).  
Type: String  
Required: No

 ** sourceCidrBlock **   
The source CIDR block for the rule.  
Type: String  
Required: No

 ** sourcePortRange **   
The source port range for the rule.  
Type: String  
Required: No

 ** sourceTransitGatewayAttachmentId **   
The ID of the source transit gateway attachment.  
Type: String  
Required: No

 ** sourceTransitGatewayAttachmentType **   
The type of the source transit gateway attachment. 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

## See Also
<a name="API_TransitGatewayMeteringPolicyRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMeteringPolicyRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMeteringPolicyRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMeteringPolicyRule) 

# TransitGatewayMulticastDeregisteredGroupMembers
<a name="API_TransitGatewayMulticastDeregisteredGroupMembers"></a>

Describes the deregistered transit gateway multicast group members.

## Contents
<a name="API_TransitGatewayMulticastDeregisteredGroupMembers_Contents"></a>

 ** DeregisteredNetworkInterfaceIds.N **   
The network interface IDs of the deregistered members.  
Type: Array of strings  
Required: No

 ** groupIpAddress **   
The IP address assigned to the transit gateway multicast group.  
Type: String  
Required: No

 ** transitGatewayMulticastDomainId **   
The ID of the transit gateway multicast domain.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayMulticastDeregisteredGroupMembers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastDeregisteredGroupMembers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastDeregisteredGroupMembers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastDeregisteredGroupMembers) 

# TransitGatewayMulticastDeregisteredGroupSources
<a name="API_TransitGatewayMulticastDeregisteredGroupSources"></a>

Describes the deregistered transit gateway multicast group sources.

## Contents
<a name="API_TransitGatewayMulticastDeregisteredGroupSources_Contents"></a>

 ** DeregisteredNetworkInterfaceIds.N **   
The network interface IDs of the non-registered members.  
Type: Array of strings  
Required: No

 ** groupIpAddress **   
The IP address assigned to the transit gateway multicast group.  
Type: String  
Required: No

 ** transitGatewayMulticastDomainId **   
The ID of the transit gateway multicast domain.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayMulticastDeregisteredGroupSources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastDeregisteredGroupSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastDeregisteredGroupSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastDeregisteredGroupSources) 

# TransitGatewayMulticastDomain
<a name="API_TransitGatewayMulticastDomain"></a>

Describes the transit gateway multicast domain.

## Contents
<a name="API_TransitGatewayMulticastDomain_Contents"></a>

 ** creationTime **   
The time the transit gateway multicast domain was created.  
Type: Timestamp  
Required: No

 ** options **   
The options for the transit gateway multicast domain.  
Type: [TransitGatewayMulticastDomainOptions](API_TransitGatewayMulticastDomainOptions.md) object  
Required: No

 ** ownerId **   
 The ID of the AWS account that owns the transit gateway multicast domain.  
Type: String  
Required: No

 ** state **   
The state of the transit gateway multicast domain.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** TagSet.N **   
The tags for the transit gateway multicast domain.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

 ** transitGatewayMulticastDomainArn **   
The Amazon Resource Name (ARN) of the transit gateway multicast domain.  
Type: String  
Required: No

 ** transitGatewayMulticastDomainId **   
The ID of the transit gateway multicast domain.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayMulticastDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastDomain) 

# TransitGatewayMulticastDomainAssociation
<a name="API_TransitGatewayMulticastDomainAssociation"></a>

Describes the resources associated with the transit gateway multicast domain.

## Contents
<a name="API_TransitGatewayMulticastDomainAssociation_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceOwnerId **   
 The ID of the AWS account that owns the transit gateway multicast domain association resource.  
Type: String  
Required: No

 ** resourceType **   
The type of resource, for example a VPC attachment.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** subnet **   
The subnet associated with the transit gateway multicast domain.  
Type: [SubnetAssociation](API_SubnetAssociation.md) object  
Required: No

 ** transitGatewayAttachmentId **   
The ID of the transit gateway attachment.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayMulticastDomainAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastDomainAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastDomainAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastDomainAssociation) 

# TransitGatewayMulticastDomainAssociations
<a name="API_TransitGatewayMulticastDomainAssociations"></a>

Describes the multicast domain associations.

## Contents
<a name="API_TransitGatewayMulticastDomainAssociations_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceOwnerId **   
 The ID of the AWS account that owns the resource.  
Type: String  
Required: No

 ** resourceType **   
The type of resource, for example a VPC attachment.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** Subnets.N **   
The subnets associated with the multicast domain.  
Type: Array of [SubnetAssociation](API_SubnetAssociation.md) objects  
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

## See Also
<a name="API_TransitGatewayMulticastDomainAssociations_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastDomainAssociations) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastDomainAssociations) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastDomainAssociations) 

# TransitGatewayMulticastDomainOptions
<a name="API_TransitGatewayMulticastDomainOptions"></a>

Describes the options for a transit gateway multicast domain.

## Contents
<a name="API_TransitGatewayMulticastDomainOptions_Contents"></a>

 ** autoAcceptSharedAssociations **   
Indicates whether to automatically cross-account subnet associations that are associated with the transit gateway multicast domain.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** igmpv2Support **   
Indicates whether Internet Group Management Protocol (IGMP) version 2 is turned on for the transit gateway multicast domain.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** staticSourcesSupport **   
Indicates whether support for statically configuring transit gateway multicast group sources is turned on.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_TransitGatewayMulticastDomainOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastDomainOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastDomainOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastDomainOptions) 

# TransitGatewayMulticastGroup
<a name="API_TransitGatewayMulticastGroup"></a>

Describes the transit gateway multicast group resources.

## Contents
<a name="API_TransitGatewayMulticastGroup_Contents"></a>

 ** groupIpAddress **   
The IP address assigned to the transit gateway multicast group.  
Type: String  
Required: No

 ** groupMember **   
Indicates that the resource is a transit gateway multicast group member.  
Type: Boolean  
Required: No

 ** groupSource **   
Indicates that the resource is a transit gateway multicast group member.  
Type: Boolean  
Required: No

 ** memberType **   
The member type (for example, `static`).  
Type: String  
Valid Values: `static | igmp`   
Required: No

 ** networkInterfaceId **   
The ID of the transit gateway attachment.  
Type: String  
Required: No

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceOwnerId **   
 The ID of the AWS account that owns the transit gateway multicast domain group resource.  
Type: String  
Required: No

 ** resourceType **   
The type of resource, for example a VPC attachment.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** sourceType **   
The source type.  
Type: String  
Valid Values: `static | igmp`   
Required: No

 ** subnetId **   
The ID of the subnet.  
Type: String  
Required: No

 ** transitGatewayAttachmentId **   
The ID of the transit gateway attachment.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayMulticastGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastGroup) 

# TransitGatewayMulticastRegisteredGroupMembers
<a name="API_TransitGatewayMulticastRegisteredGroupMembers"></a>

Describes the registered transit gateway multicast group members.

## Contents
<a name="API_TransitGatewayMulticastRegisteredGroupMembers_Contents"></a>

 ** groupIpAddress **   
The IP address assigned to the transit gateway multicast group.  
Type: String  
Required: No

 ** RegisteredNetworkInterfaceIds.N **   
The ID of the registered network interfaces.  
Type: Array of strings  
Required: No

 ** transitGatewayMulticastDomainId **   
The ID of the transit gateway multicast domain.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayMulticastRegisteredGroupMembers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastRegisteredGroupMembers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastRegisteredGroupMembers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastRegisteredGroupMembers) 

# TransitGatewayMulticastRegisteredGroupSources
<a name="API_TransitGatewayMulticastRegisteredGroupSources"></a>

Describes the members registered with the transit gateway multicast group.

## Contents
<a name="API_TransitGatewayMulticastRegisteredGroupSources_Contents"></a>

 ** groupIpAddress **   
The IP address assigned to the transit gateway multicast group.  
Type: String  
Required: No

 ** RegisteredNetworkInterfaceIds.N **   
The IDs of the network interfaces members registered with the transit gateway multicast group.  
Type: Array of strings  
Required: No

 ** transitGatewayMulticastDomainId **   
The ID of the transit gateway multicast domain.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayMulticastRegisteredGroupSources_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayMulticastRegisteredGroupSources) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayMulticastRegisteredGroupSources) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayMulticastRegisteredGroupSources) 

# TransitGatewayOptions
<a name="API_TransitGatewayOptions"></a>

Describes the options for a transit gateway.

## Contents
<a name="API_TransitGatewayOptions_Contents"></a>

 ** amazonSideAsn **   
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs.  
Type: Long  
Required: No

 ** associationDefaultRouteTableId **   
The ID of the default association route table.  
Type: String  
Required: No

 ** autoAcceptSharedAttachments **   
Indicates whether attachment requests are automatically accepted.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** defaultRouteTableAssociation **   
Indicates whether resource attachments are automatically associated with the default association route table. Enabled by default. Either `defaultRouteTableAssociation` or `defaultRouteTablePropagation` must be set to `enable` for AWS Transit Gateway to create the default transit gateway route table.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** defaultRouteTablePropagation **   
Indicates whether resource attachments automatically propagate routes to the default propagation route table. Enabled by default. If `defaultRouteTablePropagation` is set to `enable`, AWS Transit Gateway creates the default transit gateway route table.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** dnsSupport **   
Indicates whether DNS support is enabled.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** encryptionSupport **   
Defines if the Transit Gateway supports VPC Encryption Control.  
Type: [EncryptionSupport](API_EncryptionSupport.md) object  
Required: No

 ** multicastSupport **   
Indicates whether multicast is enabled on the transit gateway  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** propagationDefaultRouteTableId **   
The ID of the default propagation route table.  
Type: String  
Required: No

 ** securityGroupReferencingSupport **   
Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.   
This option is disabled by default.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** TransitGatewayCidrBlocks.N **   
The transit gateway CIDR blocks.  
Type: Array of strings  
Required: No

 ** vpnEcmpSupport **   
Indicates whether Equal Cost Multipath Protocol support is enabled.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_TransitGatewayOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayOptions) 

# TransitGatewayPeeringAttachment
<a name="API_TransitGatewayPeeringAttachment"></a>

Describes the transit gateway peering attachment.

## Contents
<a name="API_TransitGatewayPeeringAttachment_Contents"></a>

 ** accepterTgwInfo **   
Information about the accepter transit gateway.  
Type: [PeeringTgwInfo](API_PeeringTgwInfo.md) object  
Required: No

 ** accepterTransitGatewayAttachmentId **   
The ID of the accepter transit gateway attachment.  
Type: String  
Required: No

 ** creationTime **   
The time the transit gateway peering attachment was created.  
Type: Timestamp  
Required: No

 ** options **   
Details about the transit gateway peering attachment.  
Type: [TransitGatewayPeeringAttachmentOptions](API_TransitGatewayPeeringAttachmentOptions.md) object  
Required: No

 ** requesterTgwInfo **   
Information about the requester transit gateway.  
Type: [PeeringTgwInfo](API_PeeringTgwInfo.md) object  
Required: No

 ** state **   
The state of the transit gateway peering attachment. Note that the `initiating` state has been deprecated.  
Type: String  
Valid Values: `initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing`   
Required: No

 ** status **   
The status of the transit gateway peering attachment.  
Type: [PeeringAttachmentStatus](API_PeeringAttachmentStatus.md) object  
Required: No

 ** TagSet.N **   
The tags for the transit gateway peering attachment.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayAttachmentId **   
The ID of the transit gateway peering attachment.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPeeringAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPeeringAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPeeringAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPeeringAttachment) 

# TransitGatewayPeeringAttachmentOptions
<a name="API_TransitGatewayPeeringAttachmentOptions"></a>

Describes dynamic routing for the transit gateway peering attachment.

## Contents
<a name="API_TransitGatewayPeeringAttachmentOptions_Contents"></a>

 ** dynamicRouting **   
Describes whether dynamic routing is enabled or disabled for the transit gateway peering attachment.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_TransitGatewayPeeringAttachmentOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPeeringAttachmentOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPeeringAttachmentOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPeeringAttachmentOptions) 

# TransitGatewayPolicyRule
<a name="API_TransitGatewayPolicyRule"></a>

Describes a rule associated with a transit gateway policy.

## Contents
<a name="API_TransitGatewayPolicyRule_Contents"></a>

 ** destinationCidrBlock **   
The destination CIDR block for the transit gateway policy rule.  
Type: String  
Required: No

 ** destinationPortRange **   
The port range for the transit gateway policy rule. Currently this is set to \$1 (all).  
Type: String  
Required: No

 ** metaData **   
The meta data tags used for the transit gateway policy rule.  
Type: [TransitGatewayPolicyRuleMetaData](API_TransitGatewayPolicyRuleMetaData.md) object  
Required: No

 ** protocol **   
The protocol used by the transit gateway policy rule.  
Type: String  
Required: No

 ** sourceCidrBlock **   
The source CIDR block for the transit gateway policy rule.  
Type: String  
Required: No

 ** sourcePortRange **   
The port range for the transit gateway policy rule. Currently this is set to \$1 (all).  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPolicyRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPolicyRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPolicyRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPolicyRule) 

# TransitGatewayPolicyRuleMetaData
<a name="API_TransitGatewayPolicyRuleMetaData"></a>

Describes the meta data tags associated with a transit gateway policy rule.

## Contents
<a name="API_TransitGatewayPolicyRuleMetaData_Contents"></a>

 ** metaDataKey **   
The key name for the transit gateway policy rule meta data tag.  
Type: String  
Required: No

 ** metaDataValue **   
The value of the key for the transit gateway policy rule meta data tag.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPolicyRuleMetaData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPolicyRuleMetaData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPolicyRuleMetaData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPolicyRuleMetaData) 

# TransitGatewayPolicyTable
<a name="API_TransitGatewayPolicyTable"></a>

Describes a transit gateway policy table.

## Contents
<a name="API_TransitGatewayPolicyTable_Contents"></a>

 ** creationTime **   
The timestamp when the transit gateway policy table was created.  
Type: Timestamp  
Required: No

 ** state **   
The state of the transit gateway policy table  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** TagSet.N **   
he key-value pairs associated with the transit gateway policy table.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

 ** transitGatewayPolicyTableId **   
The ID of the transit gateway policy table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPolicyTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPolicyTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPolicyTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPolicyTable) 

# TransitGatewayPolicyTableAssociation
<a name="API_TransitGatewayPolicyTableAssociation"></a>

Describes a transit gateway policy table association.

## Contents
<a name="API_TransitGatewayPolicyTableAssociation_Contents"></a>

 ** resourceId **   
The resource ID of the transit gateway attachment.  
Type: String  
Required: No

 ** resourceType **   
The resource type for the transit gateway policy table association.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** state **   
The state of the transit gateway policy table association.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated`   
Required: No

 ** transitGatewayAttachmentId **   
The ID of the transit gateway attachment.  
Type: String  
Required: No

 ** transitGatewayPolicyTableId **   
The ID of the transit gateway policy table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPolicyTableAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPolicyTableAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPolicyTableAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPolicyTableAssociation) 

# TransitGatewayPolicyTableEntry
<a name="API_TransitGatewayPolicyTableEntry"></a>

Describes a transit gateway policy table entry

## Contents
<a name="API_TransitGatewayPolicyTableEntry_Contents"></a>

 ** policyRule **   
The policy rule associated with the transit gateway policy table.  
Type: [TransitGatewayPolicyRule](API_TransitGatewayPolicyRule.md) object  
Required: No

 ** policyRuleNumber **   
The rule number for the transit gateway policy table entry.  
Type: String  
Required: No

 ** targetRouteTableId **   
The ID of the target route table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPolicyTableEntry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPolicyTableEntry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPolicyTableEntry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPolicyTableEntry) 

# TransitGatewayPrefixListAttachment
<a name="API_TransitGatewayPrefixListAttachment"></a>

Describes a transit gateway prefix list attachment.

## Contents
<a name="API_TransitGatewayPrefixListAttachment_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceType **   
The resource type. Note that the `tgw-peering` resource type has been deprecated.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

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

## See Also
<a name="API_TransitGatewayPrefixListAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPrefixListAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPrefixListAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPrefixListAttachment) 

# TransitGatewayPrefixListReference
<a name="API_TransitGatewayPrefixListReference"></a>

Describes a prefix list reference.

## Contents
<a name="API_TransitGatewayPrefixListReference_Contents"></a>

 ** blackhole **   
Indicates whether traffic that matches this route is dropped.  
Type: Boolean  
Required: No

 ** prefixListId **   
The ID of the prefix list.  
Type: String  
Required: No

 ** prefixListOwnerId **   
The ID of the prefix list owner.  
Type: String  
Required: No

 ** state **   
The state of the prefix list reference.  
Type: String  
Valid Values: `pending | available | modifying | deleting`   
Required: No

 ** transitGatewayAttachment **   
Information about the transit gateway attachment.  
Type: [TransitGatewayPrefixListAttachment](API_TransitGatewayPrefixListAttachment.md) object  
Required: No

 ** transitGatewayRouteTableId **   
The ID of the transit gateway route table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPrefixListReference_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPrefixListReference) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPrefixListReference) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPrefixListReference) 

# TransitGatewayPropagation
<a name="API_TransitGatewayPropagation"></a>

Describes route propagation.

## Contents
<a name="API_TransitGatewayPropagation_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceType **   
The resource type. Note that the `tgw-peering` resource type has been deprecated.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** state **   
The state.  
Type: String  
Valid Values: `enabling | enabled | disabling | disabled`   
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 transit gateway route table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayPropagation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayPropagation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayPropagation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayPropagation) 

# TransitGatewayRequestOptions
<a name="API_TransitGatewayRequestOptions"></a>

Describes the options for a transit gateway.

## Contents
<a name="API_TransitGatewayRequestOptions_Contents"></a>

 ** AmazonSideAsn **   
A private Autonomous System Number (ASN) for the Amazon side of a BGP session. The range is 64512 to 65534 for 16-bit ASNs and 4200000000 to 4294967294 for 32-bit ASNs. The default is `64512`.  
Type: Long  
Required: No

 ** AutoAcceptSharedAttachments **   
Enable or disable automatic acceptance of attachment requests. Disabled by default.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DefaultRouteTableAssociation **   
Enable or disable automatic association with the default association route table. Enabled by default.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DefaultRouteTablePropagation **   
Enable or disable automatic propagation of routes to the default propagation route table. Enabled by default.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** DnsSupport **   
Enable or disable DNS support. Enabled by default.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** MulticastSupport **   
Indicates whether multicast is enabled on the transit gateway  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** SecurityGroupReferencingSupport **   
Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.   
This option is disabled by default.  
For more information about security group referencing, see [Security group referencing](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#vpc-attachment-security) in the * AWS Transit Gateways Guide*.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** TransitGatewayCidrBlocks.N **   
One or more IPv4 or IPv6 CIDR blocks for the transit gateway. Must be a size /24 CIDR block or larger for IPv4, or a size /64 CIDR block or larger for IPv6.  
Type: Array of strings  
Required: No

 ** VpnEcmpSupport **   
Enable or disable Equal Cost Multipath Protocol support. Enabled by default.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_TransitGatewayRequestOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRequestOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRequestOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRequestOptions) 

# TransitGatewayRoute
<a name="API_TransitGatewayRoute"></a>

Describes a route for a transit gateway route table.

## Contents
<a name="API_TransitGatewayRoute_Contents"></a>

 ** destinationCidrBlock **   
The CIDR block used for destination matches.  
Type: String  
Required: No

 ** prefixListId **   
The ID of the prefix list used for destination matches.  
Type: String  
Required: No

 ** state **   
The state of the route.  
Type: String  
Valid Values: `pending | active | blackhole | deleting | deleted`   
Required: No

 ** TransitGatewayAttachments.N **   
The attachments.  
Type: Array of [TransitGatewayRouteAttachment](API_TransitGatewayRouteAttachment.md) objects  
Required: No

 ** transitGatewayRouteTableAnnouncementId **   
The ID of the transit gateway route table announcement.   
Type: String  
Required: No

 ** type **   
The route type.  
Type: String  
Valid Values: `static | propagated`   
Required: No

## See Also
<a name="API_TransitGatewayRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRoute) 

# TransitGatewayRouteAttachment
<a name="API_TransitGatewayRouteAttachment"></a>

Describes a route attachment.

## Contents
<a name="API_TransitGatewayRouteAttachment_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceType **   
The resource type. Note that the `tgw-peering` resource type has been deprecated.   
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

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

## See Also
<a name="API_TransitGatewayRouteAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRouteAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRouteAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRouteAttachment) 

# TransitGatewayRouteTable
<a name="API_TransitGatewayRouteTable"></a>

Describes a transit gateway route table.

## Contents
<a name="API_TransitGatewayRouteTable_Contents"></a>

 ** creationTime **   
The creation time.  
Type: Timestamp  
Required: No

 ** defaultAssociationRouteTable **   
Indicates whether this is the default association route table for the transit gateway.  
Type: Boolean  
Required: No

 ** defaultPropagationRouteTable **   
Indicates whether this is the default propagation route table for the transit gateway.  
Type: Boolean  
Required: No

 ** state **   
The state of the transit gateway route table.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** TagSet.N **   
Any tags assigned to the route table.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

 ** transitGatewayRouteTableId **   
The ID of the transit gateway route table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayRouteTable_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRouteTable) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRouteTable) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRouteTable) 

# TransitGatewayRouteTableAnnouncement
<a name="API_TransitGatewayRouteTableAnnouncement"></a>

Describes a transit gateway route table announcement.

## Contents
<a name="API_TransitGatewayRouteTableAnnouncement_Contents"></a>

 ** announcementDirection **   
The direction for the route table announcement.  
Type: String  
Valid Values: `outgoing | incoming`   
Required: No

 ** coreNetworkId **   
The ID of the core network for the transit gateway route table announcement.  
Type: String  
Required: No

 ** creationTime **   
The timestamp when the transit gateway route table announcement was created.  
Type: Timestamp  
Required: No

 ** peerCoreNetworkId **   
The ID of the core network ID for the peer.  
Type: String  
Required: No

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

 ** peerTransitGatewayId **   
The ID of the peer transit gateway.  
Type: String  
Required: No

 ** state **   
The state of the transit gateway announcement.  
Type: String  
Valid Values: `available | pending | failing | failed | deleting | deleted`   
Required: No

 ** TagSet.N **   
The key-value pairs associated with the route table announcement.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

 ** transitGatewayRouteTableAnnouncementId **   
The ID of the transit gateway route table announcement.  
Type: String  
Required: No

 ** transitGatewayRouteTableId **   
The ID of the transit gateway route table.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayRouteTableAnnouncement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRouteTableAnnouncement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRouteTableAnnouncement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRouteTableAnnouncement) 

# TransitGatewayRouteTableAssociation
<a name="API_TransitGatewayRouteTableAssociation"></a>

Describes an association between a route table and a resource attachment.

## Contents
<a name="API_TransitGatewayRouteTableAssociation_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceType **   
The resource type. Note that the `tgw-peering` resource type has been deprecated.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** state **   
The state of the association.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated`   
Required: No

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

## See Also
<a name="API_TransitGatewayRouteTableAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRouteTableAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRouteTableAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRouteTableAssociation) 

# TransitGatewayRouteTablePropagation
<a name="API_TransitGatewayRouteTablePropagation"></a>

Describes a route table propagation.

## Contents
<a name="API_TransitGatewayRouteTablePropagation_Contents"></a>

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

 ** resourceType **   
The type of resource. Note that the `tgw-peering` resource type has been deprecated.  
Type: String  
Valid Values: `vpc | vpn | vpn-concentrator | direct-connect-gateway | connect | peering | tgw-peering`   
Required: No

 ** state **   
The state of the resource.  
Type: String  
Valid Values: `enabling | enabled | disabling | disabled`   
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

## See Also
<a name="API_TransitGatewayRouteTablePropagation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRouteTablePropagation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRouteTablePropagation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRouteTablePropagation) 

# TransitGatewayRouteTableRoute
<a name="API_TransitGatewayRouteTableRoute"></a>

Describes a route in a transit gateway route table.

## Contents
<a name="API_TransitGatewayRouteTableRoute_Contents"></a>

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

 ** destinationCidr **   
The CIDR block used for destination matches.  
Type: String  
Required: No

 ** prefixListId **   
The ID of the prefix list.  
Type: String  
Required: No

 ** resourceId **   
The ID of the resource for the route attachment.  
Type: String  
Required: No

 ** resourceType **   
The resource type for the route attachment.  
Type: String  
Required: No

 ** routeOrigin **   
The route origin. The following are the possible values:  
+ static
+ propagated
Type: String  
Required: No

 ** state **   
The state of the route.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayRouteTableRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayRouteTableRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayRouteTableRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayRouteTableRoute) 

# TransitGatewayVpcAttachment
<a name="API_TransitGatewayVpcAttachment"></a>

Describes a VPC attachment.

## Contents
<a name="API_TransitGatewayVpcAttachment_Contents"></a>

 ** creationTime **   
The creation time.  
Type: Timestamp  
Required: No

 ** options **   
The VPC attachment options.  
Type: [TransitGatewayVpcAttachmentOptions](API_TransitGatewayVpcAttachmentOptions.md) object  
Required: No

 ** state **   
The state of the VPC attachment. Note that the `initiating` state has been deprecated.  
Type: String  
Valid Values: `initiating | initiatingRequest | pendingAcceptance | rollingBack | pending | available | modifying | deleting | deleted | failed | rejected | rejecting | failing`   
Required: No

 ** SubnetIds.N **   
The IDs of the subnets.  
Type: Array of strings  
Required: No

 ** TagSet.N **   
The tags for the VPC attachment.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

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

 ** transitGatewayId **   
The ID of the transit gateway.  
Type: String  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

 ** vpcOwnerId **   
The ID of the AWS account that owns the VPC.  
Type: String  
Required: No

## See Also
<a name="API_TransitGatewayVpcAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayVpcAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayVpcAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayVpcAttachment) 

# TransitGatewayVpcAttachmentOptions
<a name="API_TransitGatewayVpcAttachmentOptions"></a>

Describes the VPC attachment options.

## Contents
<a name="API_TransitGatewayVpcAttachmentOptions_Contents"></a>

 ** applianceModeSupport **   
Indicates whether appliance mode support is enabled.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** dnsSupport **   
Indicates whether DNS support is enabled.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** ipv6Support **   
Indicates whether IPv6 support is disabled.  
Type: String  
Valid Values: `enable | disable`   
Required: No

 ** securityGroupReferencingSupport **   
Enables you to reference a security group across VPCs attached to a transit gateway to simplify security group management.  
This option is enabled by default.  
For more information about security group referencing, see [Security group referencing](https://docs.aws.amazon.com/vpc/latest/tgw/tgw-vpc-attachments.html#vpc-attachment-security) in the * AWS Transit Gateways Guide*.  
Type: String  
Valid Values: `enable | disable`   
Required: No

## See Also
<a name="API_TransitGatewayVpcAttachmentOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TransitGatewayVpcAttachmentOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TransitGatewayVpcAttachmentOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TransitGatewayVpcAttachmentOptions) 

# TrunkInterfaceAssociation
<a name="API_TrunkInterfaceAssociation"></a>

Information about an association between a branch network interface with a trunk network interface.

## Contents
<a name="API_TrunkInterfaceAssociation_Contents"></a>

 ** associationId **   
The ID of the association.  
Type: String  
Required: No

 ** branchInterfaceId **   
The ID of the branch network interface.  
Type: String  
Required: No

 ** greKey **   
The application key when you use the GRE protocol.  
Type: Integer  
Required: No

 ** interfaceProtocol **   
The interface protocol. Valid values are `VLAN` and `GRE`.  
Type: String  
Valid Values: `VLAN | GRE`   
Required: No

 ** TagSet.N **   
The tags for the trunk interface association.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trunkInterfaceId **   
The ID of the trunk network interface.  
Type: String  
Required: No

 ** vlanId **   
The ID of the VLAN when you use the VLAN protocol.  
Type: Integer  
Required: No

## See Also
<a name="API_TrunkInterfaceAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TrunkInterfaceAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TrunkInterfaceAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TrunkInterfaceAssociation) 

# TunnelOption
<a name="API_TunnelOption"></a>

The VPN tunnel options.

## Contents
<a name="API_TunnelOption_Contents"></a>

 ** dpdTimeoutAction **   
The action to take after a DPD timeout occurs.  
Type: String  
Required: No

 ** dpdTimeoutSeconds **   
The number of seconds after which a DPD timeout occurs.  
Type: Integer  
Required: No

 ** enableTunnelLifecycleControl **   
Status of tunnel endpoint lifecycle control feature.  
Type: Boolean  
Required: No

 ** IkeVersionSet.N **   
The IKE versions that are permitted for the VPN tunnel.  
Type: Array of [IKEVersionsListValue](API_IKEVersionsListValue.md) objects  
Required: No

 ** logOptions **   
Options for logging VPN tunnel activity.  
Type: [VpnTunnelLogOptions](API_VpnTunnelLogOptions.md) object  
Required: No

 ** outsideIpAddress **   
The external IP address of the VPN tunnel.  
Type: String  
Required: No

 ** Phase1DHGroupNumberSet.N **   
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 1 IKE negotiations.  
Type: Array of [Phase1DHGroupNumbersListValue](API_Phase1DHGroupNumbersListValue.md) objects  
Required: No

 ** Phase1EncryptionAlgorithmSet.N **   
The permitted encryption algorithms for the VPN tunnel for phase 1 IKE negotiations.  
Type: Array of [Phase1EncryptionAlgorithmsListValue](API_Phase1EncryptionAlgorithmsListValue.md) objects  
Required: No

 ** Phase1IntegrityAlgorithmSet.N **   
The permitted integrity algorithms for the VPN tunnel for phase 1 IKE negotiations.  
Type: Array of [Phase1IntegrityAlgorithmsListValue](API_Phase1IntegrityAlgorithmsListValue.md) objects  
Required: No

 ** phase1LifetimeSeconds **   
The lifetime for phase 1 of the IKE negotiation, in seconds.  
Type: Integer  
Required: No

 ** Phase2DHGroupNumberSet.N **   
The permitted Diffie-Hellman group numbers for the VPN tunnel for phase 2 IKE negotiations.  
Type: Array of [Phase2DHGroupNumbersListValue](API_Phase2DHGroupNumbersListValue.md) objects  
Required: No

 ** Phase2EncryptionAlgorithmSet.N **   
The permitted encryption algorithms for the VPN tunnel for phase 2 IKE negotiations.  
Type: Array of [Phase2EncryptionAlgorithmsListValue](API_Phase2EncryptionAlgorithmsListValue.md) objects  
Required: No

 ** Phase2IntegrityAlgorithmSet.N **   
The permitted integrity algorithms for the VPN tunnel for phase 2 IKE negotiations.  
Type: Array of [Phase2IntegrityAlgorithmsListValue](API_Phase2IntegrityAlgorithmsListValue.md) objects  
Required: No

 ** phase2LifetimeSeconds **   
The lifetime for phase 2 of the IKE negotiation, in seconds.  
Type: Integer  
Required: No

 ** preSharedKey **   
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and the customer gateway.  
Type: String  
Required: No

 ** rekeyFuzzPercentage **   
The percentage of the rekey window determined by `RekeyMarginTimeSeconds` during which the rekey time is randomly selected.  
Type: Integer  
Required: No

 ** rekeyMarginTimeSeconds **   
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey.  
Type: Integer  
Required: No

 ** replayWindowSize **   
The number of packets in an IKE replay window.  
Type: Integer  
Required: No

 ** startupAction **   
The action to take when the establishing the VPN tunnels for a VPN connection.  
Type: String  
Required: No

 ** tunnelInsideCidr **   
The range of inside IPv4 addresses for the tunnel.  
Type: String  
Required: No

 ** tunnelInsideIpv6Cidr **   
The range of inside IPv6 addresses for the tunnel.  
Type: String  
Required: No

## See Also
<a name="API_TunnelOption_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/TunnelOption) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/TunnelOption) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/TunnelOption) 

# UnsuccessfulInstanceCreditSpecificationItem
<a name="API_UnsuccessfulInstanceCreditSpecificationItem"></a>

Describes the burstable performance instance whose credit option for CPU usage was not modified.

## Contents
<a name="API_UnsuccessfulInstanceCreditSpecificationItem_Contents"></a>

 ** error **   
The applicable error for the burstable performance instance whose credit option for CPU usage was not modified.  
Type: [UnsuccessfulInstanceCreditSpecificationItemError](API_UnsuccessfulInstanceCreditSpecificationItemError.md) object  
Required: No

 ** instanceId **   
The ID of the instance.  
Type: String  
Required: No

## See Also
<a name="API_UnsuccessfulInstanceCreditSpecificationItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnsuccessfulInstanceCreditSpecificationItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnsuccessfulInstanceCreditSpecificationItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnsuccessfulInstanceCreditSpecificationItem) 

# UnsuccessfulInstanceCreditSpecificationItemError
<a name="API_UnsuccessfulInstanceCreditSpecificationItemError"></a>

Information about the error for the burstable performance instance whose credit option for CPU usage was not modified.

## Contents
<a name="API_UnsuccessfulInstanceCreditSpecificationItemError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Valid Values: `InvalidInstanceID.Malformed | InvalidInstanceID.NotFound | IncorrectInstanceState | InstanceCreditSpecification.NotSupported`   
Required: No

 ** message **   
The applicable error message.  
Type: String  
Required: No

## See Also
<a name="API_UnsuccessfulInstanceCreditSpecificationItemError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnsuccessfulInstanceCreditSpecificationItemError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnsuccessfulInstanceCreditSpecificationItemError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnsuccessfulInstanceCreditSpecificationItemError) 

# UnsuccessfulItem
<a name="API_UnsuccessfulItem"></a>

Information about items that were not successfully processed in a batch call.

## Contents
<a name="API_UnsuccessfulItem_Contents"></a>

 ** error **   
Information about the error.  
Type: [UnsuccessfulItemError](API_UnsuccessfulItemError.md) object  
Required: No

 ** resourceId **   
The ID of the resource.  
Type: String  
Required: No

## See Also
<a name="API_UnsuccessfulItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnsuccessfulItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnsuccessfulItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnsuccessfulItem) 

# UnsuccessfulItemError
<a name="API_UnsuccessfulItemError"></a>

Information about the error that occurred. For more information about errors, see [Error codes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html).

## Contents
<a name="API_UnsuccessfulItemError_Contents"></a>

 ** code **   
The error code.  
Type: String  
Required: No

 ** message **   
The error message accompanying the error code.  
Type: String  
Required: No

## See Also
<a name="API_UnsuccessfulItemError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UnsuccessfulItemError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UnsuccessfulItemError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UnsuccessfulItemError) 

# UserBucket
<a name="API_UserBucket"></a>

Describes the Amazon S3 bucket for the disk image.

## Contents
<a name="API_UserBucket_Contents"></a>

 ** S3Bucket **   
The name of the Amazon S3 bucket where the disk image is located.  
Type: String  
Required: No

 ** S3Key **   
The file name of the disk image.  
Type: String  
Required: No

## See Also
<a name="API_UserBucket_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UserBucket) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UserBucket) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UserBucket) 

# UserBucketDetails
<a name="API_UserBucketDetails"></a>

Describes the Amazon S3 bucket for the disk image.

## Contents
<a name="API_UserBucketDetails_Contents"></a>

 ** s3Bucket **   
The Amazon S3 bucket from which the disk image was created.  
Type: String  
Required: No

 ** s3Key **   
The file name of the disk image.  
Type: String  
Required: No

## See Also
<a name="API_UserBucketDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UserBucketDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UserBucketDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UserBucketDetails) 

# UserData
<a name="API_UserData"></a>

Describes the user data for an instance.

## Contents
<a name="API_UserData_Contents"></a>

 ** Data **   
The user data. If you are using an AWS SDK or command line tool, Base64-encoding is performed for you, and you can load the text from a file. Otherwise, you must provide Base64-encoded text.  
Type: String  
Required: No

## See Also
<a name="API_UserData_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UserData) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UserData) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UserData) 

# UserIdGroupPair
<a name="API_UserIdGroupPair"></a>

Describes a security group and AWS account ID pair.

## Contents
<a name="API_UserIdGroupPair_Contents"></a>

 ** Description ** (request), ** description ** (response)  
A description for the security group rule that references this user ID group pair.  
Constraints: Up to 255 characters in length. Allowed characters are a-z, A-Z, 0-9, spaces, and .\$1-:/()\$1,@[]\$1=;\$1\$1\$1\$1\$1  
Type: String  
Required: No

 ** GroupId ** (request), ** groupId ** (response)  
The ID of the security group.  
Type: String  
Required: No

 ** GroupName ** (request), ** groupName ** (response)  
[Default VPC] The name of the security group. For a security group in a nondefault VPC, use the security group ID.   
For a referenced security group in another VPC, this value is not returned if the referenced security group is deleted.  
Type: String  
Required: No

 ** PeeringStatus ** (request), ** peeringStatus ** (response)  
The status of a VPC peering connection, if applicable.  
Type: String  
Required: No

 ** UserId ** (request), ** userId ** (response)  
The ID of an AWS account.  
For a referenced security group in another VPC, the account ID of the referenced security group is returned in the response. If the referenced security group is deleted, this value is not returned.  
Type: String  
Required: No

 ** VpcId ** (request), ** vpcId ** (response)  
The ID of the VPC for the referenced security group, if applicable.  
Type: String  
Required: No

 ** VpcPeeringConnectionId ** (request), ** vpcPeeringConnectionId ** (response)  
The ID of the VPC peering connection, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_UserIdGroupPair_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/UserIdGroupPair) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/UserIdGroupPair) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/UserIdGroupPair) 

# ValidationError
<a name="API_ValidationError"></a>

The error code and error message that is returned for a parameter or parameter combination that is not valid when a new launch template or new version of a launch template is created.

## Contents
<a name="API_ValidationError_Contents"></a>

 ** code **   
The error code that indicates why the parameter or parameter combination is not valid. For more information about error codes, see [Error codes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html).  
Type: String  
Required: No

 ** message **   
The error message that describes why the parameter or parameter combination is not valid. For more information about error messages, see [Error codes](https://docs.aws.amazon.com/AWSEC2/latest/APIReference/errors-overview.html).  
Type: String  
Required: No

## See Also
<a name="API_ValidationError_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ValidationError) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ValidationError) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ValidationError) 

# ValidationWarning
<a name="API_ValidationWarning"></a>

The error codes and error messages that are returned for the parameters or parameter combinations that are not valid when a new launch template or new version of a launch template is created.

## Contents
<a name="API_ValidationWarning_Contents"></a>

 ** ErrorSet.N **   
The error codes and error messages.  
Type: Array of [ValidationError](API_ValidationError.md) objects  
Required: No

## See Also
<a name="API_ValidationWarning_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/ValidationWarning) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/ValidationWarning) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/ValidationWarning) 

# VCpuCountRange
<a name="API_VCpuCountRange"></a>

The minimum and maximum number of vCPUs.

## Contents
<a name="API_VCpuCountRange_Contents"></a>

 ** Max ** (request), ** max ** (response)  
The maximum number of vCPUs. If this parameter is not specified, there is no maximum limit.  
Type: Integer  
Required: No

 ** Min ** (request), ** min ** (response)  
The minimum number of vCPUs. If the value is `0`, there is no minimum limit.  
Type: Integer  
Required: No

## See Also
<a name="API_VCpuCountRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VCpuCountRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VCpuCountRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VCpuCountRange) 

# VCpuCountRangeRequest
<a name="API_VCpuCountRangeRequest"></a>

The minimum and maximum number of vCPUs.

## Contents
<a name="API_VCpuCountRangeRequest_Contents"></a>

 ** Min **   
The minimum number of vCPUs. To specify no minimum limit, specify `0`.  
Type: Integer  
Required: Yes

 ** Max **   
The maximum number of vCPUs. To specify no maximum limit, omit this parameter.  
Type: Integer  
Required: No

## See Also
<a name="API_VCpuCountRangeRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VCpuCountRangeRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VCpuCountRangeRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VCpuCountRangeRequest) 

# VCpuInfo
<a name="API_VCpuInfo"></a>

Describes the vCPU configurations for the instance type.

## Contents
<a name="API_VCpuInfo_Contents"></a>

 ** defaultCores **   
The default number of cores for the instance type.  
Type: Integer  
Required: No

 ** defaultThreadsPerCore **   
The default number of threads per core for the instance type.  
Type: Integer  
Required: No

 ** defaultVCpus **   
The default number of vCPUs for the instance type.  
Type: Integer  
Required: No

 ** ValidCores.N **   
The valid number of cores that can be configured for the instance type.  
Type: Array of integers  
Required: No

 ** ValidThreadsPerCore.N **   
The valid number of threads per core that can be configured for the instance type.  
Type: Array of integers  
Required: No

## See Also
<a name="API_VCpuInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VCpuInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VCpuInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VCpuInfo) 

# VerifiedAccessEndpoint
<a name="API_VerifiedAccessEndpoint"></a>

An AWS Verified Access endpoint specifies the application that AWS Verified Access provides access to. It must be attached to an AWS Verified Access group. An AWS Verified Access endpoint must also have an attached access policy before you attached it to a group.

## Contents
<a name="API_VerifiedAccessEndpoint_Contents"></a>

 ** applicationDomain **   
The DNS name for users to reach your application.  
Type: String  
Required: No

 ** attachmentType **   
The type of attachment used to provide connectivity between the AWS Verified Access endpoint and the application.  
Type: String  
Valid Values: `vpc`   
Required: No

 ** cidrOptions **   
The options for a CIDR endpoint.  
Type: [VerifiedAccessEndpointCidrOptions](API_VerifiedAccessEndpointCidrOptions.md) object  
Required: No

 ** creationTime **   
The creation time.  
Type: String  
Required: No

 ** deletionTime **   
The deletion time.  
Type: String  
Required: No

 ** description **   
A description for the AWS Verified Access endpoint.  
Type: String  
Required: No

 ** deviceValidationDomain **   
Returned if endpoint has a device trust provider attached.  
Type: String  
Required: No

 ** domainCertificateArn **   
The ARN of a public TLS/SSL certificate imported into or created with ACM.  
Type: String  
Required: No

 ** endpointDomain **   
A DNS name that is generated for the endpoint.  
Type: String  
Required: No

 ** endpointType **   
The type of AWS Verified Access endpoint. Incoming application requests will be sent to an IP address, load balancer or a network interface depending on the endpoint type specified.  
Type: String  
Valid Values: `load-balancer | network-interface | rds | cidr`   
Required: No

 ** lastUpdatedTime **   
The last updated time.  
Type: String  
Required: No

 ** loadBalancerOptions **   
The load balancer details if creating the AWS Verified Access endpoint as `load-balancer`type.  
Type: [VerifiedAccessEndpointLoadBalancerOptions](API_VerifiedAccessEndpointLoadBalancerOptions.md) object  
Required: No

 ** networkInterfaceOptions **   
The options for network-interface type endpoint.  
Type: [VerifiedAccessEndpointEniOptions](API_VerifiedAccessEndpointEniOptions.md) object  
Required: No

 ** rdsOptions **   
The options for an RDS endpoint.  
Type: [VerifiedAccessEndpointRdsOptions](API_VerifiedAccessEndpointRdsOptions.md) object  
Required: No

 ** SecurityGroupIdSet.N **   
The IDs of the security groups for the endpoint.  
Type: Array of strings  
Required: No

 ** sseSpecification **   
The options in use for server side encryption.  
Type: [VerifiedAccessSseSpecificationResponse](API_VerifiedAccessSseSpecificationResponse.md) object  
Required: No

 ** status **   
The endpoint status.  
Type: [VerifiedAccessEndpointStatus](API_VerifiedAccessEndpointStatus.md) object  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** verifiedAccessEndpointId **   
The ID of the AWS Verified Access endpoint.  
Type: String  
Required: No

 ** verifiedAccessGroupId **   
The ID of the AWS Verified Access group.  
Type: String  
Required: No

 ** verifiedAccessInstanceId **   
The ID of the AWS Verified Access instance.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpoint) 

# VerifiedAccessEndpointCidrOptions
<a name="API_VerifiedAccessEndpointCidrOptions"></a>

Describes the CIDR options for a Verified Access endpoint.

## Contents
<a name="API_VerifiedAccessEndpointCidrOptions_Contents"></a>

 ** cidr **   
The CIDR.  
Type: String  
Required: No

 ** PortRangeSet.N **   
The port ranges.  
Type: Array of [VerifiedAccessEndpointPortRange](API_VerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** protocol **   
The protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

 ** SubnetIdSet.N **   
The IDs of the subnets.  
Type: Array of strings  
Required: No

## See Also
<a name="API_VerifiedAccessEndpointCidrOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpointCidrOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpointCidrOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpointCidrOptions) 

# VerifiedAccessEndpointEniOptions
<a name="API_VerifiedAccessEndpointEniOptions"></a>

Options for a network-interface type endpoint.

## Contents
<a name="API_VerifiedAccessEndpointEniOptions_Contents"></a>

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

 ** port **   
The IP port number.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** PortRangeSet.N **   
The port ranges.  
Type: Array of [VerifiedAccessEndpointPortRange](API_VerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** protocol **   
The IP protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

## See Also
<a name="API_VerifiedAccessEndpointEniOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpointEniOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpointEniOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpointEniOptions) 

# VerifiedAccessEndpointLoadBalancerOptions
<a name="API_VerifiedAccessEndpointLoadBalancerOptions"></a>

Describes a load balancer when creating an AWS Verified Access endpoint using the `load-balancer` type.

## Contents
<a name="API_VerifiedAccessEndpointLoadBalancerOptions_Contents"></a>

 ** loadBalancerArn **   
The ARN of the load balancer.  
Type: String  
Required: No

 ** port **   
The IP port number.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** PortRangeSet.N **   
The port ranges.  
Type: Array of [VerifiedAccessEndpointPortRange](API_VerifiedAccessEndpointPortRange.md) objects  
Required: No

 ** protocol **   
The IP protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

 ** SubnetIdSet.N **   
The IDs of the subnets.  
Type: Array of strings  
Required: No

## See Also
<a name="API_VerifiedAccessEndpointLoadBalancerOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpointLoadBalancerOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpointLoadBalancerOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpointLoadBalancerOptions) 

# VerifiedAccessEndpointPortRange
<a name="API_VerifiedAccessEndpointPortRange"></a>

Describes a port range.

## Contents
<a name="API_VerifiedAccessEndpointPortRange_Contents"></a>

 ** fromPort **   
The start of the port range.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** toPort **   
The end of the port range.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

## See Also
<a name="API_VerifiedAccessEndpointPortRange_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpointPortRange) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpointPortRange) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpointPortRange) 

# VerifiedAccessEndpointRdsOptions
<a name="API_VerifiedAccessEndpointRdsOptions"></a>

Describes the RDS options for a Verified Access endpoint.

## Contents
<a name="API_VerifiedAccessEndpointRdsOptions_Contents"></a>

 ** port **   
The port.  
Type: Integer  
Valid Range: Minimum value of 1. Maximum value of 65535.  
Required: No

 ** protocol **   
The protocol.  
Type: String  
Valid Values: `http | https | tcp`   
Required: No

 ** rdsDbClusterArn **   
The ARN of the DB cluster.  
Type: String  
Required: No

 ** rdsDbInstanceArn **   
The ARN of the RDS instance.  
Type: String  
Required: No

 ** rdsDbProxyArn **   
The ARN of the RDS proxy.  
Type: String  
Required: No

 ** rdsEndpoint **   
The RDS endpoint.  
Type: String  
Required: No

 ** SubnetIdSet.N **   
The IDs of the subnets.  
Type: Array of strings  
Required: No

## See Also
<a name="API_VerifiedAccessEndpointRdsOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpointRdsOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpointRdsOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpointRdsOptions) 

# VerifiedAccessEndpointStatus
<a name="API_VerifiedAccessEndpointStatus"></a>

Describes the status of a Verified Access endpoint.

## Contents
<a name="API_VerifiedAccessEndpointStatus_Contents"></a>

 ** code **   
The status code of the Verified Access endpoint.  
Type: String  
Valid Values: `pending | active | updating | deleting | deleted`   
Required: No

 ** message **   
The status message of the Verified Access endpoint.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessEndpointStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpointStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpointStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpointStatus) 

# VerifiedAccessEndpointTarget
<a name="API_VerifiedAccessEndpointTarget"></a>

Describes the targets for the specified Verified Access endpoint.

## Contents
<a name="API_VerifiedAccessEndpointTarget_Contents"></a>

 ** verifiedAccessEndpointId **   
The ID of the Verified Access endpoint.  
Type: String  
Required: No

 ** verifiedAccessEndpointTargetDns **   
The DNS name of the target.  
Type: String  
Required: No

 ** verifiedAccessEndpointTargetIpAddress **   
The IP address of the target.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessEndpointTarget_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessEndpointTarget) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessEndpointTarget) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessEndpointTarget) 

# VerifiedAccessGroup
<a name="API_VerifiedAccessGroup"></a>

Describes a Verified Access group.

## Contents
<a name="API_VerifiedAccessGroup_Contents"></a>

 ** creationTime **   
The creation time.  
Type: String  
Required: No

 ** deletionTime **   
The deletion time.  
Type: String  
Required: No

 ** description **   
A description for the AWS Verified Access group.  
Type: String  
Required: No

 ** lastUpdatedTime **   
The last updated time.  
Type: String  
Required: No

 ** owner **   
The AWS account number that owns the group.  
Type: String  
Required: No

 ** sseSpecification **   
The options in use for server side encryption.  
Type: [VerifiedAccessSseSpecificationResponse](API_VerifiedAccessSseSpecificationResponse.md) object  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** verifiedAccessGroupArn **   
The ARN of the Verified Access group.  
Type: String  
Required: No

 ** verifiedAccessGroupId **   
The ID of the Verified Access group.  
Type: String  
Required: No

 ** verifiedAccessInstanceId **   
The ID of the AWS Verified Access instance.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessGroup) 

# VerifiedAccessInstance
<a name="API_VerifiedAccessInstance"></a>

Describes a Verified Access instance.

## Contents
<a name="API_VerifiedAccessInstance_Contents"></a>

 ** cidrEndpointsCustomSubDomain **   
The custom subdomain.  
Type: [VerifiedAccessInstanceCustomSubDomain](API_VerifiedAccessInstanceCustomSubDomain.md) object  
Required: No

 ** creationTime **   
The creation time.  
Type: String  
Required: No

 ** description **   
A description for the AWS Verified Access instance.  
Type: String  
Required: No

 ** fipsEnabled **   
Indicates whether support for Federal Information Processing Standards (FIPS) is enabled on the instance.  
Type: Boolean  
Required: No

 ** lastUpdatedTime **   
The last updated time.  
Type: String  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** verifiedAccessInstanceId **   
The ID of the AWS Verified Access instance.  
Type: String  
Required: No

 ** VerifiedAccessTrustProviderSet.N **   
The IDs of the AWS Verified Access trust providers.  
Type: Array of [VerifiedAccessTrustProviderCondensed](API_VerifiedAccessTrustProviderCondensed.md) objects  
Required: No

## See Also
<a name="API_VerifiedAccessInstance_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessInstance) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessInstance) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessInstance) 

# VerifiedAccessInstanceCustomSubDomain
<a name="API_VerifiedAccessInstanceCustomSubDomain"></a>

Describes a custom subdomain for a network CIDR endpoint for Verified Access.

## Contents
<a name="API_VerifiedAccessInstanceCustomSubDomain_Contents"></a>

 ** NameserverSet.N **   
The name servers.  
Type: Array of strings  
Required: No

 ** subDomain **   
The subdomain.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessInstanceCustomSubDomain_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessInstanceCustomSubDomain) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessInstanceCustomSubDomain) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessInstanceCustomSubDomain) 

# VerifiedAccessInstanceLoggingConfiguration
<a name="API_VerifiedAccessInstanceLoggingConfiguration"></a>

Describes logging options for an AWS Verified Access instance.

## Contents
<a name="API_VerifiedAccessInstanceLoggingConfiguration_Contents"></a>

 ** accessLogs **   
Details about the logging options.  
Type: [VerifiedAccessLogs](API_VerifiedAccessLogs.md) object  
Required: No

 ** verifiedAccessInstanceId **   
The ID of the AWS Verified Access instance.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessInstanceLoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessInstanceLoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessInstanceLoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessInstanceLoggingConfiguration) 

# VerifiedAccessInstanceOpenVpnClientConfiguration
<a name="API_VerifiedAccessInstanceOpenVpnClientConfiguration"></a>

Describes a set of routes.

## Contents
<a name="API_VerifiedAccessInstanceOpenVpnClientConfiguration_Contents"></a>

 ** config **   
The base64-encoded Open VPN client configuration.  
Type: String  
Required: No

 ** RouteSet.N **   
The routes.  
Type: Array of [VerifiedAccessInstanceOpenVpnClientConfigurationRoute](API_VerifiedAccessInstanceOpenVpnClientConfigurationRoute.md) objects  
Required: No

## See Also
<a name="API_VerifiedAccessInstanceOpenVpnClientConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessInstanceOpenVpnClientConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessInstanceOpenVpnClientConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessInstanceOpenVpnClientConfiguration) 

# VerifiedAccessInstanceOpenVpnClientConfigurationRoute
<a name="API_VerifiedAccessInstanceOpenVpnClientConfigurationRoute"></a>

Describes a route.

## Contents
<a name="API_VerifiedAccessInstanceOpenVpnClientConfigurationRoute_Contents"></a>

 ** cidr **   
The CIDR block.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessInstanceOpenVpnClientConfigurationRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessInstanceOpenVpnClientConfigurationRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessInstanceOpenVpnClientConfigurationRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessInstanceOpenVpnClientConfigurationRoute) 

# VerifiedAccessInstanceUserTrustProviderClientConfiguration
<a name="API_VerifiedAccessInstanceUserTrustProviderClientConfiguration"></a>

Describes the trust provider.

## Contents
<a name="API_VerifiedAccessInstanceUserTrustProviderClientConfiguration_Contents"></a>

 ** authorizationEndpoint **   
The authorization endpoint of the IdP.  
Type: String  
Required: No

 ** clientId **   
The OAuth 2.0 client identifier.  
Type: String  
Required: No

 ** clientSecret **   
The OAuth 2.0 client secret.  
Type: String  
Required: No

 ** issuer **   
The OIDC issuer identifier of the IdP.  
Type: String  
Required: No

 ** pkceEnabled **   
Indicates whether Proof of Key Code Exchange (PKCE) is enabled.  
Type: Boolean  
Required: No

 ** publicSigningKeyEndpoint **   
The public signing key endpoint.  
Type: String  
Required: No

 ** scopes **   
The set of user claims to be requested from the IdP.  
Type: String  
Required: No

 ** tokenEndpoint **   
The token endpoint of the IdP.  
Type: String  
Required: No

 ** type **   
The trust provider type.  
Type: String  
Valid Values: `iam-identity-center | oidc`   
Required: No

 ** userInfoEndpoint **   
The user info endpoint of the IdP.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessInstanceUserTrustProviderClientConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessInstanceUserTrustProviderClientConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessInstanceUserTrustProviderClientConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessInstanceUserTrustProviderClientConfiguration) 

# VerifiedAccessLogCloudWatchLogsDestination
<a name="API_VerifiedAccessLogCloudWatchLogsDestination"></a>

Options for CloudWatch Logs as a logging destination.

## Contents
<a name="API_VerifiedAccessLogCloudWatchLogsDestination_Contents"></a>

 ** deliveryStatus **   
The delivery status for access logs.  
Type: [VerifiedAccessLogDeliveryStatus](API_VerifiedAccessLogDeliveryStatus.md) object  
Required: No

 ** enabled **   
Indicates whether logging is enabled.  
Type: Boolean  
Required: No

 ** logGroup **   
The ID of the CloudWatch Logs log group.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessLogCloudWatchLogsDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogCloudWatchLogsDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogCloudWatchLogsDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogCloudWatchLogsDestination) 

# VerifiedAccessLogCloudWatchLogsDestinationOptions
<a name="API_VerifiedAccessLogCloudWatchLogsDestinationOptions"></a>

Options for CloudWatch Logs as a logging destination.

## Contents
<a name="API_VerifiedAccessLogCloudWatchLogsDestinationOptions_Contents"></a>

 ** Enabled **   
Indicates whether logging is enabled.  
Type: Boolean  
Required: Yes

 ** LogGroup **   
The ID of the CloudWatch Logs log group.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessLogCloudWatchLogsDestinationOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogCloudWatchLogsDestinationOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogCloudWatchLogsDestinationOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogCloudWatchLogsDestinationOptions) 

# VerifiedAccessLogDeliveryStatus
<a name="API_VerifiedAccessLogDeliveryStatus"></a>

Describes a log delivery status.

## Contents
<a name="API_VerifiedAccessLogDeliveryStatus_Contents"></a>

 ** code **   
The status code.  
Type: String  
Valid Values: `success | failed`   
Required: No

 ** message **   
The status message.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessLogDeliveryStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogDeliveryStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogDeliveryStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogDeliveryStatus) 

# VerifiedAccessLogKinesisDataFirehoseDestination
<a name="API_VerifiedAccessLogKinesisDataFirehoseDestination"></a>

Options for Kinesis as a logging destination.

## Contents
<a name="API_VerifiedAccessLogKinesisDataFirehoseDestination_Contents"></a>

 ** deliveryStatus **   
The delivery status.  
Type: [VerifiedAccessLogDeliveryStatus](API_VerifiedAccessLogDeliveryStatus.md) object  
Required: No

 ** deliveryStream **   
The ID of the delivery stream.  
Type: String  
Required: No

 ** enabled **   
Indicates whether logging is enabled.  
Type: Boolean  
Required: No

## See Also
<a name="API_VerifiedAccessLogKinesisDataFirehoseDestination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogKinesisDataFirehoseDestination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogKinesisDataFirehoseDestination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogKinesisDataFirehoseDestination) 

# VerifiedAccessLogKinesisDataFirehoseDestinationOptions
<a name="API_VerifiedAccessLogKinesisDataFirehoseDestinationOptions"></a>

Describes Amazon Kinesis Data Firehose logging options.

## Contents
<a name="API_VerifiedAccessLogKinesisDataFirehoseDestinationOptions_Contents"></a>

 ** Enabled **   
Indicates whether logging is enabled.  
Type: Boolean  
Required: Yes

 ** DeliveryStream **   
The ID of the delivery stream.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessLogKinesisDataFirehoseDestinationOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogKinesisDataFirehoseDestinationOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogKinesisDataFirehoseDestinationOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogKinesisDataFirehoseDestinationOptions) 

# VerifiedAccessLogOptions
<a name="API_VerifiedAccessLogOptions"></a>

Options for Verified Access logs.

## Contents
<a name="API_VerifiedAccessLogOptions_Contents"></a>

 ** CloudWatchLogs **   
Sends Verified Access logs to CloudWatch Logs.  
Type: [VerifiedAccessLogCloudWatchLogsDestinationOptions](API_VerifiedAccessLogCloudWatchLogsDestinationOptions.md) object  
Required: No

 ** IncludeTrustContext **   
Indicates whether to include trust data sent by trust providers in the logs.  
Type: Boolean  
Required: No

 ** KinesisDataFirehose **   
Sends Verified Access logs to Kinesis.  
Type: [VerifiedAccessLogKinesisDataFirehoseDestinationOptions](API_VerifiedAccessLogKinesisDataFirehoseDestinationOptions.md) object  
Required: No

 ** LogVersion **   
The logging version.  
Valid values: `ocsf-0.1` \$1 `ocsf-1.0.0-rc.2`   
Type: String  
Required: No

 ** S3 **   
Sends Verified Access logs to Amazon S3.  
Type: [VerifiedAccessLogS3DestinationOptions](API_VerifiedAccessLogS3DestinationOptions.md) object  
Required: No

## See Also
<a name="API_VerifiedAccessLogOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogOptions) 

# VerifiedAccessLogs
<a name="API_VerifiedAccessLogs"></a>

Describes the options for Verified Access logs.

## Contents
<a name="API_VerifiedAccessLogs_Contents"></a>

 ** cloudWatchLogs **   
CloudWatch Logs logging destination.  
Type: [VerifiedAccessLogCloudWatchLogsDestination](API_VerifiedAccessLogCloudWatchLogsDestination.md) object  
Required: No

 ** includeTrustContext **   
Indicates whether trust data is included in the logs.  
Type: Boolean  
Required: No

 ** kinesisDataFirehose **   
Kinesis logging destination.  
Type: [VerifiedAccessLogKinesisDataFirehoseDestination](API_VerifiedAccessLogKinesisDataFirehoseDestination.md) object  
Required: No

 ** logVersion **   
The log version.  
Type: String  
Required: No

 ** s3 **   
Amazon S3 logging options.  
Type: [VerifiedAccessLogS3Destination](API_VerifiedAccessLogS3Destination.md) object  
Required: No

## See Also
<a name="API_VerifiedAccessLogs_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogs) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogs) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogs) 

# VerifiedAccessLogS3Destination
<a name="API_VerifiedAccessLogS3Destination"></a>

Options for Amazon S3 as a logging destination.

## Contents
<a name="API_VerifiedAccessLogS3Destination_Contents"></a>

 ** bucketName **   
The bucket name.  
Type: String  
Required: No

 ** bucketOwner **   
The AWS account number that owns the bucket.  
Type: String  
Required: No

 ** deliveryStatus **   
The delivery status.  
Type: [VerifiedAccessLogDeliveryStatus](API_VerifiedAccessLogDeliveryStatus.md) object  
Required: No

 ** enabled **   
Indicates whether logging is enabled.  
Type: Boolean  
Required: No

 ** prefix **   
The bucket prefix.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessLogS3Destination_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogS3Destination) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogS3Destination) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogS3Destination) 

# VerifiedAccessLogS3DestinationOptions
<a name="API_VerifiedAccessLogS3DestinationOptions"></a>

Options for Amazon S3 as a logging destination.

## Contents
<a name="API_VerifiedAccessLogS3DestinationOptions_Contents"></a>

 ** Enabled **   
Indicates whether logging is enabled.  
Type: Boolean  
Required: Yes

 ** BucketName **   
The bucket name.  
Type: String  
Required: No

 ** BucketOwner **   
The ID of the AWS account that owns the Amazon S3 bucket.  
Type: String  
Required: No

 ** Prefix **   
The bucket prefix.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessLogS3DestinationOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessLogS3DestinationOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessLogS3DestinationOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessLogS3DestinationOptions) 

# VerifiedAccessSseSpecificationRequest
<a name="API_VerifiedAccessSseSpecificationRequest"></a>

 AWS Verified Access provides server side encryption by default to data at rest using AWS-owned KMS keys. You also have the option of using customer managed KMS keys, which can be specified using the options below. 

## Contents
<a name="API_VerifiedAccessSseSpecificationRequest_Contents"></a>

 ** CustomerManagedKeyEnabled **   
 Enable or disable the use of customer managed KMS keys for server side encryption.   
Valid values: `True` \$1 `False`   
Type: Boolean  
Required: No

 ** KmsKeyArn **   
 The ARN of the KMS key.   
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessSseSpecificationRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessSseSpecificationRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessSseSpecificationRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessSseSpecificationRequest) 

# VerifiedAccessSseSpecificationResponse
<a name="API_VerifiedAccessSseSpecificationResponse"></a>

The options in use for server side encryption.

## Contents
<a name="API_VerifiedAccessSseSpecificationResponse_Contents"></a>

 ** customerManagedKeyEnabled **   
Indicates whether customer managed KMS keys are in use for server side encryption.  
Valid values: `True` \$1 `False`   
Type: Boolean  
Required: No

 ** kmsKeyArn **   
The ARN of the KMS key.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessSseSpecificationResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessSseSpecificationResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessSseSpecificationResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessSseSpecificationResponse) 

# VerifiedAccessTrustProvider
<a name="API_VerifiedAccessTrustProvider"></a>

Describes a Verified Access trust provider.

## Contents
<a name="API_VerifiedAccessTrustProvider_Contents"></a>

 ** creationTime **   
The creation time.  
Type: String  
Required: No

 ** description **   
A description for the AWS Verified Access trust provider.  
Type: String  
Required: No

 ** deviceOptions **   
The options for device-identity trust provider.  
Type: [DeviceOptions](API_DeviceOptions.md) object  
Required: No

 ** deviceTrustProviderType **   
The type of device-based trust provider.  
Type: String  
Valid Values: `jamf | crowdstrike | jumpcloud`   
Required: No

 ** lastUpdatedTime **   
The last updated time.  
Type: String  
Required: No

 ** nativeApplicationOidcOptions **   
The OpenID Connect (OIDC) options.  
Type: [NativeApplicationOidcOptions](API_NativeApplicationOidcOptions.md) object  
Required: No

 ** oidcOptions **   
The options for an OpenID Connect-compatible user-identity trust provider.  
Type: [OidcOptions](API_OidcOptions.md) object  
Required: No

 ** policyReferenceName **   
The identifier to be used when working with policy rules.  
Type: String  
Required: No

 ** sseSpecification **   
The options in use for server side encryption.  
Type: [VerifiedAccessSseSpecificationResponse](API_VerifiedAccessSseSpecificationResponse.md) object  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** trustProviderType **   
The type of Verified Access trust provider.  
Type: String  
Valid Values: `user | device`   
Required: No

 ** userTrustProviderType **   
The type of user-based trust provider.  
Type: String  
Valid Values: `iam-identity-center | oidc`   
Required: No

 ** verifiedAccessTrustProviderId **   
The ID of the AWS Verified Access trust provider.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessTrustProvider_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessTrustProvider) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessTrustProvider) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessTrustProvider) 

# VerifiedAccessTrustProviderCondensed
<a name="API_VerifiedAccessTrustProviderCondensed"></a>

Condensed information about a trust provider.

## Contents
<a name="API_VerifiedAccessTrustProviderCondensed_Contents"></a>

 ** description **   
The description of trust provider.  
Type: String  
Required: No

 ** deviceTrustProviderType **   
The type of device-based trust provider.  
Type: String  
Valid Values: `jamf | crowdstrike | jumpcloud`   
Required: No

 ** trustProviderType **   
The type of trust provider (user- or device-based).  
Type: String  
Valid Values: `user | device`   
Required: No

 ** userTrustProviderType **   
The type of user-based trust provider.  
Type: String  
Valid Values: `iam-identity-center | oidc`   
Required: No

 ** verifiedAccessTrustProviderId **   
The ID of the trust provider.  
Type: String  
Required: No

## See Also
<a name="API_VerifiedAccessTrustProviderCondensed_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VerifiedAccessTrustProviderCondensed) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VerifiedAccessTrustProviderCondensed) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VerifiedAccessTrustProviderCondensed) 

# VgwTelemetry
<a name="API_VgwTelemetry"></a>

Describes telemetry for a VPN tunnel.

## Contents
<a name="API_VgwTelemetry_Contents"></a>

 ** acceptedRouteCount **   
The number of accepted routes.  
Type: Integer  
Required: No

 ** certificateArn **   
The Amazon Resource Name (ARN) of the VPN tunnel endpoint certificate.  
Type: String  
Required: No

 ** lastStatusChange **   
The date and time of the last change in status. This field is updated when changes in IKE (Phase 1), IPSec (Phase 2), or BGP status are detected.  
Type: Timestamp  
Required: No

 ** outsideIpAddress **   
The Internet-routable IP address of the virtual private gateway's outside interface.  
Type: String  
Required: No

 ** status **   
The status of the VPN tunnel.  
Type: String  
Valid Values: `UP | DOWN`   
Required: No

 ** statusMessage **   
If an error occurs, a description of the error.  
Type: String  
Required: No

## See Also
<a name="API_VgwTelemetry_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VgwTelemetry) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VgwTelemetry) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VgwTelemetry) 

# Volume
<a name="API_Volume"></a>

Describes a volume.

## Contents
<a name="API_Volume_Contents"></a>

 ** AttachmentSet.N **   
This parameter is not returned by CreateVolume.
Information about the volume attachments.  
Type: Array of [VolumeAttachment](API_VolumeAttachment.md) objects  
Required: No

 ** availabilityZone **   
The Availability Zone for the volume.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone for the volume.  
Type: String  
Required: No

 ** createTime **   
The time stamp when volume creation was initiated.  
Type: Timestamp  
Required: No

 ** encrypted **   
Indicates whether the volume is encrypted.  
Type: Boolean  
Required: No

 ** fastRestored **   
This parameter is not returned by CreateVolume.
Indicates whether the volume was created using fast snapshot restore.  
Type: Boolean  
Required: No

 ** 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  
Required: No

 ** 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  
Required: No

 ** multiAttachEnabled **   
Indicates whether Amazon EBS Multi-Attach is enabled.  
Type: Boolean  
Required: No

 ** operator **   
The service provider that manages the volume.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** size **   
The size of the volume, in GiBs.  
Type: Integer  
Required: No

 ** snapshotId **   
The snapshot from which the volume was created, if applicable.  
Type: String  
Required: No

 ** sourceVolumeId **   
The ID of the source volume from which the volume copy was created. Only for volume copies.  
Type: String  
Required: No

 ** sseType **   
This parameter is not returned by CreateVolume.
Reserved for future use.  
Type: String  
Valid Values: `sse-ebs | sse-kms | none`   
Required: No

 ** status **   
The volume state.  
Type: String  
Valid Values: `creating | available | in-use | deleting | deleted | error`   
Required: No

 ** TagSet.N **   
Any tags assigned to the volume.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** throughput **   
The throughput that the volume supports, in MiB/s.  
Type: Integer  
Required: No

 ** volumeId **   
The ID of the volume.  
Type: String  
Required: No

 ** 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  
Required: No

 ** volumeType **   
The volume type.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

## See Also
<a name="API_Volume_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Volume) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Volume) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Volume) 

# VolumeAttachment
<a name="API_VolumeAttachment"></a>

Describes volume attachment details.

## Contents
<a name="API_VolumeAttachment_Contents"></a>

 ** associatedResource **   
The ARN of the AWS-managed resource to which the volume is attached.  
Type: String  
Required: No

 ** attachTime **   
The time stamp when the attachment initiated.  
Type: Timestamp  
Required: No

 ** deleteOnTermination **   
Indicates whether the EBS volume is deleted on instance termination.  
Type: Boolean  
Required: No

 ** device **   
The device name.  
If the volume is attached to an AWS-managed resource, this parameter returns `null`.  
Type: String  
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.  
If the volume is attached to an AWS-managed resource, this parameter returns `null`.  
Type: String  
Required: No

 ** 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  
Required: No

 ** status **   
The attachment state of the volume.  
Type: String  
Valid Values: `attaching | attached | detaching | detached | busy`   
Required: No

 ** volumeId **   
The ID of the volume.  
Type: String  
Required: No

## See Also
<a name="API_VolumeAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeAttachment) 

# VolumeDetail
<a name="API_VolumeDetail"></a>

Describes an EBS volume.

## Contents
<a name="API_VolumeDetail_Contents"></a>

 ** Size **   
The size of the volume, in GiB.  
Type: Long  
Required: Yes

## See Also
<a name="API_VolumeDetail_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeDetail) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeDetail) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeDetail) 

# VolumeModification
<a name="API_VolumeModification"></a>

Describes the modification status of an EBS volume.

## Contents
<a name="API_VolumeModification_Contents"></a>

 ** endTime **   
The modification completion or failure time.  
Type: Timestamp  
Required: No

 ** modificationState **   
The current modification state.  
Type: String  
Valid Values: `modifying | optimizing | completed | failed`   
Required: No

 ** originalIops **   
The original IOPS rate of the volume.  
Type: Integer  
Required: No

 ** originalMultiAttachEnabled **   
The original setting for Amazon EBS Multi-Attach.  
Type: Boolean  
Required: No

 ** originalSize **   
The original size of the volume, in GiB.  
Type: Integer  
Required: No

 ** originalThroughput **   
The original throughput of the volume, in MiB/s.  
Type: Integer  
Required: No

 ** originalVolumeType **   
The original EBS volume type of the volume.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

 ** progress **   
The modification progress, from 0 to 100 percent complete.  
Type: Long  
Required: No

 ** startTime **   
The modification start time.  
Type: Timestamp  
Required: No

 ** statusMessage **   
A status message about the modification progress or failure.  
Type: String  
Required: No

 ** targetIops **   
The target IOPS rate of the volume.  
Type: Integer  
Required: No

 ** targetMultiAttachEnabled **   
The target setting for Amazon EBS Multi-Attach.  
Type: Boolean  
Required: No

 ** targetSize **   
The target size of the volume, in GiB.  
Type: Integer  
Required: No

 ** targetThroughput **   
The target throughput of the volume, in MiB/s.  
Type: Integer  
Required: No

 ** targetVolumeType **   
The target EBS volume type of the volume.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

 ** volumeId **   
The ID of the volume.  
Type: String  
Required: No

## See Also
<a name="API_VolumeModification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeModification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeModification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeModification) 

# VolumeRecycleBinInfo
<a name="API_VolumeRecycleBinInfo"></a>

Information about a volume that is currently in the Recycle Bin.

## Contents
<a name="API_VolumeRecycleBinInfo_Contents"></a>

 ** availabilityZone **   
The Availability Zone for the volume.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone for the volume.  
Type: String  
Required: No

 ** createTime **   
The time stamp when volume creation was initiated.  
Type: Timestamp  
Required: No

 ** iops **   
The number of I/O operations per second (IOPS) for the volume.  
Type: Integer  
Required: No

 ** operator **   
The service provider that manages the volume.  
Type: [OperatorResponse](API_OperatorResponse.md) object  
Required: No

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

 ** recycleBinEnterTime **   
The date and time when the volume entered the Recycle Bin.  
Type: Timestamp  
Required: No

 ** recycleBinExitTime **   
The date and time when the volume is to be permanently deleted from the Recycle Bin.  
Type: Timestamp  
Required: No

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

 ** snapshotId **   
The snapshot from which the volume was created, if applicable.  
Type: String  
Required: No

 ** sourceVolumeId **   
The ID of the source volume.  
Type: String  
Required: No

 ** state **   
The state of the volume.  
Type: String  
Valid Values: `creating | available | in-use | deleting | deleted | error`   
Required: No

 ** throughput **   
The throughput that the volume supports, in MiB/s.  
Type: Integer  
Required: No

 ** volumeId **   
The ID of the volume.  
Type: String  
Required: No

 ** volumeType **   
The volume type.  
Type: String  
Valid Values: `standard | io1 | io2 | gp2 | sc1 | st1 | gp3`   
Required: No

## See Also
<a name="API_VolumeRecycleBinInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeRecycleBinInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeRecycleBinInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeRecycleBinInfo) 

# VolumeStatusAction
<a name="API_VolumeStatusAction"></a>

Describes a volume status operation code.

## Contents
<a name="API_VolumeStatusAction_Contents"></a>

 ** code **   
The code identifying the operation, for example, `enable-volume-io`.  
Type: String  
Required: No

 ** description **   
A description of the operation.  
Type: String  
Required: No

 ** eventId **   
The ID of the event associated with this operation.  
Type: String  
Required: No

 ** eventType **   
The event type associated with this operation.  
Type: String  
Required: No

## See Also
<a name="API_VolumeStatusAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeStatusAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeStatusAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeStatusAction) 

# VolumeStatusAttachmentStatus
<a name="API_VolumeStatusAttachmentStatus"></a>

Information about the instances to which the volume is attached.

## Contents
<a name="API_VolumeStatusAttachmentStatus_Contents"></a>

 ** instanceId **   
The ID of the attached instance.  
Type: String  
Required: No

 ** ioPerformance **   
The maximum IOPS supported by the attached instance.  
Type: String  
Required: No

## See Also
<a name="API_VolumeStatusAttachmentStatus_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeStatusAttachmentStatus) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeStatusAttachmentStatus) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeStatusAttachmentStatus) 

# VolumeStatusDetails
<a name="API_VolumeStatusDetails"></a>

Describes a volume status.

## Contents
<a name="API_VolumeStatusDetails_Contents"></a>

 ** name **   
The name of the volume status.  
+  `io-enabled` - Indicates the volume I/O status. For more information, see [Amazon EBS volume status checks](https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-checks.html).
+  `io-performance` - Indicates the volume performance status. For more information, see [Amazon EBS volume status checks](https://docs.aws.amazon.com/ebs/latest/userguide/monitoring-volume-checks.html).
+  `initialization-state` - Indicates the status of the volume initialization process. For more information, see [Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html).
Type: String  
Valid Values: `io-enabled | io-performance | initialization-state`   
Required: No

 ** status **   
The intended status of the volume status.  
Type: String  
Required: No

## See Also
<a name="API_VolumeStatusDetails_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeStatusDetails) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeStatusDetails) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeStatusDetails) 

# VolumeStatusEvent
<a name="API_VolumeStatusEvent"></a>

Describes a volume status event.

## Contents
<a name="API_VolumeStatusEvent_Contents"></a>

 ** description **   
A description of the event.  
Type: String  
Required: No

 ** eventId **   
The ID of this event.  
Type: String  
Required: No

 ** eventType **   
The type of this event.  
Type: String  
Required: No

 ** instanceId **   
The ID of the instance associated with the event.  
Type: String  
Required: No

 ** notAfter **   
The latest end time of the event.  
Type: Timestamp  
Required: No

 ** notBefore **   
The earliest start time of the event.  
Type: Timestamp  
Required: No

## See Also
<a name="API_VolumeStatusEvent_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeStatusEvent) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeStatusEvent) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeStatusEvent) 

# VolumeStatusInfo
<a name="API_VolumeStatusInfo"></a>

Describes the status of a volume.

## Contents
<a name="API_VolumeStatusInfo_Contents"></a>

 ** Details.N **   
The details of the volume status.  
Type: Array of [VolumeStatusDetails](API_VolumeStatusDetails.md) objects  
Required: No

 ** status **   
The status of the volume.  
Type: String  
Valid Values: `ok | impaired | insufficient-data | warning`   
Required: No

## See Also
<a name="API_VolumeStatusInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeStatusInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeStatusInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeStatusInfo) 

# VolumeStatusItem
<a name="API_VolumeStatusItem"></a>

Describes the volume status.

## Contents
<a name="API_VolumeStatusItem_Contents"></a>

 ** ActionsSet.N **   
The details of the operation.  
Type: Array of [VolumeStatusAction](API_VolumeStatusAction.md) objects  
Required: No

 ** AttachmentStatuses.N **   
Information about the instances to which the volume is attached.  
Type: Array of [VolumeStatusAttachmentStatus](API_VolumeStatusAttachmentStatus.md) objects  
Required: No

 ** availabilityZone **   
The Availability Zone of the volume.  
Type: String  
Required: No

 ** availabilityZoneId **   
The ID of the Availability Zone.  
Type: String  
Required: No

 ** EventsSet.N **   
A list of events associated with the volume.  
Type: Array of [VolumeStatusEvent](API_VolumeStatusEvent.md) objects  
Required: No

 ** initializationStatusDetails **   
Information about the volume initialization. It can take up to 5 minutes for the volume initialization information to be updated.  
Only available for volumes created from snapshots. Not available for empty volumes created without a snapshot.  
For more information, see [ Initialize Amazon EBS volumes](https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html).  
Type: [InitializationStatusDetails](API_InitializationStatusDetails.md) object  
Required: No

 ** outpostArn **   
The Amazon Resource Name (ARN) of the Outpost.  
Type: String  
Required: No

 ** volumeId **   
The volume ID.  
Type: String  
Required: No

 ** volumeStatus **   
The volume status.  
Type: [VolumeStatusInfo](API_VolumeStatusInfo.md) object  
Required: No

## See Also
<a name="API_VolumeStatusItem_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VolumeStatusItem) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VolumeStatusItem) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VolumeStatusItem) 

# Vpc
<a name="API_Vpc"></a>

Describes a VPC.

## Contents
<a name="API_Vpc_Contents"></a>

 ** blockPublicAccessStates **   
The state of VPC Block Public Access (BPA).  
Type: [BlockPublicAccessStates](API_BlockPublicAccessStates.md) object  
Required: No

 ** cidrBlock **   
The primary IPv4 CIDR block for the VPC.  
Type: String  
Required: No

 ** CidrBlockAssociationSet.N **   
Information about the IPv4 CIDR blocks associated with the VPC.  
Type: Array of [VpcCidrBlockAssociation](API_VpcCidrBlockAssociation.md) objects  
Required: No

 ** dhcpOptionsId **   
The ID of the set of DHCP options you've associated with the VPC.  
Type: String  
Required: No

 ** instanceTenancy **   
The allowed tenancy of instances launched into the VPC.  
Type: String  
Valid Values: `default | dedicated | host`   
Required: No

 ** Ipv6CidrBlockAssociationSet.N **   
Information about the IPv6 CIDR blocks associated with the VPC.  
Type: Array of [VpcIpv6CidrBlockAssociation](API_VpcIpv6CidrBlockAssociation.md) objects  
Required: No

 ** isDefault **   
Indicates whether the VPC is the default VPC.  
Type: Boolean  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the VPC.  
Type: String  
Required: No

 ** state **   
The current state of the VPC.  
Type: String  
Valid Values: `pending | available`   
Required: No

 ** TagSet.N **   
Any tags assigned to the VPC.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_Vpc_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/Vpc) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/Vpc) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/Vpc) 

# VpcAttachment
<a name="API_VpcAttachment"></a>

Describes an attachment between a virtual private gateway and a VPC.

## Contents
<a name="API_VpcAttachment_Contents"></a>

 ** state **   
The current state of the attachment.  
Type: String  
Valid Values: `attaching | attached | detaching | detached`   
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_VpcAttachment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcAttachment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcAttachment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcAttachment) 

# VpcBlockPublicAccessExclusion
<a name="API_VpcBlockPublicAccessExclusion"></a>

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*.

## Contents
<a name="API_VpcBlockPublicAccessExclusion_Contents"></a>

 ** creationTimestamp **   
When the exclusion was created.  
Type: Timestamp  
Required: No

 ** deletionTimestamp **   
When the exclusion was deleted.  
Type: Timestamp  
Required: No

 ** exclusionId **   
The ID of the exclusion.  
Type: String  
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: No

 ** lastUpdateTimestamp **   
When the exclusion was last updated.  
Type: Timestamp  
Required: No

 ** reason **   
The reason for the current exclusion state.  
Type: String  
Required: No

 ** resourceArn **   
The ARN of the exclusion.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1283.  
Required: No

 ** state **   
The state of the exclusion.  
Type: String  
Valid Values: `create-in-progress | create-complete | create-failed | update-in-progress | update-complete | update-failed | delete-in-progress | delete-complete | disable-in-progress | disable-complete`   
Required: No

 ** TagSet.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 [Tag](API_Tag.md) objects  
Required: No

## See Also
<a name="API_VpcBlockPublicAccessExclusion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcBlockPublicAccessExclusion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcBlockPublicAccessExclusion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcBlockPublicAccessExclusion) 

# VpcBlockPublicAccessOptions
<a name="API_VpcBlockPublicAccessOptions"></a>

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*.

## Contents
<a name="API_VpcBlockPublicAccessOptions_Contents"></a>

 ** awsAccountId **   
An AWS account ID.  
Type: String  
Required: No

 ** awsRegion **   
An AWS Region.  
Type: String  
Required: No

 ** exclusionsAllowed **   
Determines if exclusions are allowed. If you have [enabled VPC BPA at the Organization level](https://docs.aws.amazon.com/vpc/latest/userguide/security-vpc-bpa.html#security-vpc-bpa-exclusions-orgs), exclusions may be `not-allowed`. Otherwise, they are `allowed`.  
Type: String  
Valid Values: `allowed | not-allowed`   
Required: No

 ** internetGatewayBlockMode **   
The current 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: No

 ** lastUpdateTimestamp **   
The last time the VPC BPA mode was updated.  
Type: Timestamp  
Required: No

 ** managedBy **   
The entity that manages the state of VPC BPA. 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`   
Required: No

 ** reason **   
The reason for the current state.  
Type: String  
Required: No

 ** state **   
The current state of VPC BPA.  
Type: String  
Valid Values: `default-state | update-in-progress | update-complete`   
Required: No

## See Also
<a name="API_VpcBlockPublicAccessOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcBlockPublicAccessOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcBlockPublicAccessOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcBlockPublicAccessOptions) 

# VpcCidrBlockAssociation
<a name="API_VpcCidrBlockAssociation"></a>

Describes an IPv4 CIDR block associated with a VPC.

## Contents
<a name="API_VpcCidrBlockAssociation_Contents"></a>

 ** associationId **   
The association ID for the IPv4 CIDR block.  
Type: String  
Required: No

 ** cidrBlock **   
The IPv4 CIDR block.  
Type: String  
Required: No

 ** cidrBlockState **   
Information about the state of the CIDR block.  
Type: [VpcCidrBlockState](API_VpcCidrBlockState.md) object  
Required: No

## See Also
<a name="API_VpcCidrBlockAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcCidrBlockAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcCidrBlockAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcCidrBlockAssociation) 

# VpcCidrBlockState
<a name="API_VpcCidrBlockState"></a>

Describes the state of a CIDR block.

## Contents
<a name="API_VpcCidrBlockState_Contents"></a>

 ** state **   
The state of the CIDR block.  
Type: String  
Valid Values: `associating | associated | disassociating | disassociated | failing | failed`   
Required: No

 ** statusMessage **   
A message about the status of the CIDR block, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_VpcCidrBlockState_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcCidrBlockState) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcCidrBlockState) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcCidrBlockState) 

# VpcClassicLink
<a name="API_VpcClassicLink"></a>

**Note**  
Deprecated.

Describes whether a VPC is enabled for ClassicLink.

## Contents
<a name="API_VpcClassicLink_Contents"></a>

 ** classicLinkEnabled **   
Indicates whether the VPC is enabled for ClassicLink.  
Type: Boolean  
Required: No

 ** TagSet.N **   
Any tags assigned to the VPC.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_VpcClassicLink_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcClassicLink) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcClassicLink) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcClassicLink) 

# VpcEncryptionControl
<a name="API_VpcEncryptionControl"></a>

Describes the configuration and state of VPC encryption controls.

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*.

## Contents
<a name="API_VpcEncryptionControl_Contents"></a>

 ** mode **   
The encryption mode for the VPC Encryption Control configuration.  
Type: String  
Valid Values: `monitor | enforce`   
Required: No

 ** resourceExclusions **   
Information about resource exclusions for the VPC Encryption Control configuration.  
Type: [VpcEncryptionControlExclusions](API_VpcEncryptionControlExclusions.md) object  
Required: No

 ** state **   
The current state of the VPC Encryption Control configuration.  
Type: String  
Valid Values: `enforce-in-progress | monitor-in-progress | enforce-failed | monitor-failed | deleting | deleted | available | creating | delete-failed`   
Required: No

 ** stateMessage **   
A message providing additional information about the encryption control state.  
Type: String  
Required: No

 ** TagSet.N **   
The tags assigned to the VPC Encryption Control configuration.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcEncryptionControlId **   
The ID of the VPC Encryption Control configuration.  
Type: String  
Required: No

 ** vpcId **   
The ID of the VPC associated with the encryption control configuration.  
Type: String  
Required: No

## See Also
<a name="API_VpcEncryptionControl_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEncryptionControl) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEncryptionControl) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEncryptionControl) 

# VpcEncryptionControlConfiguration
<a name="API_VpcEncryptionControlConfiguration"></a>

Describes the configuration settings for VPC Encryption Control.

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*.

## Contents
<a name="API_VpcEncryptionControlConfiguration_Contents"></a>

 ** Mode **   
The encryption mode for the VPC Encryption Control configuration.  
Type: String  
Valid Values: `monitor | enforce`   
Required: Yes

 ** 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

 ** 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

 ** 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

## See Also
<a name="API_VpcEncryptionControlConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEncryptionControlConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEncryptionControlConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEncryptionControlConfiguration) 

# VpcEncryptionControlExclusion
<a name="API_VpcEncryptionControlExclusion"></a>

Describes an exclusion configuration for VPC Encryption Control.

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*.

## Contents
<a name="API_VpcEncryptionControlExclusion_Contents"></a>

 ** state **   
The current state of the exclusion configuration.  
Type: String  
Valid Values: `enabling | enabled | disabling | disabled`   
Required: No

 ** stateMessage **   
A message providing additional information about the exclusion state.  
Type: String  
Required: No

## See Also
<a name="API_VpcEncryptionControlExclusion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEncryptionControlExclusion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEncryptionControlExclusion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEncryptionControlExclusion) 

# VpcEncryptionControlExclusions
<a name="API_VpcEncryptionControlExclusions"></a>

Describes the exclusion configurations for various resource types in VPC Encryption Control.

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*.

## Contents
<a name="API_VpcEncryptionControlExclusions_Contents"></a>

 ** egressOnlyInternetGateway **   
The exclusion configuration for egress-only internet gateway traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

 ** elasticFileSystem **   
The exclusion configuration for Elastic File System traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

 ** internetGateway **   
The exclusion configuration for internet gateway traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

 ** lambda **   
The exclusion configuration for Lambda function traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

 ** natGateway **   
The exclusion configuration for NAT gateway traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

 ** virtualPrivateGateway **   
The exclusion configuration for virtual private gateway traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

 ** vpcLattice **   
The exclusion configuration for VPC Lattice traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

 ** vpcPeering **   
The exclusion configuration for VPC peering connection traffic.  
Type: [VpcEncryptionControlExclusion](API_VpcEncryptionControlExclusion.md) object  
Required: No

## See Also
<a name="API_VpcEncryptionControlExclusions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEncryptionControlExclusions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEncryptionControlExclusions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEncryptionControlExclusions) 

# VpcEncryptionNonCompliantResource
<a name="API_VpcEncryptionNonCompliantResource"></a>

Describes a resource that is not compliant with VPC encryption 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*.

## Contents
<a name="API_VpcEncryptionNonCompliantResource_Contents"></a>

 ** description **   
A description of the non-compliant resource.  
Type: String  
Required: No

 ** id **   
The ID of the non-compliant resource.  
Type: String  
Required: No

 ** isExcludable **   
Indicates whether the resource can be excluded from encryption enforcement.  
Type: Boolean  
Required: No

 ** type **   
The type of the non-compliant resource.  
Type: String  
Required: No

## See Also
<a name="API_VpcEncryptionNonCompliantResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEncryptionNonCompliantResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEncryptionNonCompliantResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEncryptionNonCompliantResource) 

# VpcEndpoint
<a name="API_VpcEndpoint"></a>

Describes a VPC endpoint.

## Contents
<a name="API_VpcEndpoint_Contents"></a>

 ** creationTimestamp **   
The date and time that the endpoint was created.  
Type: Timestamp  
Required: No

 ** DnsEntrySet.N **   
(Interface endpoint) The DNS entries for the endpoint.  
Type: Array of [DnsEntry](API_DnsEntry.md) objects  
Required: No

 ** dnsOptions **   
The DNS options for the endpoint.  
Type: [DnsOptions](API_DnsOptions.md) object  
Required: No

 ** failureReason **   
Reason for the failure.  
Type: String  
Required: No

 ** GroupSet.N **   
(Interface endpoint) Information about the security groups that are associated with the network interface.  
Type: Array of [SecurityGroupIdentifier](API_SecurityGroupIdentifier.md) objects  
Required: No

 ** ipAddressType **   
The IP address type for the endpoint.  
Type: String  
Valid Values: `ipv4 | dualstack | ipv6`   
Required: No

 ** Ipv4PrefixSet.N **   
Array of IPv4 prefixes.  
Type: Array of [SubnetIpPrefixes](API_SubnetIpPrefixes.md) objects  
Required: No

 ** Ipv6PrefixSet.N **   
Array of IPv6 prefixes.  
Type: Array of [SubnetIpPrefixes](API_SubnetIpPrefixes.md) objects  
Required: No

 ** lastError **   
The last error that occurred for endpoint.  
Type: [LastError](API_LastError.md) object  
Required: No

 ** NetworkInterfaceIdSet.N **   
(Interface endpoint) The network interfaces for the endpoint.  
Type: Array of strings  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the endpoint.  
Type: String  
Required: No

 ** policyDocument **   
The policy document associated with the endpoint, if applicable.  
Type: String  
Required: No

 ** privateDnsEnabled **   
(Interface endpoint) Indicates whether the VPC is associated with a private hosted zone.  
Type: Boolean  
Required: No

 ** requesterManaged **   
Indicates whether the endpoint is being managed by its service.  
Type: Boolean  
Required: No

 ** resourceConfigurationArn **   
The Amazon Resource Name (ARN) of the resource configuration.  
Type: String  
Required: No

 ** RouteTableIdSet.N **   
(Gateway endpoint) The IDs of the route tables associated with the endpoint.  
Type: Array of strings  
Required: No

 ** serviceName **   
The name of the service to which the endpoint is associated.  
Type: String  
Required: No

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

 ** serviceRegion **   
The Region where the service is hosted.  
Type: String  
Required: No

 ** state **   
The state of the endpoint.  
Type: String  
Valid Values: `PendingAcceptance | Pending | Available | Deleting | Deleted | Rejected | Failed | Expired | Partial`   
Required: No

 ** SubnetIdSet.N **   
(Interface endpoint) The subnets for the endpoint.  
Type: Array of strings  
Required: No

 ** TagSet.N **   
The tags assigned to the endpoint.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcEndpointId **   
The ID of the endpoint.  
Type: String  
Required: No

 ** vpcEndpointType **   
The type of endpoint.  
Type: String  
Valid Values: `Interface | Gateway | GatewayLoadBalancer | Resource | ServiceNetwork`   
Required: No

 ** vpcId **   
The ID of the VPC to which the endpoint is associated.  
Type: String  
Required: No

## See Also
<a name="API_VpcEndpoint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEndpoint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEndpoint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEndpoint) 

# VpcEndpointAssociation
<a name="API_VpcEndpointAssociation"></a>

Describes the VPC resources, VPC endpoint services, Lattice services, or service networks associated with the VPC endpoint.

## Contents
<a name="API_VpcEndpointAssociation_Contents"></a>

 ** associatedResourceAccessibility **   
The connectivity status of the resources associated to a VPC endpoint. The resource is accessible if the associated resource configuration is `AVAILABLE`, otherwise the resource is inaccessible.  
Type: String  
Required: No

 ** associatedResourceArn **   
The Amazon Resource Name (ARN) of the associated resource.  
Type: String  
Required: No

 ** dnsEntry **   
The DNS entry of the VPC endpoint association.  
Type: [DnsEntry](API_DnsEntry.md) object  
Required: No

 ** failureCode **   
An error code related to why an VPC endpoint association failed.  
Type: String  
Required: No

 ** failureReason **   
A message related to why an VPC endpoint association failed.  
Type: String  
Required: No

 ** id **   
The ID of the VPC endpoint association.  
Type: String  
Required: No

 ** privateDnsEntry **   
The private DNS entry of the VPC endpoint association.  
Type: [DnsEntry](API_DnsEntry.md) object  
Required: No

 ** resourceConfigurationGroupArn **   
The Amazon Resource Name (ARN) of the resource configuration group.  
Type: String  
Required: No

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

 ** serviceNetworkName **   
The name of the service network.  
Type: String  
Required: No

 ** TagSet.N **   
The tags to apply to the VPC endpoint association.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcEndpointId **   
The ID of the VPC endpoint.  
Type: String  
Required: No

## See Also
<a name="API_VpcEndpointAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEndpointAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEndpointAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEndpointAssociation) 

# VpcEndpointConnection
<a name="API_VpcEndpointConnection"></a>

Describes a VPC endpoint connection to a service.

## Contents
<a name="API_VpcEndpointConnection_Contents"></a>

 ** creationTimestamp **   
The date and time that the VPC endpoint was created.  
Type: Timestamp  
Required: No

 ** DnsEntrySet.N **   
The DNS entries for the VPC endpoint.  
Type: Array of [DnsEntry](API_DnsEntry.md) objects  
Required: No

 ** GatewayLoadBalancerArnSet.N **   
The Amazon Resource Names (ARNs) of the Gateway Load Balancers for the service.  
Type: Array of strings  
Required: No

 ** ipAddressType **   
The IP address type for the endpoint.  
Type: String  
Valid Values: `ipv4 | dualstack | ipv6`   
Required: No

 ** NetworkLoadBalancerArnSet.N **   
The Amazon Resource Names (ARNs) of the network load balancers for the service.  
Type: Array of strings  
Required: No

 ** serviceId **   
The ID of the service to which the endpoint is connected.  
Type: String  
Required: No

 ** TagSet.N **   
The tags.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcEndpointConnectionId **   
The ID of the VPC endpoint connection.  
Type: String  
Required: No

 ** vpcEndpointId **   
The ID of the VPC endpoint.  
Type: String  
Required: No

 ** vpcEndpointOwner **   
The ID of the AWS account that owns the VPC endpoint.  
Type: String  
Required: No

 ** vpcEndpointRegion **   
The Region of the endpoint.  
Type: String  
Required: No

 ** vpcEndpointState **   
The state of the VPC endpoint.  
Type: String  
Valid Values: `PendingAcceptance | Pending | Available | Deleting | Deleted | Rejected | Failed | Expired | Partial`   
Required: No

## See Also
<a name="API_VpcEndpointConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcEndpointConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcEndpointConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcEndpointConnection) 

# VpcIpv6CidrBlockAssociation
<a name="API_VpcIpv6CidrBlockAssociation"></a>

Describes an IPv6 CIDR block associated with a VPC.

## Contents
<a name="API_VpcIpv6CidrBlockAssociation_Contents"></a>

 ** associationId **   
The association ID for the IPv6 CIDR block.  
Type: String  
Required: No

 ** ipSource **   
The source that allocated the IP address space. `byoip` or `amazon` indicates public IP address space allocated by Amazon or space that you have allocated with Bring your own IP (BYOIP). `none` indicates private space.  
Type: String  
Valid Values: `amazon | byoip | none`   
Required: No

 ** ipv6AddressAttribute **   
Public IPv6 addresses are those advertised on the internet from AWS. Private IP addresses are not and cannot be advertised on the internet from AWS.  
Type: String  
Valid Values: `public | private`   
Required: No

 ** ipv6CidrBlock **   
The IPv6 CIDR block.  
Type: String  
Required: No

 ** ipv6CidrBlockState **   
Information about the state of the CIDR block.  
Type: [VpcCidrBlockState](API_VpcCidrBlockState.md) object  
Required: No

 ** ipv6Pool **   
The ID of the IPv6 address pool from which the IPv6 CIDR block is allocated.  
Type: String  
Required: No

 ** networkBorderGroup **   
The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which AWS advertises IP addresses, for example, `us-east-1-wl1-bos-wlz-1`.  
Type: String  
Required: No

## See Also
<a name="API_VpcIpv6CidrBlockAssociation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcIpv6CidrBlockAssociation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcIpv6CidrBlockAssociation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcIpv6CidrBlockAssociation) 

# VpcPeeringConnection
<a name="API_VpcPeeringConnection"></a>

Describes a VPC peering connection.

## Contents
<a name="API_VpcPeeringConnection_Contents"></a>

 ** accepterVpcInfo **   
Information about the accepter VPC. CIDR block information is only returned when describing an active VPC peering connection.  
Type: [VpcPeeringConnectionVpcInfo](API_VpcPeeringConnectionVpcInfo.md) object  
Required: No

 ** expirationTime **   
The time that an unaccepted VPC peering connection will expire.  
Type: Timestamp  
Required: No

 ** requesterVpcInfo **   
Information about the requester VPC. CIDR block information is only returned when describing an active VPC peering connection.  
Type: [VpcPeeringConnectionVpcInfo](API_VpcPeeringConnectionVpcInfo.md) object  
Required: No

 ** status **   
The status of the VPC peering connection.  
Type: [VpcPeeringConnectionStateReason](API_VpcPeeringConnectionStateReason.md) object  
Required: No

 ** TagSet.N **   
Any tags assigned to the resource.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** vpcPeeringConnectionId **   
The ID of the VPC peering connection.  
Type: String  
Required: No

## See Also
<a name="API_VpcPeeringConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcPeeringConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcPeeringConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcPeeringConnection) 

# VpcPeeringConnectionOptionsDescription
<a name="API_VpcPeeringConnectionOptionsDescription"></a>

Describes the VPC peering connection options.

## Contents
<a name="API_VpcPeeringConnectionOptionsDescription_Contents"></a>

 ** allowDnsResolutionFromRemoteVpc **   
Indicates whether a local VPC can resolve public DNS hostnames to private IP addresses when queried from instances in a peer VPC.  
Type: Boolean  
Required: No

 ** allowEgressFromLocalClassicLinkToRemoteVpc **   
Deprecated.  
Type: Boolean  
Required: No

 ** allowEgressFromLocalVpcToRemoteClassicLink **   
Deprecated.  
Type: Boolean  
Required: No

## See Also
<a name="API_VpcPeeringConnectionOptionsDescription_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcPeeringConnectionOptionsDescription) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcPeeringConnectionOptionsDescription) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcPeeringConnectionOptionsDescription) 

# VpcPeeringConnectionStateReason
<a name="API_VpcPeeringConnectionStateReason"></a>

Describes the status of a VPC peering connection.

## Contents
<a name="API_VpcPeeringConnectionStateReason_Contents"></a>

 ** code **   
The status of the VPC peering connection.  
Type: String  
Valid Values: `initiating-request | pending-acceptance | active | deleted | rejected | failed | expired | provisioning | deleting`   
Required: No

 ** message **   
A message that provides more information about the status, if applicable.  
Type: String  
Required: No

## See Also
<a name="API_VpcPeeringConnectionStateReason_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcPeeringConnectionStateReason) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcPeeringConnectionStateReason) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcPeeringConnectionStateReason) 

# VpcPeeringConnectionVpcInfo
<a name="API_VpcPeeringConnectionVpcInfo"></a>

Describes a VPC in a VPC peering connection.

## Contents
<a name="API_VpcPeeringConnectionVpcInfo_Contents"></a>

 ** cidrBlock **   
The IPv4 CIDR block for the VPC.  
Type: String  
Required: No

 ** CidrBlockSet.N **   
Information about the IPv4 CIDR blocks for the VPC.  
Type: Array of [CidrBlock](API_CidrBlock.md) objects  
Required: No

 ** Ipv6CidrBlockSet.N **   
The IPv6 CIDR block for the VPC.  
Type: Array of [Ipv6CidrBlock](API_Ipv6CidrBlock.md) objects  
Required: No

 ** ownerId **   
The ID of the AWS account that owns the VPC.  
Type: String  
Required: No

 ** peeringOptions **   
Information about the VPC peering connection options for the accepter or requester VPC.  
Type: [VpcPeeringConnectionOptionsDescription](API_VpcPeeringConnectionOptionsDescription.md) object  
Required: No

 ** region **   
The Region in which the VPC is located.  
Type: String  
Required: No

 ** vpcId **   
The ID of the VPC.  
Type: String  
Required: No

## See Also
<a name="API_VpcPeeringConnectionVpcInfo_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpcPeeringConnectionVpcInfo) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpcPeeringConnectionVpcInfo) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpcPeeringConnectionVpcInfo) 

# VpnConcentrator
<a name="API_VpnConcentrator"></a>

Describes a VPN concentrator.

## Contents
<a name="API_VpnConcentrator_Contents"></a>

 ** state **   
The current state of the VPN concentrator.  
Type: String  
Required: No

 ** TagSet.N **   
Any tags assigned to the VPN concentrator.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayAttachmentId **   
The ID of the transit gateway attachment for the VPN concentrator.  
Type: String  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway associated with the VPN concentrator.  
Type: String  
Required: No

 ** type **   
The type of VPN concentrator.  
Type: String  
Required: No

 ** vpnConcentratorId **   
The ID of the VPN concentrator.  
Type: String  
Required: No

## See Also
<a name="API_VpnConcentrator_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnConcentrator) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnConcentrator) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnConcentrator) 

# VpnConnection
<a name="API_VpnConnection"></a>

Describes a VPN connection.

## Contents
<a name="API_VpnConnection_Contents"></a>

 ** category **   
The category of the VPN connection. A value of `VPN` indicates an AWS VPN connection. A value of `VPN-Classic` indicates an AWS Classic VPN connection.  
Type: String  
Required: No

 ** coreNetworkArn **   
The ARN of the core network.  
Type: String  
Required: No

 ** coreNetworkAttachmentArn **   
The ARN of the core network attachment.  
Type: String  
Required: No

 ** customerGatewayConfiguration **   
The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the [CreateVpnConnection](API_CreateVpnConnection.md) response; however, it's present in the [DescribeVpnConnections](API_DescribeVpnConnections.md) response only if the VPN connection is in the `pending` or `available` state.  
Type: String  
Required: No

 ** customerGatewayId **   
The ID of the customer gateway at your end of the VPN connection.  
Type: String  
Required: No

 ** gatewayAssociationState **   
The current state of the gateway association.  
Type: String  
Valid Values: `associated | not-associated | associating | disassociating`   
Required: No

 ** options **   
The VPN connection options.  
Type: [VpnConnectionOptions](API_VpnConnectionOptions.md) object  
Required: No

 ** preSharedKeyArn **   
The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.  
Type: String  
Required: No

 ** Routes.N **   
The static routes associated with the VPN connection.  
Type: Array of [VpnStaticRoute](API_VpnStaticRoute.md) objects  
Required: No

 ** state **   
The current state of the VPN connection.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** TagSet.N **   
Any tags assigned to the VPN connection.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** transitGatewayId **   
The ID of the transit gateway associated with the VPN connection.  
Type: String  
Required: No

 ** type **   
The type of VPN connection.  
Type: String  
Valid Values: `ipsec.1`   
Required: No

 ** VgwTelemetry.N **   
Information about the VPN tunnel.  
Type: Array of [VgwTelemetry](API_VgwTelemetry.md) objects  
Required: No

 ** vpnConcentratorId **   
The ID of the VPN concentrator associated with the VPN connection.  
Type: String  
Required: No

 ** vpnConnectionId **   
The ID of the VPN connection.  
Type: String  
Required: No

 ** vpnGatewayId **   
The ID of the virtual private gateway at the AWS side of the VPN connection.  
Type: String  
Required: No

## See Also
<a name="API_VpnConnection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnConnection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnConnection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnConnection) 

# VpnConnectionDeviceType
<a name="API_VpnConnectionDeviceType"></a>

List of customer gateway devices that have a sample configuration file available for use. 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*.

## Contents
<a name="API_VpnConnectionDeviceType_Contents"></a>

 ** platform **   
Customer gateway device platform.  
Type: String  
Required: No

 ** software **   
Customer gateway device software version.  
Type: String  
Required: No

 ** vendor **   
Customer gateway device vendor.  
Type: String  
Required: No

 ** vpnConnectionDeviceTypeId **   
Customer gateway device identifier.  
Type: String  
Required: No

## See Also
<a name="API_VpnConnectionDeviceType_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnConnectionDeviceType) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnConnectionDeviceType) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnConnectionDeviceType) 

# VpnConnectionOptions
<a name="API_VpnConnectionOptions"></a>

Describes VPN connection options.

## Contents
<a name="API_VpnConnectionOptions_Contents"></a>

 ** enableAcceleration **   
Indicates whether acceleration is enabled for the VPN connection.  
Type: Boolean  
Required: No

 ** localIpv4NetworkCidr **   
The IPv4 CIDR on the customer gateway (on-premises) side of the VPN connection.  
Type: String  
Required: No

 ** localIpv6NetworkCidr **   
The IPv6 CIDR on the customer gateway (on-premises) side of the VPN connection.  
Type: String  
Required: No

 ** outsideIpAddressType **   
The type of IPv4 address assigned to the outside interface of the customer gateway.  
Valid values: `PrivateIpv4` \$1 `PublicIpv4` \$1 `Ipv6`   
Default: `PublicIpv4`   
Type: String  
Required: No

 ** remoteIpv4NetworkCidr **   
The IPv4 CIDR on the AWS side of the VPN connection.  
Type: String  
Required: No

 ** remoteIpv6NetworkCidr **   
The IPv6 CIDR on the AWS side of the VPN connection.  
Type: String  
Required: No

 ** staticRoutesOnly **   
Indicates whether the VPN connection uses static routes only. Static routes must be used for devices that don't support BGP.  
Type: Boolean  
Required: No

 ** transportTransitGatewayAttachmentId **   
The transit gateway attachment ID in use for the VPN tunnel.  
Type: String  
Required: No

 ** tunnelBandwidth **   
 The configured bandwidth for the VPN tunnel. Represents the current throughput capacity setting for the tunnel connection. `standard` tunnel bandwidth supports up to 1.25 Gbps per tunnel while `large` supports up to 5 Gbps per tunnel. If no tunnel bandwidth was specified for the connection, `standard` is used as the default value.   
Type: String  
Valid Values: `standard | large`   
Required: No

 ** tunnelInsideIpVersion **   
Indicates whether the VPN tunnels process IPv4 or IPv6 traffic.  
Type: String  
Valid Values: `ipv4 | ipv6`   
Required: No

 ** TunnelOptionSet.N **   
Indicates the VPN tunnel options.  
Type: Array of [TunnelOption](API_TunnelOption.md) objects  
Required: No

## See Also
<a name="API_VpnConnectionOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnConnectionOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnConnectionOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnConnectionOptions) 

# VpnConnectionOptionsSpecification
<a name="API_VpnConnectionOptionsSpecification"></a>

Describes VPN connection options.

## Contents
<a name="API_VpnConnectionOptionsSpecification_Contents"></a>

 ** EnableAcceleration **   
Indicate whether to enable acceleration for the VPN connection.  
Default: `false`   
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

 ** OutsideIpAddressType **   
The type of IP address assigned to the outside interface of the customer gateway device.  
Valid values: `PrivateIpv4` \$1 `PublicIpv4` \$1 `Ipv6`   
Default: `PublicIpv4`   
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

 ** StaticRoutesOnly **   
Indicate whether the VPN connection uses static routes only. If you are creating a VPN connection for a device that does not support BGP, you must specify `true`. Use [CreateVpnConnectionRoute](API_CreateVpnConnectionRoute.md) to create a static route.  
Default: `false`   
Type: Boolean  
Required: No

 ** TransportTransitGatewayAttachmentId **   
The transit gateway attachment ID to use for the VPN tunnel.  
Required if `OutsideIpAddressType` is set to `PrivateIpv4`.  
Type: String  
Required: No

 ** TunnelBandwidth **   
 The desired bandwidth specification for the VPN tunnel, used when creating or modifying VPN connection options to set the tunnel's throughput capacity. `standard` supports up to 1.25 Gbps per tunnel, while `large` supports up to 5 Gbps per tunnel. The default value is `standard`. Existing VPN connections without a bandwidth setting will automatically default to `standard`.   
Type: String  
Valid Values: `standard | large`   
Required: No

 ** TunnelInsideIpVersion **   
Indicate whether the VPN tunnels process IPv4 or IPv6 traffic.  
Default: `ipv4`   
Type: String  
Valid Values: `ipv4 | ipv6`   
Required: No

 ** TunnelOptions.N **   
The tunnel options for the VPN connection.  
Type: Array of [VpnTunnelOptionsSpecification](API_VpnTunnelOptionsSpecification.md) objects  
Required: No

## See Also
<a name="API_VpnConnectionOptionsSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnConnectionOptionsSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnConnectionOptionsSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnConnectionOptionsSpecification) 

# VpnGateway
<a name="API_VpnGateway"></a>

Describes a virtual private gateway.

## Contents
<a name="API_VpnGateway_Contents"></a>

 ** amazonSideAsn **   
The private Autonomous System Number (ASN) for the Amazon side of a BGP session.  
Type: Long  
Required: No

 ** Attachments.N **   
Any VPCs attached to the virtual private gateway.  
Type: Array of [VpcAttachment](API_VpcAttachment.md) objects  
Required: No

 ** availabilityZone **   
The Availability Zone where the virtual private gateway was created, if applicable. This field may be empty or not returned.  
Type: String  
Required: No

 ** state **   
The current state of the virtual private gateway.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

 ** TagSet.N **   
Any tags assigned to the virtual private gateway.  
Type: Array of [Tag](API_Tag.md) objects  
Required: No

 ** type **   
The type of VPN connection the virtual private gateway supports.  
Type: String  
Valid Values: `ipsec.1`   
Required: No

 ** vpnGatewayId **   
The ID of the virtual private gateway.  
Type: String  
Required: No

## See Also
<a name="API_VpnGateway_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnGateway) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnGateway) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnGateway) 

# VpnStaticRoute
<a name="API_VpnStaticRoute"></a>

Describes a static route for a VPN connection.

## Contents
<a name="API_VpnStaticRoute_Contents"></a>

 ** destinationCidrBlock **   
The CIDR block associated with the local subnet of the customer data center.  
Type: String  
Required: No

 ** source **   
Indicates how the routes were provided.  
Type: String  
Valid Values: `Static`   
Required: No

 ** state **   
The current state of the static route.  
Type: String  
Valid Values: `pending | available | deleting | deleted`   
Required: No

## See Also
<a name="API_VpnStaticRoute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnStaticRoute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnStaticRoute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnStaticRoute) 

# VpnTunnelLogOptions
<a name="API_VpnTunnelLogOptions"></a>

Options for logging VPN tunnel activity.

## Contents
<a name="API_VpnTunnelLogOptions_Contents"></a>

 ** cloudWatchLogOptions **   
Options for sending VPN tunnel logs to CloudWatch.  
Type: [CloudWatchLogOptions](API_CloudWatchLogOptions.md) object  
Required: No

## See Also
<a name="API_VpnTunnelLogOptions_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnTunnelLogOptions) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnTunnelLogOptions) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnTunnelLogOptions) 

# VpnTunnelLogOptionsSpecification
<a name="API_VpnTunnelLogOptionsSpecification"></a>

Options for logging VPN tunnel activity.

## Contents
<a name="API_VpnTunnelLogOptionsSpecification_Contents"></a>

 ** CloudWatchLogOptions **   
Options for sending VPN tunnel logs to CloudWatch.  
Type: [CloudWatchLogOptionsSpecification](API_CloudWatchLogOptionsSpecification.md) object  
Required: No

## See Also
<a name="API_VpnTunnelLogOptionsSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnTunnelLogOptionsSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnTunnelLogOptionsSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnTunnelLogOptionsSpecification) 

# VpnTunnelOptionsSpecification
<a name="API_VpnTunnelOptionsSpecification"></a>

The tunnel options for a single VPN tunnel.

## Contents
<a name="API_VpnTunnelOptionsSpecification_Contents"></a>

 ** DPDTimeoutAction **   
The action to take after DPD timeout occurs. Specify `restart` to restart the IKE initiation. Specify `clear` to end the IKE session.  
Valid Values: `clear` \$1 `none` \$1 `restart`   
Default: `clear`   
Type: String  
Required: No

 ** DPDTimeoutSeconds **   
The number of seconds after which a DPD timeout occurs.  
Constraints: A value greater than or equal to 30.  
Default: `30`   
Type: Integer  
Required: No

 ** EnableTunnelLifecycleControl **   
Turn on or off tunnel endpoint lifecycle control feature.  
Type: Boolean  
Required: No

 ** IKEVersion.N **   
The IKE versions that are permitted for the VPN tunnel.  
Valid values: `ikev1` \$1 `ikev2`   
Type: Array of [IKEVersionsRequestListValue](API_IKEVersionsRequestListValue.md) objects  
Required: No

 ** LogOptions **   
Options for logging VPN tunnel activity.  
Type: [VpnTunnelLogOptionsSpecification](API_VpnTunnelLogOptionsSpecification.md) object  
Required: No

 ** Phase1DHGroupNumber.N **   
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 1 IKE negotiations.  
Valid values: `2` \$1 `14` \$1 `15` \$1 `16` \$1 `17` \$1 `18` \$1 `19` \$1 `20` \$1 `21` \$1 `22` \$1 `23` \$1 `24`   
Type: Array of [Phase1DHGroupNumbersRequestListValue](API_Phase1DHGroupNumbersRequestListValue.md) objects  
Required: No

 ** Phase1EncryptionAlgorithm.N **   
One or more encryption algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.  
Valid values: `AES128` \$1 `AES256` \$1 `AES128-GCM-16` \$1 `AES256-GCM-16`   
Type: Array of [Phase1EncryptionAlgorithmsRequestListValue](API_Phase1EncryptionAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase1IntegrityAlgorithm.N **   
One or more integrity algorithms that are permitted for the VPN tunnel for phase 1 IKE negotiations.  
Valid values: `SHA1` \$1 `SHA2-256` \$1 `SHA2-384` \$1 `SHA2-512`   
Type: Array of [Phase1IntegrityAlgorithmsRequestListValue](API_Phase1IntegrityAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase1LifetimeSeconds **   
The lifetime for phase 1 of the IKE negotiation, in seconds.  
Constraints: A value between 900 and 28,800.  
Default: `28800`   
Type: Integer  
Required: No

 ** Phase2DHGroupNumber.N **   
One or more Diffie-Hellman group numbers that are permitted for the VPN tunnel for phase 2 IKE negotiations.  
Valid values: `2` \$1 `5` \$1 `14` \$1 `15` \$1 `16` \$1 `17` \$1 `18` \$1 `19` \$1 `20` \$1 `21` \$1 `22` \$1 `23` \$1 `24`   
Type: Array of [Phase2DHGroupNumbersRequestListValue](API_Phase2DHGroupNumbersRequestListValue.md) objects  
Required: No

 ** Phase2EncryptionAlgorithm.N **   
One or more encryption algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.  
Valid values: `AES128` \$1 `AES256` \$1 `AES128-GCM-16` \$1 `AES256-GCM-16`   
Type: Array of [Phase2EncryptionAlgorithmsRequestListValue](API_Phase2EncryptionAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase2IntegrityAlgorithm.N **   
One or more integrity algorithms that are permitted for the VPN tunnel for phase 2 IKE negotiations.  
Valid values: `SHA1` \$1 `SHA2-256` \$1 `SHA2-384` \$1 `SHA2-512`   
Type: Array of [Phase2IntegrityAlgorithmsRequestListValue](API_Phase2IntegrityAlgorithmsRequestListValue.md) objects  
Required: No

 ** Phase2LifetimeSeconds **   
The lifetime for phase 2 of the IKE negotiation, in seconds.  
Constraints: A value between 900 and 3,600. The value must be less than the value for `Phase1LifetimeSeconds`.  
Default: `3600`   
Type: Integer  
Required: No

 ** PreSharedKey **   
The pre-shared key (PSK) to establish initial authentication between the virtual private gateway and customer gateway.  
Constraints: Allowed characters are alphanumeric characters, periods (.), and underscores (\$1). Must be between 8 and 64 characters in length and cannot start with zero (0).  
Type: String  
Required: No

 ** RekeyFuzzPercentage **   
The percentage of the rekey window (determined by `RekeyMarginTimeSeconds`) during which the rekey time is randomly selected.  
Constraints: A value between 0 and 100.  
Default: `100`   
Type: Integer  
Required: No

 ** RekeyMarginTimeSeconds **   
The margin time, in seconds, before the phase 2 lifetime expires, during which the AWS side of the VPN connection performs an IKE rekey. The exact time of the rekey is randomly selected based on the value for `RekeyFuzzPercentage`.  
Constraints: A value between 60 and half of `Phase2LifetimeSeconds`.  
Default: `270`   
Type: Integer  
Required: No

 ** ReplayWindowSize **   
The number of packets in an IKE replay window.  
Constraints: A value between 64 and 2048.  
Default: `1024`   
Type: Integer  
Required: No

 ** StartupAction **   
The action to take when the establishing the tunnel for the VPN connection. By default, your customer gateway device must initiate the IKE negotiation and bring up the tunnel. Specify `start` for AWS to initiate the IKE negotiation.  
Valid Values: `add` \$1 `start`   
Default: `add`   
Type: String  
Required: No

 ** TunnelInsideCidr **   
The range of inside IPv4 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same virtual private gateway.   
Constraints: A size /30 CIDR block from the `169.254.0.0/16` range. The following CIDR blocks are reserved and cannot be used:  
+  `169.254.0.0/30` 
+  `169.254.1.0/30` 
+  `169.254.2.0/30` 
+  `169.254.3.0/30` 
+  `169.254.4.0/30` 
+  `169.254.5.0/30` 
+  `169.254.169.252/30` 
Type: String  
Required: No

 ** TunnelInsideIpv6Cidr **   
The range of inside IPv6 addresses for the tunnel. Any specified CIDR blocks must be unique across all VPN connections that use the same transit gateway.  
Constraints: A size /126 CIDR block from the local `fd00::/8` range.  
Type: String  
Required: No

## See Also
<a name="API_VpnTunnelOptionsSpecification_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/ec2-2016-11-15/VpnTunnelOptionsSpecification) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/ec2-2016-11-15/VpnTunnelOptionsSpecification) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/ec2-2016-11-15/VpnTunnelOptionsSpecification) 