# Amazon OpenSearch Service API Reference

## [Amazon OpenSearch Service](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome_Amazon_OpenSearch_Service.md)

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es. region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see [AWS service endpoints](https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions).

### Actions

- [AcceptInboundConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AcceptInboundConnection.md): Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
- [AddDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AddDataSource.md): Creates a new direct-query data source to the specified domain.
- [AddDirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AddDirectQueryDataSource.md): Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.
- [AddReplicationPeer](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AddReplicationPeer.md): Starts replicating a domain to a peer domain in another AWS Region.
- [AddTags](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AddTags.md): Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application.
- [AssociatePackage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AssociatePackage.md): Associates a package with an Amazon OpenSearch Service domain.
- [AssociatePackages](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AssociatePackages.md): Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.
- [AttachDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AttachDataSource.md): Attaches a data source to an OpenSearch application.
- [AuthorizeVpcEndpointAccess](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AuthorizeVpcEndpointAccess.md): Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- [CancelDomainConfigChange](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CancelDomainConfigChange.md): Cancels a pending configuration change on an Amazon OpenSearch Service domain.
- [CancelServiceSoftwareUpdate](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CancelServiceSoftwareUpdate.md): Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
- [CompareDomainConfiguration](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CompareDomainConfiguration.md): Compares the metadata of two domains and reports where they differ.
- [CreateApplication](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateApplication.md): Creates an OpenSearch UI application.
- [CreateDomain](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateDomain.md): Creates an Amazon OpenSearch Service domain.
- [CreateIndex](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateIndex.md): Creates an OpenSearch index with optional automatic semantic enrichment for specified text fields.
- [CreateOutboundConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateOutboundConnection.md): Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
- [CreatePackage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreatePackage.md): Creates a package for use with Amazon OpenSearch Service domains.
- [CreateVpcEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CreateVpcEndpoint.md): Creates an Amazon OpenSearch Service-managed VPC endpoint.
- [DeleteApplication](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteApplication.md): Deletes a specified OpenSearch application.
- [DeleteDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteDataSource.md): Deletes a direct-query data source.
- [DeleteDirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteDirectQueryDataSource.md): Deletes a previously configured direct query data source from Amazon OpenSearch Service.
- [DeleteDomain](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteDomain.md): Deletes an Amazon OpenSearch Service domain and all of its data.
- [DeleteInboundConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteInboundConnection.md): Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
- [DeleteIndex](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteIndex.md): Deletes an OpenSearch index.
- [DeleteOutboundConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteOutboundConnection.md): Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
- [DeletePackage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeletePackage.md): Deletes an Amazon OpenSearch Service package.
- [DeleteVpcEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeleteVpcEndpoint.md): Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
- [DeregisterCapability](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeregisterCapability.md): Deregisters a capability from an OpenSearch UI application.
- [DescribeDataSourceAttachment](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDataSourceAttachment.md): Returns the current status and details of a specific data source attachment for an OpenSearch application.
- [DescribeDomain](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomain.md): Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
- [DescribeDomainAutoTunes](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainAutoTunes.md): Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
- [DescribeDomainChangeProgress](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainChangeProgress.md): Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
- [DescribeDomainConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainConfig.md): Returns the configuration of an Amazon OpenSearch Service domain.
- [DescribeDomainHealth](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainHealth.md): Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
- [DescribeDomainNodes](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainNodes.md): Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
- [DescribeDomainReplication](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainReplication.md): Describes the replication arrangement that a domain participates in, including the domain's role and the state of its relationship with each peer.
- [DescribeDomains](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomains.md): Returns domain configuration information about the specified Amazon OpenSearch Service domains.
- [DescribeDryRunProgress](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDryRunProgress.md): Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
- [DescribeInboundConnections](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInboundConnections.md): Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
- [DescribeInsightDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInsightDetails.md): Describes the details of an existing insight for an Amazon OpenSearch Service domain.
- [DescribeInstanceTypeLimits](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInstanceTypeLimits.md): Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
- [DescribeOutboundConnections](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeOutboundConnections.md): Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
- [DescribePackages](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribePackages.md): Describes all packages available to OpenSearch Service.
- [DescribeReservedInstanceOfferings](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstanceOfferings.md): Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
- [DescribeReservedInstances](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstances.md): Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
- [DescribeVpcEndpoints](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeVpcEndpoints.md): Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
- [DetachDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DetachDataSource.md): Removes a data source from an OpenSearch application.
- [DissociatePackage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DissociatePackage.md): Removes a package from the specified Amazon OpenSearch Service domain.
- [DissociatePackages](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DissociatePackages.md): Dissociates multiple packages from a domain simultaneously.
- [FailoverReplication](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_FailoverReplication.md): Promotes a secondary domain to primary without coordinating with the current primary.
- [GetApplication](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetApplication.md): Retrieves the configuration and status of an existing OpenSearch application.
- [GetCapability](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCapability.md): Retrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status.
- [GetCompatibleVersions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCompatibleVersions.md): Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
- [GetDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDataSource.md): Retrieves information about a direct query data source.
- [GetDefaultApplicationSetting](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDefaultApplicationSetting.md): Gets the ARN of the current default application.
- [GetDirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDirectQueryDataSource.md): Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.
- [GetDomainMaintenanceStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDomainMaintenanceStatus.md): The status of the maintenance action.
- [GetIndex](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetIndex.md): Retrieves information about an OpenSearch index including its schema and semantic enrichment configuration.
- [GetMigration](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetMigration.md): Retrieves the current status and progress of a migration job, including the number of exported and imported objects and error details if the migration failed.
- [GetPackageVersionHistory](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetPackageVersionHistory.md): Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).
- [GetUpgradeHistory](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetUpgradeHistory.md): Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
- [GetUpgradeStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetUpgradeStatus.md): Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
- [InsightFeedback](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InsightFeedback.md): Submits feedback for an existing insight in an Amazon OpenSearch Service domain.
- [ListApplications](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListApplications.md): Lists all OpenSearch applications under your account.
- [ListDataSourceAttachments](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDataSourceAttachments.md): Returns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states (PENDING, ATTACHED, and FAILED).
- [ListDataSources](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDataSources.md): Lists direct-query data sources for a specific domain.
- [ListDirectQueryDataSources](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDirectQueryDataSources.md): Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.
- [ListDomainMaintenances](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainMaintenances.md): A list of maintenance actions for the domain.
- [ListDomainNames](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainNames.md): Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
- [ListDomainsForPackage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainsForPackage.md): Lists all Amazon OpenSearch Service domains associated with a given package.
- [ListInsights](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInsights.md): Lists insights for an Amazon OpenSearch Service domain or Amazon Web Services account.
- [ListInstanceTypeDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInstanceTypeDetails.md): Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
- [ListMigrations](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListMigrations.md): Lists migration jobs for an Amazon OpenSearch Service application.
- [ListPackagesForDomain](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListPackagesForDomain.md): Lists all packages associated with an Amazon OpenSearch Service domain.
- [ListScheduledActions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.md): Retrieves a list of configuration changes that are scheduled for a domain.
- [ListTags](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListTags.md): Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application.
- [ListVersions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVersions.md): Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
- [ListVpcEndpointAccess](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpointAccess.md): Retrieves information about each AWS principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- [ListVpcEndpoints](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpoints.md): Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current AWS account and Region.
- [ListVpcEndpointsForDomain](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpointsForDomain.md): Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
- [PurchaseReservedInstanceOffering](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PurchaseReservedInstanceOffering.md): Allows you to purchase Amazon OpenSearch Service Reserved Instances.
- [PutDefaultApplicationSetting](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PutDefaultApplicationSetting.md): Sets the default application to the application with the specified ARN.
- [RegisterCapability](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RegisterCapability.md): Registers a capability for an OpenSearch UI application.
- [RejectInboundConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RejectInboundConnection.md): Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
- [RemoveReplicationPeer](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RemoveReplicationPeer.md): Stops replicating a domain to its peer.
- [RemoveTags](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RemoveTags.md): Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application.
- [RevokeVpcEndpointAccess](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RevokeVpcEndpointAccess.md): Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
- [RollbackServiceSoftwareUpdate](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RollbackServiceSoftwareUpdate.md): Rolls back a service software update for a domain to the previous version.
- [StartDomainMaintenance](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_StartDomainMaintenance.md): Starts the node maintenance process on the data node.
- [StartMigration](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_StartMigration.md): Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace.
- [StartServiceSoftwareUpdate](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_StartServiceSoftwareUpdate.md): Schedules a service software update for an Amazon OpenSearch Service domain.
- [SwitchoverReplication](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SwitchoverReplication.md): Promotes a secondary domain to primary, coordinating with the current primary so that no writes are lost.
- [UpdateApplication](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateApplication.md): Updates the configuration and settings of an existing OpenSearch application.
- [UpdateDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateDataSource.md): Updates a direct-query data source.
- [UpdateDirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateDirectQueryDataSource.md): Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.
- [UpdateDomainConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateDomainConfig.md): Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
- [UpdateIndex](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateIndex.md): Updates an existing OpenSearch index schema and semantic enrichment configuration.
- [UpdatePackage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdatePackage.md): Updates a package for use with Amazon OpenSearch Service domains.
- [UpdatePackageScope](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdatePackageScope.md): Updates the scope of a package.
- [UpdateScheduledAction](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateScheduledAction.md): Reschedules a planned domain configuration change for a later time.
- [UpdateVpcEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpdateVpcEndpoint.md): Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
- [UpgradeDomain](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpgradeDomain.md): Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

