Data retrieval APIs for Amazon OpenSearch Service
Amazon OpenSearch Service provides the following APIs for data retrieval.
| Actions | Description | Access level |
|---|---|---|
| DescribeDomain | View a description of the domain configuration for the specified OpenSearch Service domain, including the domain ID, service endpoint, and ARN | Read |
| DescribeDomainAutoTunes | View the Auto-Tune configuration of the domain for the specified OpenSearch Service domain, including the Auto-Tune state and maintenance schedules | Read |
| DescribeDomainChangeProgress | View detail stage progress of an OpenSearch Service domain | Read |
| DescribeDomainConfig | View a description of the configuration options and status of an OpenSearch Service domain | Read |
| DescribeDomainHealth | View information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node | Read |
| DescribeDomainNodes | 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 |
| DescribeDomains | View a description of the domain configuration for up to five specified OpenSearch Service domains | List |
| DescribeDryRunProgress | Describe the status of a pre-update validation check on an OpenSearch Service domain | Read |
| DescribeElasticsearchDomain | 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 |
| DescribeElasticsearchDomainConfig | View a description of the configuration and status of an OpenSearch Service domain. This permission is deprecated. Use DescribeDomainConfig instead | Read |
| DescribeElasticsearchDomains | View a description of the domain configuration for up to five specified Amazon OpenSearch domains. This permission is deprecated. Use DescribeDomains instead | List |
| DescribeElasticsearchInstanceTypeLimits | 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 |
| DescribeInboundConnections | List all the inbound cross-cluster search connections for a destination domain | List |
| DescribeInboundCrossClusterSearchConnections | List all the inbound cross-cluster search connections for a destination domain. This permission is deprecated. Use DescribeInboundConnections instead | List |
| DescribeInstanceTypeLimits | View the instance count, storage, and master node limits for a given engine version and instance type | List |
| DescribeOutboundConnections | List all the outbound cross-cluster search connections for a source domain | List |
| DescribeOutboundCrossClusterSearchConnections | List all the outbound cross-cluster search connections for a source domain. This permission is deprecated. Use DescribeOutboundConnections instead | List |
| DescribePackages | Describe all packages available to OpenSearch Service domains | Read |
| DescribeReservedElasticsearchInstanceOfferings | Fetch Reserved Instance offerings for Amazon OpenSearch Service. This permission is deprecated. Use DescribeReservedInstanceOfferings instead | List |
| DescribeReservedElasticsearchInstances | Fetch OpenSearch Service Reserved Instances that have already been purchased. This permission is deprecated. Use DescribeReservedInstances instead | List |
| DescribeReservedInstanceOfferings | Fetch Reserved Instance offerings for OpenSearch Service | List |
| DescribeReservedInstances | Fetch OpenSearch Service Reserved Instances that have already been purchased | List |
| DescribeVpcEndpoints | Describe one or more Amazon OpenSearch Service-managed VPC endpoints | List |
| ESCrossClusterGet | Send cross-cluster requests to a destination domain | Read |
| ESHttpGet | Send HTTP GET requests to the OpenSearch APIs | Read |
| ESHttpHead | Send HTTP HEAD requests to the OpenSearch APIs | Read |
| GetApplication | Get information about an OpenSearch Application | Read |
| GetCompatibleElasticsearchVersions | 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 |
| GetCompatibleVersions | Fetch list of compatible engine versions to which an OpenSearch Service domain can be upgraded | List |
| GetDataSource | Get the data source for the OpenSearch Service domain | Read |
| GetDirectQueryDataSource | Get the data source for the provided OpenSearch arns | Read |
| GetDomainMaintenanceStatus | Retrieve the status of maintenance action for the node | Read |
| GetPackageVersionHistory | Fetch the version history for a package | Read |
| GetUpgradeHistory | Fetch the upgrade history of a given OpenSearch Service domain | Read |
| GetUpgradeStatus | Fetch the upgrade status of a given OpenSearch Service domain | Read |
| ListApplications | List OpenSearch Applications | List |
| ListDataSources | Retrieve a list of data source for the OpenSearch Service domain | List |
| ListDirectQueryDataSources | Retrieve a list of data source for the provided OpenSearch arns | List |
| ListDomainMaintenances | Retrieve a list of maintenance actions for the OpenSearch Service domain | List |
| ListDomainNames | Display the names of all OpenSearch Service domains that the current user owns | List |
| ListDomainsForPackage | List all OpenSearch Service domains that a package is associated with | List |
| ListElasticsearchInstanceTypeDetails | List all instance types and available features for a given OpenSearch version. This permission is deprecated. Use ListInstanceTypeDetails instead | List |
| ListElasticsearchInstanceTypes | List all EC2 instance types that are supported for a given OpenSearch version | List |
| ListElasticsearchVersions | List all supported OpenSearch versions on Amazon OpenSearch Service. This permission is deprecated. Use ListVersions instead | List |
| ListInstanceTypeDetails | List all instance types and available features for a given OpenSearch or Elasticsearch version | List |
| ListPackagesForDomain | List all packages associated with the OpenSearch Service domain | List |
| ListScheduledActions | Retrieve a list of configuration changes that are scheduled for a OpenSearch Service domain | List |
| ListTags | Display all resource tags for an OpenSearch Service domain, data source, or application | Read |
| ListVersions | List all supported OpenSearch and Elasticsearch versions in Amazon OpenSearch Service | List |
| ListVpcEndpointAccess | 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 |
| ListVpcEndpoints | Retrieve all Amazon OpenSearch Service-managed VPC endpoints in the current AWS account and Region | List |
| ListVpcEndpointsForDomain | Retrieve all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain | List |
