v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1496640547.5 KB

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

get/2021-01-01/opensearch/instanceTypeDetails/{EngineVersion}

Path parameters

EngineVersionstring required

The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Query parameters

domainNamestring

The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

The name of the domain.

maxResultsinteger

An optional parameter that specifies the maximum number of results to return for a given request.

An optional parameter that specifies the maximum number of results to return. You can use <code>nextToken</code> to get the next page of results.

nextTokenstring

When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.

If your initial <code>ListInstanceTypeDetails</code> operation returns a <code>nextToken</code>, you can include the returned <code>nextToken</code> in subsequent <code>ListInstanceTypeDetails</code> operations, which returns results in the next page.

retrieveAZsboolean

An optional parameter that specifies the Availability Zones for the domain.

instanceTypestring

An optional parameter that lists information for a given instance type.

Response

Success

NextTokenstring

When <code>nextToken</code> is returned, there are more results available. The value of <code>nextToken</code> is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.