### Data Types

- [AccessPoliciesStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AccessPoliciesStatus.md): The configured access rules for the domain's search endpoint, and the current status of those rules.
- [AdditionalLimit](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AdditionalLimit.md): List of limits that are specific to a given instance type.
- [AdvancedOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AdvancedOptionsStatus.md): Status of the advanced options for the specified domain.
- [AdvancedSecurityOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AdvancedSecurityOptions.md): Container for fine-grained access control settings.
- [AdvancedSecurityOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AdvancedSecurityOptionsInput.md): Options for enabling and configuring fine-grained access control.
- [AdvancedSecurityOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AdvancedSecurityOptionsStatus.md): The status of fine-grained access control settings for a domain.
- [AIConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AIConfig.md): Configuration settings for AI-powered capabilities of an OpenSearch UI application.
- [AIMLOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AIMLOptionsInput.md): Container for parameters required to enable all machine learning features.
- [AIMLOptionsOutput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AIMLOptionsOutput.md): Container for parameters representing the state of machine learning features on the specified domain.
- [AIMLOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AIMLOptionsStatus.md): The status of machine learning options on the specified domain.
- [AppConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AppConfig.md): Configuration settings for an OpenSearch application.
- [ApplicationSummary](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ApplicationSummary.md): Basic details of an OpenSearch application.
- [AuthorizedPrincipal](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AuthorizedPrincipal.md): Information about an AWS account or service that has access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- [AutomatedSnapshotPauseOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutomatedSnapshotPauseOptions.md): Specifies the automated snapshot pause options for the domain.
- [AutomatedSnapshotPauseOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutomatedSnapshotPauseOptionsStatus.md): The status of automated snapshot pause options for the domain.
- [AutomatedSnapshotPauseRequestOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutomatedSnapshotPauseRequestOptions.md): Specifies the automated snapshot pause request options for the domain.
- [AutoTune](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTune.md): Information about an Auto-Tune action.
- [AutoTuneDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTuneDetails.md): Specifies details about a scheduled Auto-Tune action.
- [AutoTuneMaintenanceSchedule](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTuneMaintenanceSchedule.md)
- [AutoTuneOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTuneOptions.md): Auto-Tune settings when updating a domain.
- [AutoTuneOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTuneOptionsInput.md): Options for configuring Auto-Tune.
- [AutoTuneOptionsOutput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTuneOptionsOutput.md): The Auto-Tune settings for a domain, displayed when enabling or disabling Auto-Tune.
- [AutoTuneOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTuneOptionsStatus.md): The Auto-Tune status for the domain.
- [AutoTuneStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AutoTuneStatus.md): The current status of Auto-Tune for the domain.
- [AvailabilityZoneInfo](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AvailabilityZoneInfo.md): Information about an Availability Zone on a domain.
- [AWSDomainInformation](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_AWSDomainInformation.md): Information about an Amazon OpenSearch Service domain.
- [CancelledChangeProperty](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CancelledChangeProperty.md): A property change that was cancelled for an Amazon OpenSearch Service domain.
- [CapabilityBaseRequestConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CapabilityBaseRequestConfig.md): The base configuration for registering a capability.
- [CapabilityBaseResponseConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CapabilityBaseResponseConfig.md): The base configuration returned for a registered capability.
- [CapabilityExtendedResponseConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CapabilityExtendedResponseConfig.md): The extended configuration returned for a registered capability, including additional details beyond the base configuration.
- [CapabilityFailure](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CapabilityFailure.md): Information about a capability failure.
- [CategoryDiffResult](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CategoryDiffResult.md): The result of comparing one metadata category between two domains.
- [ChangeProgressDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ChangeProgressDetails.md): Container for information about a configuration change happening on a domain.
- [ChangeProgressStage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ChangeProgressStage.md): Progress details for each stage of a domain update.
- [ChangeProgressStatusDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ChangeProgressStatusDetails.md): The progress details of a specific domain configuration change.
- [CloudWatchDirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CloudWatchDirectQueryDataSource.md): Configuration details for a CloudWatch Logs data source that can be used for direct queries.
- [ClusterConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ClusterConfig.md): Container for the cluster configuration of an OpenSearch Service domain.
- [ClusterConfigStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ClusterConfigStatus.md): The cluster configuration status for a domain.
- [CognitoOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CognitoOptions.md): Container for the parameters required to enable Cognito authentication for an OpenSearch Service domain.
- [CognitoOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CognitoOptionsStatus.md): The status of the Cognito options for the specified domain.
- [ColdStorageOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ColdStorageOptions.md): Container for the parameters required to enable cold storage for an OpenSearch Service domain.
- [CompatibleVersionsMap](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CompatibleVersionsMap.md): A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
- [ConnectionProperties](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ConnectionProperties.md): The connection properties of an outbound connection.
- [CrossClusterSearchConnectionProperties](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_CrossClusterSearchConnectionProperties.md): Cross-cluster search specific connection properties.
- [DataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DataSource.md): Data sources that are associated with an OpenSearch application.
- [DataSourceAttachmentSummary](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DataSourceAttachmentSummary.md): Summary information about a data source attachment, including its identifier, data source ARN, and current status.
- [DataSourceDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DataSourceDetails.md): Details about a direct-query data source.
- [DataSourceType](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DataSourceType.md): The type of data source.
- [DeploymentStrategyOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeploymentStrategyOptions.md): Specifies the deployment strategy options for the domain.
- [DeploymentStrategyOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DeploymentStrategyOptionsStatus.md): The status of deployment strategy options for the domain.
- [DescribePackagesFilter](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribePackagesFilter.md): A filter to apply to the DescribePackage response.
- [DiffItems](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DiffItems.md): The items that differ within one metadata category.
- [DirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DirectQueryDataSource.md): The configuration details for a data source that can be directly queried.
- [DirectQueryDataSourceType](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DirectQueryDataSourceType.md): The type of data source that is used for direct queries.
- [DivergentField](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DivergentField.md): A single field that differs between the source and target copies of an item.
- [DivergentItem](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DivergentItem.md): An item that exists on both domains but whose contents differ.
- [DomainConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainConfig.md): Container for the configuration of an OpenSearch Service domain.
- [DomainEndpointOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainEndpointOptions.md): Options to configure a custom endpoint for an OpenSearch Service domain.
- [DomainEndpointOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainEndpointOptionsStatus.md): The configured endpoint options for a domain and their current status.
- [DomainInfo](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainInfo.md): Information about an OpenSearch Service domain.
- [DomainInformationContainer](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainInformationContainer.md): Container for information about an OpenSearch Service domain.
- [DomainMaintenanceDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainMaintenanceDetails.md): Container for the domain maintenance details.
- [DomainNodesStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainNodesStatus.md): Container for information about nodes on the domain.
- [DomainPackageDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainPackageDetails.md): Information about a package that is associated with a domain.
- [DomainStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DomainStatus.md): The current status of an OpenSearch Service domain.
- [DryRunProgressStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DryRunProgressStatus.md): Information about the progress of a pre-upgrade dry run analysis.
- [DryRunResults](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DryRunResults.md): Results of a dry run performed in an update domain request.
- [Duration](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_Duration.md): The duration of a maintenance schedule.
- [EBSOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_EBSOptions.md): Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
- [EBSOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_EBSOptionsStatus.md): The status of the EBS options for the specified OpenSearch Service domain.
- [EncryptionAtRestOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_EncryptionAtRestOptions.md): Specifies whether the domain should encrypt data at rest, and if so, the Key Management Service (KMS) key to use.
- [EncryptionAtRestOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_EncryptionAtRestOptionsStatus.md): Status of the encryption at rest options for the specified OpenSearch Service domain.
- [EngineModeStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_EngineModeStatus.md): The status of the engine mode for the domain.
- [EnvironmentInfo](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_EnvironmentInfo.md): Information about the active domain environment.
- [ErrorDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ErrorDetails.md): Additional information if the package is in an error state.
- [ExportOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ExportOptions.md): Options to filter the scope of saved objects to export during a migration.
- [Filter](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_Filter.md): A filter used to limit results when describing inbound or outbound cross-cluster connections.
- [IAMFederationOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IAMFederationOptionsInput.md): Input parameters for configuring IAM identity federation settings.
- [IAMFederationOptionsOutput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IAMFederationOptionsOutput.md): Output parameters showing the current IAM identity federation configuration.
- [IamIdentityCenterOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IamIdentityCenterOptions.md): Configuration settings for IAM Identity Center in an OpenSearch application.
- [IamIdentityCenterOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IamIdentityCenterOptionsInput.md): Configuration settings for enabling and managing IAM Identity Center.
- [IdentityCenterOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IdentityCenterOptions.md): Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources.
- [IdentityCenterOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IdentityCenterOptionsInput.md): Configuration settings for enabling and managing IAM Identity Center.
- [IdentityCenterOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IdentityCenterOptionsStatus.md): The status of IAM Identity Center configuration settings for a domain.
- [InboundConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InboundConnection.md): Describes an inbound cross-cluster connection for Amazon OpenSearch Service.
- [InboundConnectionStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InboundConnectionStatus.md): The status of an inbound cross-cluster connection for OpenSearch Service.
- [Insight](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_Insight.md): Represents an insight returned by the ListInsights operation.
- [InsightEntity](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InsightEntity.md): Specifies the entity for which to retrieve insights.
- [InsightFeedbackEntity](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InsightFeedbackEntity.md): Specifies the entity for which to submit insight feedback.
- [InsightField](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InsightField.md): Represents a field in the detailed view of an insight, returned by the DescribeInsightDetails operation.
- [InsightTimeRange](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InsightTimeRange.md): Specifies the time range for filtering insights.
- [InstanceCountLimits](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InstanceCountLimits.md): Limits on the number of instances that can be created in OpenSearch Service for a given instance type.
- [InstanceLimits](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InstanceLimits.md): Instance-related attributes that are available for a given instance type.
- [InstanceTypeDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_InstanceTypeDetails.md): Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
- [IPAddressTypeStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_IPAddressTypeStatus.md): The IP address type status for the domain.
- [JWTOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_JWTOptionsInput.md): The JWT authentication and authorization configuration for an Amazon OpenSearch Service domain.
- [JWTOptionsOutput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_JWTOptionsOutput.md): Describes the JWT options configured for the domain.
- [KeyStoreAccessOption](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_KeyStoreAccessOption.md): The configuration parameters to enable access to the key store required by the package.
- [Limits](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_Limits.md): Limits for a given instance type and for each of its roles.
- [LogPublishingOption](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_LogPublishingOption.md): Specifies whether the Amazon OpenSearch Service domain publishes the OpenSearch application and slow logs to Amazon CloudWatch.
- [LogPublishingOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_LogPublishingOptionsStatus.md): The configured log publishing options for the domain and their current status.
- [MasterUserOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_MasterUserOptions.md): Credentials for the master user for a domain.
- [MigrationError](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_MigrationError.md): Contains error details for a migration that failed or completed with errors.
- [MigrationOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_MigrationOptions.md): The configuration options for a saved objects migration job.
- [MigrationSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_MigrationSource.md): The source configuration for a migration, specifying the data source from which to export saved objects.
- [MigrationSummary](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_MigrationSummary.md): A summary of a migration job, including its status and progress.
- [MigrationWorkspace](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_MigrationWorkspace.md): The target workspace configuration for a migration.
- [ModifyingProperties](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ModifyingProperties.md): Information about the domain properties that are currently being modified.
- [NaturalLanguageQueryGenerationOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_NaturalLanguageQueryGenerationOptionsInput.md): Container for parameters required to enable the natural language query generation feature.
- [NaturalLanguageQueryGenerationOptionsOutput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_NaturalLanguageQueryGenerationOptionsOutput.md): Container for parameters representing the state of the natural language query generation feature on the specified domain.
- [NodeConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_NodeConfig.md): Configuration options for defining the setup of any node type within the cluster.
- [NodeOption](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_NodeOption.md): Configuration settings for defining the node type within a cluster.
- [NodeToNodeEncryptionOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_NodeToNodeEncryptionOptions.md): Enables or disables node-to-node encryption.
- [NodeToNodeEncryptionOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_NodeToNodeEncryptionOptionsStatus.md): Status of the node-to-node encryption options for the specified domain.
- [OffPeakWindow](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindow.md): A custom 10-hour, low-traffic window during which OpenSearch Service can perform mandatory configuration changes on the domain.
- [OffPeakWindowOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindowOptions.md): Options for a domain's off-peak window, during which OpenSearch Service can perform mandatory configuration changes on the domain.
- [OffPeakWindowOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OffPeakWindowOptionsStatus.md): The status of off-peak window options for a domain.
- [OptionStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OptionStatus.md): Provides the current status of an entity.
- [OutboundConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OutboundConnection.md): Specifies details about an outbound cross-cluster connection.
- [OutboundConnectionStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_OutboundConnectionStatus.md): The status of an outbound cross-cluster connection.
- [PackageAssociationConfiguration](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageAssociationConfiguration.md): The configuration for associating a package with a domain.
- [PackageConfiguration](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageConfiguration.md): The configuration parameters for a package.
- [PackageDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageDetails.md): Basic information about a package.
- [PackageDetailsForAssociation](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageDetailsForAssociation.md): Details of a package that is associated with a domain.
- [PackageEncryptionOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageEncryptionOptions.md): Encryption options for a package.
- [PackageSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageSource.md): The Amazon S3 location to import the package from.
- [PackageVendingOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageVendingOptions.md): Configuration options for determining whether a package can be made available for use by other users.
- [PackageVersionHistory](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PackageVersionHistory.md): Details about a package version.
- [PluginProperties](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PluginProperties.md): Basic information about the plugin.
- [PrometheusDirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_PrometheusDirectQueryDataSource.md): Configuration details for a Prometheus data source that can be used for direct queries.
- [RecurringCharge](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RecurringCharge.md): Contains the specific price and frequency of a recurring charges for an OpenSearch Reserved Instance, or for a Reserved Instance offering.
- [ReplicationPeer](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ReplicationPeer.md): A domain that another domain replicates with, and the state of that relationship.
- [ReservedInstance](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ReservedInstance.md): Details of an OpenSearch Reserved Instance.
- [ReservedInstanceOffering](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ReservedInstanceOffering.md): Details of an OpenSearch Reserved Instance offering.
- [RollbackServiceSoftwareOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_RollbackServiceSoftwareOptions.md): Details about the rollback options for a service software update.
- [S3GlueDataCatalog](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_S3GlueDataCatalog.md): Information about the Amazon S3 Glue Data Catalog.
- [S3VectorsEngine](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_S3VectorsEngine.md): Options for enabling S3 vectors engine features on the specified domain.
- [SAMLIdp](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SAMLIdp.md): The SAML identity povider information.
- [SAMLOptionsInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SAMLOptionsInput.md): The SAML authentication configuration for an Amazon OpenSearch Service domain.
- [SAMLOptionsOutput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SAMLOptionsOutput.md): Describes the SAML application configured for the domain.
- [SavedObjectIdentifier](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SavedObjectIdentifier.md): Identifies a specific saved object by its type and unique identifier.
- [ScheduledAction](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ScheduledAction.md): Information about a scheduled configuration change for an OpenSearch Service domain.
- [ScheduledAutoTuneDetails](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ScheduledAutoTuneDetails.md): Specifies details about a scheduled Auto-Tune action.
- [SecurityLakeDirectQueryDataSource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SecurityLakeDirectQueryDataSource.md): Configuration details for a Security Lake data source that can be used for direct queries.
- [ServerlessVectorAcceleration](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ServerlessVectorAcceleration.md): Configuration for serverless vector acceleration, which provides GPU-accelerated vector search capabilities for improved performance on vector workloads.
- [ServiceOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ServiceOptions.md): Options for the service, such as the supported Regions.
- [ServiceSoftwareOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ServiceSoftwareOptions.md): The current status of the service software for an Amazon OpenSearch Service domain.
- [SnapshotOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SnapshotOptions.md): The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain.
- [SnapshotOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SnapshotOptionsStatus.md): Container for information about a daily automated snapshot for an OpenSearch Service domain.
- [SoftwareUpdateOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SoftwareUpdateOptions.md): Options for configuring service software updates for a domain.
- [SoftwareUpdateOptionsStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_SoftwareUpdateOptionsStatus.md): The status of the service software options for a domain.
- [StorageType](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_StorageType.md): A list of storage types for an Amazon OpenSearch Service domain that are available for a given intance type.
- [StorageTypeLimit](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_StorageTypeLimit.md): Limits that are applicable for the given Amazon OpenSearch Service storage type.
- [Tag](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_Tag.md): A tag (key-value pair) for an Amazon OpenSearch Service resource.
- [UpgradeHistory](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpgradeHistory.md): History of the last 10 upgrades and upgrade eligibility checks for an Amazon OpenSearch Service domain.
- [UpgradeStepItem](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UpgradeStepItem.md): Represents a single step of an upgrade or upgrade eligibility check workflow.
- [UseCaseStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_UseCaseStatus.md): The status of the use case for the domain.
- [ValidationFailure](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ValidationFailure.md): A validation failure that occurred as the result of a pre-update validation check (verbose dry run) on a domain.
- [VersionStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_VersionStatus.md): The status of the the OpenSearch or Elasticsearch version options for the specified Amazon OpenSearch Service domain.
- [VPCDerivedInfo](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_VPCDerivedInfo.md): Information about the subnets and security groups for an Amazon OpenSearch Service domain provisioned within a virtual private cloud (VPC).
- [VPCDerivedInfoStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_VPCDerivedInfoStatus.md): Status of the VPC options for a specified domain.
- [VpcEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_VpcEndpoint.md): The connection endpoint for connecting to an Amazon OpenSearch Service domain through a proxy.
- [VpcEndpointError](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_VpcEndpointError.md): Error information when attempting to describe an Amazon OpenSearch Service-managed VPC endpoint.
- [VpcEndpointSummary](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_VpcEndpointSummary.md): Summary information for an Amazon OpenSearch Service-managed VPC endpoint.
- [VPCOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_VPCOptions.md): Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
- [WindowStartTime](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_WindowStartTime.md): The desired start time for an off-peak maintenance window.
- [WorkspaceConfigurationInput](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_WorkspaceConfigurationInput.md): Configuration for creating a new workspace when attaching a data source to an OpenSearch application.
- [ZoneAwarenessConfig](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ZoneAwarenessConfig.md): The zone awareness configuration for an Amazon OpenSearch Service domain.

