# Data retrieval APIs for Amazon OpenSearch Service
<a name="amazonopensearchservice"></a>

Amazon OpenSearch Service provides the following APIs for data retrieval.


****  

| Actions | Description | Access level | 
| --- | --- | --- | 
| <a name="es-DescribeDomain"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomain.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomain.html) | View a description of the domain configuration for the specified OpenSearch Service domain, including the domain ID, service endpoint, and ARN | Read | 
| <a name="es-DescribeDomainAutoTunes"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainAutoTunes.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainAutoTunes.html) | View the Auto-Tune configuration of the domain for the specified OpenSearch Service domain, including the Auto-Tune state and maintenance schedules | Read | 
| <a name="es-DescribeDomainChangeProgress"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainChangeProgress.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainChangeProgress.html) | View detail stage progress of an OpenSearch Service domain | Read | 
| <a name="es-DescribeDomainConfig"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainConfig.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainConfig.html) | View a description of the configuration options and status of an OpenSearch Service domain | Read | 
| <a name="es-DescribeDomainHealth"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainHealth.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainHealth.html) | View information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node | Read | 
| <a name="es-DescribeDomainNodes"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainNodes.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainNodes.html) | View information about nodes configured for the domain and their configurations- the node id, type of node, status of node, Availability Zone, instance type and storage | Read | 
| <a name="es-DescribeDomains"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomains.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomains.html) | View a description of the domain configuration for up to five specified OpenSearch Service domains | List | 
| <a name="es-DescribeDryRunProgress"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDryRunProgress.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDryRunProgress.html) | Describe the status of a pre-update validation check on an OpenSearch Service domain | Read | 
| <a name="es-DescribeElasticsearchDomain"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomain.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomain.html) | View a description of the domain configuration for the specified OpenSearch Service domain, including the domain ID, service endpoint, and ARN. This permission is deprecated. Use DescribeDomain instead | Read | 
| <a name="es-DescribeElasticsearchDomainConfig"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainConfig.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomainConfig.html) | View a description of the configuration and status of an OpenSearch Service domain. This permission is deprecated. Use DescribeDomainConfig instead | Read | 
| <a name="es-DescribeElasticsearchDomains"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomains.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeDomains.html) | View a description of the domain configuration for up to five specified Amazon OpenSearch domains. This permission is deprecated. Use DescribeDomains instead | List | 
| <a name="es-DescribeElasticsearchInstanceTypeLimits"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInstanceTypeLimits.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInstanceTypeLimits.html) | View the instance count, storage, and master node limits for a given OpenSearch version and instance type. This permission is deprecated. Use DescribeInstanceTypeLimits instead | List | 
| <a name="es-DescribeInboundConnections"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInboundConnections.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInboundConnections.html) | List all the inbound cross-cluster search connections for a destination domain | List | 
| <a name="es-DescribeInboundCrossClusterSearchConnections"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInboundConnections.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInboundConnections.html) | List all the inbound cross-cluster search connections for a destination domain. This permission is deprecated. Use DescribeInboundConnections instead | List | 
| <a name="es-DescribeInsightDetails"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInsightDetails.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInsightDetails.html) | View detailed information about insights for an OpenSearch Service domain | Read | 
| <a name="es-DescribeInstanceTypeLimits"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInstanceTypeLimits.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeInstanceTypeLimits.html) | View the instance count, storage, and master node limits for a given engine version and instance type | List | 
| <a name="es-DescribeOutboundConnections"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeOutboundConnections.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeOutboundConnections.html) | List all the outbound cross-cluster search connections for a source domain | List | 
| <a name="es-DescribeOutboundCrossClusterSearchConnections"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeOutboundConnections.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeOutboundConnections.html) | List all the outbound cross-cluster search connections for a source domain. This permission is deprecated. Use DescribeOutboundConnections instead | List | 
| <a name="es-DescribePackages"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribePackages.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribePackages.html) | Describe all packages available to OpenSearch Service domains | Read | 
| <a name="es-DescribeReservedElasticsearchInstanceOfferings"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstanceOfferings.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstanceOfferings.html) | Fetch Reserved Instance offerings for Amazon OpenSearch Service. This permission is deprecated. Use DescribeReservedInstanceOfferings instead | List | 
| <a name="es-DescribeReservedElasticsearchInstances"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstances.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstances.html) | Fetch OpenSearch Service Reserved Instances that have already been purchased. This permission is deprecated. Use DescribeReservedInstances instead | List | 
| <a name="es-DescribeReservedInstanceOfferings"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstanceOfferings.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstanceOfferings.html) | Fetch Reserved Instance offerings for OpenSearch Service | List | 
| <a name="es-DescribeReservedInstances"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstances.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeReservedInstances.html) | Fetch OpenSearch Service Reserved Instances that have already been purchased | List | 
| <a name="es-DescribeVpcEndpoints"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeVpcEndpoints.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_DescribeVpcEndpoints.html) | Describe one or more Amazon OpenSearch Service-managed VPC endpoints | List | 
| <a name="es-ESCrossClusterGet"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html) | Send cross-cluster requests to a destination domain | Read | 
| <a name="es-ESHttpGet"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html) | Send HTTP GET requests to the OpenSearch APIs | Read | 
| <a name="es-ESHttpHead"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/Welcome.html) | Send HTTP HEAD requests to the OpenSearch APIs | Read | 
| <a name="es-GetApplication"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetApplication.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetApplication.html) | Get information about an OpenSearch Application | Read | 
| <a name="es-GetCapability"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCapability.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCapability.html) | Get a registered capability for an OpenSearch Application | Read | 
| <a name="es-GetCompatibleElasticsearchVersions"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCompatibleVersions.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCompatibleVersions.html) | Fetch a list of compatible OpenSearch and Elasticsearch versions to which an OpenSearch Service domain can be upgraded. This permission is deprecated. Use GetCompatibleVersions instead | List | 
| <a name="es-GetCompatibleVersions"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCompatibleVersions.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetCompatibleVersions.html) | Fetch list of compatible engine versions to which an OpenSearch Service domain can be upgraded | List | 
| <a name="es-GetDataSource"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDataSource.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDataSource.html) | Get the data source for the OpenSearch Service domain | Read | 
| <a name="es-GetDefaultApplicationSetting"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDefaultApplicationSetting.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDefaultApplicationSetting.html) | Get the default application setting for OpenSearch Service | Read | 
| <a name="es-GetDirectQueryDataSource"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDirectQueryDataSource.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDirectQueryDataSource.html) | Get the data source for the provided OpenSearch arns | Read | 
| <a name="es-GetDomainMaintenanceStatus"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDomainMaintenanceStatus.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetDomainMaintenanceStatus.html) | Retrieve the status of maintenance action for the node | Read | 
| <a name="es-GetIndex"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetIndex.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetIndex.html) | Get index for the OpenSearch Service domain | Read | 
| <a name="es-GetPackageVersionHistory"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetPackageVersionHistory.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetPackageVersionHistory.html) | Fetch the version history for a package | Read | 
| <a name="es-GetUpgradeHistory"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetUpgradeHistory.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetUpgradeHistory.html) | Fetch the upgrade history of a given OpenSearch Service domain | Read | 
| <a name="es-GetUpgradeStatus"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetUpgradeStatus.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_GetUpgradeStatus.html) | Fetch the upgrade status of a given OpenSearch Service domain | Read | 
| <a name="es-ListApplications"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListApplications.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListApplications.html) | List OpenSearch Applications | List | 
| <a name="es-ListDataSources"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDataSources.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDataSources.html) | Retrieve a list of data source for the OpenSearch Service domain | List | 
| <a name="es-ListDirectQueryDataSources"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDirectQueryDataSources.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDirectQueryDataSources.html) | Retrieve a list of data source for the provided OpenSearch arns | List | 
| <a name="es-ListDomainMaintenances"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainMaintenances.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainMaintenances.html) | Retrieve a list of maintenance actions for the OpenSearch Service domain | List | 
| <a name="es-ListDomainNames"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainNames.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainNames.html) | Display the names of all OpenSearch Service domains that the current user owns | List | 
| <a name="es-ListDomainsForPackage"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainsForPackage.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListDomainsForPackage.html) | List all OpenSearch Service domains that a package is associated with | List | 
| <a name="es-ListElasticsearchInstanceTypeDetails"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInstanceTypeDetails.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInstanceTypeDetails.html) | List all instance types and available features for a given OpenSearch version. This permission is deprecated. Use ListInstanceTypeDetails instead | List | 
| <a name="es-ListElasticsearchInstanceTypes"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInstanceTypeDetails.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInstanceTypeDetails.html) | List all EC2 instance types that are supported for a given OpenSearch version | List | 
| <a name="es-ListElasticsearchVersions"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVersions.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVersions.html) | List all supported OpenSearch versions on Amazon OpenSearch Service. This permission is deprecated. Use ListVersions instead | List | 
| <a name="es-ListInsights"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInsights.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInsights.html) | List insights for OpenSearch Service domains in the account | List | 
| <a name="es-ListInstanceTypeDetails"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInstanceTypeDetails.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListInstanceTypeDetails.html) | List all instance types and available features for a given OpenSearch or Elasticsearch version | List | 
| <a name="es-ListPackagesForDomain"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListPackagesForDomain.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListPackagesForDomain.html) | List all packages associated with the OpenSearch Service domain | List | 
| <a name="es-ListScheduledActions"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListScheduledActions.html) | Retrieve a list of configuration changes that are scheduled for a OpenSearch Service domain | List | 
| <a name="es-ListTags"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListTags.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListTags.html) | Display all resource tags for an OpenSearch Service domain, data source, or application | Read | 
| <a name="es-ListVersions"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVersions.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVersions.html) | List all supported OpenSearch and Elasticsearch versions in Amazon OpenSearch Service | List | 
| <a name="es-ListVpcEndpointAccess"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpointAccess.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpointAccess.html) | Retrieve information about each AWS principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint | List | 
| <a name="es-ListVpcEndpoints"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpoints.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpoints.html) | Retrieve all Amazon OpenSearch Service-managed VPC endpoints in the current AWS account and Region | List | 
| <a name="es-ListVpcEndpointsForDomain"></a>[https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpointsForDomain.html](https://docs.aws.amazon.com/opensearch-service/latest/APIReference/API_ListVpcEndpointsForDomain.html) | Retrieve all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain | List |