## [Amazon OpenSearch Ingestion Service](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome_Amazon_OpenSearch_Ingestion_Service.md)

Use the Amazon OpenSearch Ingestion API to create and manage ingestion pipelines. OpenSearch Ingestion is a fully managed data collector that delivers real-time log and trace data to OpenSearch Service domains. For more information, see [Getting data into your cluster using OpenSearch Ingestion](https://docs.aws.amazon.com/opensearch-service/latest/developerguide/ingestion.html).

### Actions

- [CreatePipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_CreatePipeline.md): Creates an OpenSearch Ingestion pipeline.
- [CreatePipelineEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_CreatePipelineEndpoint.md): Creates a VPC endpoint for an OpenSearch Ingestion pipeline.
- [DeletePipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_DeletePipeline.md): Deletes an OpenSearch Ingestion pipeline.
- [DeletePipelineEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_DeletePipelineEndpoint.md): Deletes a VPC endpoint for an OpenSearch Ingestion pipeline.
- [DeleteResourcePolicy](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_DeleteResourcePolicy.md): Deletes a resource-based policy from an OpenSearch Ingestion resource.
- [GetPipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetPipeline.md): Retrieves information about an OpenSearch Ingestion pipeline.
- [GetPipelineBlueprint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetPipelineBlueprint.md): Retrieves information about a specific blueprint for OpenSearch Ingestion.
- [GetPipelineChangeProgress](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetPipelineChangeProgress.md): Returns progress information for the current change happening on an OpenSearch Ingestion pipeline.
- [GetResourcePolicy](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_GetResourcePolicy.md): Retrieves the resource-based policy attached to an OpenSearch Ingestion resource.
- [ListPipelineBlueprints](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelineBlueprints.md): Retrieves a list of all available blueprints for Data Prepper.
- [ListPipelineEndpointConnections](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelineEndpointConnections.md): Lists the pipeline endpoints connected to pipelines in your account.
- [ListPipelineEndpoints](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelineEndpoints.md): Lists all pipeline endpoints in your account.
- [ListPipelines](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListPipelines.md): Lists all OpenSearch Ingestion pipelines in the current AWS account and Region.
- [ListTagsForResource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ListTagsForResource.md): Lists all resource tags associated with an OpenSearch Ingestion pipeline.
- [PutResourcePolicy](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PutResourcePolicy.md): Attaches a resource-based policy to an OpenSearch Ingestion resource.
- [RevokePipelineEndpointConnections](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_RevokePipelineEndpointConnections.md): Revokes pipeline endpoints from specified endpoint IDs.
- [StartPipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_StartPipeline.md): Starts an OpenSearch Ingestion pipeline.
- [StopPipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_StopPipeline.md): Stops an OpenSearch Ingestion pipeline.
- [TagResource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_TagResource.md): Tags an OpenSearch Ingestion pipeline.
- [UntagResource](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_UntagResource.md): Removes one or more tags from an OpenSearch Ingestion pipeline.
- [UpdatePipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_UpdatePipeline.md): Updates an OpenSearch Ingestion pipeline.
- [ValidatePipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ValidatePipeline.md): Checks whether an OpenSearch Ingestion pipeline configuration is valid prior to creation.

### Data Types

- [BufferOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_BufferOptions.md): Options that specify the configuration of a persistent buffer.
- [ChangeProgressStage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ChangeProgressStage.md): Progress details for a specific stage of a pipeline configuration change.
- [ChangeProgressStatus](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ChangeProgressStatus.md): The progress details of a pipeline configuration change.
- [CloudWatchLogDestination](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_CloudWatchLogDestination.md): The destination for OpenSearch Ingestion logs sent to Amazon CloudWatch.
- [EncryptionAtRestOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_EncryptionAtRestOptions.md): Options to control how OpenSearch encrypts buffer data.
- [LogPublishingOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_LogPublishingOptions.md): Container for the values required to configure logging for the pipeline.
- [Pipeline](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_Pipeline.md): Information about an existing OpenSearch Ingestion pipeline.
- [PipelineBlueprint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineBlueprint.md): Container for information about an OpenSearch Ingestion blueprint.
- [PipelineBlueprintSummary](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineBlueprintSummary.md): A summary of an OpenSearch Ingestion blueprint.
- [PipelineDestination](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineDestination.md): An object representing the destination of a pipeline.
- [PipelineEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineEndpoint.md): Represents a VPC endpoint for an OpenSearch Ingestion pipeline, enabling private connectivity between your VPC and the pipeline.
- [PipelineEndpointConnection](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineEndpointConnection.md): Represents a connection to a pipeline endpoint, containing details about the endpoint association.
- [PipelineEndpointVpcOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineEndpointVpcOptions.md): Configuration settings for the VPC endpoint, specifying network access controls.
- [PipelineStatusReason](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineStatusReason.md): Information about a pipeline's current status.
- [PipelineSummary](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_PipelineSummary.md): Summary information for an OpenSearch Ingestion pipeline.
- [ServiceVpcEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ServiceVpcEndpoint.md): A container for information about VPC endpoints that were created to other services
- [Tag](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_Tag.md): A tag (key-value pair) for an OpenSearch Ingestion pipeline.
- [ValidationMessage](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_ValidationMessage.md): A validation message associated with a ValidatePipeline request in OpenSearch Ingestion.
- [VpcAttachmentOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_VpcAttachmentOptions.md): Options for attaching a VPC to pipeline.
- [VpcEndpoint](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_VpcEndpoint.md): An OpenSearch Ingestion-managed VPC endpoint that will access one or more pipelines.
- [VpcOptions](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_osis_VpcOptions.md): Options that specify the subnets and security groups for an OpenSearch Ingestion VPC endpoint.

## Common

- [Common Parameters](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/CommonParameters.md)
- [Common Error Types](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/CommonErrors.md)

## Full content

The entire guide is also available as a single markdown file, useful for feeding the full guide to an LLM in one pass:

- [Complete guide (single file)](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/full.md)